Skip to main content

Basis2

Struct Basis2 

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

A two-dimensional rotation matrix.

The matrix is guaranteed to be orthogonal, so some operations can be implemented more efficiently than the implementations for math::Matrix2. To enforce orthogonality at the type level the operations have been restricted to a subset of those implemented on Matrix2.

§Example

Suppose we want to rotate a vector that lies in the x-y plane by some angle. We can accomplish this quite easily with a two-dimensional rotation matrix:

use cgmath::Rad;
use cgmath::Vector2;
use cgmath::{Matrix, Matrix2};
use cgmath::{Rotation, Rotation2, Basis2};
use cgmath::UlpsEq;
use std::f64;

// For simplicity, we will rotate the unit x vector to the unit y vector --
// so the angle is 90 degrees, or π/2.
let unit_x: Vector2<f64> = Vector2::unit_x();
let rot: Basis2<f64> = Rotation2::from_angle(Rad(0.5f64 * f64::consts::PI));

// Rotate the vector using the two-dimensional rotation matrix:
let unit_y = rot.rotate_vector(unit_x);

// Since sin(π/2) may not be exactly zero due to rounding errors, we can
// use approx's assert_ulps_eq!() feature to show that it is close enough.
// assert_ulps_eq!(&unit_y, &Vector2::unit_y()); // TODO: Figure out how to use this

// This is exactly equivalent to using the raw matrix itself:
let unit_y2: Matrix2<_> = rot.into();
let unit_y2 = unit_y2 * unit_x;
assert_eq!(unit_y2, unit_y);

// Note that we can also concatenate rotations:
let rot_half: Basis2<f64> = Rotation2::from_angle(Rad(0.25f64 * f64::consts::PI));
let unit_y3 = (rot_half * rot_half).rotate_vector(unit_x);
// assert_ulps_eq!(&unit_y3, &unit_y2); // TODO: Figure out how to use this

Implementations§

Source§

impl<S: BaseFloat> Basis2<S>

Source

pub fn look_at_stable(dir: Vector2<S>, flip: bool) -> Basis2<S>

Trait Implementations§

Source§

impl<S: BaseFloat> AbsDiffEq for Basis2<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: BaseFloat> AsRef<Matrix2<S>> for Basis2<S>

Source§

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

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

impl<S: Clone> Clone for Basis2<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 Basis2<S>

Source§

impl<S: Debug> Debug for Basis2<S>

Source§

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

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

impl<S: BaseFloat> From<Basis2<S>> for Matrix2<S>

Source§

fn from(b: Basis2<S>) -> Matrix2<S>

Converts to this type from the input type.
Source§

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

Source§

type Output = Basis2<S>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

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

Source§

type Output = Basis2<S>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

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

Source§

type Output = Basis2<S>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

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

Source§

type Output = Basis2<S>

The resulting type after applying the * operator.
Source§

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

Performs the * operation. Read more
Source§

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

Source§

fn one() -> Basis2<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 Basis2<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 Basis2<S>

Source§

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

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

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

Source§

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

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

impl<S: BaseFloat> RelativeEq for Basis2<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 Basis2<S>

Source§

type Space = Point2<S>

Source§

fn look_at(dir: Vector2<S>, up: Vector2<S>) -> Basis2<S>

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

fn between_vectors(a: Vector2<S>, b: Vector2<S>) -> Basis2<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: Vector2<S>) -> Vector2<S>

Rotate a vector using this rotation.
Source§

fn invert(&self) -> Basis2<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> Rotation2 for Basis2<S>

Source§

type Scalar = S

Source§

fn from_angle<A: Into<Rad<S>>>(theta: A) -> Basis2<S>

Create a rotation by a given angle. Thus is a redundant case of both from_axis_angle() and from_euler() for 2D space.
Source§

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

Source§

impl<S: BaseFloat> UlpsEq for Basis2<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 Basis2<S>
where Matrix2<S>: Freeze,

§

impl<S> RefUnwindSafe for Basis2<S>

§

impl<S> Send for Basis2<S>
where Matrix2<S>: Send,

§

impl<S> Sync for Basis2<S>
where Matrix2<S>: Sync,

§

impl<S> Unpin for Basis2<S>
where Matrix2<S>: Unpin,

§

impl<S> UnsafeUnpin for Basis2<S>
where Matrix2<S>: UnsafeUnpin,

§

impl<S> UnwindSafe for Basis2<S>
where Matrix2<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.