fbmanipulator.h

Go to the documentation of this file.

#ifndef __FBMANIPULATOR_H__
#define __FBMANIPULATOR_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 <fbsdk/fbcomponent.h>
#include <fbcontrols/fbcontrols.h>

#ifdef FBSDKUseNamespace
    namespace FBSDKNamespace {
#endif

FB_FORWARD( FBModel );

FB_DEFINE_COMPONENT( FBSDK_DLL, Manipulator );
FB_DEFINE_COMPONENT( FBSDK_DLL, Camera  );

#define FBRegisterManipulator( ClassName, Label, Description, IconFilename ) \
    HIObject RegisterManipulator##ClassName( HIObject /*pOwner*/,const char* pName,void * /*pData*/) \
    { \
      ClassName *Class = new ClassName( Label ); \
        if (Class->FBCreate()) { \
            return Class->GetHIObject(); \
        } else { \
            delete Class; \
            return NULL; \
        } \
    } \
    FBLibraryModule( ClassName )    \
    {   \
        FBRegisterObject( ClassName,"Manipulators",Label,Description,RegisterManipulator##ClassName,true, IconFilename );   \
    }

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

#define FBManipulatorImplementation( ThisComponent ) \
        FBClassImplementation( ThisComponent )

// FBManipulator
enum FBManipulatorPickType      { 
    FBPickObjects,      
    FBPickPoints,       
    FBPickSurfaces      
};

__FB_FORWARD( FBManipulator );

class FBSDK_DLL FBManipulator : public FBComponent {
    __FBClassDeclare( FBManipulator,FBComponent );
public:
    FBManipulator(const char* pName, HIObject pObject=NULL);

    virtual bool FBCreate   ();

    // ***** Picking routines ******
    //---- Rectangle -----

    void        PickRectStart(FBManipulatorPickType pType);

    void        PickRectMotion();

    void        PickRectStop();

    //---- Single Pick -----

    void        Pick(FBManipulatorPickType pType);

    //---- Pick Result -----

    int         PickGetCount();

    FBModel*    PickGetModel(int pIndex);

    FBVertex    PickGetPoint(int pIndex);

    int         GetViewerWidth();

    int         GetViewerHeight();

    int         GetPanePosX();

    int         GetPanePosY();

    int         GetPaneWidth();

    int         GetPaneHeight();

    // Render begin/end 
    void        FBModelRenderBegin(FBModel* pModel);

    void        FBModelRenderEnd();

    virtual bool    ViewInput(int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey,int pModifier); // same as FBView

    virtual void    ViewExpose();

public:
    FBPropertyBool              Active;                     
    FBPropertyBool              AlwaysActive;               
    FBPropertyBool              Visible;                    
    FBPropertyBool              DefaultBehavior;            
    FBPropertyString            ViewerText;                 
    FBPropertyCamera            CurrentCamera;              
    FBPropertyBool              ConsumeEvent;               
                                                            //                               Custom manipulators will be called first, before the standard MotionBuilder manipulators.
                                                            //                               Remark: If your manipulator consumes an event, it must consumes all the event until the transaction is finished.
                                                            //                                       For example, if you consume the mouse down but not the mouse up, the other manipulator might be in an inconsistent state.
};

// Property list
FB_DEFINE_LIST( FBSDK_DLL, Manipulator );

class FBSDK_DLL FBPropertyListManipulator : public FBPropertyBaseList< FBManipulator* >
{
    virtual int  Add    ( FBManipulator* pItem );
    virtual void RemoveAt( int pIndex );
public:
    virtual FBManipulator* operator[](int pIndex);
    virtual int  GetCount();
};

// FBManipulatorTransform
__FB_FORWARD( FBManipulatorTransform );

FB_DEFINE_COMPONENT( FBSDK_DLL, ManipulatorTransform );

enum FBManipulatorTransformType { 
    kFBManipulatorTransformNone,        
    kFBManipulatorTransformTranslation, 
    kFBManipulatorTransformRotation,    
    kFBManipulatorTransformScaling      
};

FB_DEFINE_ENUM( FBSDK_DLL, ManipulatorTransformType );

class FBSDK_DLL FBManipulatorTransform : public FBManipulator {
    __FBClassDeclare( FBManipulatorTransform,FBManipulator );
public:
    FBManipulatorTransform(const char *pName,HIObject pObject=NULL);

    FBPropertyManipulatorTransformType      Type;                       
    FBPropertyBool                          IconVisible;                
    FBPropertyBool                          VertexSelectionEnabled;     
    FBPropertyBool                          VertexManipulationEnabled;  
};

#ifdef FBSDKUseNamespace
    }
#endif
#endif