Transform

Category: Built-In Types

Brief Description

3D transformation (3×4 matrix).

Properties

Basis basis Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )
Vector3 origin Vector3( 0, 0, 0 )

Constants

  • IDENTITY = Transform( 1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )Transform with no translation, rotation or scaling applied. When applied to other data structures, IDENTITY performs no transformation.
  • FLIP_X = Transform( -1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0 )Transform with mirroring applied perpendicular to the YZ plane.
  • FLIP_Y = Transform( 1, 0, 0, 0, -1, 0, 0, 0, 1, 0, 0, 0 )Transform with mirroring applied perpendicular to the XZ plane.
  • FLIP_Z = Transform( 1, 0, 0, 0, 1, 0, 0, 0, -1, 0, 0, 0 )Transform with mirroring applied perpendicular to the XY plane.

Description

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

Property Descriptions

Default Basis( 1, 0, 0, 0, 1, 0, 0, 0, 1 )

The basis is a matrix containing 3 Vector3 as its columns: X axis, Y axis, and Z axis. These vectors can be interpreted as the basis vectors of local coordinate system traveling with the object.

Default Vector3( 0, 0, 0 )

The translation offset of the transform.

Method Descriptions

Constructs the Transform from four Vector3. Each axis corresponds to local basis vectors (some of which may be scaled).

Constructs the Transform from a Basis and Vector3.

Constructs the Transform from a Transform2D.

Constructs the Transform from a Quat. The origin will be Vector3(0, 0, 0).

Constructs the Transform from a Basis. The origin will be Vector3(0, 0, 0).

Returns the inverse of the transform, under the assumption that the transformation is composed of rotation, scaling and translation.

Interpolates the transform to other Transform by weight amount (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 a copy of the transform rotated such that its -Z axis points towards the target position.

The transform will first be rotated around the given up vector, and then fully aligned to the target by a further rotation around an axis perpendicular to both the target and up vectors.

Operations take place in global space.

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

Rotates the transform around given axis by phi. The axis must be a normalized vector.

Scales the transform by the specified 3D scaling factors.

Translates the transform by the specified offset.

Transforms the given Vector3, Plane, AABB, or PoolVector3Array by this transform.

Inverse-transforms the given Vector3, Plane, AABB, or PoolVector3Array by this transform.