Time data structure. More...
#include <pyfbsdk_generated.h>
Public Member Functions | |
FBTime (long pTime=0) | |
FBTime (int pHour, int pMinute, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Constructor. More... | |
long | Get () |
Get time value (long) More... | |
long | Get () |
Get time value (long) More... | |
long | GetFrame (FBTimeMode pTimeMode=kFBTimeModeDefault) |
Get the frame count. More... | |
long | GetMilliSeconds () |
Get milliseconds for time. More... | |
float | GetSecondDouble () |
Get seconds as double. More... | |
str | GetTimeString (FBTimeMode pMode=kFBTimeModeDefault, ETimeFormats pFormat=eDefaultFormat) |
Get time as a string. More... | |
Set (long pTime) | |
Set time value from a long. More... | |
SetFrame (long pFrames, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Set time in frame format. More... | |
SetMilliSeconds (long pMilliSeconds) | |
Set milliseconds time. More... | |
SetSecondDouble (float pTime) | |
Set seconds from double. More... | |
SetTime (int pHour, int pMinute=0, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Set time (from separate values) More... | |
SetTimeString (str pTime) | |
Set time from string. More... | |
Public Attributes | |
FBTime | Infinity |
Time constant: Infinity, the largest time value. More... | |
FBTime | MinusInfinity |
Time constant: Minus Infinity, the lowest negative time value. More... | |
FBTime | OneHour |
Time constant: One Hour. More... | |
FBTime | OneMinute |
Time constant: One Minute. More... | |
FBTime | OneSecond |
Time constant: One Second. More... | |
FBTime | Zero |
Time constant: Zero. More... | |
Time data structure.
See samples: FBTime.py, CameraSwitcher.py, ExportAnimationLibrary.py, StartKeysAtCurrentTime.py.
FBTime | ( | int | pHour, |
int | pMinute, | ||
int | pSecond = 0 , |
||
int | pFrame = 0 , |
||
int | pField = 0 , |
||
FBTimeMode | pTimeMode = kFBTimeModeDefault |
||
) |
Constructor.
pHour | Hour value. |
pMinute | Minute value. |
pSecond | Second value. |
pFrame | Frame value. |
pField | Field value. |
pTimeMode | Time mode(default=kFBTimeModeDefault). |
long Get | ( | ) |
Get time value (long)
long Get | ( | ) |
Get time value (long)
long GetFrame | ( | FBTimeMode | pTimeMode = kFBTimeModeDefault | ) |
Get the frame count.
With this function, it is possible to obtain the cumulative and local frame counts.
pTimeMode | Time mode to get the constant (default is kFBTimeModeDefault). |
long GetMilliSeconds | ( | ) |
Get milliseconds for time.
float GetSecondDouble | ( | ) |
Get seconds as double.
str GetTimeString | ( | FBTimeMode | pMode = kFBTimeModeDefault , |
ETimeFormats | pFormat = eDefaultFormat |
||
) |
Get time as a string.
pMode | Time mode (default=kFBTimeModeDefault) to use (call FBSystem().GetTransportFps() to the the current UI displayed mode). |
pFormat | Format to use for the returned string(default=FBTime::eDefaultFormat). |
Set | ( | long | pTime | ) |
Set time value from a long.
pTime | Time value to set. |
SetFrame | ( | long | pFrames, |
FBTimeMode | pTimeMode = kFBTimeModeDefault |
||
) |
Set time in frame format.
pFrames | The number of frames. |
pTimeMode | The time mode identifier which will dictate the extraction algorithm. |
SetMilliSeconds | ( | long | pMilliSeconds | ) |
Set milliseconds time.
pMilliSeconds | MilliSeconds value. |
SetSecondDouble | ( | float | pTime | ) |
Set seconds from double.
pTime | Time to set seconds from. |
SetTime | ( | int | pHour, |
int | pMinute = 0 , |
||
int | pSecond = 0 , |
||
int | pFrame = 0 , |
||
int | pField = 0 , |
||
FBTimeMode | pTimeMode = kFBTimeModeDefault |
||
) |
Set time (from separate values)
pHour | Hour value. |
pMinute | Minute value(default=0). |
pSecond | Second value(default=0). |
pFrame | Frame value(default=0). |
pField | Field value(default=0). |
pTimeMode | Time mode to get time as(default=kFBTimeModeDefault). |
SetTimeString | ( | str | pTime | ) |
Set time from string.
pTime | String to set time from. |
FBTime Infinity |
Time constant: Infinity, the largest time value.
FBTime MinusInfinity |
Time constant: Minus Infinity, the lowest negative time value.
FBTime OneHour |
Time constant: One Hour.
FBTime OneMinute |
Time constant: One Minute.
FBTime OneSecond |
Time constant: One Second.
FBTime Zero |
Time constant: Zero.