fbsdk/fbfilter.h Source File
 
 
 
fbsdk/fbfilter.h
Go to the documentation of this file.
00001 #ifndef __FBFILTER_H__
00002 #define __FBFILTER_H__
00003 /**************************************************************************
00004  Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
00005  All Rights Reserved.
00006  
00007  The coded instructions, statements, computer programs, and/or related 
00008  material (collectively the "Data") in these files contain unpublished 
00009  information proprietary to Autodesk, Inc. and/or its licensors, which is 
00010  protected by Canada and United States of America federal copyright law 
00011  and by international treaties.
00012  
00013  The Data may not be disclosed or distributed to third parties, in whole 
00014  or in part, without the prior written consent of Autodesk, Inc. 
00015  ("Autodesk").
00016  
00017  THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
00018  ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
00019  WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
00020  ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
00021  OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
00022  PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
00023  WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
00024  FREE.
00025  
00026  IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
00027  OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
00028  EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
00029  DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
00030  OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
00031  DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
00032  LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
00033  LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
00034  DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
00035  BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.
00036  
00037 **************************************************************************/
00038 
00043 #include <kaydaradef.h>
00044 #ifndef FBSDK_DLL 
00045 
00048         #define FBSDK_DLL K_DLLIMPORT
00049 #endif
00050 
00051 #include <fbsdk/fbcomponent.h>
00052 
00053 #ifdef FBSDKUseNamespace
00054         namespace FBSDKNamespace {
00055 #endif
00056 
00057 __FB_FORWARD( FBFilter                          );
00058 __FB_FORWARD( FBPropertyListFilter      );
00059 
00060 FB_DEFINE_COMPONENT( FBSDK_DLL, Filter          );
00061 FB_DEFINE_COMPONENT( FBSDK_DLL, FilterLayout    );
00062 
00069 enum FBFilterType { 
00070         kFBFilterNumber = 1 << 0,       
00071         kFBFilterVector = 1 << 1,       
00072 };
00073 
00083 #define FBRegisterFilter( ClassName, Label, Description, FilterType, FilterErrorTable, FilterErrorCount, IconFilename ) \
00084         HIObject RegisterFilter##ClassName( HIObject pOwner,const char * /*pName*/,void * /*pData*/) \
00085         { \
00086             ClassName *Class = new ClassName( ); \
00087                 if (Class->FBCreate()) { \
00088                         return Class->GetHIObject(); \
00089                 } else { \
00090                         delete Class; \
00091                         return NULL; \
00092                 } \
00093         } \
00094         FBLibraryModule( ClassName )    \
00095         {       \
00096                 int lFilterType = FilterType; \
00097                 if( (lFilterType) & kFBFilterNumber )   FBRegisterObject( ClassName,"Filter/DataType/Number",Label,Description,RegisterFilter##ClassName,true, IconFilename );  \
00098                 if( (lFilterType) & kFBFilterVector )   FBRegisterObject( ClassName,"Filter/DataType/Vector",Label,Description,RegisterFilter##ClassName,true, IconFilename );  \
00099         }
00100 
00105 #define FBFilterDeclare( ClassName, Parent  ) \
00106         FBClassDeclare( ClassName,Parent); \
00107   public: \
00108         ClassName( HIObject pO = NULL ):Parent(pO) { FBClassInit; } \
00109   private:
00110 
00114 #define FBFilterImplementation( ThisComponent ) \
00115                 FBClassImplementation( ThisComponent )
00116 
00117 
00118 
00120 // FBFilterManager
00122 FB_FORWARD( FBFilterManager );
00123 FB_FORWARD( FBFilter );
00124 
00195 class FBSDK_DLL FBFilterManager
00196 {
00201     FBFilterManager( const FBFilterManager& );
00202 
00207     FBFilterManager& operator=( const FBFilterManager& );
00208 
00209 public:
00210 
00212     FBFilterManager();
00213 
00219     ~FBFilterManager();
00220 
00225     FBFilter* CreateFilter( const char* pFilterTypeName );
00226 
00235     FBStringList FilterTypeNames;
00236 };
00237 
00238 
00240 // FBFilter - Filter layer on top of internals.
00242 
00307 class FBSDK_DLL FBFilter : public FBComponent
00308 {
00309         //--- Open Reality declaration.
00310         __FBClassDeclare( FBFilter, FBComponent );
00311 public:
00315         FBFilter( HIObject pObject = NULL  );
00316 
00324         virtual bool Apply( FBFCurve* pCurve );
00325 
00332         virtual bool Apply( FBAnimationNode* pNode, bool pRecursive );
00333 
00337         virtual void Reset();
00338 
00339 
00340         FBPropertyTime Start;   
00341         FBPropertyTime Stop;    
00342 };
00343 
00344 #ifdef FBSDKUseNamespace
00345         }
00346 #endif
00347 #endif /* _FB_FILTER_H_ */