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

From Reallusion Wiki!
Jump to: navigation, search
m
m
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{TOC}}
 
{{TOC}}
 
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
 
{{Parent|IC_Python_API:RL_Python_Modules|Modules}}
−
== Detailed Description ==
+
{{last_modified}}
−
This class provides repetitive and single-shot timers.
+
 
−
<syntaxhighlight lang="Python">
+
== Description ==
 +
 
 +
This class is used to setup a timed event.  Use [[#SetInterval ( self, nMSec )|SetInterval]] and [[#GetInterval ( self )|GetInterval]] to access and set the time interval.  Use [[#SetSingleShot ( self, bSingleShot )|SetSingleShot]] and [[#IsSingleShot ( self )|IsSingleShot]] to access and set the trigger state (single shot or repeatly trigger). Use [[#RPyTimer.Start ( self )|Start]], [[#Stop ( self )|Stop]], and [[#IsRunning ( self )|IsRunning]] to control the execution of the Timer.
 +
 
 +
In order to receive trigger events, first create a new class and inherit from [[IC_Python_API:RLPy_RPyTimerCallback|RPyTimerCallback]] and register with [[#RegisterPyTimerCallback ( self, pCallback )|RegisterPyTimerCallback]]. When not in use, you can unregister the timer event with [[#UnregisterPyTimerCallback ( self, pCallback )|UnRegisterPyTimerCallback]].
 +
 
 +
See Also: [[IC_Python_API:RLPy_RPyTimerCallback|RPyTimerCallback]].
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 
class MyPyTimerCallback(RLPy.RPyTimerCallback):
 
class MyPyTimerCallback(RLPy.RPyTimerCallback):
−
  def __init__(self):
+
  def __init__(self):
−
   RLPy.RPyTimerCallback.__init__(self)
+
      RLPy.RPyTimerCallback.__init__(self)
 +
  def Timeout(self):
 +
      print ("timeout")
  
−
  def Timeout(self):
+
# Set Timer
−
   print ("timeout")
+
−
 
+
−
# set timer
+
 
timer = RLPy.RPyTimer()
 
timer = RLPy.RPyTimer()
 
timer.SetInterval(100)
 
timer.SetInterval(100)
 
timer.SetSingleShot(True)
 
timer.SetSingleShot(True)
−
print(timer.GetInterval()) # 100
+
print(timer.GetInterval()) # 100
−
# register callback
+
# Register the callback
 
timer_callback = MyPyTimerCallback()
 
timer_callback = MyPyTimerCallback()
 
timer.RegisterPyTimerCallback(timer_callback)
 
timer.RegisterPyTimerCallback(timer_callback)
−
# start timer
+
# Start the Timer
 
timer.Start()
 
timer.Start()
−
...
+
# Unregister the callback
−
# unregister callback
+
 
timer.UnregisterPyTimerCallback()
 
timer.UnregisterPyTimerCallback()
−
 
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
 
== Member Functions ==
 
== Member Functions ==
−
=== GetInterval ===
+
 
−
<syntaxhighlight lang="Python">
+
=== GetInterval ( self ) ===
−
RLPy.RPyTimer.GetInterval ( self )
+
 
−
</syntaxhighlight>
+
Get the time interval for the event triggered by the timer in milliseconds. The default interval value is 0, which will cause the timer to start triggering immediately after [[#Start ( self )|Start]].
−
Get timer interval value.
+
 
 +
See Also: [[#SetInterval ( self, nMSec )|SetInterval]]
 +
 
 
==== Returns ====
 
==== Returns ====
−
<div style="margin-left: 2em;">
+
:Timer interval ( milisecond ) - int
−
Timer interval in milliseconds - int
+
 
−
</div>
+
<syntaxhighlight lang="python" line='line'>
−
-----
+
timer = RLPy.RPyTimer()
−
=== IsRunning ===
+
timer.SetInterval(1000)
−
<syntaxhighlight lang="Python">
+
print (timer.GetInterval()) # 1000
−
RLPy.RPyTimer.IsRunning ( self )
+
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Check if the timer is running.
+
 
 +
=== IsRunning ( self )  ===
 +
 
 +
Check if the Timer is currently running.
 +
 
 +
See Also: [[#Start ( self )|Start]], [[#Stop ( self )|Stop]]
 +
 
 
==== Returns ====
 
==== Returns ====
−
<div style="margin-left: 2em;">
+
:'''True''' if the timer is currenlty running, else '''False''' - bool
−
True if the timer is running; otherwise returns false - bool
+
 
−
</div>
+
<syntaxhighlight lang="python" line='line'>
−
-----
+
timer = RLPy.RPyTimer()
−
=== IsSingleShot ===
+
timer.Start()
−
<syntaxhighlight lang="Python">
+
print (timer.IsRunning()) # True
−
RLPy.RPyTimer.IsSingleShot ( self )
+
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Get timer single shot status.
+
 
 +
=== IsSingleShot ( self ) ===
 +
 
 +
Get the Timer trigger settings.  Return '''True''' if the trigger is single-shot and '''False''' for repeat trigger.
 +
 
 +
See Also: [[#SetSingleShot ( self, bSingleShot )|SetSingleShot]]
 +
 
 
==== Returns ====
 
==== Returns ====
−
<div style="margin-left: 2em;">
+
:'''True''' if trigger is single-shot, else '''False''' - bool
−
Is timer single shot or not - bool
+
 
−
</div>
+
<syntaxhighlight lang="python" line='line'>
−
-----
+
timer = RLPy.RPyTimer()
−
=== RegisterPyTimerCallback ===
+
timer.SetSingleShot(True)
−
<syntaxhighlight lang="Python">
+
print (timer.IsSingleShot()) # True
−
RLPy.RPyTimer.RegisterPyTimerCallback ( self, pCallback )
+
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Register timer event callback.
+
 
 +
=== RegisterPyTimerCallback ( self, pCallback ) ===
 +
 
 +
Register a Callback object with the Timer.
 +
 
 +
See Also: [[#UnregisterPyTimerCallback ( self, pCallback )|UnregisterPyTimerCallback]]
 +
 
 
==== Parameters ====
 
==== Parameters ====
−
<div style="margin-left: 2em;">
+
:'''pCallback''' [IN] Callback object inherited from [[IC_Python_API:RLPy_RPyTimerCallback|RPyTimerCallback]]- [[IC_Python_API:RLPy_RPyTimerCallback|RPyTimerCallback]]
−
'''pCallback''' [IN] pointer of timer callback object - RLPy.RPyTimerCallback
+
 
−
</div>
+
<syntaxhighlight lang="python" line='line'>
−
-----
+
class MyPyTimerCallback(RLPy.RPyTimerCallback):
−
=== SetInterval ===
+
  def __init__(self):
−
<syntaxhighlight lang="Python">
+
      RLPy.RPyTimerCallback.__init__(self)
−
RLPy.RPyTimer.SetInterval ( self, nMSec )
+
  def Timeout(self):
 +
      print ("timeout")
 +
 +
timer = RLPy.RPyTimer()
 +
timer_callback = MyPyTimerCallback()
 +
timer.RegisterPyTimerCallback(timer_callback)
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Set timer interval value.
+
 
 +
=== UnregisterPyTimerCallback ( self, pCallback ) ===
 +
 
 +
Unregister the Callback object for the Timer.
 +
 
 +
See Also: [[#RegisterPyTimerCallback ( self, pCallback )|RegisterPyTimerCallback]]
 +
 
 +
<syntaxhighlight lang="python" line='line'>
 +
class MyPyTimerCallback(RLPy.RPyTimerCallback):
 +
  def __init__(self):
 +
      RLPy.RPyTimerCallback.__init__(self)
 +
  def Timeout(self):
 +
      print ("timeout")
 +
 +
timer = RLPy.RPyTimer()
 +
timer_callback = MyPyTimerCallback()
 +
timer.RegisterPyTimerCallback(timer_callback)
 +
# unregister callback
 +
timer.UnregisterPyTimerCallback()
 +
</syntaxhighlight>
 +
 
 +
=== SetInterval ( self, nMSec ) ===
 +
 
 +
Set the Timer trigger interval in milliseconds.  The default interval value is 0, which will cause the timer to start triggering immediately after '''Start()'''.
 +
 
 +
See Also: [[#GetInterval ( self )|GetInterval]]
 +
 
 
==== Parameters ====
 
==== Parameters ====
−
<div style="margin-left: 2em;">
+
:'''nMSec''' [IN] Timer interval in milliseconds - int
−
'''nMSec''' [IN] timer interval in milliseconds - int
+
 
−
</div>
+
<syntaxhighlight lang="python" line='line'>
−
-----
+
timer = RLPy.RPyTimer()
−
=== SetSingleShot ===
+
timer.SetInterval(1000)
−
<syntaxhighlight lang="Python">
+
print (timer.GetInterval()) # 1000
−
RLPy.RPyTimer.SetSingleShot ( self, bSingleShot )
+
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Set timer single shot status.
+
 
 +
=== SetSingleShot ( self, bSingleShot ) ===
 +
 
 +
Set the Timer trigger state.  Single-shot will only fire off the trigger event once, otherwise the event will fire off according to the Timer interval.  The default setting is '''False'''.
 +
 
 +
See Also: [[#IsSingleShot ( self )|IsSingleShot]]
 +
 
 
==== Parameters ====
 
==== Parameters ====
−
<div style="margin-left: 2em;">
+
:'''bSingleShot''' [IN] Set to single-shot triggering - bool
−
'''bSingleShot''' [IN] timer single shot status - bool
+
 
−
</div>
+
<syntaxhighlight lang="python" line='line'>
−
-----
+
timer = RLPy.RPyTimer()
−
=== Start ===
+
timer.SetSingleShot(True)
−
<syntaxhighlight lang="Python">
+
print (timer.IsSingleShot()) # True
−
RLPy.RPyTimer.Start ( self )
+
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Start the timer.
+
 
−
Starts or restarts the timer. If the timer is already running, it will be stopped and restarted.
+
=== Start ( self ) ===
−
-----
+
 
−
=== Stop ===
+
Start or restart the Timer. If the Timer is already running, then this operation will stop the Timer first then start it again.  If the trigger is set to single-shot then the Timer event will activate one more time.
−
<syntaxhighlight lang="Python">
+
 
−
RLPy.RPyTimer.Stop ( self )
+
<syntaxhighlight lang="python" line='line'>
 +
timer = RLPy.RPyTimer()
 +
timer.SetInterval(100)
 +
timer.Start()
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Stop the timer.
+
 
−
-----
+
=== Stop ( self ) ===
−
=== UnregisterPyTimerCallback ===
+
 
−
<syntaxhighlight lang="Python">
+
Stop the Timer.
−
RLPy.RPyTimer.UnregisterPyTimerCallback ( self )
+
 
 +
<syntaxhighlight lang="python" line='line'>
 +
timer = RLPy.RPyTimer()
 +
timer.SetInterval(100)
 +
timer.Start()
 +
# do something
 +
timer.Stop()
 
</syntaxhighlight>
 
</syntaxhighlight>
−
Unregister timer event callback.
 

Latest revision as of 01:03, 14 April 2020

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

Description

This class is used to setup a timed event. Use SetInterval and GetInterval to access and set the time interval. Use SetSingleShot and IsSingleShot to access and set the trigger state (single shot or repeatly trigger). Use Start, Stop, and IsRunning to control the execution of the Timer.

In order to receive trigger events, first create a new class and inherit from RPyTimerCallback and register with RegisterPyTimerCallback. When not in use, you can unregister the timer event with UnRegisterPyTimerCallback.

See Also: RPyTimerCallback. 

 1 class MyPyTimerCallback(RLPy.RPyTimerCallback):
 2    def __init__(self):
 3        RLPy.RPyTimerCallback.__init__(self)
 4    def Timeout(self):
 5        print ("timeout")
 6 
 7 # Set Timer
 8 timer = RLPy.RPyTimer()
 9 timer.SetInterval(100)
10 timer.SetSingleShot(True)
11 print(timer.GetInterval())  # 100
12 # Register the callback
13 timer_callback = MyPyTimerCallback()
14 timer.RegisterPyTimerCallback(timer_callback)
15 # Start the Timer
16 timer.Start()
17 # Unregister the callback
18 timer.UnregisterPyTimerCallback()

Member Functions

GetInterval ( self )

Get the time interval for the event triggered by the timer in milliseconds. The default interval value is 0, which will cause the timer to start triggering immediately after Start.

See Also: SetInterval

Returns

Timer interval ( milisecond ) - int
1 timer = RLPy.RPyTimer()
2 timer.SetInterval(1000)
3 print (timer.GetInterval())	# 1000

IsRunning ( self )

Check if the Timer is currently running.

See Also: Start, Stop

Returns

True if the timer is currenlty running, else False - bool
1 timer = RLPy.RPyTimer()
2 timer.Start()
3 print (timer.IsRunning())	# True

IsSingleShot ( self )

Get the Timer trigger settings. Return True if the trigger is single-shot and False for repeat trigger.

See Also: SetSingleShot

Returns

True if trigger is single-shot, else False - bool
1 timer = RLPy.RPyTimer()
2 timer.SetSingleShot(True)
3 print (timer.IsSingleShot())	# True

RegisterPyTimerCallback ( self, pCallback )

Register a Callback object with the Timer.

See Also: UnregisterPyTimerCallback

Parameters

pCallback [IN] Callback object inherited from RPyTimerCallback- RPyTimerCallback
1 class MyPyTimerCallback(RLPy.RPyTimerCallback):
2    def __init__(self):
3        RLPy.RPyTimerCallback.__init__(self)
4    def Timeout(self):
5        print ("timeout")
6  
7 timer = RLPy.RPyTimer()
8 timer_callback = MyPyTimerCallback()
9 timer.RegisterPyTimerCallback(timer_callback)

UnregisterPyTimerCallback ( self, pCallback )

Unregister the Callback object for the Timer.

See Also: RegisterPyTimerCallback 

 1 class MyPyTimerCallback(RLPy.RPyTimerCallback):
 2    def __init__(self):
 3        RLPy.RPyTimerCallback.__init__(self)
 4    def Timeout(self):
 5        print ("timeout")
 6  
 7 timer = RLPy.RPyTimer()
 8 timer_callback = MyPyTimerCallback()
 9 timer.RegisterPyTimerCallback(timer_callback)
10 # unregister callback
11 timer.UnregisterPyTimerCallback()

SetInterval ( self, nMSec )

Set the Timer trigger interval in milliseconds. The default interval value is 0, which will cause the timer to start triggering immediately after Start().

See Also: GetInterval

Parameters

nMSec [IN] Timer interval in milliseconds - int
1 timer = RLPy.RPyTimer()
2 timer.SetInterval(1000)
3 print (timer.GetInterval())	# 1000

SetSingleShot ( self, bSingleShot )

Set the Timer trigger state. Single-shot will only fire off the trigger event once, otherwise the event will fire off according to the Timer interval. The default setting is False.

See Also: IsSingleShot

Parameters

bSingleShot [IN] Set to single-shot triggering - bool
1 timer = RLPy.RPyTimer()
2 timer.SetSingleShot(True)
3 print (timer.IsSingleShot())	# True

Start ( self )

Start or restart the Timer. If the Timer is already running, then this operation will stop the Timer first then start it again. If the trigger is set to single-shot then the Timer event will activate one more time. 

1 timer = RLPy.RPyTimer()
2 timer.SetInterval(100)
3 timer.Start()

Stop ( self )

Stop the Timer. 

1 timer = RLPy.RPyTimer()
2 timer.SetInterval(100)
3 timer.Start()
4 # do something
5 timer.Stop()
Retrieved from "https://wiki.reallusion.com/index.php?title=IC_Python_API:RLPy_RPyTimer&oldid=4525"