IC Python API:RLPy RIDeviceBase

From Reallusion Wiki!
Jump to: navigation, search

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.