FBTimeSpan Class Reference
 
 
 
FBTimeSpan Class Reference

This reference page is linked to from the following overview topics: Customizing the MotionBuilder SDK.


#include <fbtime.h>


Class Description

TimeSpan class.

Definition at line 380 of file fbtime.h.

Public Member Functions

  FBTimeSpan (FBTime pStart=0, FBTime pStop=0)
  Constructor.
void  Set (FBTime pStart, FBTime pStop)
  Set the TimeSpan.
FBTime  GetDuration ()
  Get the unsigned duration value of a timespan.
FBTime  GetSignedDuration ()
  Get the signed duration value of a timespan.
int  GetDirection ()
  Get the direction of the timespan.
bool  operator& (FBTime &pTime)
  Verify if pTime is contained within the timespan.
FBTimeSpan  operator& (FBTimeSpan &pTimeSpan)
  Calculate the intersection of two timespans.
FBTime GetStart ()
  Get the start/stop time.
FBTime GetStop ()
const FBTime GetStart () const
const FBTime GetStop () const

Constructor & Destructor Documentation

FBTimeSpan::FBTimeSpan ( FBTime  pStart = 0,
FBTime  pStop = 0 
)

Constructor.

Parameters:
pStart Start time(default=0).
pStop Stop time(default=0).

Member Function Documentation

FBTime& FBTimeSpan::GetStart ( )

Get the start/stop time.

Returns:
Start/Stop time.
FBTime& FBTimeSpan::GetStop ( )
const FBTime& FBTimeSpan::GetStart ( ) const
const FBTime& FBTimeSpan::GetStop ( ) const
void FBTimeSpan::Set ( FBTime  pStart,
FBTime  pStop 
)

Set the TimeSpan.

Parameters:
pStart Start time.
pStop Stop time.
FBTime FBTimeSpan::GetDuration ( )

Get the unsigned duration value of a timespan.

Returns:
Unsigned duration of the timespan.
FBTime FBTimeSpan::GetSignedDuration ( )

Get the signed duration value of a timespan.

Returns:
Signed duration of the timespan.
int FBTimeSpan::GetDirection ( )

Get the direction of the timespan.

Returns 1 if positive, -1 otherwise.

Returns:
Direction of timespan.
bool FBTimeSpan::operator& ( FBTime pTime )

Verify if pTime is contained within the timespan.

Parameters:
pTime Time to verify if within the timespan.
Returns:
true if pTime is within the timespan.
FBTimeSpan FBTimeSpan::operator& ( FBTimeSpan pTimeSpan )

Calculate the intersection of two timespans.

Returns:
Timespan representing the intersection of the two timespans.

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