API Reference

Record TGenericMatrix3

Description
Hierarchy
Nested Types
Fields
Methods
Properties

Unit

CastleVectorsInternalDouble

Declaration

type TGenericMatrix3 = record

Description

3x3 matrix of floating-point values. Column-major, just like OpenGL, which means that the first index of Data array should be treated as a column number, the 2nd index is the row number.

This is generic type (although not using "proper" Pascal generics for implementation reasons). In has two actual uses:

  1. TMatrix3, a matrix of 3 Single values (floats with single precision),

  2. TMatrix3Double, a matrix of 3 Double values (floats with double precision).

The type TGenericScalar is, accordingly, Single or Double for TMatrix3 or TMatrix3Double.

Overview

Nested Types

Public TIndex = 0..2;
Public TIndexArray = array[TIndex] of TGenericScalar;

Fields

Public var Data: array [TIndex] of TIndexArray;

Methods

Public class operator + (const A, B: TGenericMatrix3): TGenericMatrix3; inline;
Public class operator - (const A, B: TGenericMatrix3): TGenericMatrix3; inline;
Public class operator - (const M: TGenericMatrix3): TGenericMatrix3; inline;
Public class operator * (const V: TGenericMatrix3; const Scalar: TGenericScalar): TGenericMatrix3; inline;
Public class operator * (const Scalar: TGenericScalar; const V: TGenericMatrix3): TGenericMatrix3; inline;
Public class operator * (const M: TGenericMatrix3; const V: TGenericVector3): TGenericVector3; inline;
Public class operator * (const M1, M2: TGenericMatrix3): TGenericMatrix3;
Public function ToString(const LineIndent: string = ''): string;
Public function ToRawString(const LineIndent: String = ''; const FloatFormat: String = '%g'): String;
Public function Determinant: TGenericScalar;
Public function Inverse(ADeterminant: TGenericScalar): TGenericMatrix3;
Public function TryInverse(out MInverse: TGenericMatrix3): boolean;
Public function Transpose: TGenericMatrix3;
Public class function Equals(const M1, M2: TGenericMatrix3): boolean; overload; static;
Public class function Equals(const M1, M2: TGenericMatrix3; const Epsilon: TGenericScalar): boolean; overload; static;
Public class function PerfectlyEquals(const M1, M2: TGenericMatrix3): boolean; static;
Public class function Lerp(const A: TGenericScalar; const M1, M2: TGenericMatrix3): TGenericMatrix3; static;
Public class function Zero: TGenericMatrix3; static;
Public class function Identity: TGenericMatrix3; static;

Properties

Public property Items [const AColumn,ARow: TIndex]: TGenericScalar read GetItems write SetItems;
Public property Rows [const ARow: TIndex]: TGenericVector3 read GetRows write SetRows;
Public property Columns [const AColumn: TIndex]: TGenericVector3 read GetColumns write SetColumns;

Description

Nested Types

Public TIndex = 0..2;

This item has no description.

Public TIndexArray = array[TIndex] of TGenericScalar;

This item has no description.

Fields

Public var Data: array [TIndex] of TIndexArray;

Data: array [TIndex, TIndex] of TGenericScalar;

Methods

Public class operator + (const A, B: TGenericMatrix3): TGenericMatrix3; inline;

This item has no description.

Public class operator - (const A, B: TGenericMatrix3): TGenericMatrix3; inline;

This item has no description.

Public class operator - (const M: TGenericMatrix3): TGenericMatrix3; inline;

This item has no description.

Public class operator * (const V: TGenericMatrix3; const Scalar: TGenericScalar): TGenericMatrix3; inline;

This item has no description.

Public class operator * (const Scalar: TGenericScalar; const V: TGenericMatrix3): TGenericMatrix3; inline;

This item has no description.

Public class operator * (const M: TGenericMatrix3; const V: TGenericVector3): TGenericVector3; inline;

This item has no description.

Public class operator * (const M1, M2: TGenericMatrix3): TGenericMatrix3;

Matrix * matrix makes a normal matrix algebraic multiplication (not component-wise multiplication). Note that this is different from vectors, where vector * vector makes a component-wise multiplication.

Public function ToString(const LineIndent: string = ''): string;

This item has no description.

Public function ToRawString(const LineIndent: String = ''; const FloatFormat: String = '%g'): String;

Convert to string using the most precise (not always easily readable by humans) float format. This may use the exponential (scientific) notation to represent the floating-point value, if needed.

You can pass, as parameter, the format to use. By default it is '%g', "general number format" with maximum precision documented on https://www.freepascal.org/docs-html/rtl/sysutils/format.html .

This is suitable for storing the value in a file, with a best precision possible.

Public function Determinant: TGenericScalar;

This item has no description.

Public function Inverse(ADeterminant: TGenericScalar): TGenericMatrix3;

Inverse the matrix.

This does division by ADeterminant internally, so will raise exception from this float division if the matrix is not reversible. Check Math.IsZero(ADeterminant) first to avoid this, or use TryInverse.

Public function TryInverse(out MInverse: TGenericMatrix3): boolean;

Inverse the matrix, or return False if the matrix is not invertible.

Public function Transpose: TGenericMatrix3;

This item has no description.

Public class function Equals(const M1, M2: TGenericMatrix3): boolean; overload; static;

Compare two vectors, with epsilon to tolerate slightly different floats.

Public class function Equals(const M1, M2: TGenericMatrix3; const Epsilon: TGenericScalar): boolean; overload; static;

This item has no description.

Public class function PerfectlyEquals(const M1, M2: TGenericMatrix3): boolean; static;

Compare two vectors using exact comparison (like the "=" operator to compare floats).

Public class function Lerp(const A: TGenericScalar; const M1, M2: TGenericMatrix3): TGenericMatrix3; static;

Linear interpolation between two matrix values.

See also
TGenericVector3.Lerp
Linear interpolation between two vector values.
Public class function Zero: TGenericMatrix3; static;

This item has no description.

Public class function Identity: TGenericMatrix3; static;

This item has no description.

Properties

Public property Items [const AColumn,ARow: TIndex]: TGenericScalar read GetItems write SetItems;

This item has no description.

Public property Rows [const ARow: TIndex]: TGenericVector3 read GetRows write SetRows;

This item has no description.

Public property Columns [const AColumn: TIndex]: TGenericVector3 read GetColumns write SetColumns;

This item has no description.

Generated by PasDoc 0.16.0-snapshot.

Copyright Michalis Kamburelis and Castle Game Engine Contributors.

This webpage is also open-source and we welcome pull requests to improve it.

We use cookies for analytics. See our privacy policy.