Kanzi 3.9.10
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
SRTValue2D Class Reference

A structure that describes the scale, rotation and translation transformation in 2D space. More...

Public Member Functions

 SRTValue2D ()
 Default constructor.
 
 SRTValue2D (Vector2 scale, float rotationInRadians, Vector2 translation)
 Constructor with supplied scale, rotation and translation.
 
synchronized void delete ()
 
boolean equals (Object obj)
 Indicates whether some other object is "equal to" this one.
 
float getRotation ()
 Returns the rotation.
 
Vector2 getScale ()
 Returns the scale.
 
float getScaleX ()
 Returns the scale along the x-axis.
 
float getScaleY ()
 Returns the scale along the y-axis.
 
Vector2 getTranslation ()
 Returns the translation.
 
float getTranslationX ()
 Returns the translation along the x-axis.
 
float getTranslationY ()
 Returns the translation along the y-axis.
 
int hashCode ()
 Returns a hash code value for the object.
 
void rotate (float rotationInRadians)
 Adds a rotation angle to the current rotation.
 
SRTValue2D rotated (float rotationInRadians)
 Rotates the SRT object.
 
void scale (Vector2 factor)
 Multiplies the current scale with the provided scaling factor.
 
SRTValue2D scaled (Vector2 scale)
 Scales the SRT object.
 
void setRotation (float rotationInRadians)
 Sets the rotation.
 
void setScale (Vector2 value)
 Sets the scale.
 
void setScaleX (float value)
 Sets the scale along the x-axis.
 
void setScaleY (float value)
 Sets the scale along the y-axis.
 
void setTranslation (Vector2 value)
 Sets the translation.
 
void setTranslationX (float value)
 Sets the translation along the x-axis.
 
void setTranslationY (float value)
 Sets the translation along the y-axis.
 
Matrix3x3 toMatrix ()
 Converts the SRT representation to Matrix3x3 transform.
 
void translate (Vector2 translation)
 Adds the provided translation to the current translation.
 
SRTValue2D translated (Vector2 translation)
 Translates the SRT object.
 
void uniformScale (float factor)
 Multiplies the current scale with the provided uniform scaling factor.
 

Static Public Member Functions

static SRTValue2D create (Matrix3x3 matrix)
 Attempts to create a SRT object from a given transformation 3x3 matrix.
 
static SRTValue2D createRotation (float rotationInRadians)
 Creates a rotation SRT.
 
static SRTValue2D createScale (Vector2 scale)
 Creates a scale SRT.
 
static SRTValue2D createTranslation (Vector2 translation)
 Creates a translation SRT.
 

Protected Member Functions

void finalize ()
 Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
 

Protected Attributes

transient boolean swigCMemOwn
 Does this object own its native object.
 

Detailed Description

A structure that describes the scale, rotation and translation transformation in 2D space.


Rotation is stored as angle in radians.

Constructor & Destructor Documentation

◆ SRTValue2D()

SRTValue2D ( Vector2 scale,
float rotationInRadians,
Vector2 translation )

Constructor with supplied scale, rotation and translation.


Parameters
scaleThe scale.
rotationInRadiansThe rotation angle in radians.
translationThe translation.

Member Function Documentation

◆ create()

static SRTValue2D create ( Matrix3x3 matrix)
static

Attempts to create a SRT object from a given transformation 3x3 matrix.

Note: A matrix is decomposable into SRT if its column vectors are orthogonal to each other.

Parameters
matrixThe transformation 3x3 matrix.
Returns
A SRTValue3D object if the matrix is decomposable, null otherwise.

◆ createRotation()

static SRTValue2D createRotation ( float rotationInRadians)
static

Creates a rotation SRT.


Parameters
rotationInRadiansThe rotation angle in radians.
Returns
An SRT object with rotation.

◆ createScale()

static SRTValue2D createScale ( Vector2 scale)
static

Creates a scale SRT.


Parameters
scaleThe scale.
Returns
An SRT object with scale.

◆ createTranslation()

static SRTValue2D createTranslation ( Vector2 translation)
static

Creates a translation SRT.


Parameters
translationThe translation.
Returns
An SRT object with translation.

◆ equals()

boolean equals ( Object obj)

Indicates whether some other object is "equal to" this one.

Parameters
objThe reference object with which to compare.
Returns
True if this object is the same as the obj argument, otherwise false.

◆ finalize()

void finalize ( )
protected

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

Finalization is deprecated and subject to removal in future.

◆ getRotation()

float getRotation ( )

Returns the rotation.


Returns
The rotation angle in radians.

◆ getScale()

Vector2 getScale ( )

Returns the scale.


Returns
The scale.

◆ getScaleX()

float getScaleX ( )

Returns the scale along the x-axis.


Returns
The x component of the scale.

◆ getScaleY()

float getScaleY ( )

Returns the scale along the y-axis.


Returns
The y component of the scale.

◆ getTranslation()

Vector2 getTranslation ( )

Returns the translation.


Returns
The translation.

◆ getTranslationX()

float getTranslationX ( )

Returns the translation along the x-axis.


Returns
The x component of the translation.

◆ getTranslationY()

float getTranslationY ( )

Returns the translation along the y-axis.


Returns
The y component of the translation.

◆ hashCode()

int hashCode ( )

Returns a hash code value for the object.

Returns
A hash code value for this object.

◆ rotate()

void rotate ( float rotationInRadians)

Adds a rotation angle to the current rotation.


Parameters
rotationInRadiansThe rotation angle in radians.

◆ rotated()

SRTValue2D rotated ( float rotationInRadians)

Rotates the SRT object.


Parameters
rotationInRadiansThe rotation angle in degrees.
Returns
A new SRT object with the rotation applied.

◆ scale()

void scale ( Vector2 factor)

Multiplies the current scale with the provided scaling factor.


Parameters
factorThe scaling factor.

◆ scaled()

SRTValue2D scaled ( Vector2 scale)

Scales the SRT object.


Parameters
scaleThe scaling factor.
Returns
A new SRT object with the scale applied.

◆ setRotation()

void setRotation ( float rotationInRadians)

Sets the rotation.


Parameters
rotationInRadiansThe rotation angle in radians.

◆ setScale()

void setScale ( Vector2 value)

Sets the scale.


Parameters
valueThe scale.

◆ setScaleX()

void setScaleX ( float value)

Sets the scale along the x-axis.


Parameters
valueThe x component of the scale.

◆ setScaleY()

void setScaleY ( float value)

Sets the scale along the y-axis.


Parameters
valueThe y component of the scale.

◆ setTranslation()

void setTranslation ( Vector2 value)

Sets the translation.


Parameters
valueThe translation.

◆ setTranslationX()

void setTranslationX ( float value)

Sets the translation along the x-axis.


Parameters
valueThe x component of the translation.

◆ setTranslationY()

void setTranslationY ( float value)

Sets the translation along the y-axis.


Parameters
valueThe y component of the translation.

◆ toMatrix()

Matrix3x3 toMatrix ( )

Converts the SRT representation to Matrix3x3 transform.


Returns
A matrix representation of the SRT object.

◆ translate()

void translate ( Vector2 translation)

Adds the provided translation to the current translation.


Parameters
translationThe translation term.

◆ translated()

SRTValue2D translated ( Vector2 translation)

Translates the SRT object.


Parameters
translationThe translation term.
Returns
A new SRT object with the translation applied.

◆ uniformScale()

void uniformScale ( float factor)

Multiplies the current scale with the provided uniform scaling factor.


Parameters
factorThe scaling factor.