Matrix class - special 3x2 matrix. More...

#include <edl/edlgeom.h>

Classes
struct	DecomposeInfo

Public Types
enum	eOperationTypes { eDoesTranslate = 0x1 , eDoesScale = 0x2 , eDoesRotate = 0x4 , eIsComplex = 0x8 }
	Classification of operation type flags of the transform. More...

Public Member Functions
	CTransformMatrix ()
	Initializes the matrix to identity.
	CTransformMatrix (TItem _xx, TItem _xy, TItem _yx, TItem _yy, TItem _dx, TItem _dy)
	Initializes the matrix.
	CTransformMatrix (const CTransformMatrix< TItem > &m)
	Copy constructor.
CTransformMatrix &	operator= (const CTransformMatrix< TItem > &m)
	Assignment operator.
	CTransformMatrix (const RectTmpl< TItem > &sourceRect, const RectTmpl< TItem > &destRect)
	Creates a matrix that transforms from one rectangle to another.
void	set (TItem _xx=1, TItem _xy=0, TItem _yx=0, TItem _yy=1, TItem _dx=0, TItem _dy=0)
	Set the matrix parameters.
TItem	xx () const
	Fetch the xx component.
TItem	xy () const
	Fetch the xy component.
TItem	yx () const
	Fetch the yx component.
TItem	yy () const
	Fetch the yy component.
TItem	dx () const
	Fetch the dx component.
TItem	dy () const
	Fetch the dy component.
void	setXX (TItem x)
	Sets the xx component.
void	setXY (TItem x)
	Sets the xy component.
void	setYX (TItem x)
	Sets the yx component.
void	setYY (TItem x)
	Sets the yy component.
void	setDX (TItem x)
	Sets the dx component.
void	setDY (TItem x)
	Sets the dy component.
bool	equal (const CTransformMatrix< TItem > &matrix, bool ignoreDXDY=false) const
	Compare to another matrix.
bool	identity (bool ignoreDXDY=false) const
	Determine if identity matrix.
bool	ortho (bool &rotated) const
	Determine if the matrix is orthogonal. That is, if the matrix is aligned to the x and y axes. This is true for example if the matrix flips, and/or if it rotates by 90 degrees, or is identity.
CTransformMatrix< TItem > &	preMul (const CTransformMatrix< TItem > &matrix)
	Premultiply by the given matrix.
CTransformMatrix< TItem > &	postMul (const CTransformMatrix< TItem > &matrix)
	Postmultiply by the given matrix.
bool	degenerate ()
	Check to see if the matrix is degenerate (0 scale).
bool	invert ()
	Invert the matrix.
void	transform (PointTmpl< TItem > &result, const PointTmpl< TItem > &point, bool ignoreDXDY=false) const
	Transform a point.
PointTmpl< TItem >	transform (const PointTmpl< TItem > &point, bool ignoreDXDY=false) const
	Transform a point.
bool	iTransform (PointTmpl< TItem > &result, const PointTmpl< TItem > &point, bool ignoreDXDY=false) const
	Transform a point by the inverse of the matrix.
std::pair< bool, PointTmpl< TItem > >	iTransform (const PointTmpl< TItem > &point, bool ignoreDXDY=false) const
	Transform a point by the inverse of the matrix.
void	rotate (double radians)
	Add a rotation, clockwise, in radians.
void	scale (TItem xscale, TItem yscale)
	Scale.
void	translate (TItem dx, TItem dy)
	Translate.
TItem	determinant () const
	Find the determinant of the matrix.
void	transformRect (RectTmpl< TItem > &rect, bool ignoreDXDY=false) const
	Transform a rectangle.
uint32	classify () const
	Classify the transform.
void	decompose (PointTmpl< TItem > &translate, FPoint &scale, FPoint &shear, double &rotationAngle, double eps=1.0e-06) const
	Decompose the transform into an equivalent set of translate + scale + shear + rotate.
DecomposeInfo	decompose (double eps=1.0e-06) const
	Decompose the transform into an equivalent set of translate + scale + shear + rotate but return the results in a DecomposeInfo structure.
double	getScale () const
	Determine the average scale of the transform.
bool	isSimpleScaled (TItem &scale) const
	Determine if the transform is merely a scale, and if so, populate the scale.
std::pair< bool, TItem >	isSimpleScaled () const
	Determine if the transform is merely a scale, and if so, return that scale.
void	decompose (PointTmpl< TItem > &translate, double &rotationAngle, double &shearAngle, FPoint &scale) const
	Similar to the other form of decompose, but does the decomposition in a different, potentially more useful order. It's designed to more naturally extract rotation information when objects are scaled in a rotated context.
void	compose (const PointTmpl< TItem > &translateAmount, double rotationAngle, double shearAngle, const FPoint &scaleAmount)
	Undo the second form of decompose above. It starts with an identity matrix and applies the transforms in this order:
template<typename AType>
void	asArray (AType *array) const
	Retrieve the matrix as an array of the given type.

Detailed Description

template<typename TItem>
class CTransformMatrix< TItem >

Matrix class - special 3x2 matrix.

Constructor & Destructor Documentation

◆ CTransformMatrix() [1/4]

template<typename TItem>

CTransformMatrix< TItem >::CTransformMatrix ( )

inline

Initializes the matrix to identity.

◆ CTransformMatrix() [2/4]

template<typename TItem>

CTransformMatrix< TItem >::CTransformMatrix	(	TItem	_xx,
		TItem	_xy,
		TItem	_yx,
		TItem	_yy,
		TItem	_dx,
		TItem	_dy )

inline

Initializes the matrix.

Parameters

_xx	xx component.
_xy	xy component.
_yx	yx component.
_yy	yy component.
_dx	dx component.
_dy	dy component.

◆ CTransformMatrix() [3/4]

template<typename TItem>

CTransformMatrix< TItem >::CTransformMatrix ( const CTransformMatrix< TItem > & m )

inline

Copy constructor.

Parameters

m	Transform matrix.

◆ CTransformMatrix() [4/4]

template<typename TItem>

CTransformMatrix< TItem >::CTransformMatrix	(	const RectTmpl< TItem > &	sourceRect,
		const RectTmpl< TItem > &	destRect )

inline

Creates a matrix that transforms from one rectangle to another.

Parameters

sourceRect	Source rectangle.
destRect	Destination rectangle.

Member Function Documentation

◆ asArray()

template<typename TItem>

template<typename AType>

void CTransformMatrix< TItem >::asArray ( AType * array ) const

inline

Retrieve the matrix as an array of the given type.

Parameters

array Pointer to a six-entry array of the given type.

◆ classify()

template<typename TItem>

uint32 CTransformMatrix< TItem >::classify ( ) const

inline

Classify the transform.

Returns: uint32 Operation flags.

◆ compose()

template<typename TItem>

void CTransformMatrix< TItem >::compose	(	const PointTmpl< TItem > &	translateAmount,
		double	rotationAngle,
		double	shearAngle,
		const FPoint &	scaleAmount )

inline

Undo the second form of decompose above. It starts with an identity matrix and applies the transforms in this order:

Translate
Rotate
Shear
Scale

Parameters

translateAmount	The desired translation component in x and y.
rotationAngle	The desired rotation angle in radians.
shearAngle	The desired shear angle in radians.
scaleAmount	The desired scale in x and y.

◆ decompose() [1/3]

template<typename TItem>

DecomposeInfo CTransformMatrix< TItem >::decompose ( double eps = 1.0e-06 ) const

inline

Decompose the transform into an equivalent set of translate + scale + shear + rotate but return the results in a DecomposeInfo structure.

Parameters

eps	Epsilon for determining when values are close to zero.

Returns: DecomposeInfo The decomposed parameters.

◆ decompose() [2/3]

template<typename TItem>

void CTransformMatrix< TItem >::decompose	(	PointTmpl< TItem > &	translate,
		double &	rotationAngle,
		double &	shearAngle,
		FPoint &	scale ) const

inline

Similar to the other form of decompose, but does the decomposition in a different, potentially more useful order. It's designed to more naturally extract rotation information when objects are scaled in a rotated context.

Here, once decomposed, the original matrix (within the limitations of floating point roundoff and trig functions) can be reconstructed through successive premultiplies in the following order:

Translate
Rotate
Shear
Scale

See compose, which demonstrates how to perform these steps.

Parameters

translate	Reference to receive the translation component in x and y.
rotationAngle	Reference to receive the rotation angle in radians. Please note that the rotation direction is not the same as the other decompose method, and instead uses the same semantics as the rotate member function (clockwise).
shearAngle	Reference to receive the shear angle in radians.
scale	Reference to receive the scale component in x and y.

◆ decompose() [3/3]

template<typename TItem>

void CTransformMatrix< TItem >::decompose	(	PointTmpl< TItem > &	translate,
		FPoint &	scale,
		FPoint &	shear,
		double &	rotationAngle,
		double	eps = 1.0e-06 ) const

inline

Decompose the transform into an equivalent set of translate + scale + shear + rotate.

Parameters

translate	Reference to receive the translation component in x and y.
scale	Reference to receive the scale component in x and y.
shear	Reference to receive the shear angle in radians.
rotationAngle	Reference to receive the rotation angle in radians.
eps	Epsilon for determining when values are close to zero.

◆ degenerate()

template<typename TItem>

bool CTransformMatrix< TItem >::degenerate ( )

inline

Check to see if the matrix is degenerate (0 scale).

Returns: bool true if matrix is degenerate, false otherwise.

◆ determinant()

template<typename TItem>

TItem CTransformMatrix< TItem >::determinant ( ) const

inline

Find the determinant of the matrix.

Returns: TItem the determinant.

◆ dx()

template<typename TItem>

TItem CTransformMatrix< TItem >::dx ( ) const

inline

Fetch the dx component.

Returns: TItem dx component.

◆ dy()

template<typename TItem>

TItem CTransformMatrix< TItem >::dy ( ) const

inline

Fetch the dy component.

Returns: TItem dy component.

◆ equal()

template<typename TItem>

bool CTransformMatrix< TItem >::equal	(	const CTransformMatrix< TItem > &	matrix,
		bool	ignoreDXDY = false ) const

inline

Compare to another matrix.

Parameters

matrix	Matrix to compare current instance to.
ignoreDXDY	Ignore DX & DY for this comparison.

Returns: bool true if equal, false if not.

◆ getScale()

template<typename TItem>

double CTransformMatrix< TItem >::getScale ( ) const

inline

Determine the average scale of the transform.

Returns: double The average scale.

◆ identity()

template<typename TItem>

bool CTransformMatrix< TItem >::identity ( bool ignoreDXDY = false ) const

inline

Determine if identity matrix.

Parameters

ignoreDXDY Ignore DX & DY for this operation.

Returns: bool true if identity matrix, false if not.

◆ invert()

template<typename TItem>

bool CTransformMatrix< TItem >::invert ( )

inline

Invert the matrix.

Returns: bool true if matrix was inverted, false if inversion was not possible.

◆ isSimpleScaled() [1/2]

template<typename TItem>

std::pair< bool, TItem > CTransformMatrix< TItem >::isSimpleScaled ( ) const

inline

Determine if the transform is merely a scale, and if so, return that scale.

Returns: std::pair<bool, TItem> The result, with the first in the pair representing success, and the second value (if successful) representing the scale.

◆ isSimpleScaled() [2/2]

template<typename TItem>

bool CTransformMatrix< TItem >::isSimpleScaled ( TItem & scale ) const

inline

Determine if the transform is merely a scale, and if so, populate the scale.

Parameters

scale If successful, the scale.

Returns: bool true if the transform is a simple scale, false otherwise.

◆ iTransform() [1/2]

template<typename TItem>

std::pair< bool, PointTmpl< TItem > > CTransformMatrix< TItem >::iTransform	(	const PointTmpl< TItem > &	point,
		bool	ignoreDXDY = false ) const

inline

Transform a point by the inverse of the matrix.

Parameters

point	The point.
ignoreDXDY	Ignore DX & DY for this operation.

Returns: std::pair<bool, PointTmpl<TItem> > A pair whose first element is true if the point was transformed while the second element is the resulting point.

◆ iTransform() [2/2]

template<typename TItem>

bool CTransformMatrix< TItem >::iTransform	(	PointTmpl< TItem > &	result,
		const PointTmpl< TItem > &	point,
		bool	ignoreDXDY = false ) const

inline

Transform a point by the inverse of the matrix.

Parameters

result	PointTmpl<TItem> to accept result.
point	The point.
ignoreDXDY	Ignore DX & DY for this operation.

Returns: bool true if point was transformed, false if transformation was not possible.

◆ operator=()

template<typename TItem>

CTransformMatrix & CTransformMatrix< TItem >::operator= ( const CTransformMatrix< TItem > & m )

inline

Assignment operator.

Parameters

m	Transform matrix.

Returns: CTransformMatrix The matrix after assignment.

◆ ortho()

template<typename TItem>

bool CTransformMatrix< TItem >::ortho ( bool & rotated ) const

inline

Determine if the matrix is orthogonal. That is, if the matrix is aligned to the x and y axes. This is true for example if the matrix flips, and/or if it rotates by 90 degrees, or is identity.

Parameters

rotated On return, this is set true if the matrix rotates by 90 or 270 degrees, false otherwise.

Returns: bool true if orthogonal, false if not.

◆ postMul()

template<typename TItem>

CTransformMatrix< TItem > & CTransformMatrix< TItem >::postMul ( const CTransformMatrix< TItem > & matrix )

inline

Postmultiply by the given matrix.

Parameters

matrix Matrix postmultiplier.

Returns: CTransformMatrix<TItem> Resulting matrix.

◆ preMul()

template<typename TItem>

CTransformMatrix< TItem > & CTransformMatrix< TItem >::preMul ( const CTransformMatrix< TItem > & matrix )

inline

Premultiply by the given matrix.

Parameters

matrix Matrix premultiplier.

Returns: CTransformMatrix<TItem> Resulting matrix.

◆ rotate()

template<typename TItem>

void CTransformMatrix< TItem >::rotate ( double radians )

inline

Add a rotation, clockwise, in radians.

Parameters

radians Angle in radians.

◆ scale()

template<typename TItem>

void CTransformMatrix< TItem >::scale	(	TItem	xscale,
		TItem	yscale )

inline

Scale.

Parameters

xscale	X-axis scaling factor.
yscale	Y-axis scaling factor.

◆ set()

template<typename TItem>

void CTransformMatrix< TItem >::set	(	TItem	_xx = 1,
		TItem	_xy = 0,
		TItem	_yx = 0,
		TItem	_yy = 1,
		TItem	_dx = 0,
		TItem	_dy = 0 )

inline

Set the matrix parameters.

Parameters

_xx	xx component.
_xy	xy component.
_yx	yx component.
_yy	yy component.
_dx	dx component.
_dy	dy component.

◆ setDX()

template<typename TItem>

void CTransformMatrix< TItem >::setDX ( TItem x )

inline

Sets the dx component.

Parameters

x	value to set.

◆ setDY()

template<typename TItem>

void CTransformMatrix< TItem >::setDY ( TItem x )

inline

Sets the dy component.

Parameters

x	value to set.

◆ setXX()

template<typename TItem>

void CTransformMatrix< TItem >::setXX ( TItem x )

inline

Sets the xx component.

Parameters

x	value to set.

◆ setXY()

template<typename TItem>

void CTransformMatrix< TItem >::setXY ( TItem x )

inline

Sets the xy component.

Parameters

x	value to set.

◆ setYX()

template<typename TItem>

void CTransformMatrix< TItem >::setYX ( TItem x )

inline

Sets the yx component.

Parameters

x	value to set.

◆ setYY()

template<typename TItem>

void CTransformMatrix< TItem >::setYY ( TItem x )

inline

Sets the yy component.

Parameters

x	value to set.

◆ transform() [1/2]

template<typename TItem>

PointTmpl< TItem > CTransformMatrix< TItem >::transform	(	const PointTmpl< TItem > &	point,
		bool	ignoreDXDY = false ) const

inline

Transform a point.

Parameters

point	The point before transformation.
ignoreDXDY	Ignore DX & DY for this operation.

Returns: CTransformMatrix<TItem> Resulting matrix.

◆ transform() [2/2]

template<typename TItem>

void CTransformMatrix< TItem >::transform	(	PointTmpl< TItem > &	result,
		const PointTmpl< TItem > &	point,
		bool	ignoreDXDY = false ) const

inline

Transform a point.

Parameters

result	The point after transformation.
point	The point before transformation.
ignoreDXDY	Ignore DX & DY for this operation.

◆ transformRect()

template<typename TItem>

void CTransformMatrix< TItem >::transformRect	(	RectTmpl< TItem > &	rect,
		bool	ignoreDXDY = false ) const

inline

Transform a rectangle.

Parameters

rect	Rectangle to transform.
ignoreDXDY	Ignore DX & DY for this operation.

◆ translate()

template<typename TItem>

void CTransformMatrix< TItem >::translate	(	TItem	dx,
		TItem	dy )

inline

Translate.

Parameters

dx	x-axis transformation value.
dy	y-axis transformation value.

◆ xx()

template<typename TItem>

TItem CTransformMatrix< TItem >::xx ( ) const

inline

Fetch the xx component.

Returns: TItem xx component.

◆ xy()

template<typename TItem>

TItem CTransformMatrix< TItem >::xy ( ) const

inline

Fetch the xy component.

Returns: TItem xy component.

◆ yx()

template<typename TItem>

TItem CTransformMatrix< TItem >::yx ( ) const

inline

Fetch the yx component.

Returns: TItem yx component.

◆ yy()

template<typename TItem>

TItem CTransformMatrix< TItem >::yy ( ) const

inline

Fetch the yy component.

Returns: TItem yy component.

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

edl/edlgeom.h

Classes

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CTransformMatrix() [1/4]

◆ CTransformMatrix() [2/4]

◆ CTransformMatrix() [3/4]

◆ CTransformMatrix() [4/4]

Member Function Documentation

◆ asArray()

◆ classify()

◆ compose()

◆ decompose() [1/3]

◆ decompose() [2/3]

◆ decompose() [3/3]

◆ degenerate()

◆ determinant()

◆ dx()

◆ dy()

◆ equal()

◆ getScale()

◆ identity()

◆ invert()

◆ isSimpleScaled() [1/2]

◆ isSimpleScaled() [2/2]

◆ iTransform() [1/2]

◆ iTransform() [2/2]

◆ operator=()

◆ ortho()

◆ postMul()

◆ preMul()

◆ rotate()

◆ scale()

◆ set()

◆ setDX()

◆ setDY()

◆ setXX()

◆ setXY()

◆ setYX()

◆ setYY()

◆ transform() [1/2]

◆ transform() [2/2]

◆ transformRect()

◆ translate()

◆ xx()

◆ xy()

◆ yx()

◆ yy()