https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RlDeviceBase&feed=atom&action=history
IC Python API:RLPy RlDeviceBase - Revision history
2024-03-29T09:11:53Z
Revision history for this page on the wiki
MediaWiki 1.26.2
https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RlDeviceBase&diff=2973&oldid=prev
Chuck (RL): Created page with "{{TOC}} {{Parent|IC_Python_API:RL_Python_Modules|Modules}} ==Detailed Description== This is the base class of all device class. ==Member Functions== ===AddAvatar=== <syntaxhig..."
2019-04-01T06:03:08Z
<p>Created page with "{{TOC}} {{Parent|IC_Python_API:RL_Python_Modules|Modules}} ==Detailed Description== This is the base class of all device class. ==Member Functions== ===AddAvatar=== <syntaxhig..."</p>
<p><b>New page</b></p><div>{{TOC}}<br />
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}<br />
==Detailed Description==<br />
This is the base class of all device class.<br />
==Member Functions==<br />
===AddAvatar===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.AddAvatar ( self, spAvatar )<br />
</syntaxhighlight><br />
Add avatar.<br />
====Parameters====<br />
<div style="margin-left: 2em;"><br />
<br />
'''spAvatar''' [IN] avatar - RLPy.RIAvatar<br />
</div><br />
====Return Values====<br />
<div style="margin-left: 2em;"><br />
<br />
'''RLPy.RStatus.Success''' Success<br />
<br />
'''RLPy.RStatus.Failure''' Fail<br />
</div><br />
-----<br />
===AddAvatars===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.AddAvatars ( self, kAvatarList )<br />
</syntaxhighlight><br />
Add avatar list.<br />
====Parameters====<br />
<div style="margin-left: 2em;"><br />
<br />
'''kAvatarList''' [IN] avatar list - RLPy.RIAvatar<br />
</div><br />
====Return Values====<br />
<div style="margin-left: 2em;"><br />
<br />
'''RLPy.RStatus.Success''' Success<br />
<br />
'''RLPy.RStatus.Failure''' Fail<br />
</div><br />
-----<br />
===GetAvatarAt===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.GetAvatarAt ( self, nIndex )<br />
</syntaxhighlight><br />
Get avatar by index.<br />
====Parameters====<br />
<div style="margin-left: 2em;"><br />
<br />
'''nIndex''' [IN] index of avatar - int<br />
</div><br />
====Returns====<br />
<div style="margin-left: 2em;">Avatar - RLPy.RIAvatar<br />
</div><br />
-----<br />
===GetAvatarCount===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.GetAvatarCount ( self )<br />
</syntaxhighlight><br />
Get avatar count.<br />
====Returns====<br />
<div style="margin-left: 2em;">Avatar count - int<br />
</div><br />
-----<br />
===GetDeviceID===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.GetDeviceID ( self )<br />
</syntaxhighlight><br />
Get device ID.<br />
====Returns====<br />
<div style="margin-left: 2em;">Device ID - string<br />
</div><br />
-----<br />
===GetDeviceType===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.GetDeviceType ( self )<br />
</syntaxhighlight><br />
Get device type.<br />
====Returns====<br />
<div style="margin-left: 2em;">Device type - RLPy.EDeviceType<br />
*'''RLPy.EDeviceType_Facial'''<br />
*'''RLPy.EDeviceType_Body'''<br />
*'''RLPy.EDeviceType_Hand'''<br />
*'''RLPy.EDeviceType_All'''<br />
</div><br />
-----<br />
===IsEnable===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.IsEnable ( self, spAvatar )<br />
</syntaxhighlight><br />
Get device status.<br />
====Parameters====<br />
<div style="margin-left: 2em;"><br />
<br />
'''spAvatar''' [IN] avatar - RLPy.RIAvatar<br />
</div><br />
====Returns====<br />
<div style="margin-left: 2em;">Status - bool<br />
</div><br />
-----<br />
===RemoveAvatar===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.RemoveAvatar ( self, spAvatar )<br />
</syntaxhighlight><br />
Remove avatar.<br />
====Parameters====<br />
<div style="margin-left: 2em;"><br />
<br />
'''spAvatar''' [IN] avatar - RLPy.RIAvatar<br />
</div><br />
====Return Values====<br />
<div style="margin-left: 2em;"><br />
<br />
'''RLPy.RStatus.Success''' Success<br />
<br />
'''RLPy.RStatus.Failure''' Fail<br />
</div><br />
-----<br />
===SetEnable===<br />
<syntaxhighlight lang="Python"><br />
RLPy.RIDeviceBase.SetEnable ( self, spAvatar, bEnable )<br />
</syntaxhighlight><br />
Set device status.<br />
====Parameters====<br />
<div style="margin-left: 2em;"><br />
<br />
'''spAvatar''' [IN] avatar - RLPy.RIAvatar<br />
<br />
'''bEnable''' [IN] status - bool<br />
</div><br />
==Inherited By==<br />
This class is inherited by the following classes:<br />
{| class="wikitable"<br />
!Class<br />
!Description<br />
|-<br />
| [[ IC_Python_API:RLPy_RIIBodyDevice | IBodyDevice ]] || Used to represent the body mocap device.<br />
|-<br />
| [[ IC_Python_API:RLPy_RIIFacialDevice | IFacialDevice ]] || Used to represent the facial mocap device.<br />
|-<br />
| [[ IC_Python_API:RLPy_RIIHandDevice | IHandDevice ]] || Used to represent the hand mocap device.<br />
|}</div>
Chuck (RL)