Struct rerun::archetypes::ViewCoordinates

source ·

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

Expand description

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_timeless("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

Implementations§

source §

pub const LEFT_HAND_Z_DOWN: ViewCoordinates = _

Trait Implementations§

source §

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

source §

fn name() -> ArchetypeName

The fully-qualified name of this archetype, e.g. rerun.archetypes.Points2D.

source §

fn indicator() -> MaybeOwnedComponentBatch<'static>

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

source §

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

Returns the names of all components that must be provided by the user when constructing this archetype.

source §

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

Returns the names of all components that should be provided by the user when constructing this archetype.

source §

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

Returns the names of all components that may be provided by the user when constructing this archetype.

source §

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

source §

fn from_arrow_components( arrow_data: impl IntoIterator<Item = (ComponentName, Box<dyn Array>)> ) -> Result<ViewCoordinates, DeserializationError>

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

source §

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

source §

impl AsComponents for ViewCoordinates

source §

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

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

source §

fn num_instances(&self) -> usize

The number of instances in each batch. Read more

source §

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

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

source §

impl Clone for ViewCoordinates

source §

fn clone(&self) -> ViewCoordinates

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

source §

impl Debug for ViewCoordinates

source §

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

Formats the value using the given formatter. Read more

source §

impl PartialEq for ViewCoordinates

source §

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

source §

impl SizeBytes for ViewCoordinates

source §

fn heap_size_bytes(&self) -> u64

Returns the total size of self on the heap, in bytes.

source §

fn is_pod() -> bool

Is Self just plain old data? Read more

source §

fn total_size_bytes(&self) -> u64

Returns the total size of self in bytes, accounting for both stack and heap space.

source §

fn stack_size_bytes(&self) -> u64

Returns the total size of self on the stack, in bytes. Read more

source §

impl Zeroable for ViewCoordinates

source §

fn zeroed() -> Self

Calls zeroed. Read more

source §

impl Copy for ViewCoordinates

source §

impl Eq for ViewCoordinates

source §

impl Pod for ViewCoordinates

source §

impl StructuralPartialEq for ViewCoordinates

Auto Trait Implementations§

§

impl Freeze for ViewCoordinates

§

impl RefUnwindSafe for ViewCoordinates

§

impl Send for ViewCoordinates

§

impl Sync for ViewCoordinates

§

impl Unpin for ViewCoordinates

§

impl UnwindSafe for ViewCoordinates

Blanket Implementations§

source §

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

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

impl<T> Az for T

source §

fn az<Dst>(self) -> Dst
where T: Cast<Dst>,

Casts the value.

source §

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

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

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

source §

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

Mutably borrows from an owned value. Read more

source §

impl<Src, Dst> CastFrom<Src> for Dst
where Src: Cast<Dst>,

source §

fn cast_from(src: Src) -> Dst

Casts the value.

source §

impl<T> CheckedAs for T

source §

fn checked_as<Dst>(self) -> Option<Dst>
where T: CheckedCast<Dst>,

Casts the value.

source §

impl<T> CheckedBitPattern for T
where T: AnyBitPattern,

§

type Bits = T

Self must have the same layout as the specified Bits except for the possible invalid bit patterns being checked during is_valid_bit_pattern.

source §

fn is_valid_bit_pattern(_bits: &T) -> bool

If this function returns true, then it must be valid to reinterpret bits as &Self.

source §

impl<Src, Dst> CheckedCastFrom<Src> for Dst
where Src: CheckedCast<Dst>,

source §

fn checked_cast_from(src: Src) -> Option<Dst>

Casts the value.

source §

impl<T> Downcast<T> for T

source §

fn downcast(&self) -> &T

source §

impl<T> Downcast for T
where T: Any,

source §

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.

source §

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.

source §

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.

source §

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.

source §

impl<T> DowncastSync for T
where T: Any + Send + Sync,

source §

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.

source §