Struct re_types::components::ViewCoordinates

#[repr(transparent)]
pub struct ViewCoordinates(pub [u8; 3]);

Component: 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.

The following constants are used to represent the different directions:

• Up = 1
• Down = 2
• Right = 3
• Left = 4
• Forward = 5
• Back = 6

Tuple Fields

0: [u8; 3]

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

Implementations

impl ViewCoordinates

pub const fn new(x: ViewDir, y: ViewDir, z: ViewDir) -> Self

Construct a new ViewCoordinates from an array of ViewDirs.

pub fn from_up_and_handedness(up: SignedAxis3, handedness: Handedness) -> Self

Chooses a coordinate system based on just an up-axis.

pub fn sanity_check(&self) -> Result<(), String>

Returns an error if this does not span all three dimensions.

pub fn up(&self) -> Option<SignedAxis3>

The up-axis.

pub fn right(&self) -> Option<SignedAxis3>

The right-axis.

pub fn forward(&self) -> Option<SignedAxis3>

The forward-axis.

pub fn describe_short(&self) -> String

Describe using three letters, e.g. RDF for X=Right, Y=Down, Z=Forward.

pub fn describe(&self) -> String

A long description of the coordinate system, explicitly writing out all directions.

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 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<'a> From<&'a ViewCoordinates> for Cow<'a, ViewCoordinates>

fn from(value: &'a ViewCoordinates) -> Self

Converts to this type from the input type.

impl From<[u8; 3]> for ViewCoordinates

fn from(coordinates: [u8; 3]) -> Self

Converts to this type from the input type.

impl From<ViewCoordinates> for [u8; 3]

fn from(value: ViewCoordinates) -> Self

Converts to this type from the input type.

impl<'a> From<ViewCoordinates> for Cow<'a, ViewCoordinates>

fn from(value: ViewCoordinates) -> Self

Converts to this type from the input type.

impl FromStr for ViewCoordinates

type Err = String

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Loggable for ViewCoordinates

type Name = ComponentName

fn name() -> Self::Name

The fully-qualified name of this loggable, e.g. rerun.datatypes.Vec2D.

fn arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, excluding datatype extensions.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>> ) -> SerializationResult<Box<dyn Array>>

where Self: Clone + 'a,

Given an iterator of options of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::arrow_field.

fn from_arrow_opt( arrow_data: &dyn Array ) -> DeserializationResult<Vec<Option<Self>>>

where Self: Sized,

Given an Arrow array, deserializes it into a collection of optional Loggables.

fn from_arrow(arrow_data: &dyn Array) -> DeserializationResult<Vec<Self>>

where Self: Sized,

Given an Arrow array, deserializes it into a collection of Loggables.

fn extended_arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType, including datatype extensions.

fn arrow_field() -> Field

The underlying arrow2::datatypes::Field, including datatype extensions.

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>> ) -> Result<Box<dyn Array>, SerializationError>

where Self: 'a,

Given an iterator of owned or reference values to the current Loggable, serializes them into an Arrow array. The Arrow array’s datatype will match Loggable::arrow_field.

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