fbcontrols/fbtool.h Source File
 
 
 
fbcontrols/fbtool.h
Go to the documentation of this file.
00001 #ifndef __FBTOOL_H__
00002 #define __FBTOOL_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 <fbcontrols/fbcontrols.h>
00052 
00053 #ifdef FBSDKUseNamespace
00054         namespace FBSDKNamespace {
00055 #endif
00056 
00058 // FBTool
00060 
00066 #define FBRegisterTool( ClassName, Label, Description, IconFilename ) \
00067         static HIObject RegisterTool##ClassName( HIObject pOwner,const char* pName,void * pData) \
00068         {\
00069                 ClassName *Class = new ClassName( Label ); \
00070                 if( Class->FBCreate() ) {\
00071                         return Class->GetHIObject(); \
00072                 } else { \
00073                         delete Class; \
00074                         return NULL; \
00075                 } \
00076         } \
00077         FBLibraryModule( ClassName )    \
00078         {       \
00079                 FBRegisterObject( ClassName,"UI/Tools",Label,Description,RegisterTool##ClassName, false, IconFilename );\
00080         }
00081 
00086 #define FBToolDeclare( ClassName,Parent ) \
00087         FBClassDeclare( ClassName,Parent ); \
00088   public: \
00089   ClassName(const char *pName=NULL):Parent(pName) { FBClassInit; } \
00090   private:
00091 
00095 #define FBToolImplementation( ThisComponent ) \
00096         FBClassImplementation( ThisComponent )
00097 
00098 FB_FORWARD( FBFbxObject );
00099 __FB_FORWARD( FBTool );
00100 
00101 enum FBToolPossibleDockPosition
00102 {
00103         kFBToolPossibleDockPosNone = 0, 
00104         kFBToolPossibleDockPosTop = (1 << 0),   
00105         kFBToolPossibleDockPosLeft = (1 << 1),
00106         kFBToolPossibleDockPosRight = (1 << 2),
00107         kFBToolPossibleDockPosBottom = (1 << 3),
00108 };
00109 
00111 class  FBSDK_DLL FBTool :       public FBLayout {
00112         __FBClassDeclare( FBTool,FBLayout );
00113 public:
00117         FBTool(const char* pName = NULL);
00118 
00123         FBTool(const char* pName, bool pRegisterTool);
00124 
00128     virtual void Destroy(int pIsLocal);
00130 
00134         virtual bool    FbxStore        ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
00135         virtual bool    FbxRetrieve     ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
00137 
00141         FBToolPossibleDockPosition GetPossibleDockPosition();
00142 
00146         void SetPossibleDockPosition(FBToolPossibleDockPosition pFlags);
00147 
00148         IQuery_Declare(K_IMPLEMENTATION);               // Interface to IObject.
00149 
00150         FBPropertyInt           StartSize       [2];    
00151         FBPropertyInt           MaxSize         [2];    
00152         FBPropertyInt           MinSize         [2];    
00153         FBPropertyInt           StartPos        [2];    
00154     FBPropertyString    Name;               
00155 private:
00156 
00157     void InitTool();
00158 };
00159 
00160 #ifdef FBSDKUseNamespace
00161         }
00162 #endif
00163 #endif  /* __FBTOOL_H   */