fbfilter.h File Reference

#include <kaydaradef.h>
#include <fbsdk/fbcomponent.h>

File Description

Derive new filters using the FBFilter class.

Definition in file fbfilter.h.

Classes
class	FBFilterManager
	Filter manager. More...
class	FBFilter
	Filters are used to modify motion capture data. More...

Namespaces
	ORSDK2018

Macros
#define	FBSDK_DLL   K_DLLIMPORT
	Be sure that FBSDK_DLL is defined only once... More...
#define	FBRegisterFilter(ClassName, Label, Description, FilterType, FilterErrorTable, FilterErrorCount, IconFilename)
	Filter class registration. More...
#define	FBFilterDeclare(ClassName, Parent )
	Filter class declaration. More...
#define	FBFilterImplementation(ThisComponent)   FBClassImplementation( ThisComponent )
	Filter class implementation. More...

Typedefs
typedef class FBPropertyBase< FBFilter *, kFBPT_object >	FBPropertyBaseFilter
typedef class FBPropertyBaseComponent< FBFilter * >	FBPropertyFilter
typedef class FBPropertyBase< FBFilterLayout *, kFBPT_object >	FBPropertyBaseFilterLayout
typedef class FBPropertyBaseComponent< FBFilterLayout * >	FBPropertyFilterLayout

Enumerations
enum	FBFilterType { kFBFilterNumber = 1 << 0, kFBFilterVector = 1 << 1 }
	Filter types. More...

Macro Definition Documentation

#define FBFilterDeclare	(		ClassName,
			Parent
	)

Value:

FBClassDeclare( ClassName,Parent); \
  public: \
    ClassName( HIObject pO = NULL ):Parent(pO) { FBClassInit; } \
  private:

Filter class declaration.

Parameters

ClassName	Filter class name.
Parent	Parent class name.

Examples:

Definition at line 105 of file fbfilter.h.

#define FBFilterImplementation

(

ThisComponent

)

FBClassImplementation( ThisComponent )

Filter class implementation.

Parameters

ThisComponent

Class to implement.

Examples:

Definition at line 114 of file fbfilter.h.

#define FBRegisterFilter	(		ClassName,
			Label,
			Description,
			FilterType,
			FilterErrorTable,
			FilterErrorCount,
			IconFilename
	)

Value:

HIObject RegisterFilter##ClassName( HIObject pOwner,const char * /*pName*/,void * /*pData*/) \
    { \
        ClassName *Class = new ClassName( ); \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
	FBLibraryModule( ClassName )   \
    {   \
		int lFilterType = FilterType; \
        if( (lFilterType) & kFBFilterNumber )   FBRegisterObject( ClassName,"Filter/DataType/Number",Label,Description,RegisterFilter##ClassName,true, IconFilename );  \
        if( (lFilterType) & kFBFilterVector )   FBRegisterObject( ClassName,"Filter/DataType/Vector",Label,Description,RegisterFilter##ClassName,true, IconFilename );  \
    }

Filter class registration.

Parameters

ClassName	Filter class name.
Label	Short description.
Description	Long description.
FilterType	Type of filter (see FBFilterType).
FilterErrorTable	Error strings for filter operations.
FilterErrorCount	Number of elements in FilterErrorTable.
IconFilename	Filename of associated icon.

Examples:

Definition at line 83 of file fbfilter.h.

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 48 of file fbfilter.h.

Go to the source code of this file.