IC Python API:RLPy RRotationSetting

From Reallusion Wiki!
Jump to: navigation, search

Main article: Modules.

Detailed Description

This class is the rotation setting used in the class RDeviceSetting. Provide methods to set coordinate space(WorldSpace/LocalSapce), the unit of rotation(Radians/Degrees), rotation representation(Euler/Quaternion) and the order(Euler Order/Quaternion Order).

Constructor & Destructors

__init__

RLPy.RRotationSetting.__init__ ( self, args )

Copy constructor.

Parameters

kSetting [IN] right value - RLPy.RRotationSetting

Member Functions

GetCoordinateSpace

RLPy.RRotationSetting.GetCoordinateSpace ( self )

Get coordinate space. ( Default value is EECoordinateSpace::WORLD )

Returns

Type of coordinate space - RLPy.ECoordinateSpace
  • RLPy.ECoordinateSpace_World
  • RLPy.ECoordinateSpace_Local

GetEulerOrder

RLPy.RRotationSetting.GetEulerOrder ( self )

Get Euler order. ( Default value is EEulerOrder::XYZ )

Returns

Euler order - RLPy.EEulerOrder
  • RLPy.EEulerOrder_XYZ
  • RLPy.EEulerOrder_ZYX
  • RLPy.EEulerOrder_XZY
  • RLPy.EEulerOrder_YZX
  • RLPy.EEulerOrder_YXZ
  • RLPy.EEulerOrder_ZXY

GetQuaternionOrder

RLPy.RRotationSetting.GetQuaternionOrder ( self )

Get quaternion order. ( Default value is EQuaternionOrder::XYZW )

Returns

Quaternion order - RLPy.EQuaternionOrder
  • RLPy.EQuaternionOrder_XYZW
  • RLPy.EQuaternionOrder_WXYZ

GetType

RLPy.RRotationSetting.GetType ( self )

Get rotation type. ( Default value is ERotationType::EULER )

Returns

Rotation type - RLPy.ERotationType
  • RLPy.ERotationType_Euler
  • RLPy.ERotationType_Quaternion

GetUnit

RLPy.RRotationSetting.GetUnit ( self )

Get rotation unit. ( Default value is ERotationUnit::RADIANS )

Returns

Rotation unit - RLPy.ERotationUnit
  • RLPy.ERotationUnit_Radians
  • RLPy.ERotationUnit_Degrees

SetCoordinateSpace

RLPy.RRotationSetting.SetCoordinateSpace ( self, eCoordinateSpace )

Set coordinate space.

Parameters

eCoordinateSpace [IN] Type of coordinate space - RLPy.ECoordinateSpace

  • RLPy.ECoordinateSpace_World
  • RLPy.ECoordinateSpace_Local

SetEulerOrder

RLPy.RRotationSetting.SetEulerOrder ( self, eOrder )

Set Euler order. EEulerOrder::XYZ EEulerOrder::ZYX EEulerOrder::XZY EEulerOrder::YZX EEulerOrder::YXZ EEulerOrder::ZXY.

Parameters

eOrder [IN] Euler order - RLPy.EEulerOrder

  • RLPy.EEulerOrder_XYZ
  • RLPy.EEulerOrder_ZYX
  • RLPy.EEulerOrder_XZY
  • RLPy.EEulerOrder_YZX
  • RLPy.EEulerOrder_YXZ
  • RLPy.EEulerOrder_ZXY

SetQuaternionOrder

RLPy.RRotationSetting.SetQuaternionOrder ( self, eOrder )

Set quaternion order. EQuaternionOrder::XYZW / EQuaternionOrder::WXYZ.

Parameters

eOrder [IN] Quaternion order - RLPy.EQuaternionOrder

  • RLPy.EQuaternionOrder_XYZW
  • RLPy.EQuaternionOrder_WXYZ

SetType

RLPy.RRotationSetting.SetType ( self, eType )

Set rotation type.

Parameters

eType [IN] Rotation type - RLPy.ERotationType

  • RLPy.ERotationType_Euler
  • RLPy.ERotationType_Quaternion

SetUnit

RLPy.RRotationSetting.SetUnit ( self, eUnit )

Set rotation unit.

Parameters

eUnit [IN] Rotation unit - RLPy.ERotationUnit

  • RLPy.ERotationUnit_Radians
  • RLPy.ERotationUnit_Degrees