FBTimeSpan Class Reference
 
 
 
FBTimeSpan Class Reference

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


#include <mobu-python-api.h>


Class Description

TimeSpan class.

Public Member Functions

def  __reduce__ ()
def  __init__ ()
def  GetDirection ()
def  GetDuration ()
def  GetSignedDuration ()
def  GetStart ()
def  GetStop ()
def  Set ()

Member Function Documentation

def __reduce__ ( )
def __init__ ( )

Python Docstring:

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

C++ Signature:

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

Constructor.

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

Python Docstring:

GetDirection( (FBTimeSpan)arg1) -> int 

C++ Signature:

int GetDirection() 

Get the direction of the timespan. Returns 1 if positive, -1 otherwise.

Returns:
Direction of timespan.
def GetDuration ( )

Python Docstring:

GetDuration( (FBTimeSpan)arg1) -> FBTime 

C++ Signature:

FBTime GetDuration() 

Get the unsigned duration value of a timespan.

Returns:
Unsigned duration of the timespan.
def GetSignedDuration ( )

Python Docstring:

GetSignedDuration( (FBTimeSpan)arg1) -> FBTime 

C++ Signature:

FBTime GetSignedDuration() 

Get the signed duration value of a timespan.

Returns:
Signed duration of the timespan.
def GetStart ( )

Python Docstring:

GetStart( (FBTimeSpan)arg1) -> FBTime 

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

FBTime & GetStart()
const FBTime & GetStart()
def GetStop ( )

Python Docstring:

GetStop( (FBTimeSpan)arg1) -> FBTime 

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

FBTime & GetStop()
const FBTime & GetStop()
def Set ( )

Python Docstring:

Set( (FBTimeSpan)arg1, (FBTime)arg2, (FBTime)arg3) -> None 

C++ Signature:

void Set(FBTime pStart, FBTime pStop) 

Set the TimeSpan.

Parameters:
pStart Start time.
pStop Stop time.