Struct three_d::renderer::object::InstancedModel

pub struct InstancedModel<M: Material> {
    pub material: M,
    // some fields omitted
}

Similar to Model, except it is possible to render many instances of the same model efficiently.

Fields

material: M

The material applied to the instanced model

Implementations

impl InstancedModel<ColorMaterial>

pub fn new(
    context: &Context,
    instances: &[ModelInstance],
    cpu_mesh: &CPUMesh
) -> ThreeDResult<Self>

Creates a new instanced 3D model with a triangle mesh as geometry and a default ColorMaterial. The transformations are applied to each model instance before they are rendered. The model is rendered in as many instances as there are transformation matrices.

impl<M: Material> InstancedModel<M>

pub fn new_with_material(
    context: &Context,
    instances: &[ModelInstance],
    cpu_mesh: &CPUMesh,
    material: M
) -> ThreeDResult<Self>

pub fn texture_transform(&mut self) -> &Mat3

pub fn set_texture_transform(&mut self, texture_transform: Mat3)

pub fn instances(&self) -> &[ModelInstance]

Returns all instances

pub fn set_instances(&mut self, instances: &[ModelInstance])

Create an instance for each element with the given mesh and texture transforms.

Trait Implementations

impl<M: Material> Geometry for InstancedModel<M>

fn aabb(&self) -> AxisAlignedBoundingBox

Returns the AxisAlignedBoundingBox for this geometry.

fn transformation(&self) -> Mat4

Returns the local to world transformation applied to this geometry.

impl<M: Material> GeometryMut for InstancedModel<M>

fn set_transformation(&mut self, transformation: Mat4)

Set the local to world transformation applied to this geometry.

impl<M: Material> Object for InstancedModel<M>

fn render(&self, camera: &Camera, lights: &Lights) -> ThreeDResult<()>

Render the object. Must be called in a render target render function, for example in the callback function of Screen::write. You can use Lights::default() if you know the object does not require lights to be rendered.

fn is_transparent(&self) -> bool

Returns whether or not this object should be considered transparent.

impl<M: Material> Shadable for InstancedModel<M>

fn render_with_material(
    &self,
    material: &dyn Material,
    camera: &Camera,
    lights: &Lights
) -> ThreeDResult<()>

Render the object with the given material. Must be called in a render target render function, for example in the callback function of Screen::write. You can use Lights::default() if you know the material does not require lights.

fn render_forward(
    &self,
    material: &dyn Material,
    camera: &Camera,
    lights: &Lights
) -> ThreeDResult<()>

👎 Deprecated:

use render_with_material instead

Render the object with the given material. Must be called in a render target render function, for example in the callback function of Screen::write. You can use Lights::default() if you know the material does not require lights.

fn render_deferred(
    &self,
    material: &DeferredPhysicalMaterial,
    camera: &Camera,
    viewport: Viewport
) -> ThreeDResult<()>

👎 Deprecated

Render the geometry and surface material parameters of the object. Should usually not be called directly but used in DeferredPipeline::geometry_pass.