This reference page is linked to from the following overview topics: Customizing the MotionBuilder SDK, Optical devices, FBCamera - Cameras, Keyframe Animation on Referenced Items, FBPose - Poses.
#include <fbtime.h>
Public Types |
|
enum | ETimeFormats { eSMPTE, eFrame, eDefaultFormat } |
Different time format available. More... |
|
Public Member Functions |
|
FBTime (kLongLong pTime=0) | |
FBTime (int pHour, int pMinute, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault) | |
Constructor. |
|
FBString | GetTimeString (FBTimeMode pMode=kFBTimeModeDefault, ETimeFormats pFormat=eDefaultFormat) |
Get time as a string. |
|
void | SetTimeString (const char *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) |
|
kLongLong | GetMilliSeconds () |
Get milliseconds for time. |
|
void | SetMilliSeconds (kLongLong pMilliSeconds) |
Set milliseconds time. |
|
kLongLong & | Get () |
Get time value (long) |
|
const kLongLong & | Get () const |
Get time value (long) |
|
void | Set (kLongLong pTime) |
Set time value from a long. |
|
double | GetSecondDouble () |
Get seconds as double. |
|
void | SetSecondDouble (double pTime) |
Set seconds from double. |
|
void | SetTime (int pHour, int pMinute=0, int pSecond=0, int pFrame=0, int pField=0, FBTimeMode pTimeMode=kFBTimeModeDefault) |
Set time (from separate values) |
|
kLongLong | GetFrame (FBTimeMode pTimeMode=kFBTimeModeDefault) |
Get the frame count. |
|
void | SetFrame (kLongLong pFrames, FBTimeMode pTimeMode=kFBTimeModeDefault) |
Set time in frame format. |
|
FBTime & | operator= (const FBTime &pTime) |
Overloaded assignment operators with
FBTime objects. |
|
FBTime & | operator+= (const FBTime &pTime) |
FBTime & | operator-= (const FBTime &pTime) |
FBTime & | operator*= (const FBTime &pTime) |
FBTime & | operator/= (const FBTime &pTime) |
FBTime & | operator= (double pConstant) |
Overloaded assignment operators with
constants. |
|
FBTime & | operator+= (double pConstant) |
FBTime & | operator-= (double pConstant) |
FBTime & | operator*= (double pConstant) |
FBTime & | operator/= (double pConstant) |
FBTime | operator- (const FBTime &pTime) |
Overloaded arithmetic operators with
FBTime objects. |
|
FBTime | operator+ (const FBTime &pTime) |
FBTime | operator/ (const FBTime &pTime) |
FBTime | operator* (const FBTime &pTime) |
FBTime | operator- (double pConstant) |
Overloaded arithmetic operators with
constants. |
|
FBTime | operator+ (double pConstant) |
FBTime | operator/ (double pConstant) |
FBTime | operator* (double pConstant) |
bool | operator== (const FBTime &pTime) |
Overloaded comparison operators. |
|
bool | operator!= (const FBTime &pTime) |
bool | operator>= (const FBTime &pTime) |
bool | operator<= (const FBTime &pTime) |
bool | operator> (const FBTime &pTime) |
bool | operator< (const FBTime &pTime) |
Static Public Attributes |
|
static const FBTime | Infinity |
Time constant: Infinity, the largest time
value. |
|
static const FBTime | MinusInfinity |
Time constant: Minus Infinity, the lowest
negative time value. |
|
static const FBTime | Zero |
Time constant: Zero. |
|
static const FBTime | Epsilon |
Time constant: Epsilon, the smallest time
increment. |
|
static const FBTime | OneSecond |
Time constant: One Second. |
|
static const FBTime | OneMinute |
Time constant: One Minute. |
|
static const FBTime | OneHour |
Time constant: One Hour. |
enum FBTime::ETimeFormats |
Different time format available.
eSMPTE |
format as SMPTE |
eFrame |
format as numeric frame |
eDefaultFormat |
Default Time format. |
Definition at line 93 of file fbtime.h.
{ eSMPTE, eFrame, eDefaultFormat };
FBTime::FBTime | ( | kLongLong | pTime = 0 |
) |
FBTime::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). |
FBString FBTime::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). |
void FBTime::SetTimeString | ( | const char * | pTime | ) |
bool FBTime::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. |
kLongLong FBTime::GetMilliSeconds | ( | ) |
void FBTime::SetMilliSeconds | ( | kLongLong | pMilliSeconds | ) |
kLongLong& FBTime::Get | ( | ) |
const kLongLong& FBTime::Get | ( | ) | const |
void FBTime::Set | ( | kLongLong | pTime | ) |
double FBTime::GetSecondDouble | ( | ) |
void FBTime::SetSecondDouble | ( | double | pTime | ) |
void FBTime::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). |
Overloaded assignment operators with FBTime objects.
pTime | Time to assign with operator. |
FBTime& FBTime::operator= | ( | double | pConstant | ) |
Overloaded assignment operators with constants.
pConstant | Time to assign with operator. |
FBTime& FBTime::operator+= | ( | double | pConstant | ) |
FBTime& FBTime::operator-= | ( | double | pConstant | ) |
FBTime& FBTime::operator*= | ( | double | pConstant | ) |
FBTime& FBTime::operator/= | ( | double | pConstant | ) |
FBTime FBTime::operator- | ( | double | pConstant | ) |
Overloaded arithmetic operators with constants.
pConstant | Double constant to add to time. |
FBTime FBTime::operator+ | ( | double | pConstant | ) |
FBTime FBTime::operator/ | ( | double | pConstant | ) |
FBTime FBTime::operator* | ( | double | pConstant | ) |
bool FBTime::operator== | ( | const FBTime & | pTime | ) |
Overloaded comparison operators.
pTime | Time to compare with. |
bool FBTime::operator!= | ( | const FBTime & | pTime | ) |
bool FBTime::operator>= | ( | const FBTime & | pTime | ) |
bool FBTime::operator<= | ( | const FBTime & | pTime | ) |
bool FBTime::operator> | ( | const FBTime & | pTime | ) |
bool FBTime::operator< | ( | const FBTime & | pTime | ) |
kLongLong FBTime::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). |
void FBTime::SetFrame | ( | kLongLong | 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. |
const FBTime FBTime::Infinity
[static] |
Time constant: Infinity, the largest time value.
const FBTime FBTime::MinusInfinity
[static] |
Time constant: Minus Infinity, the lowest negative time value.
const FBTime FBTime::Zero
[static] |
const FBTime FBTime::Epsilon
[static] |
Time constant: Epsilon, the smallest time increment.
const FBTime FBTime::OneSecond
[static] |
const FBTime FBTime::OneMinute
[static] |
const FBTime FBTime::OneHour
[static] |