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

From Reallusion Wiki!
Jump to: navigation, search
m
m
 
(48 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
__NOTOC__
+
{{Parent|IC_7_Python_API|IC7 Python API}}
−
{{Parent|IC_Python_API|iClone Python API}}
+
{{Related|IC8_Python_API:Modules|IC8 Python Modules}}
  
−
{{Incomplete|page|it is still under construction.}}
+
{| style="width:100%; text-align:center; background-color:#ab8080;" cellspacing="1"
−
 
+
!colspan="5" style="background-color:#f2b6b6;"| Mathematics
−
You can still access the original API reference material by visiting [http://manual.reallusion.com/iClone/script/python/modules.html http://manual.reallusion.com/iClone/script/python/modules.html]
+
−
 
+
−
 
+
−
==RLPy==
+
−
 
+
−
=== Mathematics ===
+
−
 
+
−
{| class="wikitable" style="width:100%; text-align:center;"
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RMath | RMath ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RVector2 | RVector2 ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RVector3 | RVector3 ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RVector4 | RVector4 ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RMatrix3 | RMatrix3 ]]
+
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RQuaternion | RQuaternion ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RMath | RMath ]]
−
|[[IC_Python_API:RLPy_RMatrix4 | RMatrix4 ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVector2 | RVector2 ]]
−
|[[IC_Python_API:RLPy_RTransform | RTransform ]]
+
|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 ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#ab9580;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RStatus | RStatus]]
+
!colspan="5" style="background-color:#f2dab6;"| System
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RTime | RTime ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RStatus | RStatus]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RVariant | RVariant]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RFileIO | RFileIO]]
+
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RGlobal| RGlobal]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RStatus | RStatus]]
−
|[[IC_Python_API:RLPy_Timer| RPyTimer]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTime | RTime ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RVariant | RVariant]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFileIO | RFileIO]]
 +
|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 ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#abab80;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlBase | RlBase ]]
+
! colspan="5" style="background-color:#f2e8b6;"| Scene
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlObject | RlObject ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlNode | RlNode ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlMaterialComponent | RlMaterialComponent ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlProp | RlProp ]]
+
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RlAvatar | RlAvatar]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIBase | RIBase ]]
−
|[[IC_Python_API:RLPy_RlCamera | RlCamera ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIObject | RIObject ]]
−
|[[IC_Python_API:RLPy_RlParticle | RlParticle ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RINode | RINode ]]
−
|[[IC_Python_API:RLPy_RlLight | RlLight ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIMaterialComponent | RIMaterialComponent ]]
−
|[[IC_Python_API:RLPy_RlSpotLight | RlSpotLight ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIProp | RIProp ]]
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RlPointLight | RlPointLight]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIAvatar | RIAvatar]]
−
|[[IC_Python_API:RLPy_RlDirectionalLight | RlDirectionalLight ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RICamera | RICamera ]]
−
|[[IC_Python_API:RLPy_RScene | RScene ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIParticle | RIParticle ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RILight | RILight ]]
 +
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RISpotLight | RISpotLight ]]
 +
|-
 +
|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 ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#95ab80;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RDatatBlock | RDatatBlock ]]
+
! colspan="5" style="background-color:#d4f2b6;"| Animation
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RKey | RKey ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RControl | RControl ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RFloatkey | RFloatkey ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RFloatControl | RFloatControl ]]
+
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RTransformkey | RTransformkey ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RDataBlock | RDataBlock ]]
−
|[[IC_Python_API:RLPy_RTransformControl | RTransformControl ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RKey | RKey ]]
−
|[[IC_Python_API:RLPy_RlClip | RlClip ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RControl | RControl ]]
−
|[[IC_Python_API:RLPy_RlSkeletonComponent | RlSkeletonComponent ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFloatKey | RFloatKey ]]
−
|[[IC_Python_API:RLPy_RlVisemeSmoothOption | RlVisemeSmoothOption ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RFloatControl | RFloatControl ]]
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RlVisemeComponent | RlVisemeComponent ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTransformKey | RTransformKey ]]
−
|[[IC_Python_API:RLPy_RlMorphComponent | RlMorphComponent ]]
+
|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%;"|
 
|}
 
|}
  
−
=== MotionCapture ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#80ab80;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RPositionSetting | RPositionSetting ]]
+
! colspan="5" style="background-color:#b6f2b6;"| MotionCapture
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RRotationSetting | RRotationSetting ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RDeviceSetting | RDeviceSetting ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlDeviceBase | RlDeviceBase ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RBodySetting | RBodySetting ]]
+
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RlBodyDevice | RlBodyDevice ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RPositionSetting | RPositionSetting ]]
−
|[[IC_Python_API:RLPy_RHandSetting | RHandSetting ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RRotationSetting | RRotationSetting ]]
−
|[[IC_Python_API:RLPy_RlHandDevice | RlHandDevice ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RDeviceSetting | RDeviceSetting ]]
−
|[[IC_Python_API:RLPy_RFacialSetting | RFacialSetting ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDeviceBase | RIDeviceBase ]]
−
|[[IC_Python_API:RLPy_RlFacialDevice | RlFacialDevice ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RBodySetting | RBodySetting ]]
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RlMocapManager | RlMocapManager ]]
+
|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%;"|
 
|}
 
|}
  
−
=== Events ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#80ab95;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RCallback | RCallback ]]
+
! colspan="5" style="background-color:#b6f2d4;"| Events
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RWinMessageCallback | RWinMessageCallback ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RDialogCallback | RDialogCallback ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_REventCallback | REventCallback ]]
+
−
|style="width: 150px;"|[[IC_Python_API:RLPy_REventHandler | REventHandler ]]
+
 
|-
 
|-
−
|[[IC_Python_API:RLPy_RPyTimerCallback | RPyTimerCallback]]
+
|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%;"|
 
|}
 
|}
  
−
=== UI ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#80abab;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlDialog | RlDialog ]]
+
!colspan="5" style="background-color:#b6d4f2;"| UI
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlDockWidget | RlDockWidget ]]
+
|-
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RUi | RUi ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDialog | RIDialog ]]
−
|style="width: 150px;"|
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RIDockWidget | RIDockWidget ]]
−
|style="width: 150px;"|
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RUi | RUi ]]
 +
|style="background-color:white; width:20%;"|
 +
|style="background-color:white; width:20%;"|
 
|}
 
|}
  
−
=== Media ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#8095ab;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RRgb | RRgb ]]
+
!colspan="5" style="background-color:#b6b6f2;"| Media
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RColor | RColor ]]
+
|-
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RlAudioObject | RlAudioObject ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RlAudioObject | RIAudioObject ]]
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RAudioRecorder | RAudioRecorder ]]  
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RAudioRecorder | RAudioRecorder ]]  
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RAudio | RAudio ]]
+
|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%;"|
 
|}
 
|}
  
−
=== Networking ===
 
  
−
{| class="wikitable" style="width:100%; text-align:center;"
+
{| style="width:100%; text-align:center; background-color:#8080ab;" cellspacing="1"
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RTcpCallback | RTcpCallback ]]
+
!colspan="5" style="background-color:#d4b6f2;"| Networking
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RTcpClient | RTcpClient ]]
+
|-
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RUdpCallback | RUdpCallback ]]
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTcpCallback | RTcpCallback ]]
−
|style="width: 150px;"|[[IC_Python_API:RLPy_RUdpClient | RUdpClient ]]  
+
|style="background-color:white; width:20%;"|[[IC_Python_API:RLPy_RTcpClient | RTcpClient ]]
−
|style="width: 150px;"|
+
|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
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RL_Python_Modules&oldid=5595"