Struct paddle::Transform

pub struct Transform(_);

A 2D transformation represented by a matrix

Transforms can be composed together through matrix multiplication, and are applied to Vectors through multiplication, meaning the notation used is the '*' operator. A property of matrix multiplication is that for some matrices A, B, C and vector V is

Transform = A * B * C
Transform * V = A * (B * (C * V))

This property allows encoding multiple transformations in a single matrix. A transformation that involves rotating a shape 30 degrees and then moving it six units up could be written as

use paddle::quicksilver_compat::{Transform, Vector};
let transform = Transform::rotate(30) * Transform::translate(Vector::new(0, -6));

and then applied to a Vector

transform * Vector::new(5, 5)

Implementations

impl Transform

pub const IDENTITY: Transform

The identity transformation

pub const fn from_array(array: [[f32; 3]; 3]) -> Transform

Create a Transform from an arbitrary matrix in a column-major matrix

pub fn rotate<T: Scalar>(angle: T) -> Transform

Create a rotation transformation

pub fn translate(vec: impl Into<Vector>) -> Transform

Create a translation transformation

pub fn scale(vec: impl Into<Vector>) -> Transform

Create a scale transformation

pub fn as_slice(&self) -> &[f32]

pub fn row_major(&self) -> Vec<f32>

#[must_use]pub fn inverse(&self) -> Transform

Find the inverse of a Transform

A transform's inverse will cancel it out when multplied with it, as seen below:

let transform = Transform::translate(Vector::new(4, 5));
let inverse = transform.inverse();
let vector = Vector::new(10, 10);
assert_eq!(vector, transform * inverse * vector);
assert_eq!(vector, inverse * transform * vector);

Trait Implementations

impl Clone for Transform

pub fn clone(&self) -> Transform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Transform

impl Debug for Transform

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

Formats the value using the given formatter.

impl Default for Transform

pub fn default() -> Transform

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Transform

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Transform

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

Formats the value using the given formatter.

impl Eq for Transform

impl Mul<Rectangle> for Transform

type Output = Rectangle

The resulting type after applying the * operator.

pub fn mul(self, r: Rectangle) -> Rectangle

Performs the * operation.

impl<T: Scalar> Mul<T> for Transform

Scale all of the internal values of the Transform matrix

Note this will NOT scale vectors multiplied by this transform, and generally you shouldn't need to use this.

type Output = Transform

The resulting type after applying the * operator.

pub fn mul(self, other: T) -> Transform

Performs the * operation.

impl Mul<Transform> for Transform

Concat two transforms A and B such that A * B * v = A * (B * v)

type Output = Transform

The resulting type after applying the * operator.

pub fn mul(self, other: Transform) -> Transform

Performs the * operation.

impl Mul<Transform> for Vector

type Output = Vector

The resulting type after applying the * operator.

pub fn mul(self, t: Transform) -> Vector

Performs the * operation.

impl Mul<Transform> for Rectangle

Apply Transform to all points of a Rectangle

type Output = Rectangle

The resulting type after applying the * operator.

pub fn mul(self, t: Transform) -> Rectangle

Performs the * operation.

impl Mul<Vector> for Transform

Transform a vector

type Output = Vector

The resulting type after applying the * operator.

pub fn mul(self, other: Vector) -> Vector

Performs the * operation.

impl PartialEq<Transform> for Transform

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

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Serialize for Transform

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.