Struct quicksilver::geom::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 quicksilver::geom::{Transform, Vector};
let transform = Transform::rotate(30) * Transform::translate(Vector::new(0, -6));

and then applied to a Vector

transform * Vector::new(5, 5)

Methods

impl Transform

pub const IDENTITY: Transform

The identity transformation

pub 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 into_matrix(self) -> Matrix3<f32>

Convert the Transform into an nalgebra Matrix3

#[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 Eq for Transform

impl Clone for Transform

fn clone(&self) -> Transform

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Transform

impl PartialEq<Transform> for Transform

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

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

#[must_use]

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

This method tests for !=.

impl Default for Transform

fn default() -> Transform

Returns the "default value" for a type.

impl From<Matrix<f32, U3, U3, <DefaultAllocator as Allocator<f32, U3, U3>>::Buffer>> for Transform

fn from(other: Matrix3<f32>) -> Transform

Performs the conversion.

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.

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

Performs the * operation.

impl Mul<Vector> for Transform

Transform a vector

type Output = Vector

The resulting type after applying the * operator.

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

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.

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

Performs the * operation.

impl Debug for Transform

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

Formats the value using the given formatter.

impl Display for Transform

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

Formats the value using the given formatter.

impl Serialize for Transform

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

Serialize this value into the given Serde serializer.

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

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

Deserialize this value from the given Serde deserializer.