module Matrices

This is the documentation for Enlighten.

module Matrices

Classes

Name

Description

Name

Description

Geo::Matrix

Matrix definition.

Functions

Name

Description

Name

Description

Equal(MatrixParam, MatrixParam)

Return true if all corresponding matrix elements are exactly equal.

EqualWithinEpsilon(MatrixParam, MatrixParam)

Return true if all corresponding matrix elements are within an epsilon.

GetMatrixFromString(const C *)

Read 16 float values from a string and build a Matrix. Same argument order as the 16 float constructor.

IsFinite(MatrixParam)

Returns true if all of the 16 elements of m are finite.

IsNan(MatrixParam)

Returns true if all of the 16 elements of m are finite.

IsPermutationMatrix(MatrixParam)

Returns true if the matrix is a valid permutation matrix, where each column and each row consists of a single positive or negative "1" and the rest "0".

MatrixToString(MatrixParam)

Creates a GeoString containing the 16 elements of the matrix (space-separated) in a form compatible with GetMatrixFromString.

MatrixToUtf8String(MatrixParam)

Creates a GeoString containing the 16 elements of the matrix (space-separated) in a form compatible with GetMatrixFromString.

MDet(MatrixParam)

Determinant (returned as a broadcast float)

MGetRotation(Geo::MatrixParam)

Deconstruct the matrix to retrieve the rotation part as a quaternion.

MGetTranslation(Geo::MatrixParam)

Deconstruct the matrix to retrieve the translation part as a vector.

MInverse(MatrixParam)

Generalised inverse.

MInverse(MatrixParam, v128)

with a precomputed 1/determinant

MInverseSimple(MatrixParam)

Inverts assuming only rotation and translation.

MTranspose(MatrixParam)

Determinant (returned as a broadcast float)

Typedefs

Name

Description

Name

Description

const Matrix & MatrixParam

The type to pass with a function argument so that the compiler does the minimum amount of work.



bool GEO_CALL Geo::Equal


public: bool GEO_CALL Equal
(
    MatrixParam a,
    MatrixParam b
)


Return true if all corresponding matrix elements are exactly equal.



bool GEO_CALL Geo::EqualWithinEpsilon


public: bool GEO_CALL EqualWithinEpsilon
(
    MatrixParam a,
    MatrixParam b
)