Struct three_d::renderer::object::Gm

pub struct Gm<G: Geometry, M: Material> {
    pub geometry: G,
    pub material: M,
}

A combination of a Geometry and a Material which implements Object. Use this to combine any geometry and material into an object that can be used in a render function for example render_pass. The only requirement is that the geometry provides all the per vertex information (normals, uv coordinates, etc.) that the material requires.

Fields

geometry: G

The geometry

material: M

The material applied to the geometry

Implementations

impl Gm<Mesh, M>

pub fn new(context: &Context, cpu_mesh: &CpuMesh) -> ThreeDResult<Self>

Creates a new 3D model with a Mesh as geometry and a default ColorMaterial.

impl<M: Material> Gm<Mesh, M>

pub fn new_with_material(
    context: &Context,
    cpu_mesh: &CpuMesh,
    material: M
) -> ThreeDResult<Self>

Creates a new 3D model with a Mesh as geometry and the given material.

impl Gm<InstancedMesh, M>

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

Creates a new instanced 3D model with a triangle mesh as geometry and a default ColorMaterial. The model is rendered in as many instances as there are Instance structs given as input. The transformation and texture transform in Instance are applied to each model instance before they are rendered.

impl<M: Material> Gm<InstancedMesh, M>

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

Creates a new instanced 3D model with a triangle mesh as geometry and the given material. The model is rendered in as many instances as there are Instance structs given as input. The transformation and texture transform in Instance are applied to each model instance before they are rendered.

Trait Implementations

impl<G: Geometry + Clone, M: Material + Clone> Clone for Gm<G, M>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<G: Geometry, M: Material> Deref for Gm<G, M>

type Target = G

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<G: Geometry, M: Material> DerefMut for Gm<G, M>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<G: Geometry, M: Material> Geometry for Gm<G, M>

fn aabb(&self) -> AxisAlignedBoundingBox

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

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

Render the geometry 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 an empty array for the lights argument, if you know the object does not require lights to be rendered.

impl<G: Geometry, M: Material> Object for Gm<G, M>

fn render(&self, camera: &Camera, lights: &[&dyn Light]) -> 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 an empty array for the lights argument, 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.