Instance Methodmigueldeicaza.swiftgodot 0.45.0SwiftGodot
scaled(scale:)
Returns a copy of the transform scaled by the given scale factor.
func scaled(scale: Vector2) -> Transform2D This method is an optimized version of multiplying the given transform X with a corresponding scaling transform S from the left, i.e., S * X.
This can be seen as transforming with respect to the global/parent frame.
Other members in extension
Type members
init() Constructs a default-initialized
Transform2Dset toIDENTITY.init(from: Transform2D) Constructs a
Transform2Das a copy of the givenTransform2D.init(rotation: Float, position: Vector2) Constructs the transform from a given angle (in radians) and position.
init(rotation: Float, scale: Vector2, skew: Float, position: Vector2) Constructs the transform from a given angle (in radians), scale, skew (in radians) and position.
init(xAxis: Vector2, yAxis: Vector2, origin: Vector2) Constructs the transform from 3
Vector2values representingx,y, and theorigin(the three column vectors).static let flipX: Transform2DThe
Transform2Dthat will flip something along the X axis.static let flipY: Transform2DThe
Transform2Dthat will flip something along the Y axis.static var godotType: Variant.GTypestatic let identity: Transform2DThe identity
Transform2Dwith no translation, rotation or scaling applied. When applied to other data structures,IDENTITYperforms no transformation.static func != (lhs: Transform2D, rhs: Transform2D) -> Bool Returns
trueif the transforms are not equal.static func * (lhs: Transform2D, rhs: Transform2D) -> Transform2D This operator multiplies all components of the
Transform2D, including theoriginvector, which scales it uniformly.static func * (lhs: Transform2D, rhs: Double) -> Transform2D This operator multiplies all components of the
Transform2D, including theoriginvector, which scales it uniformly.static func * (lhs: Transform2D, rhs: Int64) -> Transform2D This operator multiplies all components of the
Transform2D, including theoriginvector, which scales it uniformly.static func * (lhs: Transform2D, rhs: PackedVector2Array) -> PackedVector2Array This operator multiplies all components of the
Transform2D, including theoriginvector, which scales it uniformly.static func * (lhs: Transform2D, rhs: Rect2) -> Rect2 This operator multiplies all components of the
Transform2D, including theoriginvector, which scales it uniformly.static func * (lhs: Transform2D, rhs: Vector2) -> Vector2 This operator multiplies all components of the
Transform2D, including theoriginvector, which scales it uniformly.static func == (lhs: Transform2D, rhs: Transform2D) -> Bool Returns
trueif the transforms are exactly equal.
Instance members
var origin: Vector2The origin vector (column 2, the third column). Equivalent to array index
2. The origin vector represents translation.var x: Vector2The basis matrix’s X vector (column 0). Equivalent to array index
0.var y: Vector2The basis matrix’s Y vector (column 1). Equivalent to array index
1.subscript(Int64) -> Vector2 func affineInverse() -> Transform2D Returns the inverse of the transform, under the assumption that the basis is invertible (must have non-zero determinant).
func basisXform(v: Vector2) -> Vector2 Returns a vector transformed (multiplied) by the basis matrix.
func basisXformInv(v: Vector2) -> Vector2 Returns a vector transformed (multiplied) by the inverse basis matrix, under the assumption that the basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not).
func determinant() -> Double Returns the determinant of the basis matrix. If the basis is uniformly scaled, then its determinant equals the square of the scale factor.
func getOrigin() -> Vector2 Returns the transform’s origin (translation).
func getRotation() -> Double Returns the transform’s rotation (in radians).
func getScale() -> Vector2 Returns the scale.
func getSkew() -> Double Returns the transform’s skew (in radians).
func interpolateWith(xform: Transform2D, weight: Double) -> Transform2D Returns a transform interpolated between this transform and another by a given
weight(on the range of 0.0 to 1.0).func inverse() -> Transform2D Returns the inverse of the transform, under the assumption that the transformation basis is orthonormal (i.e. rotation/reflection is fine, scaling/skew is not). Use
affineInversefor non-orthonormal transforms (e.g. with scaling).func isConformal() -> Bool Returns
trueif the transform’s basis is conformal, meaning it preserves angles and distance ratios, and may only be composed of rotation and uniform scale. Returnsfalseif the transform’s basis has non-uniform scale or shear/skew. This can be used to validate if the transform is non-distorted, which is important for physics and other use cases.func isEqualApprox(xform: Transform2D) -> Bool Returns
trueif this transform andxformare approximately equal, by running@GlobalScope.is_equal_approxon each component.func isFinite() -> Bool Returns
trueif this transform is finite, by calling@GlobalScope.is_finiteon each component.func lookingAt(target: Vector2) -> Transform2D Returns a copy of the transform rotated such that the rotated X-axis points towards the
targetposition.func orthonormalized() -> Transform2D Returns the transform with the basis orthogonal (90 degrees), and normalized axis vectors (scale of 1 or -1).
func rotated(angle: Double) -> Transform2D Returns a copy of the transform rotated by the given
angle(in radians).func rotatedLocal(angle: Double) -> Transform2D Returns a copy of the transform rotated by the given
angle(in radians).func scaledLocal(scale: Vector2) -> Transform2D Returns a copy of the transform scaled by the given
scalefactor.func translated(offset: Vector2) -> Transform2D Returns a copy of the transform translated by the given
offset.func translatedLocal(offset: Vector2) -> Transform2D Returns a copy of the transform translated by the given
offset.