namespace sap.ui.vtm.MatrixUtilities

Visiblity: public
Available since: N/A
Module: sap/ui/vtm/MatrixUtilities
Application Component:

A set of utility functions for working with transformation matrices in a ISO 10303-42 format (in the form of a 1 dimensional array of 13 numbers)


Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.vtm.MatrixUtilities.areEqual

Returns true when the two matrix parameters are equal.

sap.ui.vtm.MatrixUtilities.createIdentity

Returns an identity transformation matrix.

sap.ui.vtm.MatrixUtilities.from4x4Matrix

Converts a 4x4 transformation matrix to a sap.ui.vtm.Matrix.

sap.ui.vtm.MatrixUtilities.fromVkMatrix

Converts a sap.ui.vk.TransformationMatrix (as used by the sap.ui.vk library) to a sap.ui.vtm.Matrix value.

sap.ui.vtm.MatrixUtilities.fromVsmMatrixString

Converts a VSM transformation matrix string to a sap.ui.vtm.Matrix value.

sap.ui.vtm.MatrixUtilities.invert

Returns the inverse of the passed matrix without modifying the passed matrix.

sap.ui.vtm.MatrixUtilities.isInvertible

Returns whether a matrix is invertible.

sap.ui.vtm.MatrixUtilities.isValid

Returns true if the parameter represents a valid transformation matrix.

sap.ui.vtm.MatrixUtilities.multiply

Returns the result of multiplying two matrices (without modifying the passed matrices).

sap.ui.vtm.MatrixUtilities.to4x4Matrix

Converts a sap.ui.vtm.Matrix to a 4x4 transformation matrix.

sap.ui.vtm.MatrixUtilities.toVkMatrix

Converts a sap.ui.vtm.Matrix value to a sap.ui.vk.TransformationMatrix as used by the sap.ui.vk library.

sap.ui.vtm.MatrixUtilities.toVsmMatrixString

Converts a sap.ui.vtm.Matrix value to a VSM transformation matrix string.

sap.ui.vtm.MatrixUtilities.areEqual

Returns true when the two matrix parameters are equal.

Param Type DefaultValue Description
vtmMatrixA sap.ui.vtm.Matrix

One matrix to compare.

vtmMatrixB sap.ui.vtm.Matrix

The other matrix to compare.

sap.ui.vtm.MatrixUtilities.createIdentity

Returns an identity transformation matrix.

Param Type DefaultValue Description

sap.ui.vtm.MatrixUtilities.from4x4Matrix

Converts a 4x4 transformation matrix to a sap.ui.vtm.Matrix.

Param Type DefaultValue Description
mat4x4 number[]

The 4x4 matrix (represented as an array of arrays of numbers) to convert.

sap.ui.vtm.MatrixUtilities.fromVkMatrix

Converts a sap.ui.vk.TransformationMatrix (as used by the sap.ui.vk library) to a sap.ui.vtm.Matrix value.

Param Type DefaultValue Description
vkMatrix sap.ui.vk.TransformationMatrix

The VIT transformation matrix.

sap.ui.vtm.MatrixUtilities.fromVsmMatrixString

Converts a VSM transformation matrix string to a sap.ui.vtm.Matrix value.

Param Type DefaultValue Description
vsmMatrixString string

The VSM transformation matrix string.

sap.ui.vtm.MatrixUtilities.invert

Returns the inverse of the passed matrix without modifying the passed matrix.

Param Type DefaultValue Description
vtmMatrix sap.ui.vtm.Matrix

The matrix to invert.

sap.ui.vtm.MatrixUtilities.isInvertible

Returns whether a matrix is invertible.

Param Type DefaultValue Description
vtmMatrix sap.ui.vtm.Matrix

The matrix to check.

sap.ui.vtm.MatrixUtilities.isValid

Returns true if the parameter represents a valid transformation matrix.

Param Type DefaultValue Description
vtmMatrix sap.ui.vtm.Matrix

The transformation matrix to check.

checkInvertibility boolean

Checks whether the matrix is invertible.
Matrices must be invertible to be used as transformation matrices.
This check is optional due to the additional cost of performing it.

sap.ui.vtm.MatrixUtilities.multiply

Returns the result of multiplying two matrices (without modifying the passed matrices).

Param Type DefaultValue Description
vtmMatrixA sap.ui.vtm.Matrix

One multiplicand.

vtmMatrixB sap.ui.vtm.Matrix

The other multiplicand.

sap.ui.vtm.MatrixUtilities.to4x4Matrix

Converts a sap.ui.vtm.Matrix to a 4x4 transformation matrix.

Param Type DefaultValue Description
vtmMatrix sap.ui.vtm.Matrix

The sap.ui.vtm.Matrix value to convert.

sap.ui.vtm.MatrixUtilities.toVkMatrix

Converts a sap.ui.vtm.Matrix value to a sap.ui.vk.TransformationMatrix as used by the sap.ui.vk library.

Param Type DefaultValue Description
vtmMatrix sap.ui.vtm.Matrix

The sap.ui.vtm.Matrix value

sap.ui.vtm.MatrixUtilities.toVsmMatrixString

Converts a sap.ui.vtm.Matrix value to a VSM transformation matrix string.

Param Type DefaultValue Description
vtmMatrix sap.ui.vtm.Matrix

The sap.ui.vtm.Matrix value.