IC Python API:RLPy RIMocapManager

From Reallusion Wiki!
Jump to: navigation, search

Main article: Modules.

Detailed Description

This class is used to manager all motion capture devices. Provide moethods to add a new device(Facial/Body/Hand), retrieve device, remove device and control the motion capture status(Preview/Record/Stop).

Member Functions

AddBodyDevice

RLPy.RIMocapManager.AddBodyDevice ( self, strDeviceID )

Add body device.

Parameters

strDeviceID [IN] device id - string

Returns

RIBodyDevice instance - RLPy.RIBodyDevice

AddFacialDevice

RLPy.RIMocapManager.AddFacialDevice ( self, strDeviceID )

Add facial device.

Parameters

strDeviceID [IN] device id - string

Returns

RIFacialDevice instance - RLPy.RIFacialDevice

AddHandDevice

RLPy.RIMocapManager.AddHandDevice ( self, strDeviceID )

Add hand device.

Parameters

strDeviceID [IN] device id - string

Returns

RIHandDevice instance - RLPy.RIHandDevice

GetDevice

RLPy.RIMocapManager.GetDevice ( self, strDeviceID )

Get device.

Parameters

strDeviceID [IN] device id - string

Returns

RIDevice instance - RLPy.RIDeviceBase

IsDeviceExist

RLPy.RIMocapManager.IsDeviceExist ( self, strDeviceID )

Is device exist.

Parameters

strDeviceID [IN] device id - string

Returns

Device exist - bool

IsRunning

RLPy.RIMocapManager.IsRunning ( self )

Get the current state is mocaping or not.

Returns

Is mocap previewing or recording - bool

MocapState

RLPy.RIMocapManager.MocapState ( self )

Get the current mocap state.

Returns

Current mocap state - RLPy.EMocapState
  • RLPy.EMocapState_Unknown
  • RLPy.EMocapState_Preview
  • RLPy.EMocapState_Record
  • RLPy.EMocapState_PreviewWithoutPlay

RemoveAllDevices

RLPy.RIMocapManager.RemoveAllDevices ( self )

Remove all devices.

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail


RemoveDevice

RLPy.RIMocapManager.RemoveDevice ( self, strDeviceID )

Remove device.

Parameters

strDeviceID [IN] device id - string

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail


Start

RLPy.RIMocapManager.Start ( self, args )

Start preview/record state.

Parameters

eState [IN] mocap state - RLPy.EMocapState

  • RLPy.EMocapState_Unknown
  • RLPy.EMocapState_Preview
  • RLPy.EMocapState_Record
  • RLPy.EMocapState_PreviewWithoutPlay

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail


Stop

RLPy.RIMocapManager.Stop ( self )

Stop preview/record.

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail