[−][src]Struct euclid::Transform2D
A 2d transform stored as a 3 by 2 matrix in row-major order in memory.
Transforms can be parametrized over the source and destination units, to describe a
transformation from a space to another.
For example, Transform2D<f32, WorldSpace, ScreenSpace>::transform_point4d
takes a Point2D<f32, WorldSpace>
and returns a Point2D<f32, ScreenSpace>
.
Transforms expose a set of convenience methods for pre- and post-transformations. A pre-transformation corresponds to adding an operation that is applied before the rest of the transformation, while a post-transformation adds an operation that is applied after.
These transforms are for working with row vectors, so the matrix math for transforming
a vector is v * T
. If your library is using column vectors, use row_major
functions when you
are asked for column_major
representations and vice versa.
Fields
m11: T
m12: T
m21: T
m22: T
m31: T
m32: T
Implementations
impl<T, Src, Dst> Transform2D<T, Src, Dst>
[src]
pub const fn row_major(m11: T, m12: T, m21: T, m22: T, m31: T, m32: T) -> Self
[src]
Create a transform specifying its matrix elements in row-major order.
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), then please use column_major
pub const fn column_major(
m11: T,
m21: T,
m31: T,
m12: T,
m22: T,
m32: T
) -> Self
[src]
m11: T,
m21: T,
m31: T,
m12: T,
m22: T,
m32: T
) -> Self
Create a transform specifying its matrix elements in column-major order.
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), then please use row_major
pub fn approx_eq(&self, other: &Self) -> bool where
T: ApproxEq<T>,
[src]
T: ApproxEq<T>,
Returns true is this transform is approximately equal to the other one, using T's default epsilon value.
The same as ApproxEq::approx_eq()
but available without importing trait.
pub fn approx_eq_eps(&self, other: &Self, eps: &T) -> bool where
T: ApproxEq<T>,
[src]
T: ApproxEq<T>,
Returns true is this transform is approximately equal to the other one, using a provided epsilon value.
The same as ApproxEq::approx_eq_eps()
but available without importing trait.
impl<T: Copy, Src, Dst> Transform2D<T, Src, Dst>
[src]
pub fn to_row_major_array(&self) -> [T; 6]
[src]
Returns an array containing this transform's terms in row-major order (the order in which the transform is actually laid out in memory).
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), then please use to_column_major_array
pub fn to_column_major_array(&self) -> [T; 6]
[src]
Returns an array containing this transform's terms in column-major order.
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), then please use to_row_major_array
pub fn to_row_arrays(&self) -> [[T; 2]; 3]
[src]
Returns an array containing this transform's 3 rows in (in row-major order) as arrays.
This is a convenience method to interface with other libraries like glium.
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), this will return column major arrays.
pub fn from_row_major_array(array: [T; 6]) -> Self
[src]
Creates a transform from an array of 6 elements in row-major order.
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), please provide a column major array.
pub fn from_row_arrays(array: [[T; 2]; 3]) -> Self
[src]
Creates a transform from 3 rows of 2 elements (row-major order).
Beware: This library is written with the assumption that row vectors
are being used. If your matrices use column vectors (i.e. transforming a vector
is T * v
), please provide a column major array.
pub fn to_untyped(&self) -> Transform2D<T, UnknownUnit, UnknownUnit>
[src]
Drop the units, preserving only the numeric value.
pub fn from_untyped(p: &Transform2D<T, UnknownUnit, UnknownUnit>) -> Self
[src]
Tag a unitless value with units.
pub fn with_source<NewSrc>(&self) -> Transform2D<T, NewSrc, Dst>
[src]
Returns the same transform with a different source unit.
pub fn with_destination<NewDst>(&self) -> Transform2D<T, Src, NewDst>
[src]
Returns the same transform with a different destination unit.
pub fn to_3d(&self) -> Transform3D<T, Src, Dst> where
T: Zero + One,
[src]
T: Zero + One,
Create a 3D transform from the current transform
impl<T: NumCast + Copy, Src, Dst> Transform2D<T, Src, Dst>
[src]
pub fn cast<NewT: NumCast>(&self) -> Transform2D<NewT, Src, Dst>
[src]
Cast from one numeric representation to another, preserving the units.
pub fn try_cast<NewT: NumCast>(&self) -> Option<Transform2D<NewT, Src, Dst>>
[src]
Fallible cast from one numeric representation to another, preserving the units.
impl<T, Src, Dst> Transform2D<T, Src, Dst> where
T: Zero + One,
[src]
T: Zero + One,
impl<T, Src, Dst> Transform2D<T, Src, Dst> where
T: Copy + Add<Output = T> + Mul<Output = T>,
[src]
T: Copy + Add<Output = T> + Mul<Output = T>,
Methods for combining generic transformations
#[must_use]pub fn post_transform<NewDst>(
&self,
mat: &Transform2D<T, Dst, NewDst>
) -> Transform2D<T, Src, NewDst>
[src]
&self,
mat: &Transform2D<T, Dst, NewDst>
) -> Transform2D<T, Src, NewDst>
Returns the multiplication of the two matrices such that mat's transformation applies after self's transformation.
Assuming row vectors, this is equivalent to self * mat
#[must_use]pub fn pre_transform<NewSrc>(
&self,
mat: &Transform2D<T, NewSrc, Src>
) -> Transform2D<T, NewSrc, Dst>
[src]
&self,
mat: &Transform2D<T, NewSrc, Src>
) -> Transform2D<T, NewSrc, Dst>
Returns the multiplication of the two matrices such that mat's transformation applies before self's transformation.
Assuming row vectors, this is equivalent to mat * self
impl<T, Src, Dst> Transform2D<T, Src, Dst> where
T: Zero + One,
[src]
T: Zero + One,
Methods for creating and combining translation transformations
pub fn create_translation(x: T, y: T) -> Self
[src]
Create a 2d translation transform:
1 0
0 1
x y
#[must_use]pub fn post_translate(&self, v: Vector2D<T, Dst>) -> Self where
T: Copy + Add<Output = T> + Mul<Output = T>,
[src]
T: Copy + Add<Output = T> + Mul<Output = T>,
Applies a translation after self's transformation and returns the resulting transform.
#[must_use]pub fn pre_translate(&self, v: Vector2D<T, Src>) -> Self where
T: Copy + Add<Output = T> + Mul<Output = T>,
[src]
T: Copy + Add<Output = T> + Mul<Output = T>,
Applies a translation before self's transformation and returns the resulting transform.
impl<T, Src, Dst> Transform2D<T, Src, Dst> where
T: Copy + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Zero + Trig,
[src]
T: Copy + Add<Output = T> + Sub<Output = T> + Mul<Output = T> + Zero + Trig,
Methods for creating and combining rotation transformations
pub fn create_rotation(theta: Angle<T>) -> Self
[src]
Returns a rotation transform.
#[must_use]pub fn post_rotate(&self, theta: Angle<T>) -> Self
[src]
Applies a rotation after self's transformation and returns the resulting transform.
#[must_use]pub fn pre_rotate(&self, theta: Angle<T>) -> Self
[src]
Applies a rotation before self's transformation and returns the resulting transform.
impl<T, Src, Dst> Transform2D<T, Src, Dst>
[src]
Methods for creating and combining scale transformations
pub fn create_scale(x: T, y: T) -> Self where
T: Zero,
[src]
T: Zero,
Create a 2d scale transform:
x 0
0 y
0 0
#[must_use]pub fn post_scale(&self, x: T, y: T) -> Self where
T: Copy + Add<Output = T> + Mul<Output = T> + Zero,
[src]
T: Copy + Add<Output = T> + Mul<Output = T> + Zero,
Applies a scale after self's transformation and returns the resulting transform.
#[must_use]pub fn pre_scale(&self, x: T, y: T) -> Self where
T: Copy + Mul<Output = T>,
[src]
T: Copy + Mul<Output = T>,
Applies a scale before self's transformation and returns the resulting transform.
impl<T, Src, Dst> Transform2D<T, Src, Dst> where
T: Copy + Add<Output = T> + Mul<Output = T>,
[src]
T: Copy + Add<Output = T> + Mul<Output = T>,
Methods for apply transformations to objects
#[must_use]pub fn transform_point(&self, point: Point2D<T, Src>) -> Point2D<T, Dst>
[src]
Returns the given point transformed by this transform.
Assuming row vectors, this is equivalent to p * self
#[must_use]pub fn transform_vector(&self, vec: Vector2D<T, Src>) -> Vector2D<T, Dst>
[src]
Returns the given vector transformed by this matrix.
Assuming row vectors, this is equivalent to v * self
#[must_use]pub fn transform_rect(&self, rect: &Rect<T, Src>) -> Rect<T, Dst> where
T: Sub<Output = T> + Zero + PartialOrd,
[src]
T: Sub<Output = T> + Zero + PartialOrd,
Returns a rectangle that encompasses the result of transforming the given rectangle by this transform.
impl<T, Src, Dst> Transform2D<T, Src, Dst> where
T: Copy + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + PartialEq + Zero + One,
[src]
T: Copy + Sub<Output = T> + Mul<Output = T> + Div<Output = T> + PartialEq + Zero + One,
pub fn determinant(&self) -> T
[src]
Computes and returns the determinant of this transform.
pub fn is_invertible(&self) -> bool
[src]
Returns whether it is possible to compute the inverse transform.
#[must_use]pub fn inverse(&self) -> Option<Transform2D<T, Dst, Src>>
[src]
Returns the inverse transform if possible.
Trait Implementations
impl<T: ApproxEq<T>, Src, Dst> ApproxEq<T> for Transform2D<T, Src, Dst>
[src]
fn approx_epsilon() -> T
[src]
fn approx_eq_eps(&self, other: &Self, eps: &T) -> bool
[src]
Returns true is this transform is approximately equal to the other one, using a provided epsilon value.
fn approx_eq(&self, other: &Self) -> bool
[src]
impl<T: Clone, Src, Dst> Clone for Transform2D<T, Src, Dst>
[src]
fn clone(&self) -> Self
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl<T: Copy, Src, Dst> Copy for Transform2D<T, Src, Dst>
[src]
impl<T, Src, Dst> Debug for Transform2D<T, Src, Dst> where
T: Copy + Debug + PartialEq + One + Zero,
[src]
T: Copy + Debug + PartialEq + One + Zero,
impl<T, Src, Dst> Default for Transform2D<T, Src, Dst> where
T: Zero + One,
[src]
T: Zero + One,
fn default() -> Self
[src]
Returns the identity transform.
impl<T, Src, Dst> Eq for Transform2D<T, Src, Dst> where
T: Eq,
[src]
T: Eq,
impl<T, Src, Dst> Hash for Transform2D<T, Src, Dst> where
T: Hash,
[src]
T: Hash,
fn hash<H: Hasher>(&self, h: &mut H)
[src]
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl<T, Src, Dst> Into<Transform2D<T, Src, Dst>> for Translation2D<T, Src, Dst> where
T: Zero + One,
[src]
T: Zero + One,
fn into(self) -> Transform2D<T, Src, Dst>
[src]
impl<T, Src, Dst> PartialEq<Transform2D<T, Src, Dst>> for Transform2D<T, Src, Dst> where
T: PartialEq,
[src]
T: PartialEq,
Auto Trait Implementations
impl<T, Src, Dst> RefUnwindSafe for Transform2D<T, Src, Dst> where
Dst: RefUnwindSafe,
Src: RefUnwindSafe,
T: RefUnwindSafe,
Dst: RefUnwindSafe,
Src: RefUnwindSafe,
T: RefUnwindSafe,
impl<T, Src, Dst> Send for Transform2D<T, Src, Dst> where
Dst: Send,
Src: Send,
T: Send,
Dst: Send,
Src: Send,
T: Send,
impl<T, Src, Dst> Sync for Transform2D<T, Src, Dst> where
Dst: Sync,
Src: Sync,
T: Sync,
Dst: Sync,
Src: Sync,
T: Sync,
impl<T, Src, Dst> Unpin for Transform2D<T, Src, Dst> where
Dst: Unpin,
Src: Unpin,
T: Unpin,
Dst: Unpin,
Src: Unpin,
T: Unpin,
impl<T, Src, Dst> UnwindSafe for Transform2D<T, Src, Dst> where
Dst: UnwindSafe,
Src: UnwindSafe,
T: UnwindSafe,
Dst: UnwindSafe,
Src: UnwindSafe,
T: UnwindSafe,
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,