Kanzi Java API
SRTValue3D Class Reference

Structure describing scale, rotation and translation transformation in 3D space. More...

Public Member Functions

 SRTValue3D (long cPtr, boolean cMemoryOwn)
 
 SRTValue3D ()
 Default constructor.
 
 SRTValue3D (Vector3 scale, Vector3 eulerAnglesInRadians, Vector3 translation)
 Constructor with supplied scale, rotation angle and translation.
 
 SRTValue3D (Vector3 scale, Quaternion rotation, Vector3 translation)
 Constructor with supplied scale, rotation as a quaternion and translation.
 
synchronized void delete ()
 
boolean equals (Object obj)
 
Quaternion getRotation ()
 Returns rotation as a quaternion.
 
Vector3 getScale ()
 Returns the scale.
 
float getScaleX ()
 Returns scale along X.
 
float getScaleY ()
 Returns scale along Y.
 
float getScaleZ ()
 Returns scale along Y.
 
Vector3 getTranslation ()
 Returns translation.
 
float getTranslationX ()
 Returns translation along X.
 
float getTranslationY ()
 Returns translation along Y.
 
float getTranslationZ ()
 Returns translation along Z.
 
void rotate (Quaternion rotation)
 Applies rotation. More...
 
void scale (Vector3 factor)
 Applies scale factor. More...
 
void setRotation (Quaternion value)
 Sets rotation. More...
 
void setRotation (Vector3 eulerAnglesInRadians)
 Sets rotation. More...
 
void setScale (Vector3 value)
 Sets the scale.
 
void setScaleX (float value)
 Sets scale along X.
 
void setScaleY (float value)
 Sets scale along Y.
 
void setScaleZ (float value)
 Sets scale along Z.
 
void setTranslation (Vector3 value)
 Sets translation.
 
void setTranslationX (float value)
 Sets translation along X.
 
void setTranslationY (float value)
 Sets translation along Y.
 
void setTranslationZ (float value)
 Sets translation along Z.
 
Matrix4x4 toMatrix ()
 Converts the SRT representation to Matrix4x4 transform.
 

Static Public Member Functions

static SRTValue3D create (Matrix4x4 matrix)
 Attempts to create a SRT object from a given transformation 4x4 matrix. More...
 
static SRTValue3D createScale (Vector3 scale)
 Creates a scale SRT.
 
static SRTValue3D createTranslation (Vector3 translation)
 Creates a translation SRT.
 
static SRTValue3D createUniformScale (float scale)
 Creates a uniform scale SRT.
 
static long getCPtr (SRTValue3D obj)
 

Protected Member Functions

void finalize ()
 

Protected Attributes

transient boolean swigCMemOwn
 

Detailed Description

Structure describing scale, rotation and translation transformation in 3D space.


Rotation is stored as quaternion, with the angle in radians.

Member Function Documentation

static SRTValue3D create ( Matrix4x4  matrix)
static

Attempts to create a SRT object from a given transformation 4x4 matrix.

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

Parameters
matrixThe transformation 4x4 matrix.
Returns
A SRTValue3D object if the matrix is decomposable, null otherwise.
void rotate ( Quaternion  rotation)

Applies rotation.


Parameters
rotationRotation quaternion.
void scale ( Vector3  factor)

Applies scale factor.


Multiplies current scale with provided factor.

void setRotation ( Quaternion  value)

Sets rotation.


Parameters
valueRotation as a quaternion.
void setRotation ( Vector3  eulerAnglesInRadians)

Sets rotation.


Parameters
eulerAnglesInRadiansRotation angle as Euler angle in radians.