Struct rerun::archetypes::ViewCoordinates

#[repr(transparent)]
pub struct ViewCoordinates {
    pub xyz: Option<SerializedComponentBatch>,
}

Archetype: How we interpret the coordinate system of an entity/space.

For instance: What is “up”? What does the Z axis mean?

The three coordinates are always ordered as [x, y, z].

For example [Right, Down, Forward] means that the X axis points to the right, the Y axis points down, and the Z axis points forward.

Make sure that this archetype is logged at or above the origin entity path of your 3D views.

⚠ Rerun does not yet support left-handed coordinate systems.

Example

View coordinates for adjusting the eye camera

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

    rec.log_static("world", &rerun::ViewCoordinates::RIGHT_HAND_Z_UP())?; // Set an up-axis
    rec.log(
        "world/xyz",
        &rerun::Arrows3D::from_vectors(
            [[1.0, 0.0, 0.0], [0.0, 1.0, 0.0], [0.0, 0.0, 1.0]], //
        )
        .with_colors([[255, 0, 0], [0, 255, 0], [0, 0, 255]]),
    )?;

    Ok(())
}

Fields

xyz: Option<SerializedComponentBatch>

The directions of the [x, y, z] axes.

Implementations

impl ViewCoordinates

pub fn descriptor_xyz() -> ComponentDescriptor

Returns the ComponentDescriptor for Self::xyz.

pub fn descriptor_indicator() -> ComponentDescriptor

Returns the ComponentDescriptor for the associated indicator component.

impl ViewCoordinates

pub const NUM_COMPONENTS: usize = 2usize

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

impl ViewCoordinates

pub fn new(xyz: impl Into<ViewCoordinates>) -> ViewCoordinates

Create a new ViewCoordinates.

pub fn update_fields() -> ViewCoordinates

Update only some specific fields of a ViewCoordinates.

pub fn clear_fields() -> ViewCoordinates

Clear all the fields of a ViewCoordinates.

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_xyz(self, xyz: impl Into<ViewCoordinates>) -> ViewCoordinates

The directions of the [x, y, z] axes.

pub fn with_many_xyz( self, xyz: impl IntoIterator<Item = impl Into<ViewCoordinates>>, ) -> ViewCoordinates

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

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

impl ViewCoordinates

pub fn ULF() -> ViewCoordinates

X=Up, Y=Left, Z=Forward

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn UFL() -> ViewCoordinates

X=Up, Y=Forward, Z=Left

pub fn LUF() -> ViewCoordinates

X=Left, Y=Up, Z=Forward

pub fn LFU() -> ViewCoordinates

X=Left, Y=Forward, Z=Up

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn FUL() -> ViewCoordinates

X=Forward, Y=Up, Z=Left

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn FLU() -> ViewCoordinates

X=Forward, Y=Left, Z=Up

pub fn ULB() -> ViewCoordinates

X=Up, Y=Left, Z=Back

pub fn UBL() -> ViewCoordinates

X=Up, Y=Back, Z=Left

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LUB() -> ViewCoordinates

X=Left, Y=Up, Z=Back

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LBU() -> ViewCoordinates

X=Left, Y=Back, Z=Up

pub fn BUL() -> ViewCoordinates

X=Back, Y=Up, Z=Left

pub fn BLU() -> ViewCoordinates

X=Back, Y=Left, Z=Up

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn URF() -> ViewCoordinates

X=Up, Y=Right, Z=Forward

pub fn UFR() -> ViewCoordinates

X=Up, Y=Forward, Z=Right

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn RUF() -> ViewCoordinates

X=Right, Y=Up, Z=Forward

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn RFU() -> ViewCoordinates

X=Right, Y=Forward, Z=Up

pub fn FUR() -> ViewCoordinates

X=Forward, Y=Up, Z=Right

pub fn FRU() -> ViewCoordinates

X=Forward, Y=Right, Z=Up

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn URB() -> ViewCoordinates

X=Up, Y=Right, Z=Back

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn UBR() -> ViewCoordinates

X=Up, Y=Back, Z=Right

pub fn RUB() -> ViewCoordinates

X=Right, Y=Up, Z=Back

pub fn RBU() -> ViewCoordinates

X=Right, Y=Back, Z=Up

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn BUR() -> ViewCoordinates

X=Back, Y=Up, Z=Right

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn BRU() -> ViewCoordinates

X=Back, Y=Right, Z=Up

pub fn DLF() -> ViewCoordinates

X=Down, Y=Left, Z=Forward

pub fn DFL() -> ViewCoordinates

X=Down, Y=Forward, Z=Left

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LDF() -> ViewCoordinates

X=Left, Y=Down, Z=Forward

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LFD() -> ViewCoordinates

X=Left, Y=Forward, Z=Down

pub fn FDL() -> ViewCoordinates

X=Forward, Y=Down, Z=Left

pub fn FLD() -> ViewCoordinates

X=Forward, Y=Left, Z=Down

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn DLB() -> ViewCoordinates

X=Down, Y=Left, Z=Back

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn DBL() -> ViewCoordinates

X=Down, Y=Back, Z=Left

pub fn LDB() -> ViewCoordinates

X=Left, Y=Down, Z=Back

pub fn LBD() -> ViewCoordinates

X=Left, Y=Back, Z=Down

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn BDL() -> ViewCoordinates

X=Back, Y=Down, Z=Left

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn BLD() -> ViewCoordinates

X=Back, Y=Left, Z=Down

pub fn DRF() -> ViewCoordinates

X=Down, Y=Right, Z=Forward

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn DFR() -> ViewCoordinates

X=Down, Y=Forward, Z=Right

pub fn RDF() -> ViewCoordinates

X=Right, Y=Down, Z=Forward

pub fn RFD() -> ViewCoordinates

X=Right, Y=Forward, Z=Down

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn FDR() -> ViewCoordinates

X=Forward, Y=Down, Z=Right

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn FRD() -> ViewCoordinates

X=Forward, Y=Right, Z=Down

pub fn DRB() -> ViewCoordinates

X=Down, Y=Right, Z=Back

pub fn DBR() -> ViewCoordinates

X=Down, Y=Back, Z=Right

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn RDB() -> ViewCoordinates

X=Right, Y=Down, Z=Back

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn RBD() -> ViewCoordinates

X=Right, Y=Back, Z=Down

pub fn BDR() -> ViewCoordinates

X=Back, Y=Down, Z=Right

pub fn BRD() -> ViewCoordinates

X=Back, Y=Right, Z=Down

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn RIGHT_HAND_X_UP() -> ViewCoordinates

X=Up, Y=Right, Z=Forward

pub fn RIGHT_HAND_X_DOWN() -> ViewCoordinates

X=Down, Y=Right, Z=Back

pub fn RIGHT_HAND_Y_UP() -> ViewCoordinates

X=Right, Y=Up, Z=Back

pub fn RIGHT_HAND_Y_DOWN() -> ViewCoordinates

X=Right, Y=Down, Z=Forward

pub fn RIGHT_HAND_Z_UP() -> ViewCoordinates

X=Right, Y=Forward, Z=Up

pub fn RIGHT_HAND_Z_DOWN() -> ViewCoordinates

X=Right, Y=Back, Z=Down

pub fn LEFT_HAND_X_UP() -> ViewCoordinates

X=Up, Y=Right, Z=Back

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LEFT_HAND_X_DOWN() -> ViewCoordinates

X=Down, Y=Right, Z=Forward

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LEFT_HAND_Y_UP() -> ViewCoordinates

X=Right, Y=Up, Z=Forward

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LEFT_HAND_Y_DOWN() -> ViewCoordinates

X=Right, Y=Down, Z=Back

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LEFT_HAND_Z_UP() -> ViewCoordinates

X=Right, Y=Back, Z=Up

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

pub fn LEFT_HAND_Z_DOWN() -> ViewCoordinates

X=Right, Y=Forward, Z=Down

⚠️ This is a left-handed coordinate system, which is not yet supported by Rerun.

Trait Implementations

impl Archetype for ViewCoordinates

type Indicator = GenericIndicatorComponent<ViewCoordinates>

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

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 ViewCoordinates

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 ViewCoordinates

fn clone(&self) -> ViewCoordinates

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ViewCoordinates

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

Formats the value using the given formatter.

impl Default for ViewCoordinates

fn default() -> ViewCoordinates

Returns the “default value” for a type.

impl PartialEq for ViewCoordinates

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

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 ViewCoordinates

impl StructuralPartialEq for ViewCoordinates