fbtool.h

Go to the documentation of this file.

#ifndef __FBTOOL_H__
#define __FBTOOL_H__
/**************************************************************************
Copyright (c) 1994 - 2009 Autodesk, Inc. and/or its licensors.
All Rights Reserved.

The coded instructions, statements, computer programs, and/or related 
material (collectively the "Data") in these files contain unpublished 
information proprietary to Autodesk, Inc. and/or its licensors, which is 
protected by Canada and United States of America federal copyright law 
and by international treaties.

The Data may not be disclosed or distributed to third parties, in whole 
or in part, without the prior written consent of Autodesk, Inc. 
("Autodesk").

THE DATA IS PROVIDED "AS IS" AND WITHOUT WARRANTY.
ALL WARRANTIES ARE EXPRESSLY EXCLUDED AND DISCLAIMED. AUTODESK MAKES NO 
WARRANTY OF ANY KIND WITH RESPECT TO THE DATA, EXPRESS, IMPLIED OR 
ARISING BY CUSTOM OR TRADE USAGE, AND DISCLAIMS ANY IMPLIED WARRANTIES 
OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
PURPOSE OR USE. WITHOUT LIMITING THE FOREGOING, AUTODESK DOES NOT 
WARRANT THAT THE OPERATION OF THE DATA WILL BE UNINTERRUPTED OR ERROR 
FREE.

IN NO EVENT SHALL AUTODESK, ITS AFFILIATES, PARENT COMPANIES, LICENSORS 
OR SUPPLIERS ("AUTODESK GROUP") BE LIABLE FOR ANY LOSSES, DAMAGES OR 
EXPENSES OF ANY KIND (INCLUDING WITHOUT LIMITATION PUNITIVE OR MULTIPLE 
DAMAGES OR OTHER SPECIAL, DIRECT, INDIRECT, EXEMPLARY, INCIDENTAL, LOSS 
OF PROFITS, REVENUE OR DATA, COST OF COVER OR CONSEQUENTIAL LOSSES OR 
DAMAGES OF ANY KIND), HOWEVER CAUSED, AND REGARDLESS OF THE THEORY OF 
LIABILITY, WHETHER DERIVED FROM CONTRACT, TORT (INCLUDING, BUT NOT 
LIMITED TO, NEGLIGENCE), OR OTHERWISE, ARISING OUT OF OR RELATING TO THE 
DATA OR ITS USE OR ANY OTHER PERFORMANCE, WHETHER OR NOT AUTODESK HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

**************************************************************************/

#include <kaydaradef.h>
#ifndef FBSDK_DLL 

#define FBSDK_DLL K_DLLIMPORT
#endif

#include <fbcontrols/fbcontrols.h>

#ifdef FBSDKUseNamespace
namespace FBSDKNamespace {;
#endif

// FBTool

#define FBRegisterTool( ClassName, Label, Description, IconFilename ) \
    static HIObject RegisterTool##ClassName( HIObject pOwner,const char* pName,void * pData) \
{\
    ClassName *Class = new ClassName( Label ); \
    Class->mAllocated = true; \
    if( Class->FBCreate() ) {\
    return Class->GetHIObject(); \
    } else { \
    delete Class; \
    return NULL; \
    } \
} \
    FBLibraryModule( ClassName )    \
{   \
    FBRegisterObject( ClassName,"UI/Tools",Label,Description,RegisterTool##ClassName, false, IconFilename );\
}

#define FBToolDeclare( ClassName,Parent ) \
    FBClassDeclare( ClassName,Parent ); \
public: \
    ClassName(const char *pName=NULL):Parent(pName) { FBClassInit; } \
private:

#define FBToolImplementation( ThisComponent ) \
    FBClassImplementation( ThisComponent )

FB_FORWARD( FBFbxObject );
__FB_FORWARD( FBTool );

enum FBToolPossibleDockPosition
{
    kFBToolPossibleDockPosNone = 0, 
    kFBToolPossibleDockPosTop = (1 << 0),   
    kFBToolPossibleDockPosLeft = (1 << 1),
    kFBToolPossibleDockPosRight = (1 << 2),
    kFBToolPossibleDockPosBottom = (1 << 3),
};

class  FBSDK_DLL FBTool :   public FBLayout {
    __FBClassDeclare( FBTool,FBLayout );
public:
    FBTool(const char* pName = NULL);

    FBTool(const char* pName, bool pRegisterTool);

    virtual void Destroy(int pIsLocal);

    virtual bool    FbxStore    ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );
    virtual bool    FbxRetrieve ( FBFbxObject* pFbxObject, kFbxObjectStore pStoreWhat );

    FBToolPossibleDockPosition GetPossibleDockPosition();

    void SetPossibleDockPosition(FBToolPossibleDockPosition pFlags);

    IQuery_Declare(K_IMPLEMENTATION);       // Interface to IObject.

    FBPropertyInt       StartSize   [2];    
    FBPropertyInt       MaxSize     [2];    
    FBPropertyInt       MinSize     [2];    
    FBPropertyInt       StartPos    [2];    
    FBPropertyString    Name;               
private:

    void InitTool();
};

FBSDK_DLL bool FBPopNormalTool( const char* pToolName, bool pSetFocus = true );

FBSDK_DLL FBTool* FBShowToolByName( const char* pToolName, bool pResizeWnd = true );

FBSDK_DLL FBTool* FBShowTool( FBTool* pTool, bool pResizeWnd = true );

FBSDK_DLL bool FBCloseToolByName( const char* pToolName );

FBSDK_DLL bool FBCloseTool( FBTool* pTool );

FBSDK_DLL void FBDestroyToolByName( const char* pToolName );

FBSDK_DLL void FBDestroyTool( FBTool* pTool );

FBSDK_DLL void FBSetToolSizeByName( const char* pToolName, int pWidth, int pHeight );

FBSDK_DLL void FBSetToolSize( FBTool* pTool, int pWidth, int pHeight );

FBSDK_DLL void FBGetToolSizeByName( const char* pToolName, int &pWidth, int &pHeight );

FBSDK_DLL void FBGetToolSize( FBTool* pTool, int &pWidth, int &pHeight );

FBSDK_DLL void FBSetToolPositionByName( const char* pToolName, int pPosX, int pPosY );

FBSDK_DLL void FBSetToolPosition( FBTool* pTool, int pPosX, int pPosY );

FBSDK_DLL void FBGetToolPositionByName( const char* pToolName, int &pPosX, int &pPosY );

FBSDK_DLL void FBGetToolPosition( FBTool* pTool, int &pPosX, int &pPosY );

#ifdef FBSDKUseNamespace
}
#endif
#endif  /* __FBTOOL_H   */