Difference between revisions of "IC Python API:RLPy RIDeviceBase"

From Reallusion Wiki!
Jump to: navigation, search
(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...")
 
m
 
Line 135: Line 135:
 
!Description
 
!Description
 
|-
 
|-
−
| [[ IC_Python_API:RLPy_RIIBodyDevice | IBodyDevice ]] || Used to represent the body mocap device.
+
| [[ IC_Python_API:RLPy_RIBodyDevice | BodyDevice ]] || Used to represent the body mocap device.
 
|-
 
|-
−
| [[ IC_Python_API:RLPy_RIIFacialDevice | IFacialDevice ]] || Used to represent the facial mocap device.
+
| [[ IC_Python_API:RLPy_RIFacialDevice | FacialDevice ]] || Used to represent the facial mocap device.
 
|-
 
|-
−
| [[ IC_Python_API:RLPy_RIIHandDevice | IHandDevice ]] || Used to represent the hand mocap device.
+
| [[ IC_Python_API:RLPy_RIHandDevice | HandDevice ]] || Used to represent the hand mocap device.
 
|}
 
|}

Latest revision as of 01:12, 1 April 2019

Main article: Modules.

Detailed Description

This is the base class of all device class.

Member Functions

AddAvatar

RLPy.RIDeviceBase.AddAvatar ( self, spAvatar )

Add avatar.

Parameters

spAvatar [IN] avatar - RLPy.RIAvatar

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail

AddAvatars

RLPy.RIDeviceBase.AddAvatars ( self, kAvatarList )

Add avatar list.

Parameters

kAvatarList [IN] avatar list - RLPy.RIAvatar

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail

GetAvatarAt

RLPy.RIDeviceBase.GetAvatarAt ( self, nIndex )

Get avatar by index.

Parameters

nIndex [IN] index of avatar - int

Returns

Avatar - RLPy.RIAvatar

GetAvatarCount

RLPy.RIDeviceBase.GetAvatarCount ( self )

Get avatar count.

Returns

Avatar count - int

GetDeviceID

RLPy.RIDeviceBase.GetDeviceID ( self )

Get device ID.

Returns

Device ID - string

GetDeviceType

RLPy.RIDeviceBase.GetDeviceType ( self )

Get device type.

Returns

Device type - RLPy.EDeviceType
  • RLPy.EDeviceType_Facial
  • RLPy.EDeviceType_Body
  • RLPy.EDeviceType_Hand
  • RLPy.EDeviceType_All

IsEnable

RLPy.RIDeviceBase.IsEnable ( self, spAvatar )

Get device status.

Parameters

spAvatar [IN] avatar - RLPy.RIAvatar

Returns

Status - bool

RemoveAvatar

RLPy.RIDeviceBase.RemoveAvatar ( self, spAvatar )

Remove avatar.

Parameters

spAvatar [IN] avatar - RLPy.RIAvatar

Return Values

RLPy.RStatus.Success Success

RLPy.RStatus.Failure Fail

SetEnable

RLPy.RIDeviceBase.SetEnable ( self, spAvatar, bEnable )

Set device status.

Parameters

spAvatar [IN] avatar - RLPy.RIAvatar

bEnable [IN] status - bool

Inherited By

This class is inherited by the following classes:

Class Description
BodyDevice Used to represent the body mocap device.
FacialDevice Used to represent the facial mocap device.
HandDevice Used to represent the hand mocap device.
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RIDeviceBase&oldid=2979"