IC Python API:RLPy RBodySetting

From Reallusion Wiki!
Jump to: navigation, search

Main article: Modules.

Detailed Description

This class is used to store the settings of body motion capture.

Constructor & Destructors

__init__

RLPy.RBodySetting.__init__ ( self, args )

copy constructor

Parameters

kSetting [IN] right value - RLPy.RBodySetting

Member Functions

GetActivePart

RLPy.RBodySetting.GetActivePart ( self )

Get active part.

Returns

Active part - RLPy.EBodyActivePart
  • RLPy.EBodyActivePart_Unknown
  • RLPy.EBodyActivePart_Head
  • RLPy.EBodyActivePart_Body
  • RLPy.EBodyActivePart_UpperArm_R
  • RLPy.EBodyActivePart_ForeArm_R
  • RLPy.EBodyActivePart_Hand_R
  • RLPy.EBodyActivePart_Finger_R
  • RLPy.EBodyActivePart_UpperArm_L
  • RLPy.EBodyActivePart_ForeArm_L
  • RLPy.EBodyActivePart_Hand_L
  • RLPy.EBodyActivePart_Finger_L
  • RLPy.EBodyActivePart_UpperLeg_R
  • RLPy.EBodyActivePart_Leg_R
  • RLPy.EBodyActivePart_Foot_R
  • RLPy.EBodyActivePart_UpperLeg_L
  • RLPy.EBodyActivePart_Leg_L
  • RLPy.EBodyActivePart_Foot_L
  • RLPy.EBodyActivePart_FullBody
  • RLPy.EBodyActivePart_UpperBody

GetCoordinateOffset

RLPy.RBodySetting.GetCoordinateOffset ( self, fRotation, vTranslation )

Get coordinate offset.

Parameters

fRotation [OUT] rotation offset - float

vTranslation [OUT] translation offset - float


GetFixLowerState

RLPy.RBodySetting.GetFixLowerState ( self )

Get fix lower state.

Returns

Fix lower state - bool

GetFootBottomToAnkle

RLPy.RBodySetting.GetFootBottomToAnkle ( self )

Get foot bottom to ankle.

Returns

Foot bottom to ankle - float

GetHipPositionLockedAxes

RLPy.RBodySetting.GetHipPositionLockedAxes ( self )

Get hip position locked axes.

Returns

Locked axes - RLPy.ECoordinateAxes
  • RLPy.ECoordinateAxes_Unknown
  • RLPy.ECoordinateAxes_X
  • RLPy.ECoordinateAxes_Y
  • RLPy.ECoordinateAxes_Z
  • RLPy.ECoordinateAxes_XY
  • RLPy.ECoordinateAxes_YZ
  • RLPy.ECoordinateAxes_XZ
  • RLPy.ECoordinateAxes_All

GetLockFootRotationState

RLPy.RBodySetting.GetLockFootRotationState ( self )

Get lock foot rotation state.

Returns

Lock foot rotation state - bool

GetMirrorState

RLPy.RBodySetting.GetMirrorState ( self )

Get mirror state.

Returns

Mirror state - bool

GetMotionApplyMode

RLPy.RBodySetting.GetMotionApplyMode ( self )

Get motion apply mode.

Returns

Motion apply mode - RLPy.EMotionApplyMode
  • RLPy.EMotionApplyMode_ReferenceToAvatar
  • RLPy.EMotionApplyMode_ReferenceToCoordinate

GetReferenceAvatar

RLPy.RBodySetting.GetReferenceAvatar ( self )

Get reference handle.

Returns

Reference handle - RLPy.RIAvatar

SetActivePart

RLPy.RBodySetting.SetActivePart ( self, eActivePart )

Set active part.

Parameters

eActivePart [IN] active part - RLPy.EBodyActivePart

  • RLPy.EBodyActivePart_Unknown
  • RLPy.EBodyActivePart_Head
  • RLPy.EBodyActivePart_Body
  • RLPy.EBodyActivePart_UpperArm_R
  • RLPy.EBodyActivePart_ForeArm_R
  • RLPy.EBodyActivePart_Hand_R
  • RLPy.EBodyActivePart_Finger_R
  • RLPy.EBodyActivePart_UpperArm_L
  • RLPy.EBodyActivePart_ForeArm_L
  • RLPy.EBodyActivePart_Hand_L
  • RLPy.EBodyActivePart_Finger_L
  • RLPy.EBodyActivePart_UpperLeg_R
  • RLPy.EBodyActivePart_Leg_R
  • RLPy.EBodyActivePart_Foot_R
  • RLPy.EBodyActivePart_UpperLeg_L
  • RLPy.EBodyActivePart_Leg_L
  • RLPy.EBodyActivePart_Foot_L
  • RLPy.EBodyActivePart_FullBody
  • RLPy.EBodyActivePart_UpperBody

SetCoordinateOffset

RLPy.RBodySetting.SetCoordinateOffset ( self, fRotation, vTranslation )

Set coordinate offset.

Parameters

fRotation [IN] rotation offset - float

vTranslation [IN] translation offset - float


SetFixLowerState

RLPy.RBodySetting.SetFixLowerState ( self, bIsFixLower )

Set fix lower state.

Parameters

bIsFixLower [IN] is fix lower - bool


SetFootBottomToAnkle

RLPy.RBodySetting.SetFootBottomToAnkle ( self, fFootBottomToAnkle )

Set foot bottom to ankle.

Parameters

fFootBottomToAnkle [IN] foot bottom to ankle - float


SetHipPositionLockedAxes

RLPy.RBodySetting.SetHipPositionLockedAxes ( self, eAxes )

Set hip position locked axes.

Parameters

eAxes [IN] locked axes - RLPy.ECoordinateAxes

  • RLPy.ECoordinateAxes_Unknown
  • RLPy.ECoordinateAxes_X
  • RLPy.ECoordinateAxes_Y
  • RLPy.ECoordinateAxes_Z
  • RLPy.ECoordinateAxes_XY
  • RLPy.ECoordinateAxes_YZ
  • RLPy.ECoordinateAxes_XZ
  • RLPy.ECoordinateAxes_All

SetLockFootRotationState

RLPy.RBodySetting.SetLockFootRotationState ( self, bIsLockFootRotation )

Set avatar active part.

Parameters

bIsLockFootRotation [IN] is lock foot rotation - bool


SetMirrorState

RLPy.RBodySetting.SetMirrorState ( self, bIsMirror )

Set mirror state.

Parameters

bIsMirror [IN] is mirror - bool


SetMotionApplyMode

RLPy.RBodySetting.SetMotionApplyMode ( self, eMotionApplyMode )

Set motion apply mode.

Parameters

eMotionApplyMode [IN] motion apply mode - RLPy.EMotionApplyMode

  • RLPy.EMotionApplyMode_ReferenceToAvatar
  • RLPy.EMotionApplyMode_ReferenceToCoordinate

SetReferenceAvatar

RLPy.RBodySetting.SetReferenceAvatar ( self, spAvatar )

Set reference avatar.

Parameters

spAvatar [IN] pointer of the reference avatar - RLPy.RIAvatar