FBEvaluateManager Class Reference

#include <mobu-python-api.h>

Class Description

+ Inheritance diagram for FBEvaluateManager:

Public Member Functions

 __reduce__ ()
 
 __init__ (object arg1)
 Constructor. More...
 
 InvalidateDAG (FBEvaluateManager arg1)
 Invalidate the DAG and trigger parallel scheduling at the next frame. More...
 
bool IsInteractiveMode (FBEvaluateManager arg1)
 Check if the application main loop is in interactive or offline render mode. More...
 
- Public Member Functions inherited from FBComponent
 __reduce__ ()
 
FBPropertyList PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
 Get list of properties which have been modified since last loading. More...
 
str ClassName (FBComponent arg1)
 Get the class name. More...
 
 DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Enable a specific Object Flags. More...
 
bool FBCreate (FBComponent arg1)
 Open Reality Creation function. More...
 
 FBDelete (FBComponent arg1)
 Open Reality deletion function. More...
 
 FBDestroy (FBComponent arg1)
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags (FBComponent arg1)
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
 Check to see if an object status is enabled. More...
 
bool HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Check whether a specific object flag is enabled. More...
 
bool Is (FBComponent arg1, object arg2)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBComponent arg1, FBProperty arg2)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
 Add a reference property to the component's property manager. More...
 
object PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
 Create user or dynamic property. More...
 
 PropertyRemove (FBComponent arg1, FBProperty arg2)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 SetObjectFlags. More...
 
 SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
 Enable/Disable a specific Object Status. More...
 
 HardSelect (FBComponent arg1)
 HardSelect. More...
 
object GetOwnerFileReference (FBComponent arg1)
 Get the owner FileReference object. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBPlug
 __reduce__ ()
 
bool BeginChange (FBPlug arg1)
 Begins a change on multiple plugs. More...
 
str ClassName (FBPlug arg1)
 internal System vars. More...
 
bool ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a destination connection. More...
 
bool ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a destination connection. More...
 
bool ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a source connection. More...
 
bool ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a source connection. More...
 
 DisconnectAllDst (FBPlug arg1)
 Remove all destination connections. More...
 
 DisconnectAllSrc (FBPlug arg1)
 Remove all source connections. More...
 
bool DisconnectDst (FBPlug arg1, FBPlug arg2)
 Remove a destination connection. More...
 
bool DisconnectDstAt (FBPlug arg1, object arg2)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrc (FBPlug arg1, FBPlug arg2)
 Remove a source connection. More...
 
bool DisconnectSrcAt (FBPlug arg1, object arg2)
 Remove a source connection at a specified index. More...
 
 EndChange (FBPlug arg1)
 Ends a change on multiple plugs. More...
 
object GetDst (FBPlug arg1, object arg2)
 Get a destination connection's plug at specified index. More...
 
int GetDstCount (FBPlug arg1)
 Get destination connection count. More...
 
FBConnectionType GetDstType (FBPlug arg1, object arg2)
 Get a destination connection's type at specified index. More...
 
object GetOwned (FBPlug arg1, object arg2)
 Get the owned plug at specified index. More...
 
int GetOwnedCount (FBPlug arg1)
 Get the owned plug count. More...
 
object GetOwner (FBPlug arg1)
 Get the owner of this plug. More...
 
object GetSrc (FBPlug arg1, object arg2)
 Get a source connection's plug at specified index. More...
 
int GetSrcCount (FBPlug arg1)
 Get source connection count. More...
 
FBConnectionType GetSrcType (FBPlug arg1, object arg2)
 Get a source connection's type at specified index. More...
 
bool Is (FBPlug arg1, object arg2)
 Is( int pTypeId ) More...
 
bool IsSDKComponent (FBPlug arg1)
 Return whether or not item is an SDK component. More...
 
 MoveSrcAt (...)
 
bool ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (FBPlug arg1, object arg2, object arg3)
 Swap source connection at index A with source connection at index B. More...
 
 SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's self has changed. More...
 
 SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
 Revert the plug's modification to original status. More...
 
 __init__ (...)
 
method staticmethod (function)
 
- Public Member Functions inherited from FBPythonWrapper
 __reduce__ ()
 
 __init__ (...)
 

Public Attributes

FBPropertyBool ParallelPipeline
 Read/Write Property: true if transformation is evaluated in parallel. More...
 
FBPropertyBool ParallelDeformation
 Read/Write Property: true if deformation is evaluated in parallel. More...
 
FBPropertyBool UseGPUDeformation
 Read/Write Property: true if GPU deformation is used. More...
 
FBPropertyBool FrameSkipOptimization
 Read/Write Property: if true, apply frame skip optimization during playback. More...
 
FBPropertyParallelScheduleType ParallelScheduleType
  DEPRICATED Read/Write Property: choose between serial and parallel DAG schedule algorithm. More...
 
FBPropertyBool ParallelEvaluation
 Read/Write Property: true if parallel DAG schedule algorithm is being used. More...
 
FBPropertyBool DualQuaternionSkinning
 Read/Write Property: Using state of the Dual Quaternion for skinning (CPU Skinning or GPU Skinning). More...
 
FBPropertyInt NodeCount
 Read only Property: Number of nodes to evaluate. More...
 
FBPropertyInt DeviceCount
 Read only Property: Number of devices to evaluate. More...
 
ORSDK2018::FBPropertyEventCallbackRenderPipeline OnRenderingPipelineEvent
  For callback events at rendering pipeline. More...
 
ORSDK2018::FBPropertyEventCallbackSynPoint OnSynchronizationEvent
  For callback events at synchronization point. More...
 
- Public Attributes inherited from FBComponent
object OwnerNamespace
 
ORSDK2018::FBPropertyListComponent Components
 List: List of components. More...
 
ORSDK2018::FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
ORSDK2018::FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
object FullName
 
ORSDK2018::FBPropertyListComponent Parents
 List: Parents. More...
 
ORSDK2018::FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
- Public Attributes inherited from FBPythonWrapper
object OnUnbind
 

Member Function Documentation

__init__ ( object  arg1)

Constructor.

Python Docstring:

__init__( (object)arg1) -> None 

C++ Signature:

 FBEvaluateManager(HIObject pObject = ((void *) 0)) 

Protected constructor, use TheOne() access instead.

Parameters
pObjectInternal parent object(default=NULL).
__reduce__ ( )
InvalidateDAG ( FBEvaluateManager  arg1)

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

Python Docstring:

InvalidateDAG( (FBEvaluateManager)arg1) -> None 

C++ Signature:

void InvalidateDAG() 
bool IsInteractiveMode ( FBEvaluateManager  arg1)

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

Python Docstring:

IsInteractiveMode( (FBEvaluateManager)arg1) -> bool 

C++ Signature:

bool IsInteractiveMode() 
Returns
true if is application is is interactive mode.

Member Data Documentation

FBPropertyInt DeviceCount

Read only Property: Number of devices to evaluate.

FBPropertyBool DualQuaternionSkinning

Read/Write Property: Using state of the Dual Quaternion for skinning (CPU Skinning or GPU Skinning).

FBPropertyBool FrameSkipOptimization

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

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

FBPropertyInt NodeCount

Read only Property: Number of nodes to evaluate.

ORSDK2018::FBPropertyEventCallbackRenderPipeline OnRenderingPipelineEvent

For callback events at rendering pipeline.

ORSDK2018::FBPropertyEventCallbackSynPoint OnSynchronizationEvent

For callback events at synchronization point.

FBPropertyBool ParallelDeformation

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

FBPropertyBool ParallelEvaluation

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

false when serial algorithm is being used.

FBPropertyBool ParallelPipeline

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

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

FBPropertyBool UseGPUDeformation

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