Struct TransformAxes3D 

pub struct TransformAxes3D {
    pub axis_length: Option<SerializedComponentBatch>,
    pub show_frame: Option<SerializedComponentBatch>,
}

Archetype: A visual representation of a archetypes::Transform3D.

Example

Visual representation of a transform as three arrows

use rerun::AsComponents;

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

    rec.set_time_sequence("step", 0);

    rec.log(
        "base",
        &[
            &rerun::Transform3D::new() as &dyn AsComponents,
            &rerun::TransformAxes3D::new(1.0),
        ],
    )?;

    for deg in 0..360 {
        rec.set_time_sequence("step", deg);
        rec.log(
            "base/rotated",
            &[
                &rerun::Transform3D::new().with_rotation(rerun::RotationAxisAngle::new(
                    [1.0, 1.0, 1.0],
                    rerun::Angle::from_degrees(deg as f32),
                )) as &dyn AsComponents,
                &rerun::TransformAxes3D::new(0.5),
            ],
        )?;
        rec.log(
            "base/rotated/translated",
            &[
                &rerun::Transform3D::new().with_translation([2.0, 0.0, 0.0]) as &dyn AsComponents,
                &rerun::TransformAxes3D::new(0.5),
            ],
        )?;
    }

    Ok(())
}

Fields

axis_length: Option<SerializedComponentBatch>

Visual length of the 3 axes.

The length is interpreted in the local coordinate system of the transform. If the transform is scaled, the axes will be scaled accordingly.

show_frame: Option<SerializedComponentBatch>

Whether to show a text label with the corresponding frame.

Implementations

impl TransformAxes3D

pub fn descriptor_axis_length() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::axis_length.

The corresponding component is crate::components::AxisLength.

pub fn descriptor_show_frame() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::show_frame.

The corresponding component is crate::components::ShowLabels.

impl TransformAxes3D

pub const NUM_COMPONENTS: usize = 2usize

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

impl TransformAxes3D

pub fn new(axis_length: impl Into<AxisLength>) -> TransformAxes3D

Create a new TransformAxes3D.

pub fn update_fields() -> TransformAxes3D

Update only some specific fields of a TransformAxes3D.

pub fn clear_fields() -> TransformAxes3D

Clear all the fields of a TransformAxes3D.

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

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, ) -> Result<impl Iterator<Item = SerializedComponentColumn>, SerializationError>

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_axis_length( self, axis_length: impl Into<AxisLength>, ) -> TransformAxes3D

Visual length of the 3 axes.

The length is interpreted in the local coordinate system of the transform. If the transform is scaled, the axes will be scaled accordingly.

pub fn with_many_axis_length( self, axis_length: impl IntoIterator<Item = impl Into<AxisLength>>, ) -> TransformAxes3D

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

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

pub fn with_show_frame( self, show_frame: impl Into<ShowLabels>, ) -> TransformAxes3D

Whether to show a text label with the corresponding frame.

pub fn with_many_show_frame( self, show_frame: impl IntoIterator<Item = impl Into<ShowLabels>>, ) -> TransformAxes3D

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

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

Trait Implementations

impl Archetype for TransformAxes3D

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 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, Arc<dyn Array>)>, ) -> Result<TransformAxes3D, DeserializationError>

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

fn all_component_identifiers() -> impl Iterator<Item = ComponentIdentifier>

Utility method based on Self::all_components to return all component identifiers.

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 TransformAxes3D

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 TransformAxes3D

fn clone(&self) -> TransformAxes3D

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransformAxes3D

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

Formats the value using the given formatter.

impl Default for TransformAxes3D

fn default() -> TransformAxes3D

Returns the “default value” for a type.

impl PartialEq for TransformAxes3D

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl SizeBytes for TransformAxes3D

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 VisualizableArchetype for TransformAxes3D

fn visualizer(&self) -> Visualizer

Create a visualizer for this archetype, using all currently set values as overrides.

impl ArchetypeReflectionMarker for TransformAxes3D

impl StructuralPartialEq for TransformAxes3D