Struct euclid::Rotation2D

#[repr(C)]
pub struct Rotation2D<T, Src, Dst> {
    pub angle: T,
    /* private fields */
}

A transform that can represent rotations in 2d, represented as an angle in radians.

Fields

angle: T

Angle in radians

Implementations

impl<T, Src, Dst> Rotation2D<T, Src, Dst>

pub fn new(angle: Angle<T>) -> Self

Creates a rotation from an angle in radians.

pub fn radians(angle: T) -> Self

Creates a rotation from an angle in radians.

pub fn identity() -> Self

where T: Zero,

Creates the identity rotation.

impl<T: Copy, Src, Dst> Rotation2D<T, Src, Dst>

pub fn cast_unit<Src2, Dst2>(&self) -> Rotation2D<T, Src2, Dst2>

Cast the unit, preserving the numeric value.

Example

enum Local {}
enum World {}

enum Local2 {}
enum World2 {}

let to_world: Rotation2D<_, Local, World> = Rotation2D::radians(42);

assert_eq!(to_world.angle, to_world.cast_unit::<Local2, World2>().angle);

pub fn to_untyped(&self) -> Rotation2D<T, UnknownUnit, UnknownUnit>

Drop the units, preserving only the numeric value.

Example

enum Local {}
enum World {}

let to_world: Rotation2D<_, Local, World> = Rotation2D::radians(42);

assert_eq!(to_world.angle, to_world.to_untyped().angle);

pub fn from_untyped(r: &Rotation2D<T, UnknownUnit, UnknownUnit>) -> Self

Tag a unitless value with units.

Example

use euclid::UnknownUnit;
enum Local {}
enum World {}

let rot: Rotation2D<_, UnknownUnit, UnknownUnit> = Rotation2D::radians(42);

assert_eq!(rot.angle, Rotation2D::<_, Local, World>::from_untyped(&rot).angle);

impl<T, Src, Dst> Rotation2D<T, Src, Dst>

where T: Copy,

pub fn get_angle(&self) -> Angle<T>

Returns self.angle as a strongly typed Angle<T>.

impl<T: Real, Src, Dst> Rotation2D<T, Src, Dst>

pub fn to_3d(&self) -> Rotation3D<T, Src, Dst>

Creates a 3d rotation (around the z axis) from this 2d rotation.

pub fn inverse(&self) -> Rotation2D<T, Dst, Src>

Returns the inverse of this rotation.

pub fn then<NewSrc>( &self, other: &Rotation2D<T, NewSrc, Src>, ) -> Rotation2D<T, NewSrc, Dst>

Returns a rotation representing the other rotation followed by this rotation.

pub fn transform_point(&self, point: Point2D<T, Src>) -> Point2D<T, Dst>

Returns the given 2d point transformed by this rotation.

The input point must be use the unit Src, and the returned point has the unit Dst.

pub fn transform_vector(&self, vector: Vector2D<T, Src>) -> Vector2D<T, Dst>

Returns the given 2d vector transformed by this rotation.

The input point must be use the unit Src, and the returned point has the unit Dst.

impl<T, Src, Dst> Rotation2D<T, Src, Dst>

where T: Copy + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Zero + Trig,

pub fn to_transform(&self) -> Transform2D<T, Src, Dst>

Returns the matrix representation of this rotation.

Trait Implementations

impl<T, Src, Dst> ApproxEq<T> for Rotation2D<T, Src, Dst>

where T: Copy + Neg<Output = T> + ApproxEq<T>,

fn approx_epsilon() -> T

Default epsilon value

fn approx_eq_eps(&self, other: &Self, eps: &T) -> bool

Returns true if this object is approximately equal to the other one, using a provided epsilon value.

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

Returns true if this object is approximately equal to the other one, using the approx_epsilon epsilon value.

impl<T: Clone, Src, Dst> Clone for Rotation2D<T, Src, Dst>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, Src, Dst> Debug for Rotation2D<T, Src, Dst>

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

Formats the value using the given formatter.

impl<T, Src, Dst> Hash for Rotation2D<T, Src, Dst>

where T: Hash,

fn hash<H: Hasher>(&self, h: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T, Src, Dst> PartialEq for Rotation2D<T, Src, Dst>

where T: PartialEq,

fn eq(&self, other: &Self) -> 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<T: Copy, Src, Dst> Copy for Rotation2D<T, Src, Dst>

impl<T, Src, Dst> Eq for Rotation2D<T, Src, Dst>

where T: Eq,