kotlin-cesium-engine/cesium.engine/Matrix3/Companion

Companion

external object Companion : Packable<Matrix3> (source)

Properties

COLUMN0ROW0

external val COLUMN0ROW0: Double

The index into Matrix3 for column 0, row 0.

COLUMN0ROW1

external val COLUMN0ROW1: Double

The index into Matrix3 for column 0, row 1.

COLUMN0ROW2

external val COLUMN0ROW2: Double

The index into Matrix3 for column 0, row 2.

COLUMN1ROW0

external val COLUMN1ROW0: Double

The index into Matrix3 for column 1, row 0.

COLUMN1ROW1

external val COLUMN1ROW1: Double

The index into Matrix3 for column 1, row 1.

COLUMN1ROW2

external val COLUMN1ROW2: Double

The index into Matrix3 for column 1, row 2.

COLUMN2ROW0

external val COLUMN2ROW0: Double

The index into Matrix3 for column 2, row 0.

COLUMN2ROW1

external val COLUMN2ROW1: Double

The index into Matrix3 for column 2, row 1.

COLUMN2ROW2

external val COLUMN2ROW2: Double

The index into Matrix3 for column 2, row 2.

IDENTITY

external val IDENTITY: Matrix3

An immutable Matrix3 instance initialized to the identity matrix.

packedLength

open external override val packedLength: Int

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

ZERO

external val ZERO: Matrix3

An immutable Matrix3 instance initialized to the zero matrix.

Functions

abs

external fun abs(matrix: Matrix3, result: Matrix3): Matrix3

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

add

external fun add(left: Matrix3, right: Matrix3, result: Matrix3): Matrix3

Computes the sum of two matrices.

clone

external fun clone(matrix: Matrix3, result: Matrix3? = definedExternally): Matrix3

Duplicates a Matrix3 instance.

computeEigenDecomposition

external fun computeEigenDecomposition(matrix: Matrix3, result: EigenDecompositionResult? = definedExternally): EigenDecompositionResult

Computes the eigenvectors and eigenvalues of a symmetric matrix.

determinant

external fun determinant(matrix: Matrix3): Double

Computes the determinant of the provided matrix.

equals

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

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

equalsEpsilon

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

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

fromArray

external fun fromArray(array: ReadonlyArray<JsDouble>, startingIndex: Int? = definedExternally, result: Matrix3? = definedExternally): Matrix3

Creates a Matrix3 from 9 consecutive elements in an array.

fromColumnMajorArray

external fun fromColumnMajorArray(values: ReadonlyArray<JsDouble>, result: Matrix3? = definedExternally): Matrix3

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

fromCrossProduct

external fun fromCrossProduct(vector: Cartesian3, result: Matrix3? = definedExternally): Matrix3

Computes a Matrix3 instance representing the cross product equivalent matrix of a Cartesian3 vector.

fromHeadingPitchRoll

external fun fromHeadingPitchRoll(headingPitchRoll: HeadingPitchRoll, result: Matrix3? = definedExternally): Matrix3

Computes a 3x3 rotation matrix from the provided headingPitchRoll. (see http://en.wikipedia.org/wiki/Conversion_between_quaternions_and_Euler_angles )

fromQuaternion

external fun fromQuaternion(quaternion: Quaternion, result: Matrix3? = definedExternally): Matrix3

Computes a 3x3 rotation matrix from the provided quaternion.

fromRotationX

external fun fromRotationX(angle: Double, result: Matrix3? = definedExternally): Matrix3

Creates a rotation matrix around the x-axis.

fromRotationY

external fun fromRotationY(angle: Double, result: Matrix3? = definedExternally): Matrix3

Creates a rotation matrix around the y-axis.

fromRotationZ

external fun fromRotationZ(angle: Double, result: Matrix3? = definedExternally): Matrix3

Creates a rotation matrix around the z-axis.

fromRowMajorArray

external fun fromRowMajorArray(values: ReadonlyArray<JsDouble>, result: Matrix3? = definedExternally): Matrix3

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

fromScale

external fun fromScale(scale: Cartesian3, result: Matrix3? = definedExternally): Matrix3

Computes a Matrix3 instance representing a non-uniform scale.

fromUniformScale

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

Computes a Matrix3 instance representing a uniform scale.

getColumn

external fun getColumn(matrix: Matrix3, index: Int, result: Cartesian3): Cartesian3

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

getElementIndex

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

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

getMaximumScale

external fun getMaximumScale(matrix: Matrix3): Double

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

getRotation

external fun getRotation(matrix: Matrix3, result: Matrix3): Matrix3

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

getRow

external fun getRow(matrix: Matrix3, index: Int, result: Cartesian3): Cartesian3

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

getScale

external fun getScale(matrix: Matrix3, result: Cartesian3): Cartesian3

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

inverse

external fun inverse(matrix: Matrix3, result: Matrix3): Matrix3

Computes the inverse of the provided matrix.

inverseTranspose

external fun inverseTranspose(matrix: Matrix3, result: Matrix3): Matrix3

Computes the inverse transpose of a matrix.

multiply

external fun multiply(left: Matrix3, right: Matrix3, result: Matrix3): Matrix3

Computes the product of two matrices.

multiplyByScalar

external fun multiplyByScalar(matrix: Matrix3, scalar: Double, result: Matrix3): Matrix3

Computes the product of a matrix and a scalar.

multiplyByScale

external fun multiplyByScale(matrix: Matrix3, scale: Cartesian3, result: Matrix3): Matrix3

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

multiplyByUniformScale

external fun multiplyByUniformScale(matrix: Matrix3, scale: Double, result: Matrix3): Matrix3

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

multiplyByVector

external fun multiplyByVector(matrix: Matrix3, cartesian: Cartesian3, result: Cartesian3): Cartesian3

Computes the product of a matrix and a column vector.

negate

external fun negate(matrix: Matrix3, result: Matrix3): Matrix3

Creates a negated copy of the provided matrix.

pack

open external override fun pack(value: Matrix3, array: ReadonlyArray<JsDouble>, startingIndex: Int? = definedExternally): ReadonlyArray<JsDouble>

Stores the provided instance into the provided array.

packArray

external fun packArray(array: ReadonlyArray<Matrix3>, result: ReadonlyArray<JsDouble>? = definedExternally): ReadonlyArray<JsDouble>

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

setColumn

external fun setColumn(matrix: Matrix3, index: Int, cartesian: Cartesian3, result: Matrix3): Matrix3

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

setRotation

external fun setRotation(matrix: Matrix3, rotation: Matrix3, result: Matrix3): Matrix3

Sets the rotation assuming the matrix is an affine transformation.

setRow

external fun setRow(matrix: Matrix3, index: Int, cartesian: Cartesian3, result: Matrix3): Matrix3

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

setScale

external fun setScale(matrix: Matrix3, scale: Cartesian3, result: Matrix3): Matrix3

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

setUniformScale

external fun setUniformScale(matrix: Matrix3, scale: Double, result: Matrix3): Matrix3

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

subtract

external fun subtract(left: Matrix3, right: Matrix3, result: Matrix3): Matrix3

Computes the difference of two matrices.

toArray

external fun toArray(matrix: Matrix3, result: ReadonlyArray<JsDouble>? = definedExternally): ReadonlyArray<JsDouble>

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

transpose

external fun transpose(matrix: Matrix3, result: Matrix3): Matrix3

Computes the transpose of the provided matrix.

unpack

open external override fun unpack(array: ReadonlyArray<JsDouble>, startingIndex: Int? = definedExternally, result: Matrix3? = definedExternally): Matrix3

Retrieves an instance from a packed array.

unpackArray

external fun unpackArray(array: ReadonlyArray<JsDouble>, result: ReadonlyArray<Matrix3>? = definedExternally): ReadonlyArray<Matrix3>

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