Struct 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_components::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 const RDF: Self

Default right-handed pinhole, camera, and image coordinates: X=Right, Y=Down, Z=Forward.

pub const RUB: Self

Default right-handed view coordinates of re_renderer: X=Right, Y=Up, Z=Back.

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

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_other(&self, other: &Self) -> Mat3

Returns a matrix that transforms from another coordinate system to this (self) one.

pub fn to_rdf(&self) -> Mat3

Returns a matrix that transforms this coordinate system to RDF.

(RDF: X=Right, Y=Down, Z=Forward)

pub fn from_rdf(&self) -> Mat3

Returns a matrix that transforms from RDF to this coordinate system.

(RDF: X=Right, Y=Down, Z=Forward)

pub fn to_rub(&self) -> Mat3

Returns a matrix that transforms this coordinate system to RUB.

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

pub fn from_rub(&self) -> Mat3

Returns a matrix that transforms from RUB to this coordinate system.

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

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

Returns a quaternion that rotates from RUB to this coordinate system.

Errors if the coordinate system is left-handed or degenerate.

(RUB: X=Right, Y=Up, Z=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: <&Self::ArrayType as IntoIterator>::Item, ) -> Option<<Self 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() -> Self::MutableArrayType

Create a new mutable array

fn arrow_serialize(v: &Self, array: &mut Self::MutableArrayType) -> Result<()>

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

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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

fn from(value: &'a 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 LegacyComponent for ViewCoordinates

fn legacy_name() -> ComponentName

The name of the component.

fn field() -> Field

Create a Field for this LegacyComponent.

impl Loggable for ViewCoordinates

type Name = ComponentName

type Item<'a> = <&'a <ViewCoordinates as ArrowDeserialize>::ArrayType as IntoIterator>::Item

type Iter<'a> = <&'a <ViewCoordinates as ArrowDeserialize>::ArrayType as IntoIterator>::IntoIter

fn name() -> Self::Name

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

fn to_arrow_datatype() -> DataType

The underlying arrow2::datatypes::DataType.

fn try_to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, _extension_wrapper: Option<&str>, ) -> 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::to_arrow_datatype.

fn try_iter_from_arrow( data: &dyn Array, ) -> DeserializationResult<Self::Iter<'_>>

where Self: Sized,

Given an Arrow array, deserializes it into a iterator of Loggable::Items.

fn convert_item_to_self(item: Self::Item<'_>) -> Option<Self>

Convert a Loggable::Item into an optional Loggable

fn to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, extension_wrapper: Option<&str>, ) -> Box<dyn Array>

where Self: Clone + '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::to_arrow_datatype.

fn try_to_arrow<'a>( data: impl IntoIterator<Item = impl Into<Cow<'a, Self>>>, extension_wrapper: Option<&str>, ) -> Result<Box<dyn Array>, SerializationError>

where Self: Clone + '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::to_arrow_datatype.

fn to_arrow_opt<'a>( data: impl IntoIterator<Item = Option<impl Into<Cow<'a, Self>>>>, extension_wrapper: Option<&str>, ) -> 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::to_arrow_datatype.

fn from_arrow(data: &(dyn Array + 'static)) -> Vec<Self>

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

fn try_from_arrow( data: &(dyn Array + 'static), ) -> Result<Vec<Self>, DeserializationError>

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

fn from_arrow_opt(data: &(dyn Array + 'static)) -> Vec<Option<Self>>

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

fn try_from_arrow_opt( data: &(dyn Array + 'static), ) -> Result<Vec<Option<Self>>, DeserializationError>

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

impl PartialEq for ViewCoordinates

fn eq(&self, other: &ViewCoordinates) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Component for ViewCoordinates

impl Copy for ViewCoordinates

impl Eq for ViewCoordinates

impl StructuralPartialEq for ViewCoordinates