FBEvaluateInfo Class Reference
 
 
 
FBEvaluateInfo Class Reference

This reference page is linked to from the following overview topics: Adjusting the Extraction, Solving from the Goal to the Skeleton.


#include <mobu-python-api.h>


Class Description

AnimationNodeNotify evaluation information. This structure is passed to the AnimationNodeNotify calls (in Constraints, Devices, and Boxes), giving the connectors information with regards to the start or stop times of the evaluation. In general, only the start time is of interest for the current evaluation cycle. The advantage of the structure is to have a common time for the evaluation of all the elements in the scene.

Public Member Functions

def  __reduce__ ()
def  GetLocalTime ()
def  GetSyncCount ()
def  GetSystemTime ()
def  IsStop ()
def  GetEvaluationID ()
def  __init__ ()

Member Function Documentation

def __reduce__ ( )
def GetLocalTime ( )

Python Docstring:

GetLocalTime( (FBEvaluateInfo)arg1) -> FBTime 

C++ Signature:

FBTime & GetLocalTime() 

Return local (scene) time.

Returns:
Local time.
def GetSyncCount ( )

Python Docstring:

GetSyncCount( (FBEvaluateInfo)arg1) -> int 

C++ Signature:

int GetSyncCount() 

Return the wanted timer sync count (internal or external).

Returns:
sync count or -1 if no sync is present
def GetSystemTime ( )

Python Docstring:

GetSystemTime( (FBEvaluateInfo)arg1) -> FBTime 

C++ Signature:

FBTime & GetSystemTime() 

Return system time.

Returns:
System time.
def IsStop ( )

Python Docstring:

IsStop( (FBEvaluateInfo)arg1) -> bool 

C++ Signature:

bool IsStop() 

Is local time stopped? (ie: no animation).

Returns:
true if local time is stopped.
def GetEvaluationID ( )

Python Docstring:

GetEvaluationID( (FBEvaluateInfo)arg1) -> int 

C++ Signature:

int GetEvaluationID() 

Return the wanted timer sync count (internal or external).

Returns:
sync count or -1 if no sync is present
def __init__ ( )

Python Docstring:

Raises an exception
This class cannot be instantiated from Python