Struct re_types :: components :: ViewCoordinates Copy item path

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.

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) -> Result<Handedness, String>

Returns whether or not this coordinate system is left or right handed.

If the coordinate system is degenerate, an error is returned.

impl ViewCoordinates

pub const ULF: Self = _

X=Up, Y=Left, Z=Forward

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

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

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

pub const FUL: Self = _

X=Forward, Y=Up, Z=Left

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

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

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

pub const LUB: Self = _

X=Left, Y=Up, Z=Back

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

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

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

pub const URF: Self = _

X=Up, Y=Right, Z=Forward

pub const UFR: Self = _

X=Up, Y=Forward, Z=Right

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

pub const RUF: Self = _

X=Right, Y=Up, Z=Forward

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

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

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

pub const URB: Self = _

X=Up, Y=Right, Z=Back

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

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

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

pub const BUR: Self = _

X=Back, Y=Up, Z=Right

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

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

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

pub const LDF: Self = _

X=Left, Y=Down, Z=Forward

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

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

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

pub const DLB: Self = _

X=Down, Y=Left, Z=Back

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

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

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

pub const BDL: Self = _

X=Back, Y=Down, Z=Left

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

pub const BLD: Self = _

X=Back, Y=Left, Z=Down

pub const DRF: Self = _

X=Down, Y=Right, Z=Forward

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

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

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

pub const FDR: Self = _

X=Forward, Y=Down, Z=Right

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

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

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

pub const RDB: Self = _

X=Right, Y=Down, Z=Back

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

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

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

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

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

pub const LEFT_HAND_X_DOWN: Self = _

X=Down, Y=Right, Z=Forward

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

pub const LEFT_HAND_Y_UP: Self = _

X=Right, Y=Up, Z=Forward

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

pub const LEFT_HAND_Y_DOWN: Self = _

X=Right, Y=Down, Z=Back

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

pub const LEFT_HAND_Z_UP: Self = _

X=Right, Y=Back, Z=Up

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

pub const LEFT_HAND_Z_DOWN: Self = _

X=Right, Y=Forward, Z=Down

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

Methods from Deref<Target = [u8; 3]>§

1.57.0 · source

pub fn as_slice(&self) -> &[T]

Returns a slice containing the entire array. Equivalent to &s[..].

1.57.0 · source

pub fn as_mut_slice(&mut self) -> &mut [T]

Returns a mutable slice containing the entire array. Equivalent to &mut s[..].

1.77.0 · source

pub fn each_ref(&self) -> [&T; N]

Borrows each element and returns an array of references with the same size as self.

§Example

let floats = [3.1, 2.7, -1.0];
let float_refs: [&f64; 3] = floats.each_ref();
assert_eq!(float_refs, [&3.1, &2.7, &-1.0]);

This method is particularly useful if combined with other methods, like map. This way, you can avoid moving the original array if its elements are not Copy.

let strings = ["Ferris".to_string(), "♥".to_string(), "Rust".to_string()];
let is_ascii = strings.each_ref().map(|s| s.is_ascii());
assert_eq!(is_ascii, [true, false, true]);

// We can still access the original array: it has not been moved.
assert_eq!(strings.len(), 3);

1.77.0 · source

pub fn each_mut(&mut self) -> [&mut T; N]

Borrows each element mutably and returns an array of mutable references with the same size as self.

§Example


let mut floats = [3.1, 2.7, -1.0];
let float_refs: [&mut f64; 3] = floats.each_mut();
*float_refs[0] = 0.0;
assert_eq!(float_refs, [&mut 0.0, &mut 2.7, &mut -1.0]);
assert_eq!(floats, [0.0, 2.7, -1.0]);

pub fn split_array_ref<const M: usize>(&self) -> (&[T; M], &[T])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.split_array_ref::<0>();
   assert_eq!(left, &[]);
   assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<2>();
    assert_eq!(left, &[1, 2]);
    assert_eq!(right, &[3, 4, 5, 6]);
}

{
    let (left, right) = v.split_array_ref::<6>();
    assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
    assert_eq!(right, &[]);
}

pub fn split_array_mut<const M: usize>(&mut self) -> (&mut [T; M], &mut [T])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index.

The first will contain all indices from [0, M) (excluding the index M itself) and the second will contain all indices from [M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.split_array_mut::<2>();
assert_eq!(left, &mut [1, 0][..]);
assert_eq!(right, &mut [3, 0, 5, 6]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn rsplit_array_ref<const M: usize>(&self) -> (&[T], &[T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let v = [1, 2, 3, 4, 5, 6];

{
   let (left, right) = v.rsplit_array_ref::<0>();
   assert_eq!(left, &[1, 2, 3, 4, 5, 6]);
   assert_eq!(right, &[]);
}

{
    let (left, right) = v.rsplit_array_ref::<2>();
    assert_eq!(left, &[1, 2, 3, 4]);
    assert_eq!(right, &[5, 6]);
}

{
    let (left, right) = v.rsplit_array_ref::<6>();
    assert_eq!(left, &[]);
    assert_eq!(right, &[1, 2, 3, 4, 5, 6]);
}

pub fn rsplit_array_mut<const M: usize>(&mut self) -> (&mut [T], &mut [T; M])

🔬This is a nightly-only experimental API. (split_array)

Divides one mutable array reference into two at an index from the end.

The first will contain all indices from [0, N - M) (excluding the index N - M itself) and the second will contain all indices from [N - M, N) (excluding the index N itself).

§Panics

Panics if M > N.

§Examples

#![feature(split_array)]

let mut v = [1, 0, 3, 0, 5, 6];
let (left, right) = v.rsplit_array_mut::<4>();
assert_eq!(left, &mut [1, 0]);
assert_eq!(right, &mut [3, 0, 5, 6][..]);
left[1] = 2;
right[1] = 4;
assert_eq!(v, [1, 2, 3, 4, 5, 6]);

pub fn as_ascii(&self) -> Option<&[AsciiChar; N]>

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, or returns None if any of the characters is non-ASCII.

§Examples

#![feature(ascii_char)]
#![feature(const_option)]

const HEX_DIGITS: [std::ascii::Char; 16] =
    *b"0123456789abcdef".as_ascii().unwrap();

assert_eq!(HEX_DIGITS[1].as_str(), "1");
assert_eq!(HEX_DIGITS[10].as_str(), "a");

pub unsafe fn as_ascii_unchecked(&self) -> &[AsciiChar; N]

🔬This is a nightly-only experimental API. (ascii_char)

Converts this array of bytes into a array of ASCII characters, without checking whether they’re valid.

§Safety

Every byte in the array must be in 0..=127, or else this is UB.

Trait Implementations§

impl Borrow<ViewCoordinates> for ViewCoordinates

fn borrow(&self) -> &ViewCoordinates

Immutably borrows from an owned value. Read more

impl Clone for ViewCoordinates

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

impl Debug for ViewCoordinates

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

Formats the value using the given formatter. Read more

impl Default for ViewCoordinates

fn default() -> Self

Returns the “default value” for a type. Read more

impl Deref for ViewCoordinates

type Target = ViewCoordinates

The resulting type after dereferencing.

fn deref(&self) -> &ViewCoordinates

Dereferences the value.

impl DerefMut for ViewCoordinates

fn deref_mut(&mut self) -> &mut ViewCoordinates

Mutably dereferences the value.

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

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

Converts to this type from the input type.

impl<T: Into<ViewCoordinates>> From<T> for ViewCoordinates

fn from(v: T) -> 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. Read more

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

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

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

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.

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

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

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§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<C> AsComponents for C
where C: Component,

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

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

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

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

impl<T> Az for T

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

Casts the value.

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

fn cast_from(src: Src) -> Dst

Casts the value.

impl<T> CheckedAs for T

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.

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

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

Casts the value.

impl<C> ComponentBatch for C
where C: Component,

fn to_arrow_list_array(&self) -> Result<ListArray<i32>, SerializationError>

Serializes the batch into an Arrow list array with a single component per list.

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.

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

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.

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoEither for T

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

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