FBFilterManager Class Reference

FBFilterManager Class Reference

#include <mobu-python-api.h>

Class Description

Filter manager.

This class provides list of all available filter types and a factory method in order to create an instance of the desired filter type. This manager will list both built-in and plug-in filters. See the class FBFilter for more details.

Note
Filter type names are not localised, and are the same as presented in the GUI.

The following sample code shows how to use C++ or Python to create an instance of the orfilter_template filter and set one of its property. For the sample code to work, the plugin must have been compiled and copied in the plugins folder prior to the application startup. Sample C++ code:

// Create a filter of a known type. In this case the sample filter
// provided with the samples: orfilter_template.
FBFilterManager lFilterManager;
FBFilter* lFilter = lFilterManager.CreateFilter( "OR - Filter Template" );
// Set one of the filter property:
FBPropertyDouble* lPropDouble = (FBPropertyDouble*)lFilter->PropertyList.Find( "Test Double" );
if( lPropDouble )
{
(*lPropDouble) = 2.0;
}
// Now we can apply the filter on an FCurve.
// ...
// And when we are done, destroy it.
lFilter->FBDelete();
lFilter = NULL;

Sample Python code:

from pyfbsdk import *
# Create a filter of a known type. In this case the sample filter
# provided with the samples: orfilter_template.
lFilterManager = FBFilterManager()
lFilter = lFilterManager.CreateFilter( 'OR - Filter Template' );
# Set one of the filter property:
lPropDouble = lFilter.PropertyList.Find( 'Test Double' );
if lPropDouble: lPropDouble.Data = 2.0
# Now we can apply the filter on an FCurve.
# ...
# And when we are done, destroy it.
lFilter.FBDelete()
+ Inheritance diagram for FBFilterManager:

Public Member Functions

 __reduce__ ()
 
 __init__ (object arg1)
 
object CreateFilter (FBFilterManager arg1, str arg2)
 Create a filter instance according to the filter type requested. More...
 

Public Attributes

ORSDK2018::FBStringList FilterTypeNames
 List of available filters. More...
 

Member Function Documentation

__init__ ( object  arg1)

Python Docstring:

__init__( (object)arg1) -> None 

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

__reduce__ ( )
object CreateFilter ( FBFilterManager  arg1,
str  arg2 
)

Create a filter instance according to the filter type requested.

Python Docstring:

CreateFilter( (FBFilterManager)arg1, (str)arg2) -> object 

C++ Signature:

ORSDK2018::FBFilter * CreateFilter(const char * pFilterTypeName) 
Parameters
pFilterTypeNameString describing the type of the desired filter, as obtained from list FilterTypeNames.
Returns
A pointer to a filter instance, or a NULL if the type name was invalid.

Member Data Documentation

ORSDK2018::FBStringList FilterTypeNames

List of available filters.

This list does provide the complete list of available filters, both system defined and user defined.

Warning
This list should not be modified. Changes to its value will not affect the shaders supported.