PSMatrixMathProcs Struct Reference

The set of routines available for the Matrix Math Suite. More...

#include <PIGeneral.h>

Data Fields
SPAPI Boolean(*	Inverse )(PIAffineMatrix *m, PIAffineMatrix *result)
	Performs an inverse operation on the matrix m.
SPAPI Boolean(*	Equals )(const PIAffineMatrix *m1, const PIAffineMatrix *m2)
	Checks if the two matrices passed in are equal.
SPAPI void(*	ScalarMultiply )(const real64 scalar, PIAffineMatrix *m, PIAffineMatrix *result)
	Multiplies the matrix m by scalar.
SPAPI void(*	MatrixMultiply )(const PIAffineMatrix *m1, PIAffineMatrix *m2, PIAffineMatrix *result)
	Multiplies the two matrices m1 and m2.
SPAPI void(*	PointMultiply )(PIFloatPoint *p, const PIAffineMatrix *m, PIFloatPoint *result)
	Multiplies the point p by matrix m.
SPAPI void(*	PointsMultiply )(PIFloatPoint *p, int32 count, const PIAffineMatrix *m, PIFloatPoint *result)

---

Detailed Description

The set of routines available for the Matrix Math Suite.

---

Field Documentation

SPAPI Boolean(* PSMatrixMathProcs::Inverse)(PIAffineMatrix *m, PIAffineMatrix *result)

Performs an inverse operation on the matrix m.

If result == NULL, the solution is put in m.

Parameters:

m	The 3x3 matrix to invert.
result	[OUT] A 3x3 matrix with the result of the inversion.

Returns:

SPAPI Boolean(* PSMatrixMathProcs::Equals)(const PIAffineMatrix *m1, const PIAffineMatrix *m2)

Checks if the two matrices passed in are equal.

Parameters:

m1	A 3x3 matrix.
m2	A 3x3 matrix.

Returns:

True if m1 and m2 are equal; False if they are not equal.

SPAPI void(* PSMatrixMathProcs::ScalarMultiply)(const real64 scalar, PIAffineMatrix *m, PIAffineMatrix *result)

Multiplies the matrix m by scalar.

Works in-place if result == NULL.

Parameters:

scalar	The scalar by which to multiply m.
m	The 3x3 matrix.
result	[OUT] A 3x3 matrix with the result of the scalar multiply.

SPAPI void(* PSMatrixMathProcs::MatrixMultiply)(const PIAffineMatrix *m1, PIAffineMatrix *m2, PIAffineMatrix *result)

Multiplies the two matrices m1 and m2.

If result == NULL the solution is put in m2.

Parameters:

m1	A 3x3 matrix.
m2	A 3x3 matrix.
result	[OUT] A 3x3 matrix with the result of the matrix multiplication.

SPAPI void(* PSMatrixMathProcs::PointMultiply)(PIFloatPoint *p, const PIAffineMatrix *m, PIFloatPoint *result)

Multiplies the point p by matrix m.

If result == NULL the solution is put in m.

Parameters:

p	The point to multiply by m.
m	The 3x3 matrix.
result	[OUT] A point with the result of the point multiply.

SPAPI void(* PSMatrixMathProcs::PointsMultiply)(PIFloatPoint *p, int32 count, const PIAffineMatrix *m, PIFloatPoint *result)

---

The documentation for this struct was generated from the following file:

• PIGeneral.h