AnimationNodeNotify evaluation information. More...

#include <fbevaluateinfo.h>

Public Member Functions
FBTime &	GetLocalTime ()
	Return local (scene) time. More...

FBTime &	GetSystemTime ()
	Return system time. More...

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

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

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

int	GetDeviceID ()
	Return the ID of the device requesting the evaluation. More...

int	GetBufferID (FBBox *pBufferOwner)
	User in case of constraints that can be called from multiple thread should implement multi buffering system. More...

FBEvaluateInfo *	GetSourceEvaluateInfo ()
	Return the source EvaluationInfo for background evaluation. More...

int	GetRecursionLevel (FBBox *pConstraint)
	Return recursion level for given pConstraint. More...

void	Goto (FBTime pTime)
	Change local time. More...

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.

Definition at line 78 of file fbevaluateinfo.h.

Member Function Documentation

◆ GetBufferID()

int GetBufferID ( FBBox * pBufferOwner )

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

Parameters

pBufferOwner This 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.

◆ GetDeviceID()

int GetDeviceID ( )

Return the ID of the device requesting the evaluation.

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

◆ GetEvaluationID()

int GetEvaluationID ( )

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

Returns: sync count or -1 if no sync is present

◆ GetLocalTime()

FBTime& GetLocalTime ( )

Return local (scene) time.

Returns: Local time.

◆ GetRecursionLevel()

int GetRecursionLevel ( FBBox * pConstraint )

Return recursion level for given pConstraint.

Returns: recursion level.

◆ GetSourceEvaluateInfo()

FBEvaluateInfo* GetSourceEvaluateInfo ( )

Return the source EvaluationInfo for background evaluation.

Returns: Source EvaluationInfo

◆ GetSyncCount()

int GetSyncCount ( )

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

Returns: sync count or -1 if no sync is present

◆ GetSystemTime()

FBTime& GetSystemTime ( )

Return system time.

Returns: System time.

◆ Goto()

void Goto ( FBTime pTime )

Change local time.

Parameters

pTime Assigned local time

◆ IsStop()

bool IsStop ( )

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

Returns: true if local time is stopped.

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

fbevaluateinfo.h

Public Member Functions