FBEvaluateManager Class Reference

Inheritance diagram for FBEvaluateManager:

List of all members.

Public Member Functions

 RegisterEvaluationGlobalFunction (function pCallback, FBGlobalEvalCallbackTiming pTiming)
 Register free callback function to critical timings / stages in the pipeline.
 UnregisterEvaluationGlobalFunction (function pCallback, FBGlobalEvalCallbackTiming pTiming)
 Register free callback function to critical timings / stages in the pipeline.
 InvalidateDAG ()
 Invalidate the DAG and trigger parallel scheduling at the next frame.
bool IsInteractiveMode ()
 Check if the application main loop is in interactive or offline render mode.
FBEvaluateManager TheOne ()
 Get the global object for this class.

Public Attributes

FBPropertyEventCallbackEvalPipeline OnEvaluationPipelineEvent
  For callback events at evaluation pipeline.
FBPropertyEventCallbackRenderPipeline OnRenderingPipelineEvent
  For callback events at rendering pipeline.
FBPropertyEventCallbackSynPoint OnSynchronizationEvent
  For callback events at synchronization point.
FBPropertyBase ParallelPipeline
 Read/Write Property: true if transformation is evaluated in parallel.
FBPropertyBase ParallelDeformation
 Read/Write Property: true if deformation is evaluated in parallel.
FBPropertyBase UseGPUDeformation
 Read/Write Property: true if GPU deformation is used.
FBPropertyBase FrameSkipOptimization
 Read/Write Property: if true, apply frame skip optimization during playback.
FBPropertyParallelScheduleType ParallelScheduleType
  DEPRICATED Read/Write Property: choose between serial and parallel DAG schedule algorithm.
FBPropertyBase ParallelEvaluation
 Read/Write Property: true if parallel DAG schedule algorithm is being used.
FBPropertyBase NodeCount
 Read only Property: Number of nodes to evaluate.
FBPropertyBase DeviceCount
 Read only Property: Number of devices to evaluate.

Member Function Documentation

RegisterEvaluationGlobalFunction ( function  pCallback,
FBGlobalEvalCallbackTiming  pTiming 
)

Register free callback function to critical timings / stages in the pipeline.

Parameters:
pCallbackfree function to be registered
pTimingcallback timing to be registered
Note:
Global callback functions calling order is same as registration order, which is different from FBPropertyEvent callbacks.
UnregisterEvaluationGlobalFunction ( function  pCallback,
FBGlobalEvalCallbackTiming  pTiming 
)

Register free callback function to critical timings / stages in the pipeline.

Parameters:
pCallbackfree callback to be unregistered
pTimingcallback timing to be unregistered
InvalidateDAG ( )

Invalidate the DAG and trigger parallel scheduling at the next frame.

bool IsInteractiveMode ( )

Check if the application main loop is in interactive or offline render mode.

Returns:
true if is application is is interactive mode.
FBEvaluateManager TheOne ( )

Get the global object for this class.

Returns:
the global object.

Member Data Documentation

FBPropertyEventCallbackEvalPipeline OnEvaluationPipelineEvent

For callback events at evaluation pipeline.

. This callback will be invoked from different thread than the main thread in parallel pipeline setup. And this property is not exposed to pyfbsdk because pyfbsdk doesn't support multi-thread properly yet.

FBPropertyEventCallbackRenderPipeline OnRenderingPipelineEvent

For callback events at rendering pipeline.

.

FBPropertyEventCallbackSynPoint OnSynchronizationEvent

For callback events at synchronization point.

.

FBPropertyBase ParallelPipeline

Read/Write Property: true if transformation is evaluated in parallel.

FBPropertyBase ParallelDeformation

Read/Write Property: true if deformation is evaluated in parallel.

FBPropertyBase UseGPUDeformation

Read/Write Property: true if GPU deformation is used.

FBPropertyBase FrameSkipOptimization

Read/Write Property: if true, apply frame skip optimization during playback.

off-line rendering don't use frame skip optimization.

FBPropertyParallelScheduleType ParallelScheduleType

DEPRICATED Read/Write Property: choose between serial and parallel DAG schedule algorithm.

kFBParallelScheduleSimple and kFBParallelScheduleAdvanced will set ParallelEvalution to true. kFBParallelScheduleSerial will set ParallelEvalution to false

FBPropertyBase ParallelEvaluation

Read/Write Property: true if parallel DAG schedule algorithm is being used.

false when serial algorithm is being used.

FBPropertyBase NodeCount

Read only Property: Number of nodes to evaluate.

FBPropertyBase DeviceCount

Read only Property: Number of devices to evaluate.


FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager
FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager FBEvaluateManager