FBTime Class Reference
 
 
 
FBTime Class Reference

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>


Class Description

Time data structure.

Definition at line 86 of file 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.

Member Enumeration Documentation

Different time format available.

Enumerator:
eSMPTE 

format as SMPTE

eFrame 

format as numeric frame

eDefaultFormat 

Default Time format.

Definition at line 93 of file fbtime.h.


Constructor & Destructor Documentation

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

Constructor.

Parameters:
pHour Hour value.
pMinute Minute value.
pSecond Second value.
pFrame Frame value.
pField Field value.
pTimeMode Time mode(default=kFBTimeModeDefault).

Member Function Documentation

FBString FBTime::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.
void FBTime::SetTimeString ( const char *  pTime )

Set time from string.

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

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.
Returns:
true if an acceptable TimeMode value was chosen.
kLongLong FBTime::GetMilliSeconds ( )

Get milliseconds for time.

Returns:
MilliSeconds value.
void FBTime::SetMilliSeconds ( kLongLong  pMilliSeconds )

Set milliseconds time.

Parameters:
pMilliSeconds MilliSeconds value.
kLongLong& FBTime::Get ( )

Get time value (long)

Returns:
Time value as long.
const kLongLong& FBTime::Get ( ) const

Get time value (long)

Returns:
Time value as long.
void FBTime::Set ( kLongLong  pTime )

Set time value from a long.

Parameters:
pTime Time value to set.
double FBTime::GetSecondDouble ( )

Get seconds as double.

Returns:
Seconds in double form.
void FBTime::SetSecondDouble ( double  pTime )

Set seconds from double.

Parameters:
pTime Time to set seconds from.
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)

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).
FBTime& FBTime::operator= ( const FBTime pTime )

Overloaded assignment operators with FBTime objects.

Parameters:
pTime Time to assign with operator.
Returns:
Resulting time from operation.
FBTime& FBTime::operator+= ( const FBTime pTime )
FBTime& FBTime::operator-= ( const FBTime pTime )
FBTime& FBTime::operator*= ( const FBTime pTime )
FBTime& FBTime::operator/= ( const FBTime pTime )
FBTime& FBTime::operator= ( double  pConstant )

Overloaded assignment operators with constants.

Parameters:
pConstant Time to assign with operator.
Returns:
Resulting time from operation.
FBTime& FBTime::operator+= ( double  pConstant )
FBTime& FBTime::operator-= ( double  pConstant )
FBTime& FBTime::operator*= ( double  pConstant )
FBTime& FBTime::operator/= ( double  pConstant )
FBTime FBTime::operator- ( const FBTime pTime )

Overloaded arithmetic operators with FBTime objects.

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

Overloaded arithmetic operators with constants.

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

Overloaded comparison operators.

Parameters:
pTime Time to compare with.
Returns:
Result of comparison.
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.

Parameters:
pTimeMode Time mode to get the constant (default is kFBTimeModeDefault).
Returns:
Frames per second constant for the specified time mode.
void FBTime::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.

Member Data Documentation

const FBTime FBTime::Infinity [static]

Time constant: Infinity, the largest time value.

Definition at line 256 of file fbtime.h.

const FBTime FBTime::MinusInfinity [static]

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

Definition at line 259 of file fbtime.h.

const FBTime FBTime::Zero [static]

Time constant: Zero.

Definition at line 262 of file fbtime.h.

const FBTime FBTime::Epsilon [static]

Time constant: Epsilon, the smallest time increment.

Definition at line 265 of file fbtime.h.

const FBTime FBTime::OneSecond [static]

Time constant: One Second.

Definition at line 268 of file fbtime.h.

const FBTime FBTime::OneMinute [static]

Time constant: One Minute.

Definition at line 271 of file fbtime.h.

const FBTime FBTime::OneHour [static]

Time constant: One Hour.

Definition at line 274 of file fbtime.h.


The documentation for this class was generated from the following file: