Struct rerun::sdk::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?

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

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

Implementations§

source§

impl ViewCoordinates

source

pub const NUM_COMPONENTS: usize = 2usize

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

source§

impl ViewCoordinates

source

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

Create a new ViewCoordinates.

source§

impl ViewCoordinates

source

pub const ULF: ViewCoordinates = _

X=Up, Y=Left, Z=Forward

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

source

pub const UFL: ViewCoordinates = _

X=Up, Y=Forward, Z=Left

source

pub const LUF: ViewCoordinates = _

X=Left, Y=Up, Z=Forward

source

pub const LFU: ViewCoordinates = _

X=Left, Y=Forward, Z=Up

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

source

pub const FUL: ViewCoordinates = _

X=Forward, Y=Up, Z=Left

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

source

pub const FLU: ViewCoordinates = _

X=Forward, Y=Left, Z=Up

source

pub const ULB: ViewCoordinates = _

X=Up, Y=Left, Z=Back

source

pub const UBL: ViewCoordinates = _

X=Up, Y=Back, Z=Left

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

source

pub const LUB: ViewCoordinates = _

X=Left, Y=Up, Z=Back

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

source

pub const LBU: ViewCoordinates = _

X=Left, Y=Back, Z=Up

source

pub const BUL: ViewCoordinates = _

X=Back, Y=Up, Z=Left

source

pub const BLU: ViewCoordinates = _

X=Back, Y=Left, Z=Up

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

source

pub const URF: ViewCoordinates = _

X=Up, Y=Right, Z=Forward

source

pub const UFR: ViewCoordinates = _

X=Up, Y=Forward, Z=Right

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

source

pub const RUF: ViewCoordinates = _

X=Right, Y=Up, Z=Forward

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

source

pub const RFU: ViewCoordinates = _

X=Right, Y=Forward, Z=Up

source

pub const FUR: ViewCoordinates = _

X=Forward, Y=Up, Z=Right

source

pub const FRU: ViewCoordinates = _

X=Forward, Y=Right, Z=Up

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

source

pub const URB: ViewCoordinates = _

X=Up, Y=Right, Z=Back

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

source

pub const UBR: ViewCoordinates = _

X=Up, Y=Back, Z=Right

source

pub const RUB: ViewCoordinates = _

X=Right, Y=Up, Z=Back

source

pub const RBU: ViewCoordinates = _

X=Right, Y=Back, Z=Up

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

source

pub const BUR: ViewCoordinates = _

X=Back, Y=Up, Z=Right

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

source

pub const BRU: ViewCoordinates = _

X=Back, Y=Right, Z=Up

source

pub const DLF: ViewCoordinates = _

X=Down, Y=Left, Z=Forward

source

pub const DFL: ViewCoordinates = _

X=Down, Y=Forward, Z=Left

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

source

pub const LDF: ViewCoordinates = _

X=Left, Y=Down, Z=Forward

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

source

pub const LFD: ViewCoordinates = _

X=Left, Y=Forward, Z=Down

source

pub const FDL: ViewCoordinates = _

X=Forward, Y=Down, Z=Left

source

pub const FLD: ViewCoordinates = _

X=Forward, Y=Left, Z=Down

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

source

pub const DLB: ViewCoordinates = _

X=Down, Y=Left, Z=Back

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

source

pub const DBL: ViewCoordinates = _

X=Down, Y=Back, Z=Left

source

pub const LDB: ViewCoordinates = _

X=Left, Y=Down, Z=Back

source

pub const LBD: ViewCoordinates = _

X=Left, Y=Back, Z=Down

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

source

pub const BDL: ViewCoordinates = _

X=Back, Y=Down, Z=Left

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

source

pub const BLD: ViewCoordinates = _

X=Back, Y=Left, Z=Down

source

pub const DRF: ViewCoordinates = _

X=Down, Y=Right, Z=Forward

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

source

pub const DFR: ViewCoordinates = _

X=Down, Y=Forward, Z=Right

source

pub const RDF: ViewCoordinates = _

X=Right, Y=Down, Z=Forward

source

pub const RFD: ViewCoordinates = _

X=Right, Y=Forward, Z=Down

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

source

pub const FDR: ViewCoordinates = _

X=Forward, Y=Down, Z=Right

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

source

pub const FRD: ViewCoordinates = _

X=Forward, Y=Right, Z=Down

source

pub const DRB: ViewCoordinates = _

X=Down, Y=Right, Z=Back

source

pub const DBR: ViewCoordinates = _

X=Down, Y=Back, Z=Right

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

source

pub const RDB: ViewCoordinates = _

X=Right, Y=Down, Z=Back

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

source

pub const RBD: ViewCoordinates = _

X=Right, Y=Back, Z=Down

source

pub const BDR: ViewCoordinates = _

X=Back, Y=Down, Z=Right

source

pub const BRD: ViewCoordinates = _

X=Back, Y=Right, Z=Down

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

source

pub const RIGHT_HAND_X_UP: ViewCoordinates = _

X=Up, Y=Right, Z=Forward

source

pub const RIGHT_HAND_X_DOWN: ViewCoordinates = _

X=Down, Y=Right, Z=Back

source

pub const RIGHT_HAND_Y_UP: ViewCoordinates = _

X=Right, Y=Up, Z=Back

source

pub const RIGHT_HAND_Y_DOWN: ViewCoordinates = _

X=Right, Y=Down, Z=Forward

source

pub const RIGHT_HAND_Z_UP: ViewCoordinates = _

X=Right, Y=Forward, Z=Up

source

pub const RIGHT_HAND_Z_DOWN: ViewCoordinates = _

X=Right, Y=Back, Z=Down

source

pub const 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.

source

pub const 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.

source

pub const 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.

source

pub const 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.

source

pub const 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.

source

pub const 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§

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 display_name() -> &'static str

Readable name for displaying in ui.
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 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

§

fn zeroed() -> Self

Calls zeroed. Read more
source§

impl ArchetypeReflectionMarker for ViewCoordinates

source§

impl Copy for ViewCoordinates

source§

impl Eq for ViewCoordinates

source§

impl Pod for ViewCoordinates

source§

impl StructuralPartialEq for ViewCoordinates

Auto Trait Implementations§

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

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

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

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

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

§

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

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

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

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

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

§

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§

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

source§

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

§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

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

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<Src, Dst> LosslessTryInto<Dst> for Src
where Dst: LosslessTryFrom<Src>,

source§

fn lossless_try_into(self) -> Option<Dst>

Performs the conversion.
source§

impl<Src, Dst> LossyInto<Dst> for Src
where Dst: LossyFrom<Src>,

source§

fn lossy_into(self) -> Dst

Performs the conversion.
source§

impl<T> OverflowingAs for T

source§

fn overflowing_as<Dst>(self) -> (Dst, bool)
where T: OverflowingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> OverflowingCastFrom<Src> for Dst
where Src: OverflowingCast<Dst>,

source§

fn overflowing_cast_from(src: Src) -> (Dst, bool)

Casts the value.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> SaturatingAs for T

source§

fn saturating_as<Dst>(self) -> Dst
where T: SaturatingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> SaturatingCastFrom<Src> for Dst
where Src: SaturatingCast<Dst>,

source§

fn saturating_cast_from(src: Src) -> Dst

Casts the value.
§

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

§

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.
§

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.
source§

impl<T> UnwrappedAs for T

source§

fn unwrapped_as<Dst>(self) -> Dst
where T: UnwrappedCast<Dst>,

Casts the value.
source§

impl<Src, Dst> UnwrappedCastFrom<Src> for Dst
where Src: UnwrappedCast<Dst>,

source§

fn unwrapped_cast_from(src: Src) -> Dst

Casts the value.
§

impl<T> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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

impl<T> WrappingAs for T

source§

fn wrapping_as<Dst>(self) -> Dst
where T: WrappingCast<Dst>,

Casts the value.
source§

impl<Src, Dst> WrappingCastFrom<Src> for Dst
where Src: WrappingCast<Dst>,

source§

fn wrapping_cast_from(src: Src) -> Dst

Casts the value.
§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

§

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

§

impl<T> NoUninit for T
where T: Pod,

§

impl<T> Ungil for T
where T: Send,

§

impl<T> WasmNotSend for T
where T: Send,

§

impl<T> WasmNotSendSync for T
where T: WasmNotSend + WasmNotSync,

§

impl<T> WasmNotSync for T
where T: Sync,