Struct re_types::archetypes::ViewCoordinates

#[repr(transparent)]
pub struct ViewCoordinates {
    pub xyz: ViewCoordinates,
}

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

For instance: What is “up”? What does the Z axis mean? Is this right-handed or left-handed?

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.

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: ViewCoordinates

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

Implementations

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>) -> Self

Create a new ViewCoordinates.

impl ViewCoordinates

pub const ULF: Self = _

X=Up, Y=Left, Z=Forward

pub const UFL: Self = _

X=Up, Y=Forward, Z=Left

pub const LUF: Self = _

X=Left, Y=Up, Z=Forward

pub const LFU: Self = _

X=Left, Y=Forward, Z=Up

pub const FUL: Self = _

X=Forward, Y=Up, Z=Left

pub const FLU: Self = _

X=Forward, Y=Left, Z=Up

pub const ULB: Self = _

X=Up, Y=Left, Z=Back

pub const UBL: Self = _

X=Up, Y=Back, Z=Left

pub const LUB: Self = _

X=Left, Y=Up, Z=Back

pub const LBU: Self = _

X=Left, Y=Back, Z=Up

pub const BUL: Self = _

X=Back, Y=Up, Z=Left

pub const BLU: Self = _

X=Back, Y=Left, Z=Up

pub const URF: Self = _

X=Up, Y=Right, Z=Forward

pub const UFR: Self = _

X=Up, Y=Forward, Z=Right

pub const RUF: Self = _

X=Right, Y=Up, Z=Forward

pub const RFU: Self = _

X=Right, Y=Forward, Z=Up

pub const FUR: Self = _

X=Forward, Y=Up, Z=Right

pub const FRU: Self = _

X=Forward, Y=Right, Z=Up

pub const URB: Self = _

X=Up, Y=Right, Z=Back

pub const UBR: Self = _

X=Up, Y=Back, Z=Right

pub const RUB: Self = _

X=Right, Y=Up, Z=Back

pub const RBU: Self = _

X=Right, Y=Back, Z=Up

pub const BUR: Self = _

X=Back, Y=Up, Z=Right

pub const BRU: Self = _

X=Back, Y=Right, Z=Up

pub const DLF: Self = _

X=Down, Y=Left, Z=Forward

pub const DFL: Self = _

X=Down, Y=Forward, Z=Left

pub const LDF: Self = _

X=Left, Y=Down, Z=Forward

pub const LFD: Self = _

X=Left, Y=Forward, Z=Down

pub const FDL: Self = _

X=Forward, Y=Down, Z=Left

pub const FLD: Self = _

X=Forward, Y=Left, Z=Down

pub const DLB: Self = _

X=Down, Y=Left, Z=Back

pub const DBL: Self = _

X=Down, Y=Back, Z=Left

pub const LDB: Self = _

X=Left, Y=Down, Z=Back

pub const LBD: Self = _

X=Left, Y=Back, Z=Down

pub const BDL: Self = _

X=Back, Y=Down, Z=Left

pub const BLD: Self = _

X=Back, Y=Left, Z=Down

pub const DRF: Self = _

X=Down, Y=Right, Z=Forward

pub const DFR: Self = _

X=Down, Y=Forward, Z=Right

pub const RDF: Self = _

X=Right, Y=Down, Z=Forward

pub const RFD: Self = _

X=Right, Y=Forward, Z=Down

pub const FDR: Self = _

X=Forward, Y=Down, Z=Right

pub const FRD: Self = _

X=Forward, Y=Right, Z=Down

pub const DRB: Self = _

X=Down, Y=Right, Z=Back

pub const DBR: Self = _

X=Down, Y=Back, Z=Right

pub const RDB: Self = _

X=Right, Y=Down, Z=Back

pub const RBD: Self = _

X=Right, Y=Back, Z=Down

pub const BDR: Self = _

X=Back, Y=Down, Z=Right

pub const BRD: Self = _

X=Back, Y=Right, Z=Down

pub const RIGHT_HAND_X_UP: Self = _

X=Up, Y=Right, Z=Forward

pub const RIGHT_HAND_X_DOWN: Self = _

X=Down, Y=Right, Z=Back

pub const RIGHT_HAND_Y_UP: Self = _

X=Right, Y=Up, Z=Back

pub const RIGHT_HAND_Y_DOWN: Self = _

X=Right, Y=Down, Z=Forward

pub const RIGHT_HAND_Z_UP: Self = _

X=Right, Y=Forward, Z=Up

pub const RIGHT_HAND_Z_DOWN: Self = _

X=Right, Y=Back, Z=Down

pub const LEFT_HAND_X_UP: Self = _

X=Up, Y=Right, Z=Back

pub const LEFT_HAND_X_DOWN: Self = _

X=Down, Y=Right, Z=Forward

pub const LEFT_HAND_Y_UP: Self = _

X=Right, Y=Up, Z=Forward

pub const LEFT_HAND_Y_DOWN: Self = _

X=Right, Y=Down, Z=Back

pub const LEFT_HAND_Z_UP: Self = _

X=Right, Y=Back, Z=Up

pub const LEFT_HAND_Z_DOWN: Self = _

X=Right, Y=Forward, Z=Down

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 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>)> ) -> 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, 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 ViewCoordinates

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

Formats the value using the given formatter.

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 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 Zeroable for ViewCoordinates

fn zeroed() -> Self

Calls zeroed.

impl Copy for ViewCoordinates

impl Eq for ViewCoordinates

impl Pod for ViewCoordinates

impl StructuralPartialEq for ViewCoordinates