Struct re_types::archetypes::Asset3D

pub struct Asset3D {
    pub blob: Blob,
    pub media_type: Option<MediaType>,
    pub transform: Option<OutOfTreeTransform3D>,
}

Expand description

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

See also Mesh3D.

Example

Simple 3D asset

//! Log a 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]>", args[0]);
    };

    let (rec, storage) =
        rerun::RecordingStreamBuilder::new("rerun_example_asset3d_simple").memory()?;

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

    rerun::native_viewer::show(storage.take())?;
    Ok(())
}

Fields§

§blob: Blob

The asset’s bytes.

§media_type: Option<MediaType>

The Media Type of the asset.

Supported values:

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

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.

§transform: Option<OutOfTreeTransform3D>

An out-of-tree transform.

Applies a transformation to the asset itself without impacting its children.

Implementations§

impl Asset3D

pub const NUM_COMPONENTS: usize = 5usize

impl Asset3D

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

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

pub fn with_transform(self, transform: impl Into<OutOfTreeTransform3D>) -> Self

impl Asset3D

pub fn from_file(path: 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.

pub fn from_bytes( bytes: impl AsRef<[u8]>, media_type: Option<impl Into<MediaType>> ) -> Self

Creates a new Asset3D from the given bytes.

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. Read more

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. Read more

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. Read more

fn from_arrow( arrow_data: impl IntoIterator<Item = (Field, Box<dyn Array>)> ) -> DeserializationResult<Self>

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

impl AsComponents for Asset3D

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

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

fn num_instances(&self) -> usize

The number of instances in each batch. Read more

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

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

impl Clone for Asset3D

fn clone(&self) -> Asset3D

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for Asset3D

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

Formats the value using the given formatter. Read more

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 ==.

1.0.0 · source§

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 StructuralPartialEq for Asset3D

Auto Trait Implementations§

impl RefUnwindSafe for Asset3D

impl Send for Asset3D

impl Sync for Asset3D

impl Unpin for Asset3D

impl UnwindSafe for Asset3D

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> DynClone for T
where T: Clone,

fn __clone_box(&self, _: Private) -> *mut ()

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more