#include <mobu-python-api.h>
Filters are used to modify motion capture data.
Filters are objects which can be applied on a FCurve, or the animation node associated with an animated object property, to modify shape and number of keys. Filters can be created from the GUI, using the Filters tool, or programmatically with an instance of a FBFilterManager. The filter properties can be found in the object's PropertyList data member. They will use the same name, and be of the same type, as what can be seen in the GUI.
Sample C++ code:
Sample Python code:
Public Member Functions | |
__reduce__ () | |
Apply (...) | |
FBDelete (FBFilter arg1) | |
Reset (FBFilter arg1) | |
Reset properties. More... | |
__init__ (...) | |
Constructor. More... | |
![]() | |
__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... | |
![]() | |
__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) |
![]() | |
__reduce__ () | |
__init__ (...) | |
Public Attributes | |
FBPropertyTime | Start |
Read Write Property: Start time of the filtering region More... | |
FBPropertyTime | Stop |
Read Write Property: Stop time of the filtering region More... | |
![]() | |
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... | |
![]() | |
object | OnUnbind |
__init__ | ( | ... | ) |
Constructor.
Python Docstring:
Raises an exception This class cannot be instantiated from Python
C++ Signature:
FBFilter(HIObject pObject = ((void *) 0))
pObject | For internal use only (default is NULL). |
__reduce__ | ( | ) |
Apply | ( | ... | ) |
Python Docstring:
Apply( (FBFilter)arg1, (FBAnimationNode)arg2, (object)arg3) -> bool Apply( (FBFilter)arg1, (FBFCurve)arg2) -> bool
Related C++ documentation:
The reference documentation for the following C++ symbols may contain additional relevant information.
FBDelete | ( | FBFilter | arg1 | ) |
Python Docstring:
FBDelete( (FBFilter)arg1) -> None
Reset | ( | FBFilter | arg1 | ) |
Reset properties.
Python Docstring:
Reset( (FBFilter)arg1) -> None
C++ Signature:
void Reset()
FBPropertyTime Start |
Read Write Property: Start time of the filtering region
FBPropertyTime Stop |
Read Write Property: Stop time of the filtering region