Python Reference Guide
 
Loading...
Searching...
No Matches
FBFCurveEventManager Class Reference

FCurve Event Manager Interface to the FBFCurveEventManager. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBFCurveEventManager:

Public Member Functions

bool RegisterProperty (FBAnimatable pProperty)
 Register a property to the FCurve Event Manager.
 
bool UnregisterProperty (FBAnimatable pProperty)
 Unregister a property from the FCurve Event Manager.
 
- Public Member Functions inherited from FBComponent
 FBComponent ()
 Constructor.
 
str ClassName ()
 Get the class name.
 
 DisableObjectFlags (FBObjectFlag pFlags)
 Disable a specific Object Flags.
 
 EnableObjectFlags (FBObjectFlag pFlags)
 Enable a specific Object Flags.
 
bool FBCreate ()
 Open Reality Creation function.
 
 FBDelete ()
 Open Reality deletion function.
 
 FBDestroy ()
 Open Reality destruction function.
 
FBObjectFlag GetObjectFlags ()
 Get all Object Flags (concatenated).
 
bool GetObjectStatus (FBObjectStatus pStatus)
 Check to see if an object status is enabled.
 
FBFileReference GetOwnerFileReference (p0)
 Get the owner FileReference object.
 
 HardSelect ()
 HardSelect.
 
bool HasObjectFlags (FBObjectFlag pFlags)
 Check whether a specific object flag is enabled.
 
bool Is (int pTypeId)
 Returns true if object is of type TypeId.
 
bool ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessNamespaceHierarchy.
 
bool ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
 ProcessObjectNamespace.
 
int PropertyAdd (FBProperty pProperty)
 Add a property to the component's property manager.
 
bool PropertyAddReferenceProperty (FBProperty pReferenceProperty)
 Add a reference property to the component's property manager.
 
FBProperty PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
 Create user or dynamic property.
 
 PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
 Get list of properties which have been modified since last loading.
 
 PropertyRemove (FBProperty pProperty)
 Remove a Property from the component's Property manager.
 
 SetObjectFlags (FBObjectFlag pFlags)
 SetObjectFlags.
 
 SetObjectStatus (FBObjectStatus pStatus, bool pValue)
 Enable/Disable a specific Object Status.
 

Public Attributes

FBFCurveChanged OnFCurveEvent
 Event: Called when a registered FCurve is modified.

 
FBChanged OnPropertyEvent
 Event: Called when a registered property state is modified (detached, destroyed...).

 
- Public Attributes inherited from FBComponent
FBListComponent Components
 List: List of components.

 
str LongName
 Read Write Property: Name and namespace for object.

 
str Name
 Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.
 
FBListComponent Parents
 List: Parents.

 
FBManager PropertyList
 Read Only Property: Manages all of the properties for the component.

 
bool Selected
 Read Write Property: Selected property.

 
int TypeInfo
 Contains the Type information of the object.

 
- Public Attributes inherited from FBPlug
str ClassGroupName
 ClassGroupName of the object.

 
int TypeInfo
 TypeInfo.

 

Detailed Description

FCurve Event Manager Interface to the FBFCurveEventManager.


This class is used to track the changes on a FCurve of a property.

Member Function Documentation

◆ RegisterProperty()

bool RegisterProperty ( FBAnimatable  pProperty)

Register a property to the FCurve Event Manager.

Properties that are registered will receive events with the OnFCurveEvent/OnPropertyEvent properties when their FCurves are modified.

Parameters
pPropertyThe property to track.
Returns
True if the registration was successful, False otherwise.

◆ UnregisterProperty()

bool UnregisterProperty ( FBAnimatable  pProperty)

Unregister a property from the FCurve Event Manager.

Those properties will not be tracked and no update will be sent with the OnFCurveEvent/OnPropertyEvent properties anymore.

Parameters
pPropertyThe property to stop tracking.
Returns
True if the unregistration was successful, False otherwise.

Member Data Documentation

◆ OnFCurveEvent

FBFCurveChanged OnFCurveEvent

Event: Called when a registered FCurve is modified.

◆ OnPropertyEvent

FBChanged OnPropertyEvent

Event: Called when a registered property state is modified (detached, destroyed...).