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

From Reallusion Wiki!
Jump to: navigation, search
(Created page with "{{TOC}} {{Parent|IC_Python_API:RL_Python_Modules|Modules}} ==Inheritance== This class inherits public member functions from: *RLPy.RCallback =...")
 
m
Line 1: Line 1:
 
{{TOC}}
 
{{TOC}}
 
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
 
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
−
==Inheritance==
+
{{last_modified}}
−
This class inherits public member functions from:
+
 
−
*[[IC_Python_API:RLPy_RCallback|RLPy.RCallback]]
+
== Description ==
−
==Detailed Description==
+
 
−
This class is used to register callbacks for system events.
+
This class provides a way to monitor iClone events and register callbacks for system events. Once an instance is created, iClone trigger events can be recieved, i.e. playback status, file read status, object creation and deletion status, etc. Note: [[IC_Python_API:RLPy_REventCallback|REventCallback]] can not be created as a local variable, otherwise the application will crash. Errors in the callback function can also cause the application to crash without warnings, therefore one should consider using Python's '''try except''' for fool-proof implementation.
−
<syntaxhighlight lang="Python">
+
 
 +
=== Inheritance ===
 +
 
 +
[[IC_Python_API:RLPy_RCallback|RCallback]]> [[IC_Python_API:RLPy_REventCallback|REventCallback]]
 +
 
 +
=== Examples ===
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 
class REventCallbackSampleCode(RLPy.REventCallback):
 
class REventCallbackSampleCode(RLPy.REventCallback):
−
  def __init__(self):
+
  def __init__(self):
−
   RLPy.REventCallback.__init__(self)
+
      RLPy.REventCallback.__init__(self)
 +
  def OnTimerUpdated (self, fTime):
 +
      print('Updated time:' + str(fTime)) 
 +
  def OnCurrentTimeChanged (self, fTime):
 +
      print('Current time:' + str(fTime))     
 +
  def OnBeforeLoadFile(self, nFileType):
 +
      print('File type:' + str(nFileType))
 +
  def OnFileLoaded(self, nFileType):
 +
      print('File type:' + str(nFileType))
 +
  def OnAfterFileLoaded(self, nFileType):
 +
      print('File type:' + str(nFileType))
 +
  def OnProjectDataChanged(self, nProjectDataType):
 +
      print('Project Data type:' + str(nProjectDataType))
 +
  def OnBeforeSaveFile(self, nFileType, pProjectName):
 +
      print('File type:' + str(nFileType) + ', Project Data type:' + str(nProjectDataType))
 +
  def OnFileSaved(self, nFileType, pProjectName):
 +
      print('File type:' + str(nFileType) + ', Project Data type:' + str(nProjectDataType))
 +
  def OnObjectSelectionChanged(self):
 +
      print('Object Selection Changed')
 +
  def OnObjectDataChanged(self):
 +
      print('Object Data Changed')
 +
  def OnObjectAdded(self):
 +
      print('Object Added')
 +
  def OnObjectDeleted(self):
 +
      print('Object Deleted')
 +
  def OnDialogModeChanged(self, nDialogMode):
 +
      print('Dialog Mode Changed ~ ' + 'Dialog Mode:' + str(nDialogMode))
 +
  def OnPickedModeChanged(self, nPickMode, nPreviousPickMode):
 +
      print('Picked Mode Changed ~ ' + ' Pick Mode:' + str(nPickMode) + ', Previous Pick Mode:' + str(nPreviousPickMode) )
 +
  def OnUndoRedoDone(self):
 +
      print('Undo Redo Done')
 +
  def OnPlayed(self):
 +
      print('Play')
 +
  def OnStopped(self):
 +
      print('Stop')
 +
 +
# register event
 +
event_callback = None
 +
def run_script():
 +
    # register event
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
  
−
  def OnTimerUpdated (self, fTime):
+
== Member Functions ==
−
   print('Updated time:' + str(fTime))
+
−
 
+
−
  def OnCurrentTimeChanged (self, fTime):
+
−
   print('Current time:' + str(fTime))
+
−
  
+
−
  def OnBeforeLoadFile(self, nFileType):
+
−
   print('File type:' + str(nFileType))
+
  
−
  def OnFileLoaded(self, nFileType):
+
=== OnTimerUpdated ( self, fTime ) ===
−
   print('File type:' + str(nFileType))
+
  
−
  def OnAfterFileLoaded(self, nFileType):
+
Trigger events while the iClone timeline plays back and return the current time during playback.
−
   print('File type:' + str(nFileType))
+
  
−
  def OnProjectDataChanged(self, nProjectDataType):
+
==== Parameters ====
−
   print('Project Data type:' + str(nProjectDataType))
+
:'''fTime''' [IN] current time (ms) - float
  
−
  def OnBeforeSaveFile(self, nFileType, pProjectName):
+
<syntaxhighlight lang="python" line='line'>
−
   print('File type:' + str(nFileType) + ', Project Data type:' + str(nProjectDataType))
+
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnTimerUpdated (self, fTime):
 +
        print('Updated time:' + str(fTime))
  
−
  def OnFileSaved(self, nFileType, pProjectName):
+
event_callback = None
−
   print('File type:' + str(nFileType) + ', Project Data type:' + str(nProjectDataType))
+
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
  
−
  def OnObjectSelectionChanged(self):
+
=== OnCurrentTimeChanged ( self, fTime ) ===
−
   print('Object Selection Changed')
+
  
−
  def OnObjectDataChanged(self):
+
Trigger an event everytime a change has been applied to the iClone timeline and return the current time. For example, updates are triggered when the timeline is stopped and while scrubbing the timeline, but playing the timeline does not.
−
   print('Object Data Changed')
+
  
−
  def OnObjectAdded(self):
+
==== Parameters ====
−
   print('Object Added')
+
:'''fTime''' [IN] current time - float
  
−
  def OnObjectDeleted(self):
+
<syntaxhighlight lang="python" line='line'>
−
   print('Object Deleted')
+
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnCurrentTimeChanged (self, fTime):
 +
        print('Current time:' + str(fTime))
  
−
  def OnDialogModeChanged(self, nDialogMode):
+
event_callback = None
−
   print('Dialog Mode Changed ~ ' + 'Dialog Mode:' + str(nDialogMode))
+
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
  
−
  def OnPickedModeChanged(self, nPickMode, nPreviousPickMode):
+
=== OnBeforeLoadFile ( self,nFileType ) ===
−
   print('Picked Mode Changed ~ ' + ' Pick Mode:' + str(nPickMode) + ', Previous Pick Mode:' + str(nPreviousPickMode) )
+
  
−
  def OnUndoRedoDone(self):
+
Trigger an event before an object is read from file and return the object's type.
−
   print('Undo Redo Done')
+
  
−
  def OnPlayed(self):
+
==== Parameters ====
−
   print('Play')
+
:'''nFileType''' [IN] file type - integer
  
−
  def OnStopped(self):
+
<syntaxhighlight lang="python" line='line'>
−
   print('Stop')
+
class REventCallbackSampleCode(RLPy.REventCallback):
−
 
+
    def __init__(self):
−
# register event
+
        RLPy.REventCallback.__init__(self)
−
event_callback = REventCallbackSampleCode()
+
    def OnBeforeLoadFile(self, nFileType):
−
id = RLPy.REventHandler.RegisterCallback(event_callback)
+
        print('File type:' + str(nFileType))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
==Member Functions==
+
 
−
===OnAfterFileLoaded===
+
=== OnFileLoaded ( self, nFileType ) ===
−
<syntaxhighlight lang="Python">
+
 
−
RLPy.REventCallback.OnAfterFileLoaded ( self, nFileType )
+
Trigger an event when an object is read from file and return the object's type.
 +
 
 +
===== Parameters =====
 +
:'''nFileType''' [IN] file type - integer
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnFileLoaded(self, nFileType):
 +
        print('File type:' + str(nFileType))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for after file loaded.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nFileType''' [IN] file type - int
+
=== OnAfterFileLoaded ( self, nFileType ) ===
−
</div>
+
 
−
-----
+
Trigger an event after iClone has finished reading an object from file and return the object's type.
−
===OnBeforeLoadFile===
+
 
−
<syntaxhighlight lang="Python">
+
===== Parameters =====
−
RLPy.REventCallback.OnBeforeLoadFile ( self, nFileType )
+
:'''nFileType''' [IN] file type - integer
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnAfterFileLoaded(self, nFileType):
 +
        print('File type:' + str(nFileType))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for before load file.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nFileType''' [IN] file type - int
+
=== OnProjectDataChanged ( self, nProjectDataType )  ===
−
</div>
+
 
−
-----
+
Trigger an event when the iClone project's settings change and return the settings type.
−
===OnBeforeSaveFile===
+
 
−
<syntaxhighlight lang="Python">
+
==== Parameters ====
−
RLPy.REventCallback.OnBeforeSaveFile ( self, nFileType, pProjectName )
+
:'''nProjectDataType''' [IN] project data type - integer
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnProjectDataChanged(self, nProjectDataType):
 +
        print('Project Data type:' + str(nProjectDataType))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for before save file.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nFileType''' [IN] file type - int
+
=== OnBeforeSaveFile ( self, nFileTypep, strProjectName ) ===
  
−
'''pProjectName''' [IN] project name - string
+
Trigger an event right before iClone saves a file and return the file path.
−
</div>
+
 
−
-----
+
==== Parameters ====
−
===OnCurrentTimeChanged===
+
:'''nFileType''' [IN] file type - integer
−
<syntaxhighlight lang="Python">
+
:'''strProjectName''' [IN] project name - string
−
RLPy.REventCallback.OnCurrentTimeChanged ( self, fTime )
+
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnBeforeSaveFile(self, nFileType, strProjectName):
 +
        print('File type:' + str(nFileType) + ', Project Name:' + str(pProjectName))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for current time changed.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''fTime''' [IN] current time - float
+
=== OnFileSaved ( self, nFileType, strProjectName ) ===
−
</div>
+
 
−
-----
+
Trigger an event when iClone has succesfully saved a file and return the file path.
−
===OnDialogModeChanged===
+
 
−
<syntaxhighlight lang="Python">
+
==== Parameters ====
−
RLPy.REventCallback.OnDialogModeChanged ( self, nDialogMode )
+
:'''nFileType''' [IN] file type - integer
 +
:'''strProjectName''' [IN] project name - string
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnFileSaved(self, nFileType, strProjectName):
 +
        print('File type:' + str(nFileType) + ', Project Name:' + str(pProjectName))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for dialog mode changed.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nDialogMode''' [IN] dialog mode - int
+
=== OnObjectSelectionChanged ( self ) ===
−
</div>
+
 
−
-----
+
Trigger an event when an iClone object is selection.
−
===OnFileLoaded===
+
 
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
RLPy.REventCallback.OnFileLoaded ( self, nFileType )
+
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnObjectSelectionChanged(self):
 +
        print('Object Selection Changed')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for file loaded.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nFileType''' [IN] file type - int
+
=== OnObjectDataChanged ( self ) ===
−
</div>
+
 
−
-----
+
Trigger an event when an iClone object data has changed (ObjectChangedDataType).
−
===OnFileSaved===
+
 
−
<syntaxhighlight lang="Python">
+
==== Enum.ObjectChangedDataType ====
−
RLPy.REventCallback.OnFileSaved ( self, nFileType, pProjectName )
+
 
 +
{| class="wikitable"
 +
|-
 +
!Enum
 +
!Code
 +
!Enum
 +
!Code
 +
!Enum
 +
!Code
 +
|-
 +
|None
 +
|0
 +
|Transform
 +
|1
 +
|Attribute
 +
|2
 +
|-
 +
|Physics
 +
|4
 +
|Material
 +
|8
 +
|Substance
 +
|16
 +
|-
 +
|NodeType
 +
|32
 +
|Replace
 +
|64
 +
|Reach
 +
|128
 +
|-
 +
|Name
 +
|256
 +
|ShapingMorph
 +
|512
 +
|ReplaceAvatar
 +
|1024
 +
|-
 +
|EditMeshDone
 +
|2048
 +
|CustomMorphWeightChange
 +
|4096
 +
|CustomMorph
 +
|8192
 +
|-
 +
|PopcornFx
 +
|16384
 +
|SetMainMesh
 +
|32768
 +
|MotionOffset
 +
|65536
 +
|-
 +
|Motion
 +
|131072
 +
|MeshSmoothSetting
 +
|262144
 +
|CreateLodData
 +
|524288
 +
|-
 +
|Appearance
 +
|1048576
 +
|SkinSubstance
 +
|2097152
 +
|Texture
 +
|4194304
 +
|-
 +
|ShaderType
 +
|8388608
 +
|Wrinkle
 +
|16777216
 +
|MaterialTexture
 +
|4194312
 +
|-
 +
|MaterialAll
 +
|12582920
 +
|
 +
|
 +
|
 +
|
 +
|}
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnObjectDataChanged(self):
 +
        print('Object Data Changed')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for file saved.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nFileType''' [IN] file type - int
+
=== OnObjectAdded ( self ) ===
  
−
'''pProjectName''' [IN] project name - string
+
Trigger an event when an iClone object is added to the scene. Currently triggers on the creation of Lights, Cameras, Paths, and duplication of any type of object.
−
</div>
+
 
−
-----
+
<syntaxhighlight lang="python" line='line'>
−
===OnProjectDataChanged===
+
class REventCallbackSampleCode(RLPy.REventCallback):
−
<syntaxhighlight lang="Python">
+
    def __init__(self):
−
RLPy.REventCallback.OnProjectDataChanged ( self, nProjectDataType )
+
        RLPy.REventCallback.__init__(self)
 +
    def OnObjectAdded(self):
 +
        print('Object Added')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for project data changed.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''nProjectDataType''' [IN] project data type - int
+
=== OnObjectDeleted ( self ) ===
−
</div>
+
 
−
-----
+
Trigger an event when an iClone object is deleted.
−
===OnTimerUpdated===
+
 
−
<syntaxhighlight lang="Python">
+
<syntaxhighlight lang="python" line='line'>
−
RLPy.REventCallback.OnTimerUpdated ( self, fTime )
+
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnObjectDeleted(self):
 +
        print('Object Deleted')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Callback for timer updated.
 
−
====Parameters====
 
−
<div style="margin-left: 2em;">
 
  
−
'''fTime''' [IN] current time - float
+
=== OnDialogModeChanged ( self, nDialogMode ) ===
−
</div>
+
 
 +
Trigger an event when an iClone window related function is called and return the window's dialog mode (DialogModeType).
 +
 
 +
==== Enum.DialogMode ====
 +
 
 +
{| class="wikitable"
 +
|-
 +
!Enum
 +
!Code
 +
!Enum
 +
!Code
 +
!Enum
 +
!Code
 +
|-
 +
|DM_None
 +
|0
 +
|DM_PivotEdit
 +
|1
 +
|DM_DirectPuppet
 +
|2
 +
|-
 +
|DM_MotionPuppet
 +
|3
 +
|DM_DevicePuppet
 +
|4
 +
|DM_PropPuppet
 +
|5
 +
|-
 +
|DM_MographEdit
 +
|6
 +
|DM_AvatarProport
 +
|7
 +
|DM_Duplicate
 +
|8
 +
|-
 +
|DM_IkEditing
 +
|9
 +
|DM_ReachTarget
 +
|10
 +
|DM_BoneSetting
 +
|11
 +
|-
 +
|DM_QuickLight
 +
|12
 +
|DM_FacePuppet
 +
|13
 +
|DM_FaceKey
 +
|14
 +
|-
 +
|DM_FacialFeature
 +
|15
 +
|DM_FacialDeform
 +
|16
 +
|DM_FacialMocap
 +
|17
 +
|-
 +
|DM_ClipMotionPuppet
 +
|18
 +
|DM_PhysicsCenterOfMass
 +
|19
 +
|DM_PhysicsCollisionShape
 +
|20
 +
|-
 +
|DM_CreateFace
 +
|21
 +
|DM_TTS
 +
|22
 +
|DM_GrassEditing
 +
|23
 +
|-
 +
|DM_TreeEditing
 +
|24
 +
|DM_PhysicsMaterial
 +
|25
 +
|DM_ClothFitting
 +
|26
 +
|-
 +
|DM_VisemeSmooth
 +
|27
 +
|DM_CCSubstanceHighPerformance
 +
|28
 +
|DM_NoitomMocapPuppet
 +
|29
 +
|-
 +
|DM_CreateSlider
 +
|30
 +
|DM_FloorContact
 +
|31
 +
|DM_EditFace
 +
|32
 +
|-
 +
|DM_EditVertex
 +
|33
 +
|DM_EditElement
 +
|34
 +
|DM_IblEditting
 +
|35
 +
|-
 +
|DM_MorphAnimation
 +
|36
 +
|DM_EditSkinWeightByVertex
 +
|37
 +
|DM_EditSkinWeightByBrush
 +
|38
 +
|-
 +
|DM_EditSkinWeightRotateBone
 +
|39
 +
|DM_EditSkinWeightSelectBone
 +
|40
 +
|DM_AdjustTPose
 +
|41
 +
|-
 +
|DM_FkEditing
 +
|42
 +
|DM_EditPartialConformByVertex
 +
|43
 +
|DM_EditPartialConformByElement
 +
|44
 +
|-
 +
|DM_EditPartialConformByBrush
 +
|45
 +
|DM_EditNormal
 +
|46
 +
|DM_OptimizeMesh_All
 +
|47
 +
|-
 +
|DM_OptimizeMesh_Select
 +
|48
 +
|DM_OptimizeMesh_Element
 +
|49
 +
|DM_EditHighHeel
 +
|50
 +
|-
 +
|DM_EditMeshByBrush
 +
|51
 +
|DM_ConvertToAccessory
 +
|52
 +
|DM_SkinWeightTemplate
 +
|53
 +
|-
 +
|DM_SelectGameBaseUV
 +
|54
 +
|DM_ContentHideMesh
 +
|55
 +
|DM_ContentHideBodyMeshByFace
 +
|56
 +
|-
 +
|DM_ContentHideBodyMeshByBrush
 +
|57
 +
|DM_PaintMaskByBrush
 +
|58
 +
|DM_SkinSubstance
 +
|59
 +
|-
 +
|DM_CC1Substance
 +
|60
 +
|DM_FacialCalibration
 +
|61
 +
|DM_PluginCustomMode
 +
|9527
 +
|-
 +
|DM_OpenPluginDialog_Begin
 +
|99999
 +
|
 +
|
 +
|
 +
|
 +
|}
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnDialogModeChanged(self, nDialogMode):
 +
        print('Dialog Mode Changed ~ ' + 'Dialog Mode:' + str(nDialogMode))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
 +
 
 +
==== Parameters ====
 +
:'''nDialogMode''' [IN] dialog mode - integer
 +
 
 +
=== OnUndoRedoDone ( self ) ===
 +
 
 +
Trigger an event when an iClone undo or redo action is executed.
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnUndoRedoDone(self):
 +
        print('Undo Redo Done')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
 +
 
 +
=== OnPlayed ( self ) ===
 +
 
 +
Trigger an event when the iClone timeline begins playing.
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnPlayed(self):
 +
        print('Play')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
 +
 
 +
=== OnStopped ( self ) ===
 +
 
 +
Trigger an event when the iClone timeline has stopped playing, also works with pausing.
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnStopped(self):
 +
        print('Stop')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
 +
 
 +
=== OnObjectDataChangedWithType ( self, nDataType ) ===
 +
 
 +
Trigger an event when receiving data updates on iClone objects and retrieve the object type.
 +
 
 +
==== Parameters ====
 +
:'''nDataType''' [OUT] ObjectChangedDataType
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnObjectDataChangedWithType(self, nDataType):
 +
        print('Object Data Changed:' + str(nDataType))
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>
 +
 
 +
=== OnHierarchyChanged ( self ) ===
 +
 
 +
Trigger an event when receiving updates to the heirarchy data structure. Trigger actions include Attach, Detach, ConvertToTerrain, ConvertTerrainToProp, ReachEffector, MergeSubProps.
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class REventCallbackSampleCode(RLPy.REventCallback):
 +
    def __init__(self):
 +
        RLPy.REventCallback.__init__(self)
 +
    def OnHierarchyChanged(self):
 +
        print('Hierarchy Changed')
 +
 
 +
event_callback = None
 +
def run_script():
 +
    global event_callback
 +
    event_callback = REventCallbackSampleCode()
 +
    id = RLPy.REventHandler.RegisterCallback(event_callback)
 +
</syntaxhighlight>

Revision as of 22:34, 29 April 2020

Main article: Modules.
Last modified: 04/29/2020

Description

This class provides a way to monitor iClone events and register callbacks for system events. Once an instance is created, iClone trigger events can be recieved, i.e. playback status, file read status, object creation and deletion status, etc. Note: REventCallback can not be created as a local variable, otherwise the application will crash. Errors in the callback function can also cause the application to crash without warnings, therefore one should consider using Python's try except for fool-proof implementation.

Inheritance

RCallback> REventCallback

Examples

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2    def __init__(self):
 3        RLPy.REventCallback.__init__(self)
 4    def OnTimerUpdated (self, fTime):
 5        print('Updated time:' + str(fTime))  
 6    def OnCurrentTimeChanged (self, fTime):
 7        print('Current time:' + str(fTime))      
 8    def OnBeforeLoadFile(self, nFileType):
 9        print('File type:' + str(nFileType))
10    def OnFileLoaded(self, nFileType):
11        print('File type:' + str(nFileType))
12    def OnAfterFileLoaded(self, nFileType):
13        print('File type:' + str(nFileType))
14    def OnProjectDataChanged(self, nProjectDataType):
15        print('Project Data type:' + str(nProjectDataType))
16    def OnBeforeSaveFile(self, nFileType, pProjectName):
17        print('File type:' + str(nFileType) + ', Project Data type:' + str(nProjectDataType))
18    def OnFileSaved(self, nFileType, pProjectName):
19        print('File type:' + str(nFileType) + ', Project Data type:' + str(nProjectDataType))
20    def OnObjectSelectionChanged(self):
21        print('Object Selection Changed')
22    def OnObjectDataChanged(self):
23        print('Object Data Changed')
24    def OnObjectAdded(self):
25        print('Object Added')
26    def OnObjectDeleted(self):
27        print('Object Deleted')
28    def OnDialogModeChanged(self, nDialogMode):
29        print('Dialog Mode Changed ~ ' + 'Dialog Mode:' + str(nDialogMode))
30    def OnPickedModeChanged(self, nPickMode, nPreviousPickMode):
31        print('Picked Mode Changed ~ ' + ' Pick Mode:' + str(nPickMode) + ', Previous Pick Mode:' + str(nPreviousPickMode) )
32    def OnUndoRedoDone(self):
33        print('Undo Redo Done')
34    def OnPlayed(self):
35        print('Play')
36    def OnStopped(self):
37        print('Stop')
38  
39 # register event
40 event_callback = None
41 def run_script():
42     # register event
43     global event_callback
44     event_callback = REventCallbackSampleCode()
45     id = RLPy.REventHandler.RegisterCallback(event_callback)

Member Functions

OnTimerUpdated ( self, fTime )

Trigger events while the iClone timeline plays back and return the current time during playback.

Parameters

fTime [IN] current time (ms) - float
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnTimerUpdated (self, fTime):
 5         print('Updated time:' + str(fTime))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnCurrentTimeChanged ( self, fTime )

Trigger an event everytime a change has been applied to the iClone timeline and return the current time. For example, updates are triggered when the timeline is stopped and while scrubbing the timeline, but playing the timeline does not.

Parameters

fTime [IN] current time - float
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnCurrentTimeChanged (self, fTime):
 5         print('Current time:' + str(fTime))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnBeforeLoadFile ( self,nFileType )

Trigger an event before an object is read from file and return the object's type.

Parameters

nFileType [IN] file type - integer
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnBeforeLoadFile(self, nFileType):
 5         print('File type:' + str(nFileType))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnFileLoaded ( self, nFileType )

Trigger an event when an object is read from file and return the object's type.

Parameters
nFileType [IN] file type - integer
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnFileLoaded(self, nFileType):
 5         print('File type:' + str(nFileType))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnAfterFileLoaded ( self, nFileType )

Trigger an event after iClone has finished reading an object from file and return the object's type.

Parameters
nFileType [IN] file type - integer
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnAfterFileLoaded(self, nFileType):
 5         print('File type:' + str(nFileType))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnProjectDataChanged ( self, nProjectDataType )

Trigger an event when the iClone project's settings change and return the settings type.

Parameters

nProjectDataType [IN] project data type - integer
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnProjectDataChanged(self, nProjectDataType):
 5         print('Project Data type:' + str(nProjectDataType))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnBeforeSaveFile ( self, nFileTypep, strProjectName )

Trigger an event right before iClone saves a file and return the file path.

Parameters

nFileType [IN] file type - integer
strProjectName [IN] project name - string
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnBeforeSaveFile(self, nFileType, strProjectName):
 5         print('File type:' + str(nFileType) + ', Project Name:' + str(pProjectName))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnFileSaved ( self, nFileType, strProjectName )

Trigger an event when iClone has succesfully saved a file and return the file path.

Parameters

nFileType [IN] file type - integer
strProjectName [IN] project name - string
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnFileSaved(self, nFileType, strProjectName):
 5         print('File type:' + str(nFileType) + ', Project Name:' + str(pProjectName))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnObjectSelectionChanged ( self )

Trigger an event when an iClone object is selection. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnObjectSelectionChanged(self):
 5         print('Object Selection Changed')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnObjectDataChanged ( self )

Trigger an event when an iClone object data has changed (ObjectChangedDataType).

Enum.ObjectChangedDataType

Enum Code Enum Code Enum Code
None 0 Transform 1 Attribute 2
Physics 4 Material 8 Substance 16
NodeType 32 Replace 64 Reach 128
Name 256 ShapingMorph 512 ReplaceAvatar 1024
EditMeshDone 2048 CustomMorphWeightChange 4096 CustomMorph 8192
PopcornFx 16384 SetMainMesh 32768 MotionOffset 65536
Motion 131072 MeshSmoothSetting 262144 CreateLodData 524288
Appearance 1048576 SkinSubstance 2097152 Texture 4194304
ShaderType 8388608 Wrinkle 16777216 MaterialTexture 4194312
MaterialAll 12582920 
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnObjectDataChanged(self):
 5         print('Object Data Changed')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnObjectAdded ( self )

Trigger an event when an iClone object is added to the scene. Currently triggers on the creation of Lights, Cameras, Paths, and duplication of any type of object. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnObjectAdded(self):
 5         print('Object Added')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnObjectDeleted ( self )

Trigger an event when an iClone object is deleted. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnObjectDeleted(self):
 5         print('Object Deleted')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnDialogModeChanged ( self, nDialogMode )

Trigger an event when an iClone window related function is called and return the window's dialog mode (DialogModeType).

Enum.DialogMode

Enum Code Enum Code Enum Code
DM_None 0 DM_PivotEdit 1 DM_DirectPuppet 2
DM_MotionPuppet 3 DM_DevicePuppet 4 DM_PropPuppet 5
DM_MographEdit 6 DM_AvatarProport 7 DM_Duplicate 8
DM_IkEditing 9 DM_ReachTarget 10 DM_BoneSetting 11
DM_QuickLight 12 DM_FacePuppet 13 DM_FaceKey 14
DM_FacialFeature 15 DM_FacialDeform 16 DM_FacialMocap 17
DM_ClipMotionPuppet 18 DM_PhysicsCenterOfMass 19 DM_PhysicsCollisionShape 20
DM_CreateFace 21 DM_TTS 22 DM_GrassEditing 23
DM_TreeEditing 24 DM_PhysicsMaterial 25 DM_ClothFitting 26
DM_VisemeSmooth 27 DM_CCSubstanceHighPerformance 28 DM_NoitomMocapPuppet 29
DM_CreateSlider 30 DM_FloorContact 31 DM_EditFace 32
DM_EditVertex 33 DM_EditElement 34 DM_IblEditting 35
DM_MorphAnimation 36 DM_EditSkinWeightByVertex 37 DM_EditSkinWeightByBrush 38
DM_EditSkinWeightRotateBone 39 DM_EditSkinWeightSelectBone 40 DM_AdjustTPose 41
DM_FkEditing 42 DM_EditPartialConformByVertex 43 DM_EditPartialConformByElement 44
DM_EditPartialConformByBrush 45 DM_EditNormal 46 DM_OptimizeMesh_All 47
DM_OptimizeMesh_Select 48 DM_OptimizeMesh_Element 49 DM_EditHighHeel 50
DM_EditMeshByBrush 51 DM_ConvertToAccessory 52 DM_SkinWeightTemplate 53
DM_SelectGameBaseUV 54 DM_ContentHideMesh 55 DM_ContentHideBodyMeshByFace 56
DM_ContentHideBodyMeshByBrush 57 DM_PaintMaskByBrush 58 DM_SkinSubstance 59
DM_CC1Substance 60 DM_FacialCalibration 61 DM_PluginCustomMode 9527
DM_OpenPluginDialog_Begin 99999 
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnDialogModeChanged(self, nDialogMode):
 5         print('Dialog Mode Changed ~ ' + 'Dialog Mode:' + str(nDialogMode))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

Parameters

nDialogMode [IN] dialog mode - integer

OnUndoRedoDone ( self )

Trigger an event when an iClone undo or redo action is executed. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnUndoRedoDone(self):
 5         print('Undo Redo Done')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnPlayed ( self )

Trigger an event when the iClone timeline begins playing. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnPlayed(self):
 5         print('Play')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnStopped ( self )

Trigger an event when the iClone timeline has stopped playing, also works with pausing. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnStopped(self):
 5         print('Stop')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnObjectDataChangedWithType ( self, nDataType )

Trigger an event when receiving data updates on iClone objects and retrieve the object type.

Parameters

nDataType [OUT] ObjectChangedDataType
 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnObjectDataChangedWithType(self, nDataType):
 5         print('Object Data Changed:' + str(nDataType))
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)

OnHierarchyChanged ( self )

Trigger an event when receiving updates to the heirarchy data structure. Trigger actions include Attach, Detach, ConvertToTerrain, ConvertTerrainToProp, ReachEffector, MergeSubProps. 

 1 class REventCallbackSampleCode(RLPy.REventCallback):
 2     def __init__(self):
 3         RLPy.REventCallback.__init__(self)
 4     def OnHierarchyChanged(self):
 5         print('Hierarchy Changed')
 6 
 7 event_callback = None
 8 def run_script():
 9     global event_callback
10     event_callback = REventCallbackSampleCode()
11     id = RLPy.REventHandler.RegisterCallback(event_callback)
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_REventCallback&oldid=4588"