Kanzi  3.9.9
Kanzi Engine C++ API
kanzi::Matrix3x3 Class Reference

Matrix with 3x3 elements. More...

#include <kanzi/core/math/matrix3x3.hpp>

Public Member Functions

Vector3 getColumn (size_t index) const
 Gets the column of a matrix. More...
 
float getRotationAngle () const
 Get rotation angle of the matrix. More...
 
Vector3 getRow (size_t index) const
 Gets the row of a matrix. More...
 
Vector2 getScale () const
 Get scale as a vector. More...
 
float getScaleX () const
 Get X scale component. More...
 
float getScaleY () const
 Get Y scale component. More...
 
Vector2 getTranslation () const
 Get translation. More...
 
float getTranslationX () const
 Get translation on X axis. More...
 
float getTranslationY () const
 Get translation on Y axis. More...
 
Vector2 getXAxis () const
 Get X axis. More...
 
Vector2 getYAxis () const
 Get Y axis. More...
 
 Matrix3x3 ()
 Default constructor, initializes the matrix to identity matrix. More...
 
 Matrix3x3 (float x0, float x1, float x2, float x3, float x4, float x5, float x6, float x7, float x8)
 Constructs the matrix from elements in column-major order. More...
 
 Matrix3x3 (const Vector2 &x, const Vector2 &y, const Vector2 &translation)
 Constructs the matrix from three column vectors. More...
 
Matrix3x3operator*= (const Matrix3x3 &m)
 Modifies this matrix by multiplying it with another matrix. More...
 
Matrix3x3operator+= (const Matrix3x3 &m)
 Modifies this matrix by adding another matrix. More...
 
Matrix3x3operator-= (const Matrix3x3 &m)
 Modifies this matrix by subtracting another matrix from this matrix. More...
 
const float & operator[] (size_t index) const
 Access to individual elements of the matrix. More...
 
float & operator[] (size_t index)
 Access to individual elements of the matrix. More...
 
void scale (const Vector2 &v)
 Scales this matrix. More...
 
void setColumn (size_t index, const Vector3 &column)
 Sets the column of a matrix. More...
 
void setRow (size_t index, const Vector3 &row)
 Sets the row of a matrix. More...
 
void setTranslation (Vector2 translation)
 Set translation. More...
 
void setTranslation (float translationX, float translationY)
 Set translation. More...
 
void setTranslationX (float translationX)
 Set translation on X axis. More...
 
void setTranslationY (float translationY)
 Set translation on Y axis. More...
 
void setXAxis (Vector2 v)
 Set X axis. More...
 
void setYAxis (Vector2 v)
 Set Y axis. More...
 
void translate (const Vector2 &v)
 Translates this matrix. More...
 
Matrix3x3 transposed () const
 Applies a transpose to a matrix. More...
 

Static Public Member Functions

static Matrix3x3 createFilled (float value)
 Creates a matrix with all elements set to value. More...
 
static Matrix3x3 createIdentity ()
 Creates identity matrix. More...
 
static Matrix3x3 createRotationInDegrees (float angleInDegrees)
 Creates a rotation matrix. More...
 
static Matrix3x3 createRotationInRadians (float angleInRadians)
 Creates a rotation matrix. More...
 
static Matrix3x3 createScale (Vector2 scale)
 Creates a scaled matrix. More...
 
static Matrix3x3 createSRT (Vector2 scale, float rotationInRadians, Vector2 translation)
 Create an SRT matrix. More...
 
static Matrix3x3 createTranslation (Vector2 translation)
 Creates translation matrix. More...
 
static Matrix3x3 createTranslation (float x, float y)
 Creates translation matrix. More...
 

Friends

Matrix3x3 operator+ (Matrix3x3 lhs, const Matrix3x3 &rhs)
 Creates a new matrix by adding an existing matrix to another one. More...
 
Matrix3x3 operator- (Matrix3x3 lhs, const Matrix3x3 &rhs)
 Creates a new matrix by subtracting an existing matrix from another one. More...
 

Detailed Description

Matrix with 3x3 elements.

Constructor & Destructor Documentation

kanzi::Matrix3x3::Matrix3x3 ( )
inlineexplicit

Default constructor, initializes the matrix to identity matrix.

kanzi::Matrix3x3::Matrix3x3 ( float  x0,
float  x1,
float  x2,
float  x3,
float  x4,
float  x5,
float  x6,
float  x7,
float  x8 
)
inlineexplicit

Constructs the matrix from elements in column-major order.

kanzi::Matrix3x3::Matrix3x3 ( const Vector2 x,
const Vector2 y,
const Vector2 translation 
)
inlineexplicit

Constructs the matrix from three column vectors.

Member Function Documentation

const float& kanzi::Matrix3x3::operator[] ( size_t  index) const
inline

Access to individual elements of the matrix.

Elements are stored in column-major order.

Parameters
indexIndex of the accessed element. Possible values are numbers from 0 to 8.
Returns
float& kanzi::Matrix3x3::operator[] ( size_t  index)
inline

Access to individual elements of the matrix.

Elements are stored in column-major order.

Parameters
indexIndex of the accessed element. Possible values are numbers from 0 to 8.
Returns
Vector3 kanzi::Matrix3x3::getRow ( size_t  index) const
inline

Gets the row of a matrix.

Parameters
indexIndex of the accessed row.
Returns
The row.
Vector3 kanzi::Matrix3x3::getColumn ( size_t  index) const
inline

Gets the column of a matrix.

Parameters
indexIndex of the accessed column.
Returns
The column.
void kanzi::Matrix3x3::setRow ( size_t  index,
const Vector3 row 
)
inline

Sets the row of a matrix.

Parameters
indexIndex of the accessed row.
rowThe value to set to the row.
void kanzi::Matrix3x3::setColumn ( size_t  index,
const Vector3 column 
)
inline

Sets the column of a matrix.

Parameters
indexIndex of the accessed column.
columnThe value to set to the column.
Vector2 kanzi::Matrix3x3::getXAxis ( ) const
inline

Get X axis.

Vector2 kanzi::Matrix3x3::getYAxis ( ) const
inline

Get Y axis.

float kanzi::Matrix3x3::getScaleX ( ) const
inline

Get X scale component.

float kanzi::Matrix3x3::getScaleY ( ) const
inline

Get Y scale component.

Vector2 kanzi::Matrix3x3::getScale ( ) const
inline

Get scale as a vector.

void kanzi::Matrix3x3::scale ( const Vector2 v)
inline

Scales this matrix.

Parameters
vScaling vector.
void kanzi::Matrix3x3::translate ( const Vector2 v)
inline

Translates this matrix.

Parameters
vTranslation vector.
void kanzi::Matrix3x3::setXAxis ( Vector2  v)
inline

Set X axis.

Parameters
vX axis vector.
void kanzi::Matrix3x3::setYAxis ( Vector2  v)
inline

Set Y axis.

Parameters
vY axis vector.
void kanzi::Matrix3x3::setTranslation ( Vector2  translation)
inline

Set translation.

Parameters
translationTranslation vector.
void kanzi::Matrix3x3::setTranslation ( float  translationX,
float  translationY 
)
inline

Set translation.

Parameters
translationXTranslation X component.
translationYTranslation Y component.
Vector2 kanzi::Matrix3x3::getTranslation ( ) const
inline

Get translation.

Returns
Translation vector.
float kanzi::Matrix3x3::getTranslationX ( ) const
inline

Get translation on X axis.

Returns
Translation X component.
void kanzi::Matrix3x3::setTranslationX ( float  translationX)
inline

Set translation on X axis.

Parameters
translationXTranslation X component.
float kanzi::Matrix3x3::getTranslationY ( ) const
inline

Get translation on Y axis.

Returns
Translation Y component.
void kanzi::Matrix3x3::setTranslationY ( float  translationY)
inline

Set translation on Y axis.

Parameters
translationYTranslation Y component.
float kanzi::Matrix3x3::getRotationAngle ( ) const

Get rotation angle of the matrix.

Returns
Rotation angle of the matrix.
Matrix3x3& kanzi::Matrix3x3::operator+= ( const Matrix3x3 m)
inline

Modifies this matrix by adding another matrix.

Parameters
mAnother matrix.
Returns
This matrix.
Matrix3x3& kanzi::Matrix3x3::operator-= ( const Matrix3x3 m)
inline

Modifies this matrix by subtracting another matrix from this matrix.

Parameters
mAnother matrix.
Returns
This matrix.
Matrix3x3& kanzi::Matrix3x3::operator*= ( const Matrix3x3 m)

Modifies this matrix by multiplying it with another matrix.

Parameters
mAnother matrix.
Returns
This matrix.
static Matrix3x3 kanzi::Matrix3x3::createTranslation ( Vector2  translation)
inlinestatic

Creates translation matrix.

Parameters
translationTranslation vector.
Returns
Translation matrix.
static Matrix3x3 kanzi::Matrix3x3::createTranslation ( float  x,
float  y 
)
inlinestatic

Creates translation matrix.

Parameters
xX component of the Translation vector.
yY component of the Translation vector.
Returns
Translation matrix.
static Matrix3x3 kanzi::Matrix3x3::createScale ( Vector2  scale)
inlinestatic

Creates a scaled matrix.

Parameters
scaleScaling vector.
Returns
Scaled matrix.
static Matrix3x3 kanzi::Matrix3x3::createIdentity ( )
inlinestatic

Creates identity matrix.

Returns
Identity matrix.
static Matrix3x3 kanzi::Matrix3x3::createRotationInDegrees ( float  angleInDegrees)
static

Creates a rotation matrix.

Parameters
angleInDegreesRotation angle in degrees.
Returns
Rotation matrix.
static Matrix3x3 kanzi::Matrix3x3::createRotationInRadians ( float  angleInRadians)
static

Creates a rotation matrix.

Parameters
angleInRadiansRotation angle in radians.
Returns
Rotation matrix.
static Matrix3x3 kanzi::Matrix3x3::createSRT ( Vector2  scale,
float  rotationInRadians,
Vector2  translation 
)
static

Create an SRT matrix.

Parameters
scaleScales by axises.
rotationInRadiansRotation component in radians.
translationTranslation component.
Returns
Newly constructed matrix.
static Matrix3x3 kanzi::Matrix3x3::createFilled ( float  value)
inlinestatic

Creates a matrix with all elements set to value.

Parameters
valueValue to set to all elements.
Returns
The constructed matrix.
Since
Kanzi 3.9.9
Matrix3x3 kanzi::Matrix3x3::transposed ( ) const
inline

Applies a transpose to a matrix.

Returns
Newly constructed transpose matrix.

Friends And Related Function Documentation

Matrix3x3 operator+ ( Matrix3x3  lhs,
const Matrix3x3 rhs 
)
friend

Creates a new matrix by adding an existing matrix to another one.

Parameters
lhsFirst matrix, left hand side.
rhsSecond matrix, right hand side.
Returns
A new matrix resulting from the addition of the right hand side to the left hand side.
Matrix3x3 operator- ( Matrix3x3  lhs,
const Matrix3x3 rhs 
)
friend

Creates a new matrix by subtracting an existing matrix from another one.

Parameters
lhsFirst matrix, left hand side.
rhsSecond matrix, right hand side.
Returns
A new matrix resulting from the subtraction of the right hand side to the left hand side.

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