Struct re_types::archetypes::Asset3D

pub struct Asset3D {
    pub blob: Option<SerializedComponentBatch>,
    pub media_type: Option<SerializedComponentBatch>,
    pub albedo_factor: Option<SerializedComponentBatch>,
}

Archetype: A prepacked 3D asset (.gltf, .glb, .obj, .stl, etc.).

See also archetypes::Mesh3D.

If there are multiple archetypes::InstancePoses3D instances logged to the same entity as a mesh, an instance of the mesh will be drawn for each transform.

Example

Simple 3D asset

use rerun::external::anyhow;

fn main() -> anyhow::Result<()> {
    let args = std::env::args().collect::<Vec<_>>();
    let Some(path) = args.get(1) else {
        anyhow::bail!("Usage: {} <path_to_asset.[gltf|glb|obj|stl]>", args[0]);
    };

    let rec = rerun::RecordingStreamBuilder::new("rerun_example_asset3d").spawn()?;

    rec.log_static("world", &rerun::ViewCoordinates::RIGHT_HAND_Z_UP())?; // Set an up-axis
    rec.log("world/asset", &rerun::Asset3D::from_file(path)?)?;

    Ok(())
}

Fields

blob: Option<SerializedComponentBatch>

The asset’s bytes.

media_type: Option<SerializedComponentBatch>

The Media Type of the asset.

Supported values:

• model/gltf-binary
• model/gltf+json
• model/obj (.mtl material files are not supported yet, references are silently ignored)
• model/stl

If omitted, the viewer will try to guess from the data blob. If it cannot guess, it won’t be able to render the asset.

albedo_factor: Option<SerializedComponentBatch>

A color multiplier applied to the whole asset.

For mesh who already have albedo_factor in materials, it will be overwritten by actual albedo_factor of archetypes::Asset3D (if specified).

Implementations

impl Asset3D

pub fn descriptor_blob() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::blob.

pub fn descriptor_media_type() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::media_type.

pub fn descriptor_albedo_factor() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::albedo_factor.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl Asset3D

pub const NUM_COMPONENTS: usize = 4usize

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

impl Asset3D

pub fn new(blob: impl Into<Blob>) -> Self

Create a new Asset3D.

pub fn update_fields() -> Self

Update only some specific fields of a Asset3D.

pub fn clear_fields() -> Self

Clear all the fields of a Asset3D.

pub fn columns<I>( self, _lengths: I, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

where I: IntoIterator<Item = usize> + Clone,

Partitions the component data into multiple sub-batches.

Specifically, this transforms the existing SerializedComponentBatches data into SerializedComponentColumns instead, via SerializedComponentBatch::partitioned.

This makes it possible to use RecordingStream::send_columns to send columnar data directly into Rerun.

The specified lengths must sum to the total length of the component batch.

pub fn columns_of_unit_batches( self, ) -> SerializationResult<impl Iterator<Item = SerializedComponentColumn>>

Helper to partition the component data into unit-length sub-batches.

This is semantically similar to calling Self::columns with std::iter::take(1).repeat(n), where n is automatically guessed.

pub fn with_blob(self, blob: impl Into<Blob>) -> Self

The asset’s bytes.

pub fn with_many_blob( self, blob: impl IntoIterator<Item = impl Into<Blob>>, ) -> Self

This method makes it possible to pack multiple crate::components::Blob in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_blob should be used when logging a single row’s worth of data.

pub fn with_media_type(self, media_type: impl Into<MediaType>) -> Self

The Media Type of the asset.

Supported values:

• model/gltf-binary
• model/gltf+json
• model/obj (.mtl material files are not supported yet, references are silently ignored)
• model/stl

If omitted, the viewer will try to guess from the data blob. If it cannot guess, it won’t be able to render the asset.

pub fn with_many_media_type( self, media_type: impl IntoIterator<Item = impl Into<MediaType>>, ) -> Self

This method makes it possible to pack multiple crate::components::MediaType in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_media_type should be used when logging a single row’s worth of data.

pub fn with_albedo_factor(self, albedo_factor: impl Into<AlbedoFactor>) -> Self

A color multiplier applied to the whole asset.

For mesh who already have albedo_factor in materials, it will be overwritten by actual albedo_factor of archetypes::Asset3D (if specified).

pub fn with_many_albedo_factor( self, albedo_factor: impl IntoIterator<Item = impl Into<AlbedoFactor>>, ) -> Self

This method makes it possible to pack multiple crate::components::AlbedoFactor in a single component batch.

This only makes sense when used in conjunction with Self::columns. Self::with_albedo_factor should be used when logging a single row’s worth of data.

impl Asset3D

pub fn from_file(filepath: impl AsRef<Path>) -> Result<Self>

Creates a new Asset3D from the file contents at path.

The MediaType will first be guessed from the file extension, then from the file contents if needed.

If no MediaType can be guessed at the moment, the Rerun Viewer will try to guess one from the data at render-time. If it can’t, rendering will fail with an error.

Returns an error if the file cannot be read.

pub fn from_file_contents( contents: Vec<u8>, media_type: Option<impl Into<MediaType>>, ) -> Self

Creates a new Asset3D from the given contents.

The MediaType will be guessed from magic bytes in the data.

If no MediaType can be guessed at the moment, the Rerun Viewer will try to guess one from the data at render-time. If it can’t, rendering will fail with an error.

Trait Implementations

impl Archetype for Asset3D

type Indicator = GenericIndicatorComponent<Asset3D>

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 display_name() -> &'static str

Readable name for displaying in UI.

fn indicator() -> SerializedComponentBatch

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

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

Returns all component descriptors that must be provided by the user when constructing this archetype.

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

Returns all component descriptors that should be provided by the user when constructing this archetype.

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

Returns all component descriptors that may be provided by the user when constructing this archetype.

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

Returns all component descriptors that must, should and may be provided by the user when constructing this archetype.

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentDescriptor, ArrayRef)>, ) -> DeserializationResult<Self>

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

fn from_arrow( data: impl IntoIterator<Item = (Field, Arc<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 Asset3D

fn as_serialized_batches(&self) -> Vec<SerializedComponentBatch>

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

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

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

impl Clone for Asset3D

fn clone(&self) -> Asset3D

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Asset3D

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

Formats the value using the given formatter.

impl Default for Asset3D

fn default() -> Asset3D

Returns the “default value” for a type.

impl PartialEq for Asset3D

fn eq(&self, other: &Asset3D) -> 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 Asset3D

fn heap_size_bytes(&self) -> u64

Returns how many bytes self uses on the heap.

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.

fn is_pod() -> bool

Is Self just plain old data?

impl ArchetypeReflectionMarker for Asset3D

impl StructuralPartialEq for Asset3D