Defines the transformation to be applied at one point in time of an Animation. More...

#include <STransformation.h>

Public Member Functions
	STransformation ()
	Creates a new transformation with alpha = 1 and the identity matrix.

IMatrix *	GetMatrix () OVERRIDE
	Gets the matrix representing the transformation.

BYTE	GetAlpha () SCONST OVERRIDE
	Gets the degree of transparency.

void	SetAlpha (BYTE alpha) OVERRIDE
	Sets the degree of transparency.

void	Compose (const ITransformation *t) OVERRIDE
	Composes this transformation with another transformation.

void	Clear () OVERRIDE
	Clears the transformation to the identity matrix and alpha to 1.

void	SetTransformationType (int type) OVERRIDE
	Sets the type of transformation.

int	getTransformationType () const
	Indicates the nature of this transformation.

void	set (STransformation t)
	Clones the specified transformation.

void	compose (const STransformation &t)
	Applies this STransformation to an existing STransformation.

void	postCompose (STransformation t)
	Composes this transformation with another transformation using postConcat.

const SMatrix &	getMatrix () const
	Gets the 3x3 matrix representing the transformation.

SMatrix &	getMatrix ()
	Gets the 3x3 matrix representing the transformation.

void	setMatrix (const SMatrix &mtx)
	Sets the matrix representing the transformation.

void	updateMatrixType ()
	Updates the transformation type based on the current matrix and alpha.

bool	hasAlpha () const
	Checks if the transformation affects the alpha property.

bool	hasMatrix () const
	Checks if the transformation affects the matrix property.

bool	isIdentity () const
	Checks if the transformation is the identity transformation.

Protected Attributes
SMatrix	mMatrix
	The 3x3 matrix representing the transformation.

BYTE	mAlpha
	The degree of transparency (255 means fully opaque, 0 means fully transparent).

int	mTransformationType
	Indicates the nature of this transformation.

Detailed Description

Defines the transformation to be applied at one point in time of an Animation.

Definition at line 14 of file STransformation.h.

Constructor & Destructor Documentation

◆ STransformation()

STransformation::STransformation ( )

Creates a new transformation with alpha = 1 and the identity matrix.

Definition at line 116 of file STransformation.cpp.

Member Function Documentation

◆ Clear()

void STransformation::Clear ( )

Clears the transformation to the identity matrix and alpha to 1.

Definition at line 109 of file STransformation.cpp.

◆ Compose()

void STransformation::Compose ( const ITransformation * t )

Composes this transformation with another transformation.

Parameters

t	Pointer to the transformation to compose with.

Definition at line 71 of file STransformation.cpp.

◆ compose()

void STransformation::compose ( const STransformation & t )

Applies this STransformation to an existing STransformation.

Parameters

t	The transformation to compose with.

Definition at line 77 of file STransformation.cpp.

◆ GetAlpha()

BYTE STransformation::GetAlpha ( )

Gets the degree of transparency.

Returns: The alpha value (255 means fully opaque, 0 means fully transparent).

Definition at line 22 of file STransformation.cpp.

◆ GetMatrix()

IMatrix * STransformation::GetMatrix ( )

Gets the matrix representing the transformation.

Returns: Pointer to the matrix.

Definition at line 121 of file STransformation.cpp.

◆ getMatrix() [1/2]

SMatrix & STransformation::getMatrix ( )

Gets the 3x3 matrix representing the transformation.

Returns: Reference to the matrix.

Definition at line 47 of file STransformation.cpp.

◆ getMatrix() [2/2]

const SMatrix & STransformation::getMatrix ( ) const

Gets the 3x3 matrix representing the transformation.

Returns: Constant reference to the matrix.

Definition at line 52 of file STransformation.cpp.

◆ getTransformationType()

int STransformation::getTransformationType ( ) const

Indicates the nature of this transformation.

Returns: TYPE_ALPHA, TYPE_MATRIX, TYPE_BOTH, or TYPE_IDENTITY.

Definition at line 104 of file STransformation.cpp.

◆ hasAlpha()

bool STransformation::hasAlpha ( ) const

Checks if the transformation affects the alpha property.

Returns: TRUE if the transformation affects the alpha property, FALSE otherwise.

Definition at line 17 of file STransformation.cpp.

◆ hasMatrix()

bool STransformation::hasMatrix ( ) const

Checks if the transformation affects the matrix property.

Returns: TRUE if the transformation affects the matrix property, FALSE otherwise.

Definition at line 12 of file STransformation.cpp.

◆ isIdentity()

SNSBEGIN bool STransformation::isIdentity ( ) const

Checks if the transformation is the identity transformation.

Returns: TRUE if the transformation is the identity transformation, FALSE otherwise.

Definition at line 7 of file STransformation.cpp.

◆ postCompose()

void STransformation::postCompose ( STransformation t )

Composes this transformation with another transformation using postConcat.

Parameters

t	The transformation to compose with. @hide

Definition at line 57 of file STransformation.cpp.

◆ set()

void STransformation::set ( STransformation t )

Clones the specified transformation.

Parameters

t	The transformation to clone.

Definition at line 91 of file STransformation.cpp.

◆ SetAlpha()

void STransformation::SetAlpha ( BYTE alpha )

Sets the degree of transparency.

Parameters

alpha The alpha value (255 means fully opaque, 0 means fully transparent).

Definition at line 35 of file STransformation.cpp.

◆ setMatrix()

void STransformation::setMatrix ( const SMatrix & mtx )

Sets the matrix representing the transformation.

Parameters

mtx	The matrix to set.

Definition at line 41 of file STransformation.cpp.

◆ SetTransformationType()

void STransformation::SetTransformationType ( int type )

Sets the type of transformation.

Parameters

type	The type of transformation.

Definition at line 99 of file STransformation.cpp.

◆ updateMatrixType()

void STransformation::updateMatrixType ( )

Updates the transformation type based on the current matrix and alpha.

Definition at line 27 of file STransformation.cpp.

Member Data Documentation

◆ mAlpha

BYTE STransformation::mAlpha

protected

The degree of transparency (255 means fully opaque, 0 means fully transparent).

Definition at line 23 of file STransformation.h.

◆ mMatrix

SMatrix STransformation::mMatrix

protected

The 3x3 matrix representing the transformation.

Definition at line 22 of file STransformation.h.

◆ mTransformationType

int STransformation::mTransformationType

protected

Indicates the nature of this transformation.

Definition at line 24 of file STransformation.h.

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

SOUI/include/animation/STransformation.h
SOUI/src/animation/STransformation.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ STransformation()

Member Function Documentation

◆ Clear()

◆ Compose()

◆ compose()

◆ GetAlpha()

◆ GetMatrix()

◆ getMatrix() [1/2]

◆ getMatrix() [2/2]

◆ getTransformationType()

◆ hasAlpha()

◆ hasMatrix()

◆ isIdentity()

◆ postCompose()

◆ set()

◆ SetAlpha()

◆ setMatrix()

◆ SetTransformationType()

◆ updateMatrixType()

Member Data Documentation

◆ mAlpha

◆ mMatrix

◆ mTransformationType