View source for IC Python API:RLPy RTime

{{TOC}}
{{Parent|IC_Python_API:RL_Python_Modules#System|System Module}}

Class in RLPy / Inherits from: _object

== Description ==

This class is used to hold and manipulate timing information.

Time is stored internally in system as milliseconds. Most API methods that require or return timing information do so through variables of this type. This class also provide methods to convert between Frame and RTime, such as GetFrameIndex() and IndexedFrameTime(). Use of GetFrameTime() can ensure that RTime is on the correct frame. 

== Member Functions ==

=== GetFrameIndex ===

{{Input|def RLPy.RTime.GetFrameIndex(kTime, nFps)}}

Convert the current time to frame index.  Since iClone is 60 frames per second, the return value is usually the time in seconds times 60.

The following example gives the frame index at the 3 second mark.

{{Code|<nowiki>
import RLPy

#create a time object of 3 seconds
time = RLPy.RTime(3000)

#print the frame index at the 3 second mark: 180
print(RLPy.RTime.GetFrameIndex(time, RLPy.RGlobal.GetFps()))
</nowiki>}}

=== GetFrameTime ===

{{Input|def RLPy.RTime.GetFrameTime(kTime,nFps)}}

Deduce the frame time from a time object.

The RTime object may not give a time that perfectly matches a frame.  Call this function to get the closest frame time for a RTime object - not to be confused with frame index.

The following code retrieves the frame accurate time from a given time value.

{{Code|<nowiki>
import RLPy

#Construct time object that does not align perfectly with a frame.
time = RLPy.RTime(3005)

#Derive the nearest frame time from the RTime object.
frame_time = RLPy.RTime.GetFrameTime(time, RLPy.RGlobal.GetFps())

#Print the frame time: 3000
print(frame_time.GetValue())      
</nowiki>
}}

===IndexedFrameTime===

{{Input|
def RLPy.RTime.IndexedFrameTime(nFrameindex,nFps)
}}

Get the frame time from the frame index. 

Since iClone runs 60 frames per second, the resultant time in milliseconds is the usually the frame count divided by 60 times 1000.

{{Code|<nowiki>
import RLPy

#Derive the frame time from the frame index: 3000 (ms)
time = RLPy.RTime.IndexedFrameTime(180, RLPy.RGlobal.GetFps())
print(time.GetValue())
</nowiki>}}

===GetValue===

{{Input|
def RLPy.RTime.GetValue(self)
}}

Get the time in milliseconds for this RTime object.

The following example fetches the current frame time in milliseconds.  The current frame time is indicated by the position of your play-head in the timeline.

{{Code|<nowiki>
import RLPy

#Print the current frame time 
time = RLPy.RGlobal.GetTime()
print(time.GetValue())
</nowiki>}}