Difference between revisions of "IC Python API:RL Python Modules"

From Reallusion Wiki!
Jump to: navigation, search
m (Scene)
m
 
(100 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{TOC}}
+
{{Parent|IC_7_Python_API|IC7 Python API}}
{{Parent|IC_Python_API|iClone Python API}}
+
{{Related|IC8_Python_API:Modules|IC8 Python Modules}}
  
Inherits from RLPy
+
{| style="width:100%; text-align:center; background-color:#ab8080;" cellspacing="1"
 +
!colspan="5" style="background-color:#f2b6b6;"| Mathematics
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RMath | RMath ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVector2 | RVector2 ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVector3 | RVector3 ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVector4 | RVector4 ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RMatrix3 | RMatrix3 ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RQuaternion | RQuaternion ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RMatrix4 | RMatrix4 ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTransform | RTransform ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RRgb | RRgb ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RColor | RColor ]]
 +
|}
  
== System ==
 
  
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
+
{| style="width:100%; text-align:center; background-color:#ab9580;" cellspacing="1"
* RStatus - API level error handling.
+
!colspan="5" style="background-color:#f2dab6;"| System
* RTime - Hold and manipulate timing information.
+
|-
* RVariant - Union for most common data types.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RStatus | RStatus]]
* RFileIO - Input/output operations for scene files.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTime | RTime ]]
* RGlobal - Common API global functions.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVariant | RVariant]]
* RPyTimer - Repetitive and single-shot timers.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFileIO | RFileIO]]
</div>
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RGlobal | RGlobal]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RPyTimer | RPyTimer]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RApplication | RApplication]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|}
  
== Scene ==
 
  
<div style="column-count:3;-moz-column-count:3;-webkit-column-count:3">
+
{| style="width:100%; text-align:center; background-color:#abab80;" cellspacing="1"
* RlBase - Base class for scene components.
+
! colspan="5" style="background-color:#f2e8b6;"| Scene
* RlObject - Base class for scene objects.
+
|-
* RlNode - Base class for scene nodes.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIBase | RIBase ]]
* RlMaterialComponent -  
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIObject | RIObject ]]
* RlProp - Base class for scene props.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RINode | RINode ]]
* RlAvatar - Interface for scene avatars.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIMaterialComponent | RIMaterialComponent ]]
* RlCamera - Interface for scene cameras.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIProp | RIProp ]]
* RlParticle - Interface for scene particles.
+
|-
* RlLight - Interface for scene lights.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIAvatar | RIAvatar]]
* RlSpotLight - Interface for scene spot lights.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RICamera | RICamera ]]
* RlPointLight - Interface for scene point lights.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIParticle | RIParticle ]]
* RlDirectionalLight - Interface for scene lights.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RILight | RILight ]]
* RScene - methods for the current scene.
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RISpotLight | RISpotLight ]]
</div>
+
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIPointLight | RIPointLight]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDirectionalLight | RIDirectionalLight ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RScene | RScene ]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|}
  
== Animation ==
 
  
== MotionCapture ==
+
{| style="width:100%; text-align:center; background-color:#95ab80;" cellspacing="1"
 +
! colspan="5" style="background-color:#d4f2b6;"| Animation
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RDataBlock | RDataBlock ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RKey | RKey ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RControl | RControl ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFloatKey | RFloatKey ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFloatControl | RFloatControl ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTransformKey | RTransformKey ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTransformControl | RTransformControl ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIClip | RlClip ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RISkeletonComponent | RISkeletonComponent ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIHikEffectorComponent | RIHikEffectorComponent ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVisemeKey | RVisemeKey ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVisemeSmoothOption | RVisemeSmoothOption ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIVisemeComponent | RIVisemeComponent ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIMorphComponent | RIMorphComponent ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIFaceComponent | RIFaceComponent ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RCameraDofData | RCameraDofData ]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|}
  
== Events ==
 
  
== UI ==
+
{| style="width:100%; text-align:center; background-color:#80ab80;" cellspacing="1"
 +
! colspan="5" style="background-color:#b6f2b6;"| MotionCapture
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RPositionSetting | RPositionSetting ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RRotationSetting | RRotationSetting ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RDeviceSetting | RDeviceSetting ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDeviceBase | RIDeviceBase ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RBodySetting | RBodySetting ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIBodyDevice | RIBodyDevice ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RHandSetting | RHandSetting ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIHandDevice | RIHandDevice ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFacialSetting | RFacialSetting ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIFacialDevice | RIFacialDevice ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIMocapManager | RIMocapManager ]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|}
  
== Media ==
 
  
== Networking ==
+
{| style="width:100%; text-align:center; background-color:#80ab95;" cellspacing="1"
 +
! colspan="5" style="background-color:#b6f2d4;"| Events
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RCallback | RCallback ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RWinMessageCallback | RWinMessageCallback ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RDialogCallback | RDialogCallback ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_REventCallback | REventCallback ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_REventHandler | REventHandler ]]
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RPyTimerCallback | RPyTimerCallback]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIEventListener | RIEventListener ]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|}
  
== Mathematics ==
+
 
 +
{| style="width:100%; text-align:center; background-color:#80abab;" cellspacing="1"
 +
!colspan="5" style="background-color:#b6d4f2;"| UI
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDialog | RIDialog ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDockWidget | RIDockWidget ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RUi | RUi ]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 +
|}
 +
 
 +
 
 +
{| style="width:100%; text-align:center; background-color:#8095ab;" cellspacing="1"
 +
!colspan="5" style="background-color:#b6b6f2;"| Media
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RlAudioObject | RIAudioObject ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RAudioRecorder | RAudioRecorder ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RAudio | RAudio ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RAudioRecorderCallback | RAudioRecorderCallback ]]
 +
|style="background-color:white; width:20%;"|
 +
|}
 +
 
 +
 
 +
{| style="width:100%; text-align:center; background-color:#8080ab;" cellspacing="1"
 +
!colspan="5" style="background-color:#d4b6f2;"| Networking
 +
|-
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTcpCallback | RTcpCallback ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTcpClient | RTcpClient ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RUdpCallback | RUdpCallback ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RUdpClient | RUdpClient ]]
 +
|style="background-color:white; width:20%;"|
 +
|}

Latest revision as of 19:14, 3 January 2023

Main article: IC7 Python API.
Related article: IC8 Python Modules.
Mathematics
RMath RVector2 RVector3 RVector4 RMatrix3
RQuaternion RMatrix4 RTransform RRgb RColor


System
RStatus RTime RVariant RFileIO RGlobal
RPyTimer RApplication


Scene
RIBase RIObject RINode RIMaterialComponent RIProp
RIAvatar RICamera RIParticle RILight RISpotLight
RIPointLight RIDirectionalLight RScene


Animation
RDataBlock RKey RControl RFloatKey RFloatControl
RTransformKey RTransformControl RlClip RISkeletonComponent RIHikEffectorComponent
RVisemeKey RVisemeSmoothOption RIVisemeComponent RIMorphComponent RIFaceComponent
RCameraDofData


MotionCapture
RPositionSetting RRotationSetting RDeviceSetting RIDeviceBase RBodySetting
RIBodyDevice RHandSetting RIHandDevice RFacialSetting RIFacialDevice
RIMocapManager


Events
RCallback RWinMessageCallback RDialogCallback REventCallback REventHandler
RPyTimerCallback RIEventListener


UI
RIDialog RIDockWidget RUi


Media
RIAudioObject RAudioRecorder RAudio RAudioRecorderCallback


Networking
RTcpCallback RTcpClient RUdpCallback RUdpClient