Transform2D

Category: Built-In Types

Brief Description

2D transformation (3×2 matrix).

Properties

Vector2 origin Vector2( 0, 0 )
Vector2 x Vector2( 1, 0 )
Vector2 y Vector2( 0, 1 )

Constants

  • IDENTITY = Transform2D( 1, 0, 0, 1, 0, 0 )Transform2D with no translation, rotation or scaling applied. When applied to other data structures, IDENTITY performs no transformation.
  • FLIP_X = Transform2D( -1, 0, 0, 1, 0, 0 )Transform2D with mirroring applied parallel to the X axis.
  • FLIP_Y = Transform2D( 1, 0, 0, -1, 0, 0 )Transform2D with mirroring applied parallel to the Y axis.

Description

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

Property Descriptions

Default Vector2( 0, 0 )

The transform’s translation offset.

Default Vector2( 1, 0 )

The X axis of 2×2 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.

Default Vector2( 0, 1 )

The Y axis of 2×2 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, Rect2, or PoolVector2Array by this transform.

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