View source for IC 8 Python API:Dealing With Custom FPS

{{TOC}}

{{Parent|IC_8_Python_API|iC8 Python API}}

iClone 8 supports custom FPS settings that users can adjust. The FPS value can be changed to suit the project in the '''Project''' settings (as shown below). In order to support custom FPS, iClone 8 core has made many corresponding modifications.

[[File:Ic8_python_api_dealing_with_custom_fps_01.png]]

'''RTime''' is the class used by iClone to represent time. In order to realize the function of customizing FPS, iClone 8 adjusts the core 'tick value from "1000" to "6000", and the value of 1 tick equals 1/6000 seconds or 0.16666666 milliseconds.

Therefore in iClone 8, '''RTime''' is rewritten with the addition of two new classes: '''RTick''' and '''RFps''':

<syntaxhighlight lang="python" line='line'>
time = RLPy.RTime.FromValue(6000)  # create RTime from value
print( time.ToInt() )              # get value from RTime
</syntaxhighlight>

'''RFps''' defines the current FPS supported by iClone (for example: '''RFps.Fps24''', '''RFps.Fps60''', '''RFps.Fps120'''..). When calling '''RLPy.RGlobal.GetFps()''' to get the FPS setting of the current Project, the function will also return the '''RFps''' object. Therefore, you will need to use the following code when you want to convert between the frame index and '''RTime''':

<syntaxhighlight lang="python" line='line'>
fps = RLPy.RGlobal.GetFps()      # return RFps
# convert to frame index
frame_index = RLPy.GetFrameIndex(current_time, fps)             
# convert to RTime   
current_time = RLPy.IndexedFrameTime(frame_index, fps)      
# time on frame
frame_time = RLPy.RGlobal.GetFps().GetFrameTime( current_time ) 
</syntaxhighlight>

'''RTick''' provides many time unit conversion functions, allowing you to convert from different time units to '''RTime''', such as:

<syntaxhighlight lang="python" line='line'>
time1 = RLPy.RTick.FromMilliSecond(2000)    # convert from millisecond
time2 = RLPy.RTick.FromSecond(2)            # convert from second
</syntaxhighlight>

In addition, when calling '''Control > AddKey()''' function, the FPS parameter is removed in iClone 8:

<syntaxhighlight lang="python" line='line'>
control = clone.GetControl("Transform")
control.AddKey(key)
</syntaxhighlight>