IC Python API:RLPy RTransform

From Reallusion Wiki!
Jump to: navigation, search
Main article: Modules.

Detailed Description

This class represent the transform data.

Operators

This class supports the following operators:

Member Operation Syntax Description Example
__add__ Addition a + b Adds values on either side of the operator. a + b = 30
__eq__ Equality a == b If the values of two operands are equal, then the condition becomes true. (a == b) is not true.
__ne__ Difference a != b If values of two operands are not equal, then condition becomes true. (a != b) is true.
__iadd__ Addition (Inplace) a += b It adds right operand to the left operand and assign the result to left operand. c += a is equivalent to c = c + a

Member Functions

AlmostEquel

RLPy.RTransform.AlmostEquel ( self, kRts )

Two transform are almost equal or not.

Parameters

kRts [IN] The transform - RLPy.RTransform

Returns

Return true while two transform is almost equal - bool

D

RLPy.RTransform.D ( self, args )

Get the determinate sign.

Returns

The value of determinate sign - float

From

RLPy.RTransform.From ( self, mMatrix )

Set a transform from 4x4 matrix.

Returns

A transform composited from 4x4 matrix - RLPy.RTransform

GetSR

RLPy.RTransform.GetSR ( self )

Form a 3x3 matrix with rotation and scale.

Returns

A 3x3 matrix from this transform - RLPy.RMatrix3

Inverse

RLPy.RTransform.Inverse ( self )

Inverse of the transform.

Returns

A inversed transform - RLPy.RTransform

IsIdentity

RLPy.RTransform.IsIdentity ( self )

Is this transform identity.

Returns

True if the transform is identity - bool

Matrix

RLPy.RTransform.Matrix ( self )

Form a 4x4 matrix.

Returns

A 4x4 matrix - RLPy.RMatrix4

R

RLPy.RTransform.R ( self, args )

Get the rotation.

Returns

The value of rotation in quaternion - RLPy.RQuaternion

Rotate

RLPy.RTransform.Rotate ( self )

Form a rotate matrix.

Returns

A 3x3 rotate matrix from this transform - RLPy.RMatrix3

S

RLPy.RTransform.S ( self, args )

Get the scale.

Returns

The value of scale in 3D vector - RLPy.RVector3

Scale

RLPy.RTransform.Scale ( self )

Form a scale matrix.

Returns

A 3x3 scale matrix from this transform - RLPy.RMatrix3

T

RLPy.RTransform.T ( self, args )

Get the translation.

Returns

The value of translation in 3D vector - RLPy.RVector3

U

RLPy.RTransform.U ( self, args )

Get the stretch.

Returns

The value of stretch in quaternion - RLPy.RQuaternion