Struct re_sdk::components::ViewCoordinates

pub struct ViewCoordinates(pub [ViewDir; 3]);

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?

For 3D view-space and image-space.

use re_log_types::component_types::ViewCoordinates;
use arrow2_convert::field::ArrowField;
use arrow2::datatypes::{DataType, Field};

assert_eq!(
    ViewCoordinates::data_type(),
    DataType::FixedSizeBinary(3)
);

Tuple Fields

0: [ViewDir; 3]

Implementations

impl ViewCoordinates

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

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

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

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

pub fn describe_short(&self) -> String

pub fn describe(&self) -> String

pub fn from_rub(&self) -> Mat3

Returns a matrix that translates RUB to this coordinate system.

(RUB: X=Right, Y=Up, B=Back)

pub fn to_rub(&self) -> Mat3

Returns a matrix that translates this coordinate system to RUB.

(RUB: X=Right, Y=Up, B=Back)

pub fn handedness(&self) -> Option<Handedness>

Trait Implementations

impl ArrowDeserialize for ViewCoordinates

type ArrayType = <FixedSizeBinary<3> as ArrowDeserialize>::ArrayType

The arrow2::Array type corresponding to this field

fn arrow_deserialize( bytes: <&<ViewCoordinates as ArrowDeserialize>::ArrayType as IntoIterator>::Item ) -> Option<<ViewCoordinates as ArrowField>::Type>

Deserialize this field from arrow

impl ArrowField for ViewCoordinates

type Type = ViewCoordinates

This should be Self except when implementing large offset and fixed placeholder types. For the later, it should refer to the actual type. For example when the placeholder type is LargeString, this should be String.

fn data_type() -> DataType

The DataType

impl ArrowSerialize for ViewCoordinates

type MutableArrayType = <FixedSizeBinary<3> as ArrowSerialize>::MutableArrayType

The arrow2::array::MutableArray that holds this value

fn new_array() -> <ViewCoordinates as ArrowSerialize>::MutableArrayType

Create a new mutable array

fn arrow_serialize( v: &ViewCoordinates, array: &mut <ViewCoordinates as ArrowSerialize>::MutableArrayType ) -> Result<(), Error>

Serialize this field to arrow

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

fn name() -> ComponentName

The name of the component.

fn field() -> Field

Create a Field for this Component.

impl Debug for ViewCoordinates

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ViewCoordinates

fn deserialize<__D>( __deserializer: __D ) -> Result<ViewCoordinates, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromStr for ViewCoordinates

type Err = String

The associated error which can be returned from parsing.

fn from_str( s: &str ) -> Result<ViewCoordinates, <ViewCoordinates as FromStr>::Err>

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

impl PartialEq<ViewCoordinates> 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 Serialize for ViewCoordinates

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ViewCoordinates

impl Eq for ViewCoordinates

impl StructuralEq for ViewCoordinates

impl StructuralPartialEq for ViewCoordinates