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.

float	getRotationAngle () const
	Get rotation angle of the matrix.

Vector3	getRow (size_t index) const
	Gets the row of a matrix.

Vector2	getScale () const
	Get scale as a vector.

float	getScaleX () const
	Get X scale component.

float	getScaleY () const
	Get Y scale component.

Vector2	getTranslation () const
	Get translation.

float	getTranslationX () const
	Get translation on X axis.

float	getTranslationY () const
	Get translation on Y axis.

Vector2	getXAxis () const
	Get X axis.

Vector2	getYAxis () const
	Get Y axis.

	Matrix3x3 ()
	Default constructor, initializes the matrix to identity matrix.

	Matrix3x3 (const Vector2 &x, const Vector2 &y, const Vector2 &translation)
	Constructs the matrix from three column vectors.

	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.

Matrix3x3 &	operator*= (const Matrix3x3 &m)
	Modifies this matrix by multiplying it with another matrix.

Matrix3x3 &	operator+= (const Matrix3x3 &m)
	Modifies this matrix by adding another matrix.

Matrix3x3 &	operator-= (const Matrix3x3 &m)
	Modifies this matrix by subtracting another matrix from this matrix.

float &	operator[] (size_t index)
	Access to individual elements of the matrix.

const float &	operator[] (size_t index) const
	Access to individual elements of the matrix.

void	scale (const Vector2 &v)
	Scales this matrix.

void	setColumn (size_t index, const Vector3 &column)
	Sets the column of a matrix.

void	setRow (size_t index, const Vector3 &row)
	Sets the row of a matrix.

void	setTranslation (float translationX, float translationY)
	Set translation.

void	setTranslation (Vector2 translation)
	Set translation.

void	setTranslationX (float translationX)
	Set translation on X axis.

void	setTranslationY (float translationY)
	Set translation on Y axis.

void	setXAxis (Vector2 v)
	Set X axis.

void	setYAxis (Vector2 v)
	Set Y axis.

void	translate (const Vector2 &v)
	Translates this matrix.

Matrix3x3	transposed () const
	Applies a transpose to a matrix.

Static Public Member Functions
static Matrix3x3	createFilled (float value)
	Creates a matrix with all elements set to `value`.

static Matrix3x3	createIdentity ()
	Creates identity matrix.

static Matrix3x3	createRotationInDegrees (float angleInDegrees)
	Creates a rotation matrix.

static Matrix3x3	createRotationInRadians (float angleInRadians)
	Creates a rotation matrix.

static Matrix3x3	createScale (Vector2 scale)
	Creates a scaled matrix.

static Matrix3x3	createSRT (Vector2 scale, float rotationInRadians, Vector2 translation)
	Create an SRT matrix.

static Matrix3x3	createTranslation (float x, float y)
	Creates translation matrix.

static Matrix3x3	createTranslation (Vector2 translation)
	Creates translation matrix.

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

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

Detailed Description

Matrix with 3x3 elements.

Constructor & Destructor Documentation

◆ Matrix3x3() [1/3]

kanzi::Matrix3x3::Matrix3x3 ( )

inlineexplicit

Default constructor, initializes the matrix to identity matrix.

◆ Matrix3x3() [2/3]

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.

◆ Matrix3x3() [3/3]

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

inlineexplicit

Constructs the matrix from three column vectors.

Member Function Documentation

◆ operator[]() [1/2]

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

index Index of the accessed element. Possible values are numbers from 0 to 8.

Returns

◆ operator[]() [2/2]

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

inline

Access to individual elements of the matrix.

Elements are stored in column-major order.

Parameters

index Index of the accessed element. Possible values are numbers from 0 to 8.

Returns

◆ getRow()

Vector3 kanzi::Matrix3x3::getRow ( size_t index ) const

inline

Gets the row of a matrix.

Parameters

index Index of the accessed row.

Returns: The row.

◆ getColumn()

Vector3 kanzi::Matrix3x3::getColumn ( size_t index ) const

inline

Gets the column of a matrix.

Parameters

index Index of the accessed column.

Returns: The column.

◆ setRow()

void kanzi::Matrix3x3::setRow	(	size_t	index,
		const Vector3 &	row )

inline

Sets the row of a matrix.

Parameters

index	Index of the accessed row.
row	The value to set to the row.

◆ setColumn()

void kanzi::Matrix3x3::setColumn	(	size_t	index,
		const Vector3 &	column )

inline

Sets the column of a matrix.

Parameters

index	Index of the accessed column.
column	The value to set to the column.

◆ getXAxis()

Vector2 kanzi::Matrix3x3::getXAxis ( ) const

inline

Get X axis.

◆ getYAxis()

Vector2 kanzi::Matrix3x3::getYAxis ( ) const

inline

Get Y axis.

◆ getScaleX()

float kanzi::Matrix3x3::getScaleX ( ) const

inline

Get X scale component.

◆ getScaleY()

float kanzi::Matrix3x3::getScaleY ( ) const

inline

Get Y scale component.

◆ getScale()

Vector2 kanzi::Matrix3x3::getScale ( ) const

inline

Get scale as a vector.

◆ scale()

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

inline

Scales this matrix.

Parameters

v	Scaling vector.

◆ translate()

void kanzi::Matrix3x3::translate ( const Vector2 & v )

inline

Translates this matrix.

Parameters

v	Translation vector.

◆ setXAxis()

void kanzi::Matrix3x3::setXAxis ( Vector2 v )

inline

Set X axis.

Parameters

v	X axis vector.

◆ setYAxis()

void kanzi::Matrix3x3::setYAxis ( Vector2 v )

inline

Set Y axis.

Parameters

v	Y axis vector.

◆ setTranslation() [1/2]

void kanzi::Matrix3x3::setTranslation ( Vector2 translation )

inline

Set translation.

Parameters

translation Translation vector.

◆ setTranslation() [2/2]

void kanzi::Matrix3x3::setTranslation	(	float	translationX,
		float	translationY )

inline

Set translation.

Parameters

translationX	Translation X component.
translationY	Translation Y component.

◆ getTranslation()

Vector2 kanzi::Matrix3x3::getTranslation ( ) const

inline

Get translation.

Returns: Translation vector.

◆ getTranslationX()

float kanzi::Matrix3x3::getTranslationX ( ) const

inline

Get translation on X axis.

Returns: Translation X component.

◆ setTranslationX()

void kanzi::Matrix3x3::setTranslationX ( float translationX )

inline

Set translation on X axis.

Parameters

translationX Translation X component.

◆ getTranslationY()

float kanzi::Matrix3x3::getTranslationY ( ) const

inline

Get translation on Y axis.

Returns: Translation Y component.

◆ setTranslationY()

void kanzi::Matrix3x3::setTranslationY ( float translationY )

inline

Set translation on Y axis.

Parameters

translationY Translation Y component.

◆ getRotationAngle()

float kanzi::Matrix3x3::getRotationAngle ( ) const

Get rotation angle of the matrix.

Returns: Rotation angle of the matrix.

◆ operator+=()

Matrix3x3 & kanzi::Matrix3x3::operator+= ( const Matrix3x3 & m )

inline

Modifies this matrix by adding another matrix.

Parameters

m	Another matrix.

Returns: This matrix.

◆ operator-=()

Matrix3x3 & kanzi::Matrix3x3::operator-= ( const Matrix3x3 & m )

inline

Modifies this matrix by subtracting another matrix from this matrix.

Parameters

m	Another matrix.

Returns: This matrix.

◆ operator*=()

Matrix3x3 & kanzi::Matrix3x3::operator*= ( const Matrix3x3 & m )

Modifies this matrix by multiplying it with another matrix.

Parameters

m	Another matrix.

Returns: This matrix.

◆ createTranslation() [1/2]

static Matrix3x3 kanzi::Matrix3x3::createTranslation ( Vector2 translation )

inlinestatic

Creates translation matrix.

Parameters

translation Translation vector.

Returns: Translation matrix.

◆ createTranslation() [2/2]

static Matrix3x3 kanzi::Matrix3x3::createTranslation	(	float	x,
		float	y )

inlinestatic

Creates translation matrix.

Parameters

x	X component of the Translation vector.
y	Y component of the Translation vector.

Returns: Translation matrix.

◆ createScale()

static Matrix3x3 kanzi::Matrix3x3::createScale ( Vector2 scale )

inlinestatic

Creates a scaled matrix.

Parameters

scale Scaling vector.

Returns: Scaled matrix.

◆ createIdentity()

static Matrix3x3 kanzi::Matrix3x3::createIdentity ( )

inlinestatic

Creates identity matrix.

Returns: Identity matrix.

◆ createRotationInDegrees()

static Matrix3x3 kanzi::Matrix3x3::createRotationInDegrees ( float angleInDegrees )

static

Creates a rotation matrix.

Parameters

angleInDegrees Rotation angle in degrees.

Returns: Rotation matrix.

◆ createRotationInRadians()

static Matrix3x3 kanzi::Matrix3x3::createRotationInRadians ( float angleInRadians )

static

Creates a rotation matrix.

Parameters

angleInRadians Rotation angle in radians.

Returns: Rotation matrix.

◆ createSRT()

static Matrix3x3 kanzi::Matrix3x3::createSRT	(	Vector2	scale,
		float	rotationInRadians,
		Vector2	translation )

static

Create an SRT matrix.

Parameters

scale	Scales by axises.
rotationInRadians	Rotation component in radians.
translation	Translation component.

Returns: Newly constructed matrix.

◆ createFilled()

static Matrix3x3 kanzi::Matrix3x3::createFilled ( float value )

inlinestatic

Creates a matrix with all elements set to value.

Parameters

value Value to set to all elements.

Returns: The constructed matrix.

Since: Kanzi 3.9.9

◆ transposed()

Matrix3x3 kanzi::Matrix3x3::transposed ( ) const

inline

Applies a transpose to a matrix.

Returns: Newly constructed transpose matrix.

Friends And Related Symbol Documentation

◆ operator+

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

friend

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

Parameters

lhs	First matrix, left hand side.
rhs	Second matrix, right hand side.

Returns: A new matrix resulting from the addition of the right hand side to the left hand side.

◆ operator-

Matrix3x3 operator-	(	Matrix3x3	lhs,
		const Matrix3x3 &	rhs )

friend

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

Parameters

lhs	First matrix, left hand side.
rhs	Second 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:

kanzi/core/math/matrix3x3.hpp

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Matrix3x3() [1/3]

◆ Matrix3x3() [2/3]

◆ Matrix3x3() [3/3]

Member Function Documentation

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ getRow()

◆ getColumn()

◆ setRow()

◆ setColumn()

◆ getXAxis()

◆ getYAxis()

◆ getScaleX()

◆ getScaleY()

◆ getScale()

◆ scale()

◆ translate()

◆ setXAxis()

◆ setYAxis()

◆ setTranslation() [1/2]

◆ setTranslation() [2/2]

◆ getTranslation()

◆ getTranslationX()

◆ setTranslationX()

◆ getTranslationY()

◆ setTranslationY()

◆ getRotationAngle()

◆ operator+=()

◆ operator-=()

◆ operator*=()

◆ createTranslation() [1/2]

◆ createTranslation() [2/2]

◆ createScale()

◆ createIdentity()

◆ createRotationInDegrees()

◆ createRotationInRadians()

◆ createSRT()

◆ createFilled()

◆ transposed()

Friends And Related Symbol Documentation

◆ operator+

◆ operator-