Struct three_d::renderer::geometry::InstancedMesh

pub struct InstancedMesh { /* private fields */ }

Similar to Mesh, except it is possible to render many instances of the same mesh efficiently.

Implementations

impl InstancedMesh

pub fn new(context: &Context, instances: &Instances, cpu_mesh: &CpuMesh) -> Self

Creates a new instanced 3D mesh from the given CpuMesh. All data in the CpuMesh is transfered to the GPU, so make sure to remove all unnecessary data from the CpuMesh before calling this method. The model is rendered in as many instances as there are attributes in Instances given as input.

pub fn transformation(&self) -> Mat4

Returns the local to world transformation applied to all instances.

pub fn set_transformation(&mut self, transformation: Mat4)

Set the local to world transformation applied to all instances. This is applied before the transform for each instance.

pub fn set_animation( &mut self, animation: impl Fn(f32) -> Mat4 + Send + Sync + 'static )

Specifies a function which takes a time parameter as input and returns a transformation that should be applied to this mesh at the given time. To actually animate this instanced mesh, call Geometry::animate at each frame which in turn evaluates the animation function defined by this method. This transformation is applied first, then the local to world transformation defined by Self::set_transformation.

pub fn instance_count(&self) -> u32

Returns the number of instances that is rendered.

pub fn set_instances(&mut self, instances: &Instances)

Update the instances.

Trait Implementations

impl Geometry for InstancedMesh

fn draw( &self, camera: &Camera, program: &Program, render_states: RenderStates, attributes: FragmentAttributes )

Draw this geometry.

fn vertex_shader_source( &self, required_attributes: FragmentAttributes ) -> String

Returns the vertex shader source for this geometry given that the fragment shader needs the given vertex attributes.

fn id(&self, required_attributes: FragmentAttributes) -> u16

Returns a unique ID for each variation of the shader source returned from Geometry::vertex_shader_source.

fn aabb(&self) -> AxisAlignedBoundingBox

Returns the AxisAlignedBoundingBox for this geometry in the global coordinate system.

fn animate(&mut self, time: f32)

For updating the animation of this geometry if it is animated, if not, this method does nothing. The time parameter should be some continious time, for example the time since start.

fn render_with_material( &self, material: &dyn Material, camera: &Camera, lights: &[&dyn Light] )

Render the geometry with the given Material. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method. Use an empty array for the lights argument, if the material does not require lights to be rendered.

fn render_with_effect( &self, material: &dyn Effect, camera: &Camera, lights: &[&dyn Light], color_texture: Option<ColorTexture<'_>>, depth_texture: Option<DepthTexture<'_>> )

Render the geometry with the given Effect. Must be called in the callback given as input to a RenderTarget, ColorTarget or DepthTarget write method. Use an empty array for the lights argument, if the material does not require lights to be rendered.

impl<'a> IntoIterator for &'a InstancedMesh

type Item = &'a dyn Geometry

The type of the elements being iterated over.

type IntoIter = Once<&'a dyn Geometry>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.