FBTime Class Reference
 
 
 
FBTime Class Reference

This reference page is linked to from the following overview topics: Customizing the MotionBuilder SDK, Optical devices, Keyframe Animation on Referenced Items, FBCamera - Cameras, FBPose - Poses.


#include <mobu-python-api.h>


Class Description

Time data structure.

Public Member Functions

def  __reduce__ ()
def  __init__ ()
def  __repr__ ()
def  Get ()
def  GetFrame ()
def  SetFrame ()
def  GetMilliSeconds ()
def  GetSecondDouble ()
def  GetTimeString ()
def  Set ()
def  SetMilliSeconds ()
def  SetSecondDouble ()
def  SetTime ()
def  SetTimeString ()
def  __add__ ()
def  __sub__ ()
def  __eq__ ()
def  __ne__ ()
def  __gt__ ()
def  __ge__ ()
def  __lt__ ()
def  __le__ ()

Public Attributes

const FBTime  MinusInfinity
const FBTime  Zero
const FBTime  OneSecond
const FBTime  OneMinute
const FBTime  OneHour
const FBTime  Infinity

Member Function Documentation

def __reduce__ ( )
def __init__ ( )

Python Docstring:

__init__( (object)arg1 [, (object)arg2]) -> None

__init__( (object)arg1, (object)arg2, (object)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6 [, (FBTimeMode)arg7]]]]) -> None

__init__( (object)arg1, (FBTime)arg2) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBTime(kLongLong pTime = 0)
 FBTime(int pHour, int pMinute, int pSecond = 0, int pFrame = 0, int pField = 0, FBTimeMode pTimeMode = kFBTimeModeDefault)
def __repr__ ( )

Python Docstring:

__repr__( (FBTime)arg1) -> str 
def Get ( )

Python Docstring:

Get( (FBTime)arg1) -> int 

Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.

kLongLong & Get()
const kLongLong & Get()
def GetFrame ( )

Python Docstring:

GetFrame( (FBTime)arg1 [, (FBTimeMode)arg2]) -> int 

C++ Signature:

kLongLong GetFrame(FBTimeMode pTimeMode = kFBTimeModeDefault) 

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

Parameters:
pTimeMode Time mode to get the constant (default is kFBTimeModeDefault).
Returns:
Frames per second constant for the specified time mode.
def SetFrame ( )

Python Docstring:

SetFrame( (FBTime)arg1, (object)arg2 [, (FBTimeMode)arg3]) -> None 

C++ Signature:

void SetFrame(kLongLong pFrames, FBTimeMode pTimeMode = kFBTimeModeDefault) 

Set time in frame format.

Parameters:
pFrames The number of frames.
pTimeMode The time mode identifier which will dictate the extraction algorithm.
def GetMilliSeconds ( )

Python Docstring:

GetMilliSeconds( (FBTime)arg1) -> int 

C++ Signature:

kLongLong GetMilliSeconds() 

Get milliseconds for time.

Returns:
MilliSeconds value.
def GetSecondDouble ( )

Python Docstring:

GetSecondDouble( (FBTime)arg1) -> float 

C++ Signature:

double GetSecondDouble() 

Get seconds as double.

Returns:
Seconds in double form.
def GetTimeString ( )

Python Docstring:

GetTimeString( (FBTime)arg1 [, (FBTimeMode)arg2 [, (ETimeFormats)arg3]]) -> str 

C++ Signature:

FBString GetTimeString(FBTimeMode pMode = kFBTimeModeDefault, ETimeFormats pFormat = eDefaultFormat) 

Get time as a string.

Parameters:
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).
Returns:
String value of time.
def Set ( )

Python Docstring:

Set( (FBTime)arg1, (object)arg2) -> None 

C++ Signature:

void Set(kLongLong pTime) 

Set time value from a long.

Parameters:
pTime Time value to set.
def SetMilliSeconds ( )

Python Docstring:

SetMilliSeconds( (FBTime)arg1, (object)arg2) -> None 

C++ Signature:

void SetMilliSeconds(kLongLong pMilliSeconds) 

Set milliseconds time.

Parameters:
pMilliSeconds MilliSeconds value.
def SetSecondDouble ( )

Python Docstring:

SetSecondDouble( (FBTime)arg1, (object)arg2) -> None 

C++ Signature:

void SetSecondDouble(double pTime) 

Set seconds from double.

Parameters:
pTime Time to set seconds from.
def SetTime ( )

Python Docstring:

SetTime( (FBTime)arg1, (object)arg2 [, (object)arg3 [, (object)arg4 [, (object)arg5 [, (object)arg6 [, (FBTimeMode)arg7]]]]]) -> None 

C++ Signature:

void SetTime(int pHour, int pMinute = 0, int pSecond = 0, int pFrame = 0, int pField = 0, FBTimeMode pTimeMode = kFBTimeModeDefault) 

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).
def SetTimeString ( )

Python Docstring:

SetTimeString( (FBTime)arg1, (str)arg2) -> None 

C++ Signature:

void SetTimeString(const char * pTime) 

Set time from string.

Parameters:
pTime String to set time from.
def __add__ ( )

Python Docstring:

__add__( (FBTime)arg1, (FBTime)arg2) -> object

__add__( (FBTime)arg1, (object)arg2) -> object 
def __sub__ ( )

Python Docstring:

__sub__( (FBTime)arg1, (FBTime)arg2) -> object

__sub__( (FBTime)arg1, (object)arg2) -> object 
def __eq__ ( )

Python Docstring:

__eq__( (FBTime)arg1, (FBTime)arg2) -> object 
def __ne__ ( )

Python Docstring:

__ne__( (FBTime)arg1, (FBTime)arg2) -> object 
def __gt__ ( )

Python Docstring:

__gt__( (FBTime)arg1, (FBTime)arg2) -> object 
def __ge__ ( )

Python Docstring:

__ge__( (FBTime)arg1, (FBTime)arg2) -> object 
def __lt__ ( )

Python Docstring:

__lt__( (FBTime)arg1, (FBTime)arg2) -> object 
def __le__ ( )

Python Docstring:

__le__( (FBTime)arg1, (FBTime)arg2) -> object 

Member Data Documentation

Time constant: Minus Infinity, the lowest negative time value.

Time constant: Infinity, the largest time value.