Time data structure.
Public Member Functions | |
FBTime | operator= (FBTime pTime) |
Overloaded assignment operators with FBTime objects. | |
FBTime | operator+= (FBTime pTime) |
FBTime | operator-= (FBTime pTime) |
FBTime | operator*= (FBTime pTime) |
FBTime | operator/= (FBTime pTime) |
FBTime | operator= (float pConstant) |
Overloaded assignment operators with constants. | |
FBTime | operator+= (float pConstant) |
FBTime | operator-= (float pConstant) |
FBTime | operator*= (float pConstant) |
FBTime | operator/= (float pConstant) |
FBTime | operator- (FBTime pTime) |
Overloaded arithmetic operators with FBTime objects. | |
FBTime | operator+ (FBTime pTime) |
FBTime | operator/ (FBTime pTime) |
FBTime | operator* (FBTime pTime) |
FBTime | operator- (float pConstant) |
Overloaded arithmetic operators with constants. | |
FBTime | operator+ (float pConstant) |
FBTime | operator/ (float pConstant) |
FBTime | operator* (float pConstant) |
bool | operator== (FBTime pTime) |
Overloaded comparison operators. | |
bool | operator!= (FBTime pTime) |
bool | operator>= (FBTime pTime) |
bool | operator<= (FBTime pTime) |
bool | operator> (FBTime pTime) |
bool | operator< (FBTime pTime) |
__init__ (long pTime=0) | |
__init__ (int pHour, int pMinute, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Constructor. | |
str | GetTimeString (FBTimeMode pMode=kFBTimeModeDefault, ETimeFormats pFormat=eDefaultFormat) |
Get time as a string. | |
SetTimeString (str pTime) | |
Set time from string. | |
bool | GetTime (int pHour, int pMinute, int pSecond, int pFrame, int pField, int pMilliSecond, FBTimeMode pTimeMode=kFBTimeModeDefault) |
Get time (filling separate values). | |
long | GetMilliSeconds () |
Get milliseconds for time. | |
SetMilliSeconds (long pMilliSeconds) | |
Set milliseconds time. | |
long | Get () |
Get time value (long). | |
long | Get () |
Get time value (long). | |
Set (long pTime) | |
Set time value from a long. | |
float | GetSecondDouble () |
Get seconds as double. | |
SetSecondDouble (float pTime) | |
Set seconds from double. | |
SetTime (int pHour, int pMinute=0, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Set time (from separate values). | |
long | GetFrame (FBTimeMode pTimeMode=kFBTimeModeDefault) |
Get the frame count. | |
SetFrame (long pFrames, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Set time in frame format. | |
Public Attributes | |
FBTime | Infinity |
Time constant: Infinity, the largest time value. | |
FBTime | MinusInfinity |
Time constant: Minus Infinity, the lowest negative time value. | |
FBTime | Zero |
Time constant: Zero. | |
FBTime | Epsilon |
Time constant: Epsilon, the smallest time increment. | |
FBTime | OneSecond |
Time constant: One Second. | |
FBTime | OneMinute |
Time constant: One Minute. | |
FBTime | OneHour |
Time constant: One Hour. |
Overloaded assignment operators with FBTime objects.
pTime | Time to assign with operator. |
Overloaded assignment operators with constants.
pConstant | Time to assign with operator. |
Overloaded arithmetic operators with constants.
pConstant | Double constant to add to time. |
Overloaded comparison operators.
pTime | Time to compare with. |
__init__ | ( | long | pTime = 0 | ) |
__init__ | ( | 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). |
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). |
SetTimeString | ( | str | pTime | ) |
bool GetTime | ( | int | pHour, |
int | pMinute, | ||
int | pSecond, | ||
int | pFrame, | ||
int | pField, | ||
int | pMilliSecond, | ||
FBTimeMode | pTimeMode = kFBTimeModeDefault |
||
) |
Get time (filling separate values).
pHour | Hour value. |
pMinute | Minute value. |
pSecond | Second value. |
pFrame | Frame value. |
pField | Field value. |
pMilliSecond | MilliSecond value. |
pTimeMode | Time mode to get time as. |
long GetMilliSeconds | ( | ) |
SetMilliSeconds | ( | long | pMilliSeconds | ) |
long Get | ( | ) |
long Get | ( | ) |
Set | ( | long | pTime | ) |
float GetSecondDouble | ( | ) |
SetSecondDouble | ( | float | pTime | ) |
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). |
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). |
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. |
Time constant: Infinity, the largest time value.
Time constant: Minus Infinity, the lowest negative time value.
Time constant: Zero.
Time constant: Epsilon, the smallest time increment.
Time constant: One Second.
Time constant: One Minute.
Time constant: One Hour.