Struct rerun::Mesh3D

pub struct Mesh3D {
    pub vertex_positions: Vec<Position3D>,
    pub triangle_indices: Option<Vec<TriangleIndices>>,
    pub vertex_normals: Option<Vec<Vector3D>>,
    pub vertex_colors: Option<Vec<Color>>,
    pub vertex_texcoords: Option<Vec<Texcoord2D>>,
    pub mesh_material: Option<Material>,
    pub albedo_texture: Option<TensorData>,
    pub class_ids: Option<Vec<ClassId>>,
}

Archetype: A 3D triangle mesh as specified by its per-mesh and per-vertex properties.

See also Asset3D.

Example

Simple indexed 3D mesh

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let rec = rerun::RecordingStreamBuilder::new("rerun_example_mesh3d_indexed").spawn()?;

    rec.log(
        "triangle",
        &rerun::Mesh3D::new([[0.0, 1.0, 0.0], [1.0, 0.0, 0.0], [0.0, 0.0, 0.0]])
            .with_vertex_normals([[0.0, 0.0, 1.0]])
            .with_vertex_colors([0x0000FFFF, 0x00FF00FF, 0xFF0000FF])
            .with_triangle_indices([[2, 1, 0]]),
    )?;

    Ok(())
}

Fields

vertex_positions: Vec<Position3D>

The positions of each vertex.

If no triangle_indices are specified, then each triplet of positions is interpreted as a triangle.

triangle_indices: Option<Vec<TriangleIndices>>

Optional indices for the triangles that make up the mesh.

vertex_normals: Option<Vec<Vector3D>>

An optional normal for each vertex.

vertex_colors: Option<Vec<Color>>

An optional color for each vertex.

vertex_texcoords: Option<Vec<Texcoord2D>>

An optional uv texture coordinate for each vertex.

mesh_material: Option<Material>

Optional material properties for the mesh as a whole.

albedo_texture: Option<TensorData>

Optional albedo texture.

Used with vertex_texcoords on Mesh3D. Currently supports only sRGB(A) textures, ignoring alpha. (meaning that the tensor must have 3 or 4 channels and use the u8 format)

class_ids: Option<Vec<ClassId>>

Optional class Ids for the vertices.

The class ID provides colors and labels if not specified explicitly.

Implementations

impl Mesh3D

pub const NUM_COMPONENTS: usize = 9usize

The total number of components in the archetype: 1 required, 3 recommended, 5 optional

impl Mesh3D

pub fn new( vertex_positions: impl IntoIterator<Item = impl Into<Position3D>> ) -> Mesh3D

Create a new Mesh3D.

pub fn with_triangle_indices( self, triangle_indices: impl IntoIterator<Item = impl Into<TriangleIndices>> ) -> Mesh3D

Optional indices for the triangles that make up the mesh.

pub fn with_vertex_normals( self, vertex_normals: impl IntoIterator<Item = impl Into<Vector3D>> ) -> Mesh3D

An optional normal for each vertex.

pub fn with_vertex_colors( self, vertex_colors: impl IntoIterator<Item = impl Into<Color>> ) -> Mesh3D

An optional color for each vertex.

pub fn with_vertex_texcoords( self, vertex_texcoords: impl IntoIterator<Item = impl Into<Texcoord2D>> ) -> Mesh3D

An optional uv texture coordinate for each vertex.

pub fn with_mesh_material(self, mesh_material: impl Into<Material>) -> Mesh3D

Optional material properties for the mesh as a whole.

pub fn with_albedo_texture( self, albedo_texture: impl Into<TensorData> ) -> Mesh3D

Optional albedo texture.

Used with vertex_texcoords on Mesh3D. Currently supports only sRGB(A) textures, ignoring alpha. (meaning that the tensor must have 3 or 4 channels and use the u8 format)

pub fn with_class_ids( self, class_ids: impl IntoIterator<Item = impl Into<ClassId>> ) -> Mesh3D

Optional class Ids for the vertices.

The class ID provides colors and labels if not specified explicitly.

impl Mesh3D

pub fn sanity_check(&self) -> Result<(), Mesh3DError>

Check that this is a valid mesh, e.g. that the vertex indices are within bounds and that we have the same number of positions and normals (if any).

pub fn num_vertices(&self) -> usize

The total number of vertices.

pub fn num_triangles(&self) -> usize

The total number of triangles.

Trait Implementations

impl Archetype for Mesh3D

type Indicator = GenericIndicatorComponent<Mesh3D>

The associated indicator component, whose presence indicates that the high-level archetype-based APIs were used to log the data.

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

fn indicator() -> MaybeOwnedComponentBatch<'static>

Creates a ComponentBatch out of the associated Self::Indicator component.

fn required_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must be provided by the user when constructing this archetype.

fn recommended_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that should be provided by the user when constructing this archetype.

fn optional_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that may be provided by the user when constructing this archetype.

fn all_components() -> Cow<'static, [ComponentName]>

Returns the names of all components that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<Mesh3D, DeserializationError>

Given an iterator of Arrow arrays and their respective ComponentNames, deserializes them into this archetype.

fn from_arrow( data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> Result<Self, DeserializationError>

where Self: Sized,

Given an iterator of Arrow arrays and their respective field metadata, deserializes them into this archetype.

impl AsComponents for Mesh3D

fn as_component_batches(&self) -> Vec<MaybeOwnedComponentBatch<'_>>

Exposes the object’s contents as a set of ComponentBatchs.

fn to_arrow(&self) -> Result<Vec<(Field, Box<dyn Array>)>, SerializationError>

Serializes all non-null Components of this bundle into Arrow arrays.

impl Clone for Mesh3D

fn clone(&self) -> Mesh3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Mesh3D

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl PartialEq for Mesh3D

fn eq(&self, other: &Mesh3D) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl SizeBytes for Mesh3D

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

fn is_pod() -> bool

Is Self just plain old data?

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes.

impl ToArchetype<Mesh3D> for LatestAtResults

fn to_archetype( &self, resolver: &PromiseResolver ) -> PromiseResult<Result<Mesh3D, QueryError>>

Converts the result into an re_types_core::Archetype.

impl StructuralPartialEq for Mesh3D