AffineTransform

Description

struct Tinman.Terrain.Util.AffineTransform

Represents an affine transformation matrix that is decomposable into translation, rotation / reflection, and uniform scaling.

Public / Constants

Identity

public static readonly attribute Identity → (AffineTransform)

The identity transform.

Public / Constructors

AffineTransform

_7 overloads

public constructor AffineTransform¹ → (1)

translation ⁱⁿ : Vec3D: The translation component of the affine transform.

Creates a new instance of AffineTransform.

public constructor AffineTransform² → (1)

rotation ⁱⁿ : Mat3D: The affine matrix that represents the rotation component of the affine transform.

Creates a new instance of AffineTransform.

public constructor AffineTransform³ → (1)

scaling ⁱⁿ : float64: The uniform scale factor of the affine transform.

Creates a new instance of AffineTransform.

public constructor AffineTransform⁴ → (2)

translation ⁱⁿ : Vec3D: The translation component of the affine transform.
rotation ⁱⁿ : Mat3D: The matrix that represents the rotation / reflection component of the affine transform.

Creates a new instance of AffineTransform.

public constructor AffineTransform⁵ → (2)

translation ⁱⁿ : Vec3D: The translation component of the affine transform.
scaling ⁱⁿ : float64: The uniform scale factor of the affine transform.

Creates a new instance of AffineTransform.

public constructor AffineTransform⁶ → (2)

rotation ⁱⁿ : Mat3D: The matrix that represents the rotation / reflection component of the affine transform.
scaling ⁱⁿ : float64: The uniform scale factor of the affine transform.

Creates a new instance of AffineTransform.

public constructor AffineTransform⁷ → (3)

translation ⁱⁿ : Vec3D: The translation component of the affine transform.
rotation ⁱⁿ : Mat3D: The matrix that represents the rotation / reflection component of the affine transform.
scaling ⁱⁿ : float64: The uniform scale factor of the affine transform.

Creates a new instance of AffineTransform.

FromMatrix

[Pure]
public static method FromMatrix → (1)

matrix ⁱⁿ : Mat4D: The matrix for which to create an affine transform.
returns → AffineTransform: The affine transform.

Creates a new instance of AffineTransform.

Public / Methods

Append

[Pure]
public method Append → (1)

transform ⁱⁿ : AffineTransform: The affine transform to append.
returns → AffineTransform: The resulting affine transform, which applies this affine transform first and the given transform ⁱⁿ afterwards. This is opposite to matrix multiplication.

Appends the given affine transform to this one.

EqualsAlmost

[Pure]
public method EqualsAlmost → (1)

other ⁱⁿ : AffineTransform: The other transform.
returns → bool: true if both transforms are similar, false if they are not.

Checks if this transform and the given one are similar but necessarily equal.

See also: Maths.Similar²

Scale

[Pure]
public method Scale → (1)

factor ⁱⁿ : float64: The scale factor to apply.
returns → AffineTransform: The resulting affine transform.

Multiplies the scaling component of this affine transform with the given factor.

ToMatrix

[Pure]
public method ToMatrix → (1)

inverse ^opt : bool = false: Apply the inverse transformation?
returns → Mat4D: The matrix.

Converts this affine transform into a matrix.

TransformBox

[Pure]
public method TransformBox → (2)

box ⁱⁿ : Box3D: The axis-aligned bounding box.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Box3D: The transformed axis-aligned bounding box.

Transforms the given axis-aligned bounding box.

TransformPoint

_2 overloads

[Pure]
public method TransformPoint¹ → (2)

point ⁱⁿ : Vec3D: The point.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Vec3D: The transformed point.

Transforms the given point.

[Pure]
public method TransformPoint² → (4)

x ⁱⁿ : float64: X-coordinate of the point.
y ⁱⁿ : float64: Y-coordinate of the point.
z ⁱⁿ : float64: Z-coordinate of the point.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Vec3D: The transformed point.

Transforms the given point.

TransformRay

[Pure]
public method TransformRay → (2)

ray ⁱⁿ : Ray: The ray.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Ray: The transformed ray.

Transforms the given ray.

TransformScalar

[Pure]
public method TransformScalar → (2)

v ⁱⁿ : float64: The scalar value.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → float64: The transformed scalar.

Transforms the given scalar.

TransformSphere

[Pure]
public method TransformSphere → (2)

sphere ⁱⁿ : Sphere: The bounding sphere.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Sphere: The transformed bounding sphere box.

Transforms the given bounding sphere.

TransformVector

_2 overloads

[Pure]
public method TransformVector¹ → (2)

vector ⁱⁿ : Vec3D: The vector.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Vec3D: The transformed vector.

Transforms the given vector.

[Pure]
public method TransformVector² → (4)

x ⁱⁿ : float64: X-component of the vector.
y ⁱⁿ : float64: Y-component of the vector.
z ⁱⁿ : float64: Z-component of the vector.
inverse ^opt : bool = false: Apply the inverse transformation?
returns → Vec3D: The transformed vector.

Transforms the given vector.

Public / Attributes

Rotation

public readonly attribute Rotation → (Mat3D)

The orthonormal matrix that represents the rotation / reflection component of the transform.

Scaling

public readonly attribute Scaling → (float64)

The uniform scale factor of the transform.

Translation

public readonly attribute Translation → (Vec3D)

The translation component of the transform.