Open Reality Reference Guide
 
Loading...
Searching...
No Matches
fbfilter.h
Go to the documentation of this file.
1#ifndef __FBFILTER_H__
2#define __FBFILTER_H__
3/**************************************************************************
4 Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
5 All Rights Reserved.
6
7 The coded instructions, statements, computer programs, and/or related
8 material (collectively the "Data") in these files contain unpublished
9 information proprietary to Autodesk, Inc. and/or its licensors, which is
10 protected by Canada and United States of America federal copyright law
11 and by international treaties.
12
13 The Data may not be disclosed or distributed to third parties, in whole
14 or in part, without the prior written consent of Autodesk, Inc.
15 ("Autodesk").
16
17 THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
18 ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO
19 WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR
20 ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES
21 OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR
22 PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT
23 WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR
24 FREE.
25
26 IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS
27 OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR
28 EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE
29 DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS
30 OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR
31 DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF
32 LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT
33 LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE
34 DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS
35 BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
36
37**************************************************************************/
38
43#include <kaydaradef.h>
44#ifndef FBSDK_DLL
48 #define FBSDK_DLL K_DLLIMPORT
49#endif
50
51#include <fbsdk/fbcomponent.h>
52
53#ifdef FBSDKUseNamespace
54 namespace FBSDKNamespace {
55#endif
56
58__FB_FORWARD( FBPropertyListFilter );
59
61FB_DEFINE_COMPONENT( FBSDK_DLL, FilterLayout );
62
70 kFBFilterNumber = 1 << 0,
71 kFBFilterVector = 1 << 1,
72};
73
83#define FBRegisterFilter( ClassName, Label, Description, FilterType, FilterErrorTable, FilterErrorCount, IconFilename ) \
84 HIObject RegisterFilter##ClassName( HIObject pOwner,const char * /*pName*/,void * /*pData*/) \
85 { \
86 ClassName *Class = new ClassName( ); \
87 if (Class->FBCreate()) { \
88 return Class->GetHIObject(); \
89 } else { \
90 delete Class; \
91 return NULL; \
92 } \
93 } \
94 FBLibraryModule( ClassName ) \
95 { \
96 int lFilterType = FilterType; \
97 if( (lFilterType) & kFBFilterNumber ) FBRegisterObject( ClassName,"Filter/DataType/Number",Label,Description,RegisterFilter##ClassName,true, IconFilename ); \
98 if( (lFilterType) & kFBFilterVector ) FBRegisterObject( ClassName,"Filter/DataType/Vector",Label,Description,RegisterFilter##ClassName,true, IconFilename ); \
99 }
100
105#define FBFilterDeclare( ClassName, Parent ) \
106 FBClassDeclare( ClassName,Parent); \
107 public: \
108 ClassName( HIObject pO = NULL ):Parent(pO) { FBClassInit; } \
109 private:
110
114#define FBFilterImplementation( ThisComponent ) \
115 FBClassImplementation( ThisComponent )
116
117
118
120// FBFilterManager
124
196{
202
207 FBFilterManager& operator=( const FBFilterManager& );
208
209public:
210
213
220
225 FBFilter* CreateFilter( const char* pFilterTypeName );
226
236};
237
238
240// FBFilter - Filter layer on top of internals.
242
308{
309 //--- Open Reality declaration.
311public:
315 FBFilter( HIObject pObject = NULL );
316
324 virtual bool Apply( FBFCurve* pCurve );
325
332 virtual bool Apply( FBAnimationNode* pNode, bool pRecursive );
333
337 virtual void Reset();
338
339
342};
343
344#ifdef FBSDKUseNamespace
345 }
346#endif
347#endif /* _FB_FILTER_H_ */
MotionBuilder SDK base class.
FCurve class.
Definition fbdata.h:340
Filters are used to modify motion capture data.
Definition fbfilter.h:308
virtual bool Apply(FBAnimationNode *pNode, bool pRecursive)
Apply the filter to an animation node.
FBFilter(HIObject pObject=NULL)
Constructor.
FBPropertyTime Start
Read Write Property: Start time of the filtering region
Definition fbfilter.h:340
FBPropertyTime Stop
Read Write Property: Stop time of the filtering region
Definition fbfilter.h:341
virtual void Reset()
Reset properties.
virtual bool Apply(FBFCurve *pCurve)
Apply the filter to an FCurve.
Filter manager.
Definition fbfilter.h:196
FBFilterManager()
Constructor.
FBStringList FilterTypeNames
List of available filters.
Definition fbfilter.h:235
~FBFilterManager()
Destructor.
FBFilter * CreateFilter(const char *pFilterTypeName)
Create a filter instance according to the filter type requested.
String list.
Definition fbstring.h:208
Basic class definitions.
#define __FBClassDeclare(Name, Parent)
For internal use only.
#define FBSDK_DLL
Be sure that FBSDK_DLL is defined only once...
FBFilterType
Filter types.
Definition fbfilter.h:69
@ kFBFilterVector
Filter a vector (3 FCurves).
Definition fbfilter.h:71
@ kFBFilterNumber
Filter single FCurves.
Definition fbfilter.h:70
class K_DLLIMPORT FBPropertyBase< FBTime, kFBPT_Time > FBPropertyTime
Property: FBTime
#define FB_DEFINE_COMPONENT(DllTag, Type)
Define a component and give it the ability to be a property.
#define FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition fbtypes.h:62
#define __FB_FORWARD(ClassName)
Forwarding of class and typedef declaration.
Definition fbtypes.h:68