IC Python API:RLPy RDeviceSetting

From Reallusion Wiki!
Jump to: navigation, search

Main article: Modules.

Detailed Description

This class is the device setting used in the device class, such as RBodyDevice and RHandDevice. Provide methods to set the coordinate system (Lefthand/Righthand),axis orientation(Up & Front), offset data(Rotation & Position offset) and setting data(RPositionSetting & RRotationSetting).

Member Functions

GetAxisXYZ

RLPy.RDeviceSetting.GetAxisXYZ ( self, eAxis )

Get vector of an axis.

Parameters

eAxis [IN] An axis - RLPy.ECoordinateAxis

  • RLPy.ECoordinateAxis_X
  • RLPy.ECoordinateAxis_NegativeX
  • RLPy.ECoordinateAxis_Y
  • RLPy.ECoordinateAxis_NegativeY
  • RLPy.ECoordinateAxis_Z
  • RLPy.ECoordinateAxis_NegativeZ

Returns

Vector of an axis - float

GetCoordinateOffset

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

Get translation and rotation offset of the mocap coordinate.

Parameters

fRotation [OUT] Rotation offset - float

vTranslation [OUT] Translation offset - float


GetCoordinateSystem

RLPy.RDeviceSetting.GetCoordinateSystem ( self )

Get coordinate system. ( Default value is ECoordinateSystem::RIGHT_HAND )

Returns

Coordinate system - RLPy.ECoordinateSystem
  • RLPy.ECoordinateSystem_RightHand
  • RLPy.ECoordinateSystem_LeftHand

GetMocapCoordinateFrontAxis

RLPy.RDeviceSetting.GetMocapCoordinateFrontAxis ( self )

Get front-axis of mocap coordinate. ( Default value is ECoordinateAxis::NEGATIVE_Y )

Returns

Front-axis of mocap coordinate - RLPy.ECoordinateAxis
  • RLPy.ECoordinateAxis_X
  • RLPy.ECoordinateAxis_NegativeX
  • RLPy.ECoordinateAxis_Y
  • RLPy.ECoordinateAxis_NegativeY
  • RLPy.ECoordinateAxis_Z
  • RLPy.ECoordinateAxis_NegativeZ

GetMocapCoordinateSystem

RLPy.RDeviceSetting.GetMocapCoordinateSystem ( self )

Get coordinate system of mocap coordinate. ( Default value is ECoordinateSystem::RIGHT_HAND )

Returns

Coordinate system of mocap coordinate - RLPy.ECoordinateSystem
  • RLPy.ECoordinateSystem_RightHand
  • RLPy.ECoordinateSystem_LeftHand

GetMocapCoordinateUpAxis

RLPy.RDeviceSetting.GetMocapCoordinateUpAxis ( self )

Get up-axis of mocap coordinate. ( Default value is ECoordinateAxis::Z )

Returns

Up-axis of mocap coordinate - RLPy.ECoordinateAxis
  • RLPy.ECoordinateAxis_X
  • RLPy.ECoordinateAxis_NegativeX
  • RLPy.ECoordinateAxis_Y
  • RLPy.ECoordinateAxis_NegativeY
  • RLPy.ECoordinateAxis_Z
  • RLPy.ECoordinateAxis_NegativeZ

GetPositionSetting

RLPy.RDeviceSetting.GetPositionSetting ( self )

Get position setting.

Returns

Position setting - RLPy.RPositionSetting

GetRotationSetting

RLPy.RDeviceSetting.GetRotationSetting ( self )

Get rotation setting.

Returns

Rotation setting - RLPy.RRotationSetting

SetCoordinateOffset

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

Set translation and rotation offset of the mocap coordinate.

Parameters

fRotation [IN] Rotation offset - float

vTranslation [IN] Translation offset - float


SetCoordinateSystem

RLPy.RDeviceSetting.SetCoordinateSystem ( self, eCoordinateSystem )

Set coordinate system.

Parameters

eCoordinateSystem [IN] Coordinate system - RLPy.ECoordinateSystem

  • RLPy.ECoordinateSystem_RightHand
  • RLPy.ECoordinateSystem_LeftHand

SetMocapCoordinate

RLPy.RDeviceSetting.SetMocapCoordinate ( self, eUpAxis, eFrontAxis, eCoordinateSystem )

Set mocap coordinate.

Parameters

eUpAxis [IN] Up-axis - RLPy.ECoordinateAxis

  • RLPy.ECoordinateAxis_X
  • RLPy.ECoordinateAxis_NegativeX
  • RLPy.ECoordinateAxis_Y
  • RLPy.ECoordinateAxis_NegativeY
  • RLPy.ECoordinateAxis_Z
  • RLPy.ECoordinateAxis_NegativeZ

eFrontAxis [IN] Front-axis - RLPy.ECoordinateAxis

  • RLPy.ECoordinateAxis_X
  • RLPy.ECoordinateAxis_NegativeX
  • RLPy.ECoordinateAxis_Y
  • RLPy.ECoordinateAxis_NegativeY
  • RLPy.ECoordinateAxis_Z
  • RLPy.ECoordinateAxis_NegativeZ

eCoordinateSystem [IN] Coordinate system - RLPy.ECoordinateSystem

  • RLPy.ECoordinateSystem_RightHand
  • RLPy.ECoordinateSystem_LeftHand

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail