kotlin-cesium-engine/cesium.engine/Matrix2/Companion

Companion

object Companion : Packable<Matrix2> (source)

Properties

COLUMN0ROW0

val COLUMN0ROW0: Double

The index into Matrix2 for column 0, row 0.

COLUMN0ROW1

val COLUMN0ROW1: Double

The index into Matrix2 for column 0, row 1.

COLUMN1ROW0

val COLUMN1ROW0: Double

The index into Matrix2 for column 1, row 0.

COLUMN1ROW1

val COLUMN1ROW1: Double

The index into Matrix2 for column 1, row 1.

IDENTITY

val IDENTITY: Matrix2

An immutable Matrix2 instance initialized to the identity matrix.

packedLength

open override val packedLength: Int

The number of elements used to pack the object into an array.

ZERO

val ZERO: Matrix2

An immutable Matrix2 instance initialized to the zero matrix.

Functions

abs

fun abs(matrix: Matrix2, result: Matrix2): Matrix2

Computes a matrix, which contains the absolute (unsigned) values of the provided matrix's elements.

add

fun add(left: Matrix2, right: Matrix2, result: Matrix2): Matrix2

Computes the sum of two matrices.

clone

fun clone(matrix: Matrix2, result: Matrix2? = definedExternally): Matrix2

Duplicates a Matrix2 instance.

equals

fun equals(left: Matrix2? = definedExternally, right: Matrix2? = definedExternally): Boolean

Compares the provided matrices componentwise and returns true if they are equal, false otherwise.

equalsEpsilon

fun equalsEpsilon(left: Matrix2? = definedExternally, right: Matrix2? = definedExternally, epsilon: Double? = definedExternally): Boolean

Compares the provided matrices componentwise and returns true if they are within the provided epsilon, false otherwise.

fromArray

fun fromArray(array: ReadonlyArray<Double>, startingIndex: Int? = definedExternally, result: Matrix2? = definedExternally): Matrix2

Creates a Matrix2 from 4 consecutive elements in an array.

fromColumnMajorArray

fun fromColumnMajorArray(values: ReadonlyArray<Double>, result: Matrix2? = definedExternally): Matrix2

Creates a Matrix2 instance from a column-major order array.

fromRotation

fun fromRotation(angle: Double, result: Matrix2? = definedExternally): Matrix2

Creates a rotation matrix.

fromRowMajorArray

fun fromRowMajorArray(values: ReadonlyArray<Double>, result: Matrix2? = definedExternally): Matrix2

Creates a Matrix2 instance from a row-major order array. The resulting matrix will be in column-major order.

fromScale

fun fromScale(scale: Cartesian2, result: Matrix2? = definedExternally): Matrix2

Computes a Matrix2 instance representing a non-uniform scale.

fromUniformScale

fun fromUniformScale(scale: Double, result: Matrix2? = definedExternally): Matrix2

Computes a Matrix2 instance representing a uniform scale.

getColumn

fun getColumn(matrix: Matrix2, index: Int, result: Cartesian2): Cartesian2

Retrieves a copy of the matrix column at the provided index as a Cartesian2 instance.

getElementIndex

fun getElementIndex(row: Int, column: Int): Int

Computes the array index of the element at the provided row and column.

getMaximumScale

fun getMaximumScale(matrix: Matrix2): Double

Computes the maximum scale assuming the matrix is an affine transformation. The maximum scale is the maximum length of the column vectors.

getRotation

fun getRotation(matrix: Matrix2, result: Matrix2): Matrix2

Extracts the rotation matrix assuming the matrix is an affine transformation.

getRow

fun getRow(matrix: Matrix2, index: Int, result: Cartesian2): Cartesian2

Retrieves a copy of the matrix row at the provided index as a Cartesian2 instance.

getScale

fun getScale(matrix: Matrix2, result: Cartesian2): Cartesian2

Extracts the non-uniform scale assuming the matrix is an affine transformation.

multiply

fun multiply(left: Matrix2, right: Matrix2, result: Matrix2): Matrix2

Computes the product of two matrices.

multiplyByScalar

fun multiplyByScalar(matrix: Matrix2, scalar: Double, result: Matrix2): Matrix2

Computes the product of a matrix and a scalar.

multiplyByScale

fun multiplyByScale(matrix: Matrix2, scale: Cartesian2, result: Matrix2): Matrix2

Computes the product of a matrix times a (non-uniform) scale, as if the scale were a scale matrix.

multiplyByUniformScale

fun multiplyByUniformScale(matrix: Matrix2, scale: Double, result: Matrix2): Matrix2

Computes the product of a matrix times a uniform scale, as if the scale were a scale matrix.

multiplyByVector

fun multiplyByVector(matrix: Matrix2, cartesian: Cartesian2, result: Cartesian2): Cartesian2

Computes the product of a matrix and a column vector.

negate

fun negate(matrix: Matrix2, result: Matrix2): Matrix2

Creates a negated copy of the provided matrix.

pack

open override fun pack(value: Matrix2, array: ReadonlyArray<Double>, startingIndex: Int?): ReadonlyArray<Double>

Stores the provided instance into the provided array.

packArray

fun packArray(array: ReadonlyArray<Matrix2>, result: ReadonlyArray<Double>? = definedExternally): ReadonlyArray<Double>

Flattens an array of Matrix2s into an array of components. The components are stored in column-major order.

setColumn

fun setColumn(matrix: Matrix2, index: Int, cartesian: Cartesian2, result: Cartesian2): Matrix2

Computes a new matrix that replaces the specified column in the provided matrix with the provided Cartesian2 instance.

setRotation

fun setRotation(matrix: Matrix2, rotation: Matrix2, result: Matrix2): Matrix2

Sets the rotation assuming the matrix is an affine transformation.

setRow

fun setRow(matrix: Matrix2, index: Int, cartesian: Cartesian2, result: Matrix2): Matrix2

Computes a new matrix that replaces the specified row in the provided matrix with the provided Cartesian2 instance.

setScale

fun setScale(matrix: Matrix2, scale: Cartesian2, result: Matrix2): Matrix2

Computes a new matrix that replaces the scale with the provided scale. This assumes the matrix is an affine transformation.

setUniformScale

fun setUniformScale(matrix: Matrix2, scale: Double, result: Matrix2): Matrix2

Computes a new matrix that replaces the scale with the provided uniform scale. This assumes the matrix is an affine transformation.

subtract

fun subtract(left: Matrix2, right: Matrix2, result: Matrix2): Matrix2

Computes the difference of two matrices.

toArray

fun toArray(matrix: Matrix2, result: ReadonlyArray<Double>? = definedExternally): ReadonlyArray<Double>

Creates an Array from the provided Matrix2 instance. The array will be in column-major order.

transpose

fun transpose(matrix: Matrix2, result: Matrix2): Matrix2

Computes the transpose of the provided matrix.

unpack

open override fun unpack(array: ReadonlyArray<Double>, startingIndex: Int?, result: Matrix2?): Matrix2

Retrieves an instance from a packed array.

unpackArray

fun unpackArray(array: ReadonlyArray<Double>, result: ReadonlyArray<Matrix2>? = definedExternally): ReadonlyArray<Matrix2>

Unpacks an array of column-major matrix components into an array of Matrix2s.