FBTime Class Reference


Detailed Description

List of all members.

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.

Member Function Documentation

FBTime operator= ( FBTime  pTime)

Overloaded assignment operators with FBTime objects.

Parameters:
pTimeTime to assign with operator.
Returns:
Resulting time from operation.
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.

Parameters:
pConstantTime to assign with operator.
Returns:
Resulting time from operation.
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.

Parameters:
pTimeTime to use in operation.
Returns:
Result in FBTime data.
FBTime operator+ ( FBTime  pTime)
FBTime operator/ ( FBTime  pTime)
FBTime operator* ( FBTime  pTime)
FBTime operator- ( float  pConstant)

Overloaded arithmetic operators with constants.

Parameters:
pConstantDouble constant to add to time.
Returns:
Result in FBTime data.
FBTime operator+ ( float  pConstant)
FBTime operator/ ( float  pConstant)
FBTime operator* ( float  pConstant)
bool operator== ( FBTime  pTime)

Overloaded comparison operators.

Parameters:
pTimeTime to compare with.
Returns:
Result of comparison.
bool operator!= ( FBTime  pTime)
bool operator>= ( FBTime  pTime)
bool operator<= ( FBTime  pTime)
bool operator> ( FBTime  pTime)
bool operator< ( FBTime  pTime)
__init__ ( int  pHour,
int  pMinute,
int  pSecond = 0,
int  pFrame = 0,
int  pField = 0,
FBTimeMode  pTimeMode = kFBTimeModeDefault 
)

Constructor.

Parameters:
pHourHour value.
pMinuteMinute value.
pSecondSecond value.
pFrameFrame value.
pFieldField value.
pTimeModeTime mode(default=kFBTimeModeDefault).
Examples
Tasks/ExportAnimationLibrary.py, Tasks/StartKeysAtCurrentTime.py, Samples/Camera/CameraSwitcher.py, BasicOperations/FBTime.py
str GetTimeString ( FBTimeMode  pMode = kFBTimeModeDefault,
ETimeFormats  pFormat = eDefaultFormat 
)

Get time as a string.

Parameters:
pModeTime mode (default=kFBTimeModeDefault) to use (call FBSystem().GetTransportFps() to the the current UI displayed mode).
pFormatFormat to use for the returned string(default=FBTime::eDefaultFormat).
Returns:
String value of time.
SetTimeString ( str  pTime)

Set time from string.

Parameters:
pTimeString to set time from.
bool GetTime ( int  pHour,
int  pMinute,
int  pSecond,
int  pFrame,
int  pField,
int  pMilliSecond,
FBTimeMode  pTimeMode = kFBTimeModeDefault 
)

Get time (filling separate values).

Return values:
pHourHour value.
pMinuteMinute value.
pSecondSecond value.
pFrameFrame value.
pFieldField value.
pMilliSecondMilliSecond value.
Parameters:
pTimeModeTime mode to get time as.
Returns:
true if an acceptable TimeMode value was chosen.
long GetMilliSeconds ( )

Get milliseconds for time.

Returns:
MilliSeconds value.
SetMilliSeconds ( long  pMilliSeconds)

Set milliseconds time.

Parameters:
pMilliSecondsMilliSeconds value.
long Get ( )

Get time value (long).

Returns:
Time value as long.
long Get ( )

Get time value (long).

Returns:
Time value as long.
Set ( long  pTime)

Set time value from a long.

Parameters:
pTimeTime value to set.
float GetSecondDouble ( )

Get seconds as double.

Returns:
Seconds in double form.
SetSecondDouble ( float  pTime)

Set seconds from double.

Parameters:
pTimeTime 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).

Parameters:
pHourHour value.
pMinuteMinute value(default=0).
pSecondSecond value(default=0).
pFrameFrame value(default=0).
pFieldField value(default=0).
pTimeModeTime 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.

Parameters:
pTimeModeTime mode to get the constant (default is kFBTimeModeDefault).
Returns:
Frames per second constant for the specified time mode.
SetFrame ( long  pFrames,
FBTimeMode  pTimeMode = kFBTimeModeDefault 
)

Set time in frame format.

Parameters:
pFramesThe number of frames.
pTimeModeThe time mode identifier which will dictate the extraction algorithm.

Member Data Documentation

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.


FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime
FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime FBTime