Difference between revisions of "IC Python API:RLPy RIMocapManager"
From Reallusion Wiki!
Chuck (RL) (Talk | contribs) (Created page with "{{TOC}} {{Parent|IC_Python_API:RL_Python_Modules|Modules}} ==Detailed Description== This class is used to manager all motion capture devices. Provide moethods to add a new dev...") |
Chuck (RL) (Talk | contribs) m |
||
| Line 13: | Line 13: | ||
Add body device. | Add body device. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''strDeviceID''' [IN] device id - string | + | <div style="margin-left: 2em;"> |
| + | '''strDeviceID''' [IN] device id - string | ||
</div> | </div> | ||
====Returns==== | ====Returns==== | ||
| Line 25: | Line 26: | ||
Add facial device. | Add facial device. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''strDeviceID''' [IN] device id - string | + | <div style="margin-left: 2em;"> |
| + | '''strDeviceID''' [IN] device id - string | ||
</div> | </div> | ||
====Returns==== | ====Returns==== | ||
| Line 37: | Line 39: | ||
Add hand device. | Add hand device. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''strDeviceID''' [IN] device id - string | + | <div style="margin-left: 2em;"> |
| + | '''strDeviceID''' [IN] device id - string | ||
</div> | </div> | ||
====Returns==== | ====Returns==== | ||
| Line 49: | Line 52: | ||
Get device. | Get device. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''strDeviceID''' [IN] device id - string | + | <div style="margin-left: 2em;"> |
| + | '''strDeviceID''' [IN] device id - string | ||
</div> | </div> | ||
====Returns==== | ====Returns==== | ||
| Line 61: | Line 65: | ||
Is device exist. | Is device exist. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''strDeviceID''' [IN] device id - string | + | <div style="margin-left: 2em;"> |
| + | '''strDeviceID''' [IN] device id - string | ||
</div> | </div> | ||
====Returns==== | ====Returns==== | ||
| Line 95: | Line 100: | ||
Remove all devices. | Remove all devices. | ||
====Return Values==== | ====Return Values==== | ||
| − | <div style="margin-left: 2em;">'''RLPy.RStatus.Success''' Success '''RLPy.RStatus.Failure''' Fail | + | <div style="margin-left: 2em;"> |
| + | '''RLPy.RStatus.Success''' Success | ||
| + | |||
| + | '''RLPy.RStatus.Failure''' Fail | ||
</div> | </div> | ||
----- | ----- | ||
| Line 104: | Line 112: | ||
Remove device. | Remove device. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''strDeviceID''' [IN] device id - string | + | <div style="margin-left: 2em;"> |
| + | '''strDeviceID''' [IN] device id - string | ||
</div> | </div> | ||
====Return Values==== | ====Return Values==== | ||
| − | <div style="margin-left: 2em;">'''RLPy.RStatus.Success''' Success '''RLPy.RStatus.Failure''' Fail | + | <div style="margin-left: 2em;"> |
| + | '''RLPy.RStatus.Success''' Success | ||
| + | |||
| + | '''RLPy.RStatus.Failure''' Fail | ||
</div> | </div> | ||
----- | ----- | ||
| Line 116: | Line 128: | ||
Start preview/record state. | Start preview/record state. | ||
====Parameters==== | ====Parameters==== | ||
| − | <div style="margin-left: 2em;">'''eState''' [IN] mocap state - RLPy.EMocapState | + | <div style="margin-left: 2em;"> |
| + | '''eState''' [IN] mocap state - RLPy.EMocapState | ||
*'''RLPy.EMocapState_Unknown''' | *'''RLPy.EMocapState_Unknown''' | ||
*'''RLPy.EMocapState_Preview''' | *'''RLPy.EMocapState_Preview''' | ||
| Line 123: | Line 136: | ||
</div> | </div> | ||
====Return Values==== | ====Return Values==== | ||
| − | <div style="margin-left: 2em;">'''RLPy.RStatus.Success''' Success '''RLPy.RStatus.Failure''' Fail | + | <div style="margin-left: 2em;"> |
| + | '''RLPy.RStatus.Success''' Success | ||
| + | |||
| + | '''RLPy.RStatus.Failure''' Fail | ||
</div> | </div> | ||
----- | ----- | ||
| Line 132: | Line 148: | ||
Stop preview/record. | Stop preview/record. | ||
====Return Values==== | ====Return Values==== | ||
| − | <div style="margin-left: 2em;">'''RLPy.RStatus.Success''' Success '''RLPy.RStatus.Failure''' Fail | + | <div style="margin-left: 2em;"> |
| + | '''RLPy.RStatus.Success''' Success | ||
| + | |||
| + | '''RLPy.RStatus.Failure''' Fail | ||
</div> | </div> | ||
Latest revision as of 00:25, 1 April 2019
- 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
