MutableAffineTransform

MutableAffineTransform()

Constructs an identity MutableAffineTransform:

⎡1  0  0⎤
⎢0  1  0⎥
⎣0  0  1⎦

This is useful when pre-allocating a scratch instance to be filled later.

MutableAffineTransform(
    m00: Float,
    m10: Float,
    m20: Float,
    m01: Float,
    m11: Float,
    m21: Float
)

Constructs this transform with 6 float values, starting with the top left corner of the matrix and proceeding in row-major order. Prefer to create this object with functions that apply specific transform operations, such as populateFromScale or populateFromRotationDegrees, rather than directly passing in the actual numeric values of this transform. This constructor is useful for when the values are needed to be provided all at once, for example for serialization. To access these values in the same order as they are passed in here, use AffineTransform.getValues. To construct this object using an array as input, there is another public constructor for that.

open operator fun equals(other: Any?): Boolean

Component-wise equality operator for MutableAffineTransform.

Due to the propagation floating point precision errors, operations that may be equivalent over the real numbers are not always equivalent for floats, and might return false for equals in some cases.

fun populateFrom(input: AffineTransform): MutableAffineTransform

Fills this MutableAffineTransform with the same values contained in input.

Returns the modified instance to allow chaining calls.

fun populateFromIdentity(): MutableAffineTransform

Fills this MutableAffineTransform with an identity transformation, which maps a point to itself, i.e. it leaves it unchanged.

Returns the modified instance to allow chaining calls.

fun populateFromRotationDegrees(degrees: @AngleDegreesFloat Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that rotates degrees in the direction from the positive x-axis towards the positive y-axis.

Returns the modified instance to allow chaining calls.

fun populateFromScale(scaleFactor: Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that scales in both the x and y direction by the given scaleFactor, centered about the origin.

Returns the modified instance to allow chaining calls.

fun populateFromScale(xScaleFactor: Float, yScaleFactor: Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that scales in both the x- and y-direction by the given pair of factors; xScaleFactor and yScaleFactor respectively, centered about the origin.

Returns the modified instance to allow chaining calls.

fun populateFromScaleX(scaleFactor: Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that scales in the x-direction by the given factor, centered about the origin.

Returns the modified instance to allow chaining calls.

fun populateFromScaleY(scaleFactor: Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that scales in the y-direction by the given factor, centered about the origin.

Returns the modified instance to allow chaining calls.

fun populateFromSkewX(sx: Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that skews in the x-direction by the given factor.

Returns the modified instance to allow chaining calls.

fun populateFromSkewY(sy: Float): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that skews in the y-direction by the given factor.

Returns the modified instance to allow chaining calls.

fun populateFromTranslation(offset: Vec): MutableAffineTransform

Fills this MutableAffineTransform with a transformation that translates by the given offset vector.

Returns the modified instance to allow chaining calls.

fun setValues(values: @Size(min = 6) FloatArray): Unit

Like setValues, but accepts a FloatArray instead of individual float values.

fun setValues(m00: Float, m10: Float, m20: Float, m01: Float, m11: Float, m21: Float): Unit

Populates this transform with the given values, starting with the top left corner of the matrix and proceeding in row-major order.

Prefer to modify this object with functions that apply specific transform operations, such as populateFromScale or populateFromRotationDegrees, rather than directly setting the actual numeric values of this transform. This function is useful for when the values are needed to be provided in bulk, for example for serialization.

To access these values in the same order as they are set here, use AffineTransform.getValues.

open fun toImmutable(): ImmutableAffineTransform

Returns an immutable equivalent of this object. This will return itself if called on an immutable instance.

open var m00: Float

Value in the first row, first column of the transform matrix.

open var m01: Float

Value in the second row, first column of the transform matrix.

open var m10: Float

Value in the first row, second column of the transform matrix.

open var m11: Float

Value in the second row, second column of the transform matrix.

open var m20: Float

Value in the first row, third column of the transform matrix.

open var m21: Float

Value in the second row, third column of the transform matrix.

fun MutableAffineTransform.populateFrom(matrix: Matrix): MutableAffineTransform

Fills this MutableAffineTransform with the values from matrix.

If matrix is not an affine transform, throws IllegalArgumentException instead.

Leaves matrix unchanged. Returns this modified instance to allow chaining calls.

fun MutableAffineTransform.populateFrom(matrix: Matrix): MutableAffineTransform

Fills this MutableAffineTransform with the values from matrix.

If matrix is not an affine transform, throws IllegalArgumentException instead.

Leaves the input matrix unchanged. Returns the modified instance to allow chaining calls.