Transform2D

2D transformation (3×2 matrix).

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.

Properties

Vector2originVector2( 0, 0 )
Vector2xVector2( 1, 0 )
Vector2yVector2( 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.

Property Descriptions

DefaultVector2( 0, 0 )

The transform’s translation offset.


DefaultVector2( 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.


DefaultVector2( 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 true if this transform and transform are approximately equal, by calling is_equal_approx on each component.


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


Rotates the transform by the given angle (in radians), using matrix multiplication.


Scales the transform by the given scale factor, using matrix multiplication.


Translates the transform by the given offset, relative to the transform’s basis vectors.

Unlike rotated and scaled, this does not use matrix multiplication.


Transforms the given Vector2, Rect2, or PoolVector2Array by this transform.


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

Doc ID missing

Disclaimer: This page has been automaticaly and directly extracted from the official Godot Docs website, the 1970-01-01 at 00:00:00. It’s the English Stable version because it’s what most Godot users should use. The Copyright owners are Juan Linietsky, Ariel Manzur and the Godot community. CC-BY 3.0. Thanks for your patience and generosity.