FBEvaluateInfo Class Reference


Detailed 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.

List of all members.

Public Member Functions

FBTime GetLocalTime ()
 Return local (scene) time.
FBTime GetSystemTime ()
 Return system time.
bool IsStop ()
 Is local time stopped? (ie: no animation).
int GetSyncCount ()
 Return the wanted timer sync count (internal or external).
int GetEvaluationID ()
 Return the wanted timer sync count (internal or external).
int GetDeviceID ()
 Return the ID of the device requesting the evaluation.
int GetBufferID (FBBox pBufferOwner)
 User in case of constraints that can be called from multiple thread should implement multi buffering system.
FBEvaluateInfo GetSourceEvaluateInfo ()
 Return the source EvaluationInfo for background evaluation.
int GetRecursionLevel (FBBox pConstraint)
 Return recursion level for given pConstraint.

Member Function Documentation

FBTime GetLocalTime ( )

Return local (scene) time.

Returns:
Local time.
FBTime GetSystemTime ( )

Return system time.

Returns:
System time.
bool IsStop ( )

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

Returns:
true if local time is stopped.
int GetSyncCount ( )

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

Returns:
sync count or -1 if no sync is present
int GetEvaluationID ( )

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

Returns:
sync count or -1 if no sync is present
int GetDeviceID ( )

Return the ID of the device requesting the evaluation.

Returns:
Device Id (0x00: Viewer, 0x01 .. 0x1F Devices, 0xFFF: Evaluation manager or plot)
int GetBufferID ( FBBox  pBufferOwner)

User in case of constraints that can be called from multiple thread should implement multi buffering system.

Parameters:
pBufferOwnerThis should be always passed to get access to optimized buffer management.
Returns:
Buffer associated to this evaluation info.
Note:
For now there are no intentions to expose this into python, since it's not possible to create constraints in python.
FBEvaluateInfo GetSourceEvaluateInfo ( )

Return the source EvaluationInfo for background evaluation.

Returns:
Source EvaluationInfo
int GetRecursionLevel ( FBBox  pConstraint)

Return recursion level for given pConstraint.

Returns:
recursion level.

FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo
FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo FBEvaluateInfo