Skip to main content

Basis3

Struct Basis3 

Source
pub struct Basis3<S> { /* private fields */ }
Expand description

A three-dimensional rotation matrix.

The matrix is guaranteed to be orthogonal, so some operations, specifically inversion, can be implemented more efficiently than the implementations for math::Matrix3. To ensure orthogonality is maintained, the operations have been restricted to a subset of those implemented on Matrix3.

Implementations§

Source§

impl<S: BaseFloat> Basis3<S>

Source

pub fn from_quaternion(quaternion: &Quaternion<S>) -> Basis3<S>

Create a new rotation matrix from a quaternion.

Trait Implementations§

Source§

impl<S: BaseFloat> AbsDiffEq for Basis3<S>

Source§

type Epsilon = <S as AbsDiffEq>::Epsilon

Used for specifying relative comparisons.
Source§

fn default_epsilon() -> S::Epsilon

The default tolerance to use when testing values that are close together. Read more
Source§

fn abs_diff_eq(&self, other: &Self, epsilon: S::Epsilon) -> bool

A test for equality that uses the absolute difference to compute the approximate equality of two numbers.
Source§

fn abs_diff_ne(&self, other: &Rhs, epsilon: Self::Epsilon) -> bool

The inverse of AbsDiffEq::abs_diff_eq.
Source§

impl<S> AsRef<Matrix3<S>> for Basis3<S>

Source§

fn as_ref(&self) -> &Matrix3<S>

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

impl<S: Clone> Clone for Basis3<S>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<S: Copy> Copy for Basis3<S>

Source§

impl<S: Debug> Debug for Basis3<S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: BaseFloat> From<Basis3<S>> for Matrix3<S>

Source§

fn from(b: Basis3<S>) -> Matrix3<S>

Converts to this type from the input type.
Source§

impl<S: BaseFloat> From<Basis3<S>> for Quaternion<S>

Source§

fn from(b: Basis3<S>) -> Quaternion<S>

Converts to this type from the input type.
Source§

impl<A> From<Euler<A>> for Basis3<A::Unitless>
where A: Into<Rad<<A as Angle>::Unitless>> + Angle,

Source§

fn from(src: Euler<A>) -> Basis3<A::Unitless>

Create a three-dimensional rotation matrix from a set of euler angles.

Source§

impl<S: BaseFloat> From<Quaternion<S>> for Basis3<S>

Source§

fn from(quat: Quaternion<S>) -> Basis3<S>

Converts to this type from the input type.
Source§

impl<S: BaseFloat> Mul for Basis3<S>

Source§

type Output = Basis3<S>

The resulting type after applying the * operator.
Source§

fn mul(self, other: Basis3<S>) -> Basis3<S>

Performs the * operation. Read more
Source§

impl<'a, S: BaseFloat> Mul<&'a Basis3<S>> for Basis3<S>

Source§

type Output = Basis3<S>

The resulting type after applying the * operator.
Source§

fn mul(self, other: &'a Basis3<S>) -> Basis3<S>

Performs the * operation. Read more
Source§

impl<'a, 'b, S: BaseFloat> Mul<&'a Basis3<S>> for &'b Basis3<S>

Source§

type Output = Basis3<S>

The resulting type after applying the * operator.
Source§

fn mul(self, other: &'a Basis3<S>) -> Basis3<S>

Performs the * operation. Read more
Source§

impl<'a, S: BaseFloat> Mul<Basis3<S>> for &'a Basis3<S>

Source§

type Output = Basis3<S>

The resulting type after applying the * operator.
Source§

fn mul(self, other: Basis3<S>) -> Basis3<S>

Performs the * operation. Read more
Source§

impl<S: BaseFloat> One for Basis3<S>

Source§

fn one() -> Basis3<S>

Returns the multiplicative identity element of Self, 1. Read more
Source§

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.
Source§

fn is_one(&self) -> bool
where Self: PartialEq,

Returns true if self is equal to the multiplicative identity. Read more
Source§

impl<S: PartialEq> PartialEq for Basis3<S>

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl<S: BaseFloat> Product for Basis3<S>

Source§

fn product<I: Iterator<Item = Basis3<S>>>(iter: I) -> Basis3<S>

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl<'a, S: 'a + BaseFloat> Product<&'a Basis3<S>> for Basis3<S>

Source§

fn product<I: Iterator<Item = &'a Basis3<S>>>(iter: I) -> Basis3<S>

Takes an iterator and generates Self from the elements by multiplying the items.
Source§

impl<S: BaseFloat> RelativeEq for Basis3<S>

Source§

fn default_max_relative() -> S::Epsilon

The default relative tolerance for testing values that are far-apart. Read more
Source§

fn relative_eq( &self, other: &Self, epsilon: S::Epsilon, max_relative: S::Epsilon, ) -> bool

A test for equality that uses a relative comparison if the values are far apart.
Source§

fn relative_ne( &self, other: &Rhs, epsilon: Self::Epsilon, max_relative: Self::Epsilon, ) -> bool

The inverse of RelativeEq::relative_eq.
Source§

impl<S: BaseFloat> Rotation for Basis3<S>

Source§

type Space = Point3<S>

Source§

fn look_at(dir: Vector3<S>, up: Vector3<S>) -> Basis3<S>

Create a rotation to a given direction with an ‘up’ vector.
Source§

fn between_vectors(a: Vector3<S>, b: Vector3<S>) -> Basis3<S>

Create a shortest rotation to transform vector ‘a’ into ‘b’. Both given vectors are assumed to have unit length.
Source§

fn rotate_vector(&self, vec: Vector3<S>) -> Vector3<S>

Rotate a vector using this rotation.
Source§

fn invert(&self) -> Basis3<S>

Create a new rotation which “un-does” this rotation. That is, r * r.invert() is the identity.
Source§

fn rotate_point(&self, point: Self::Space) -> Self::Space

Rotate a point using this rotation, by converting it to its representation as a vector.
Source§

impl<S: BaseFloat> Rotation3 for Basis3<S>

Source§

type Scalar = S

Source§

fn from_axis_angle<A: Into<Rad<S>>>(axis: Vector3<S>, angle: A) -> Basis3<S>

Create a rotation using an angle around a given axis. Read more
Source§

fn from_angle_x<A: Into<Rad<S>>>(theta: A) -> Basis3<S>

Create a rotation from an angle around the x axis (pitch).
Source§

fn from_angle_y<A: Into<Rad<S>>>(theta: A) -> Basis3<S>

Create a rotation from an angle around the y axis (yaw).
Source§

fn from_angle_z<A: Into<Rad<S>>>(theta: A) -> Basis3<S>

Create a rotation from an angle around the z axis (roll).
Source§

impl<S: PartialEq> StructuralPartialEq for Basis3<S>

Source§

impl<S: BaseFloat> UlpsEq for Basis3<S>

Source§

fn default_max_ulps() -> u32

The default ULPs to tolerate when testing values that are far-apart. Read more
Source§

fn ulps_eq(&self, other: &Self, epsilon: S::Epsilon, max_ulps: u32) -> bool

A test for equality that uses units in the last place (ULP) if the values are far apart.
Source§

fn ulps_ne(&self, other: &Rhs, epsilon: Self::Epsilon, max_ulps: u32) -> bool

The inverse of UlpsEq::ulps_eq.

Auto Trait Implementations§

§

impl<S> Freeze for Basis3<S>
where Matrix3<S>: Freeze,

§

impl<S> RefUnwindSafe for Basis3<S>

§

impl<S> Send for Basis3<S>
where Matrix3<S>: Send,

§

impl<S> Sync for Basis3<S>
where Matrix3<S>: Sync,

§

impl<S> Unpin for Basis3<S>
where Matrix3<S>: Unpin,

§

impl<S> UnsafeUnpin for Basis3<S>
where Matrix3<S>: UnsafeUnpin,

§

impl<S> UnwindSafe for Basis3<S>
where Matrix3<S>: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.