Transform2D

Category: Built-In Types

Brief Description

2D Transformation. 3x2 matrix.

Constants

  • IDENTITY = Transform2D( 1, 0, 0, 1, 0, 0 )
  • FLIP_X = Transform2D( -1, 0, 0, 1, 0, 0 )
  • FLIP_Y = Transform2D( 1, 0, 0, -1, 0, 0 )

Description

Represents one or many transformations in 2D space such as translation, rotation, or scaling. It consists of a two Vector2 x, y and Vector2 “origin”. It is similar to a 3x2 matrix.

Property Descriptions

The transform’s translation offset.

The X axis of 2x2 basis matrix containing 2 Vector2s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.

The Y axis of 2x2 basis matrix containing 2 Vector2s as its columns: X axis and Y axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.

Method Descriptions

Constructs the transform from a 3D Transform.

Constructs the transform from 3 Vector2s representing x, y, and origin.

Constructs the transform from a given angle (in radians) and position.

Returns the inverse of the matrix.

Transforms the given vector by this transform’s basis (no translation).

Inverse-transforms the given vector by this transform’s basis (no translation).

Returns the transform’s origin (translation).

Returns the transform’s rotation (in radians).

Returns the scale.

Returns a transform interpolated between this transform and another by a given weight (0-1).

Returns the inverse of the transform, under the assumption that the transformation is composed of rotation and translation (no scaling, use affine_inverse for transforms with scaling).

Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors.

Rotates the transform by the given angle (in radians).

Scales the transform by the given factor.

Translates the transform by the given offset.

Transforms the given Vector2 or Rect2 by this transform.

Inverse-transforms the given Vector2 or Rect2 by this transform.