FBFilterManager Class Reference

FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager FBFilterManager
Inheritance diagram for FBFilterManager:
Inheritance graph
[legend]

List of all members.


Detailed 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.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;

    HFBFilter 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()

Public Member Functions

  FBFilterManager ()
  Constructor.
FBFilter  CreateFilter (str pFilterTypeName)
  Create a filter instance according to the filter type requested.

Public Attributes

FBStringList  FilterTypeNames
  List of available filters.

Constructor & Destructor Documentation

FBFilterManager (  ) 

Constructor.


Member Function Documentation

FBFilter CreateFilter ( str  pFilterTypeName  ) 

Create a filter instance according to the filter type requested.

Parameters:
pFilterTypeName  String 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

FBStringList FilterTypeNames

List of available filters.


Generated on Tue Feb 9 19:34:21 2010 for Python Reference Guide by  doxygen 1.5.3