Detailed Description

Time data structure.

Examples: Tasks/ExportAnimationLibrary.py, Tasks/StartKeysAtCurrentTime.py, Samples/Camera/CameraSwitcher.py, BasicOperations/FBTime.py

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, float pFramerate=0.0)
	Constructor.
str	GetTimeString ()
	Get time as a string.
	SetTimeString (str pTime)
	Set time from string.
bool	GetTime (long pHour, long pMinute, long pSecond, long pFrame, long pField, long pMilliSecond, FBTimeMode pTimeMode=kFBTimeModeDefault, float pFramerate=0.0)
	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, float pFramerate=0.0)
	Set time (from separate values).
long	GetFrame (bool pCummul=False, FBTimeMode pTimeMode=kFBTimeModeDefault, float pFramerate=0.0)
	Get the frame count.
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:

pTime Time 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:

pConstant Time 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:

pTime Time 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:

pConstant Double 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:

pTime Time 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__ ( long pTime = 0 )

Search for all occurrences

Examples: Tasks/ExportAnimationLibrary.py, Tasks/StartKeysAtCurrentTime.py, Samples/Camera/CameraSwitcher.py, BasicOperations/FBTime.py

__init__	(	int	pHour,
		int	pMinute,
		int	pSecond = `0`,
		int	pFrame = `0`,
		int	pField = `0`,
		FBTimeMode	pTimeMode = `kFBTimeModeDefault`,
		float	pFramerate = `0.0`
	)

Search for all occurrences

Constructor.

Parameters:

pHour	Hour value.
pMinute	Minute value.
pSecond	Second value.
pFrame	Frame value.
pField	Field value.
pTimeMode	Time mode(default=kFBTimeModeDefault).
pFramerate	Custom framerate value in case of pTimeMode = kFBTimeModeCustom.

Examples: Tasks/ExportAnimationLibrary.py, Tasks/StartKeysAtCurrentTime.py, Samples/Camera/CameraSwitcher.py, BasicOperations/FBTime.py

str GetTimeString ( )

Search for all occurrences

Get time as a string.

Returns:: String value of time.

SetTimeString ( str pTime )

Search for all occurrences

Set time from string.

Parameters:

pTime String to set time from.

bool GetTime	(	long	pHour,
		long	pMinute,
		long	pSecond,
		long	pFrame,
		long	pField,
		long	pMilliSecond,
		FBTimeMode	pTimeMode = `kFBTimeModeDefault`,
		float	pFramerate = `0.0`
	)

Search for all occurrences

Get time (filling separate values).

Return values:

pHour	Hour value.
pMinute	Minute value.
pSecond	Second value.
pFrame	Frame value.
pField	Field value.
pMilliSecond	MilliSecond value.

Parameters:

pTimeMode	Time mode to get time as.
pFramerate	Custom framerate value in case of pTimeMode = kFBTimeModeCustom.

Returns:: true if an acceptable TimeMode value was chosen.

long GetMilliSeconds ( )

Search for all occurrences

Get milliseconds for time.

Returns:: MilliSeconds value.

SetMilliSeconds ( long pMilliSeconds )

Search for all occurrences

Set milliseconds time.

Parameters:

pMilliSeconds MilliSeconds value.

long Get ( )

Search for all occurrences

Get time value (long).

Returns:: Time value as long.

long Get ( )

Search for all occurrences

Get time value (long).

Returns:: Time value as long.

Set ( long pTime )

Search for all occurrences

Set time value from a long.

Parameters:

pTime Time value to set.

float GetSecondDouble ( )

Search for all occurrences

Get seconds as double.

Returns:: Seconds in double form.

SetSecondDouble ( float pTime )

Search for all occurrences

Set seconds from double.

Parameters:

pTime Time to set seconds from.

SetTime	(	int	pHour,
		int	pMinute = `0`,
		int	pSecond = `0`,
		int	pFrame = `0`,
		int	pField = `0`,
		FBTimeMode	pTimeMode = `kFBTimeModeDefault`,
		float	pFramerate = `0.0`
	)

Search for all occurrences

Set time (from separate values).

Parameters:

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).
pFramerate	Custom framerate value in case of pTimeMode = kFBTimeModeCustom.

long GetFrame	(	bool	pCummul = `False`,
		FBTimeMode	pTimeMode = `kFBTimeModeDefault`,
		float	pFramerate = `0.0`
	)

Search for all occurrences

Get the frame count.

With this function, it is possible to obtain the cumulative and local frame counts.

Parameters:

pCummul	Cumulative frame count (true ), or local frame count (false )(default is false).
pTimeMode	Time mode to get the constant (default is kFBTimeModeDefault).
pFramerate	Custom framerate value in case of pTimeMode = kFBTimeModeCustom.