Struct coordinate_frame :: WestUpNorth Copy item path

impl<T> WestUpNorth<T>

pub const fn new(west: T, up: T, north: T) -> Self

Creates a new WestUpNorth instance from its west, up and north components.

pub const fn from_array(vec: [T; 3]) -> Self

Constructs an instance from an array.

pub fn x(&self) -> T
where T: Clone,

Gets the value of the first dimension. For this type, this represents the west direction.

pub fn y(&self) -> T
where T: Clone,

Gets the value of the second dimension. For this type, this represents the up direction.

pub fn z(&self) -> T
where T: Clone,

Gets the value of the third dimension. For this type, this represents the north direction.

pub fn x_ref(&self) -> &T

Gets a reference to the value of the first dimension. For this type, this represents the west direction.

pub fn y_ref(&self) -> &T

Gets a reference to the value of the second dimension. For this type, this represents the up direction.

pub fn z_ref(&self) -> &T

Gets a reference to the value of the third dimension. For this type, this represents the north direction.

pub fn x_mut(&mut self) -> &mut T

Gets a mutable reference to the value of the first dimension. For this type, this represents the west direction.

pub fn y_mut(&mut self) -> &mut T

Gets a mutable reference to the value of the second dimension. For this type, this represents the up direction.

pub fn z_mut(&mut self) -> &mut T

Gets a mutable reference to the value of the third dimension. For this type, this represents the north direction.

pub const fn into_inner(self) -> [T; 3]
where T: Copy,

Consumes self and returns its inner value.

pub const fn coordinate_frame(&self) -> CoordinateFrameType

Returns the coordinate frame of this instance.

pub const fn right_handed(&self) -> bool

Indicates whether this coordinate system is right-handed or left-handed.

pub fn x_axis() -> [T; 3]
where T: ZeroOne<Output = T> + Neg<Output = T>,

Returns the base vector for the x axis in the global frame.

pub fn y_axis() -> [T; 3]
where T: ZeroOne<Output = T> + Neg<Output = T>,

Returns the base vector for the y axis in the global frame.

pub fn z_axis() -> [T; 3]
where T: ZeroOne<Output = T> + Neg<Output = T>,

Returns the base vector for the z axis in the global frame.

pub fn norm_sq(&self) -> T
where T: Clone + Mul<T, Output = T> + Add<T, Output = T>,

Calculates the squared norm of the components.

§Panics

This operation may overflow.

pub fn cross(&self, rhs: &Self) -> Self
where T: Clone + Mul<T, Output = T> + Sub<T, Output = T>,

Calculates the cross product (outer product) of two coordinates.

§Panics

This operation may overflow.

pub fn dot(&self, rhs: &Self) -> T
where T: Clone + Mul<T, Output = T> + Add<T, Output = T>,

Calculates the dot product (inner product) of two coordinates.

§Panics

This operation may overflow.

pub fn with_west(self, west: T) -> Self

Consumes self and returns a new instance with the west component set to the provided value.

pub const fn west(&self) -> T
where T: Copy,

Returns the west component of this coordinate.

pub const fn west_ref(&self) -> &T

Returns a reference to the west component of this coordinate.

pub fn west_mut(&mut self) -> &mut T

Returns a mutable reference to the west component of this coordinate.

pub fn with_up(self, up: T) -> Self

Consumes self and returns a new instance with the up component set to the provided value.

pub const fn up(&self) -> T
where T: Copy,

Returns the up component of this coordinate.

pub const fn up_ref(&self) -> &T

Returns a reference to the up component of this coordinate.

pub fn up_mut(&mut self) -> &mut T

Returns a mutable reference to the up component of this coordinate.

pub fn with_north(self, north: T) -> Self

Consumes self and returns a new instance with the north component set to the provided value.

pub const fn north(&self) -> T
where T: Copy,

Returns the north component of this coordinate.

pub const fn north_ref(&self) -> &T

Returns a reference to the north component of this coordinate.

pub fn north_mut(&mut self) -> &mut T

Returns a mutable reference to the north component of this coordinate.

pub fn east(&self) -> T
where T: Copy + SaturatingNeg<Output = T>,

Returns the east component of this coordinate. This component is not a native axis of the coordinate frame and is derived from the west component at runtime.

pub fn down(&self) -> T
where T: Copy + SaturatingNeg<Output = T>,

Returns the down component of this coordinate. This component is not a native axis of the coordinate frame and is derived from the up component at runtime.

pub fn south(&self) -> T
where T: Copy + SaturatingNeg<Output = T>,

Returns the south component of this coordinate. This component is not a native axis of the coordinate frame and is derived from the north component at runtime.

pub fn to_ned(&self) -> NorthEastDown<T>
where T: Copy + SaturatingNeg<Output = T>,

Converts this type to a NorthEastDown instance.

pub fn to_enu(&self) -> EastNorthUp<T>
where T: Copy + SaturatingNeg<Output = T>,

Converts this type to an EastNorthUp instance.

Methods from Deref<Target = [T; 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<T> Add<T> for WestUpNorth<T>
where T: Add<T, Output = T> + Clone,

type Output = WestUpNorth<T>

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation. Read more

impl<T> Add for WestUpNorth<T>
where T: Add<T, Output = T> + Clone,

type Output = WestUpNorth<T>

The resulting type after applying the + operator.

fn add(self, rhs: WestUpNorth<T>) -> Self::Output

Performs the + operation. Read more

impl<T> AddAssign<T> for WestUpNorth<T>
where T: AddAssign<T> + Clone,

fn add_assign(&mut self, rhs: T)

Performs the += operation. Read more

impl<T> AsMut<[T]> for WestUpNorth<T>

fn as_mut(&mut self) -> &mut [T]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsMut<[T; 3]> for WestUpNorth<T>

fn as_mut(&mut self) -> &mut [T; 3]

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<[T]> for WestUpNorth<T>

fn as_ref(&self) -> &[T]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> AsRef<[T; 3]> for WestUpNorth<T>

fn as_ref(&self) -> &[T; 3]

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Clone> Clone for WestUpNorth<T>

fn clone(&self) -> WestUpNorth<T>

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<T> CoordinateFrame for WestUpNorth<T>

const COORDINATE_FRAME: CoordinateFrameType = CoordinateFrameType::WestUpNorth

The coordinate frame.

fn coordinate_frame(&self) -> CoordinateFrameType

Returns the coordinate frame of this instance.

fn to_ned(&self) -> NorthEastDown<Self::Type>
where Self::Type: Copy + SaturatingNeg<Output = Self::Type>,

Converts this type to a NorthEastDown instance.

fn to_enu(&self) -> EastNorthUp<Self::Type>
where Self::Type: Copy + SaturatingNeg<Output = Self::Type>,

Converts this type to an EastNorthUp instance.

fn x(&self) -> Self::Type
where Self::Type: Clone,

Gets the value of the first dimension. For this type, this represents the west direction.

fn y(&self) -> Self::Type
where Self::Type: Clone,

Gets the value of the second dimension. For this type, this represents the up direction.

fn z(&self) -> Self::Type
where Self::Type: Clone,

Gets the value of the third dimension. For this type, this represents the north direction.

fn x_ref(&self) -> &Self::Type

Gets a reference to the value of the first dimension. For this type, this represents the west direction.

fn y_ref(&self) -> &Self::Type

Gets a reference to the value of the second dimension. For this type, this represents the up direction.

fn z_ref(&self) -> &Self::Type

Gets a reference to the value of the third dimension. For this type, this represents the north direction.

fn x_mut(&mut self) -> &mut Self::Type

Gets a mutable reference to the value of the first dimension. For this type, this represents the west direction.

fn y_mut(&mut self) -> &mut Self::Type

Gets a mutable reference to the value of the second dimension. For this type, this represents the up direction.

fn z_mut(&mut self) -> &mut Self::Type

Gets a mutable reference to the value of the third dimension. For this type, this represents the north direction.

fn right_handed(&self) -> bool

Indicates whether this coordinate system is right-handed or left-handed.

fn x_axis() -> [Self::Type; 3]
where Self::Type: ZeroOne<Output = Self::Type> + Neg<Output = Self::Type>,

Returns the base vector for the x axis.

fn y_axis() -> [Self::Type; 3]
where Self::Type: ZeroOne<Output = Self::Type> + Neg<Output = Self::Type>,

Returns the base vector for the y axis.

fn z_axis() -> [Self::Type; 3]
where Self::Type: ZeroOne<Output = Self::Type> + Neg<Output = Self::Type>,

Returns the base vector for the z axis.

type Type = T

The type of each coordinate value.

impl<T: Debug> Debug for WestUpNorth<T>

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

Formats the value using the given formatter. Read more

impl<T> Deref for WestUpNorth<T>

type Target = [T; 3]

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for WestUpNorth<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for WestUpNorth<T>
where T: Display,

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

Formats the value using the given formatter. Read more

impl<T> Div<T> for WestUpNorth<T>
where T: Div<T, Output = T> + Clone,

type Output = WestUpNorth<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation. Read more

impl<T> DivAssign<T> for WestUpNorth<T>
where T: DivAssign<T> + Clone,

fn div_assign(&mut self, rhs: T)

Performs the /= operation. Read more

impl<T> Format for WestUpNorth<T>
where T: Format,

Available on crate feature defmt only.

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.