Struct ludomath::vec2d::Transform

pub struct Transform {
    pub mat: [[f32; 2]; 2],
    pub vec: Vector,
}

Represents an affine transformation of the plane.

Can represent any linear transformation, plus translation. Equivalent in layout to a GLSL (column-major) 3x2 matrix, where the rightmost column contains the translation vector.

Fields

mat: [[f32; 2]; 2]

The 2x2 linear transformation matrix.

Stored in column-major order as a 2D array.

vec: Vector

The translation vector.

Methods

impl Transform

pub fn new(translation: Vector, rotation: Rotation, scale: Vector) -> Transform

Constructs a new Transform from translation, rotation and scale.

pub fn new_rad(translation: Vector, angle: f32, scale: Vector) -> Transform

Constructs a new Transform from position, rotation and scale.

Rotation is given as an angle in radians.

pub fn new_deg(translation: Vector, angle: f32, scale: Vector) -> Transform

Constructs a new Transform from position, rotation and scale.

Rotation is given as an angle in degrees.

pub fn new_matrix(
    mat1_1: f32,
    mat2_1: f32,
    mat1_2: f32,
    mat2_2: f32
) -> Transform

Constructs a Transform from a 2x2 linear tranformation matrix.

The order of the arguments is their order in memory - column-major.

pub fn new_scaling(scale: Vector) -> Transform

Constructs a scaling Transform.

pub fn new_rotation(rotation: Rotation) -> Transform

Constructs a rotating Transform from a Rotation.

pub fn new_rotation_rad(angle: f32) -> Transform

Constructs a rotating Transform from an angle in radians.

pub fn new_rotation_deg(angle: f32) -> Transform

Constructs a rotating Transform from an angle in degrees.

pub fn new_translation(offset: Vector) -> Transform

Constructs a translating Transform from an offset.

pub fn translate(self, offset: Vector) -> Transform

Creates a new Transform by translating an existing one.

The offset is relative to the global coordinate system.

pub fn translate_mut(&mut self, offset: Vector)

Translates a Transform, mutating it.

The offset is relative to the global coordinate system.

pub fn translate_local(self, offset: Vector) -> Transform

Creates a new Transform by translating an existing one.

The offset is relative to the local coordinate system defined by the Transform.

pub fn translate_local_mut(&mut self, offset: Vector)

Translates a Transform, mutating it.

The offset is relative to the local coordinate system defined by the Transform.

pub fn rotate(self, rotation: Rotation) -> Transform

Creates a new Transform by rotating an existing one.

pub fn rotate_rad(self, angle: f32) -> Transform

Creates a new Transform by rotating an existing one by an angle in radians.

pub fn rotate_deg(self, angle: f32) -> Transform

Creates a new Transform by rotating an existing one by an angle in degrees.

pub fn rotate_mut(&mut self, rotation: Rotation)

Rotates a Transform, mutating it.

pub fn rotate_rad_mut(&mut self, angle: f32)

Rotates a Transform by an angle in radians, mutating it.

pub fn rotate_deg_mut(&mut self, angle: f32)

Rotates a Transform by an angle in degrees, mutating it.

pub fn scale(self, factor: Vector) -> Transform

Creates a new Transform by scaling an existing one.

pub fn scale_by_num(self, factor: f32) -> Transform

Creates a new Transform by scaling an existing one.

Scales by the same amount in both axes.

pub fn scale_mut(&mut self, factor: Vector)

Scales a Transform, mutating it.

pub fn scale_by_num_mut(&mut self, factor: f32)

Scales a Transform equally in both axes, mutating it.

pub fn transform_arr<T>(self, arr: &[T]) -> Vec<T> where
    Self: Transformation<T>,
    T: Copy, 

Transforms a list of transformable items into a new Vec.

pub fn transform_arr_mut<T>(self, arr: &mut [T]) where
    Self: Transformation<T>,
    T: Copy, 

Transforms a list of transformable items, mutating them.

pub fn from_mat3x2(mat3x2: [[f32; 2]; 3]) -> Transform

Converts a OpenGL-style mat3x2 to a Transform.

Optimizes into a simple copy, since the types have the same layout.

pub fn to_mat3x2(self) -> [[f32; 2]; 3]

Converts a Transform to a OpenGL-style mat3x2.

Optimizes into a simple copy, since the types have the same layout.

pub fn to_mat4x4(self) -> [[f32; 4]; 4]

Converts a Transform to a OpenGL-style mat4x4.

The matrix is inserted in the top-left corner, and the translation vector in the top of the rightmost column. The rest of the elements are set to the identity matrix.

pub fn arr_from_mat3x2s(arr: &[[[f32; 4]; 4]]) -> &[Transform]

Reinterprets a slice of OpenGL-style mat4x4s as Transforms.

Does not allocate a new array, only changes the type of the pointer.

pub fn arr_to_mat3x2s(arr: &[Transform]) -> &[[[f32; 4]; 4]]

Reinterprets a slice of Transforms as OpenGL-style mat4x4s.

Does not allocate a new array, only changes the type of the pointer.

Trait Implementations

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 for Transform

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

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

fn ne(&self, __arg_0: &Transform) -> bool

This method tests for !=.

impl Debug for Transform

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

Formats the value using the given formatter.

impl MaybeInvertible for Transform

fn is_invertible(self) -> bool

Returns true if the object is invertible, false otherwise.

fn invert(self) -> Self

Returns the inverse of an object.

fn invert_mut(&mut self)

Inverts an object, mutating it.

fn invert_checked(self) -> Option<Self>

Attempts to compute the inverse of a transformation.

impl Transformation<Vector> for Transform

fn transform(self, vec: Vector) -> Vector

Returns a transformed copy of an object.

fn inverse_transform(self, vec: Vector) -> Vector

Transforms an object by the inverse of a transformation.

fn transform_mut(self, operand: &mut T) where
    T: Copy, 

Transforms an object, mutating it.

fn inverse_transform_checked(self, operand: T) -> Option<T>

Transforms an object by the inverse of a transformation.

impl Transformation<Point> for Transform

fn transform(self, pt: Point) -> Point

Returns a transformed copy of an object.

fn inverse_transform(self, pt: Point) -> Point

Transforms an object by the inverse of a transformation.

fn transform_mut(self, operand: &mut T) where
    T: Copy, 

Transforms an object, mutating it.

fn inverse_transform_checked(self, operand: T) -> Option<T>

Transforms an object by the inverse of a transformation.

impl Transformation<Transform> for Transform

fn transform(self, rhs: Transform) -> Transform

Returns a transformed copy of an object.

fn transform_mut(self, operand: &mut T) where
    T: Copy, 

Transforms an object, mutating it.

fn inverse_transform(self, operand: T) -> T

Transforms an object by the inverse of a transformation.

fn inverse_transform_checked(self, operand: T) -> Option<T>

Transforms an object by the inverse of a transformation.