IViewportButton.h

Go to the documentation of this file.

/*==============================================================================
// Copyright (c) 1998-2008 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
// DESCRIPTION: Interface to the Simple Viewport Button System
// AUTHOR: Michael Zyracki created May/June 2008
//***************************************************************************/
#pragma once

#include "MaxHeap.h"
#include "ifnpub.h"
#include "strclass.h"
#include "IPoint2.h"
#include "color.h"
#include "box2.h"
// forward declarations
class GraphicsWindow;
class ViewExp;


class IViewportButton :public MaxHeapOperators
{

public:
    //constructor/deconstructor
    IViewportButton(){};
    virtual ~IViewportButton(){};

    //properties
    virtual bool GetEnabled()const =0;

    virtual void SetEnabled(bool v) =0;

    virtual MSTR GetLabel()const =0;

    virtual void SetLabel(MSTR &label)=0;

    virtual IPoint2 GetLocation() const =0;

    virtual void SetLocation(IPoint2 &loc)=0;

    virtual void SetColor(Color &c) =0;

    virtual Color GetColor()const =0;

    virtual bool ShowInActiveViewportOnly()=0;
    //Callbacks
    enum Action{
        eLeftClick = 0x0,
        eRightClick,
        eMouseMove,
    };

    virtual bool OnAction(HWND hwnd,GraphicsWindow *gw,IPoint2 hitLoc,IViewportButton::Action action)=0;

    virtual bool OnUpdate(HWND hwnd, ViewExp * vpt)=0;
    
    virtual void Display(TimeValue t, ViewExp *vpt, int flags) = 0;     

    virtual void GetViewportRect( TimeValue t, ViewExp *vpt, Rect *rect )=0;


};




class ViewportTextButton: public IViewportButton
{
public:
    CoreExport ViewportTextButton();
    CoreExport ~ViewportTextButton();
    
    //properties
    CoreExport bool GetEnabled()const;
    CoreExport void SetEnabled(bool v);
    CoreExport MSTR GetLabel()const;

    CoreExport void SetLabel(MSTR &label);
    CoreExport IPoint2 GetLocation() const;
    CoreExport void SetLocation(IPoint2 &loc);

    CoreExport void SetColor(Color &c);
    CoreExport Color GetColor()const;
    CoreExport bool ShowInActiveViewportOnly();
    
    CoreExport bool OnAction(HWND hwnd,GraphicsWindow *gw,IPoint2 hitLoc,IViewportButton::Action action);
    CoreExport bool OnUpdate(HWND hwnd, ViewExp * vpt); 
    //Display
    CoreExport void Display(TimeValue t, ViewExp *vpt, int flags);      
    CoreExport void GetViewportRect( TimeValue t, ViewExp *vpt, Rect *rect );

protected:
    bool mEnabled;
    MSTR mButtonText;
    MSTR mLabel;
    IPoint2 mLocation; 
    Color mColor;
    bool mMouseOver;
    bool mOldMouseOver;
};


#define IVIEWPORTBUTTONMANAGER_INTERFACE Interface_ID(0x47ab2195, 0x22e8126e)


class IViewportButtonManager : public FPStaticInterface
{
public:


    virtual void RegisterButton(IViewportButton *button)=0;


    virtual void UnRegisterButton(IViewportButton *button)=0;


    virtual bool IsButtonRegistered(IViewportButton *button)const=0;


    virtual int GetNumRegisteredButtons()const=0;


    virtual IViewportButton * GetViewportButton(int index)=0;
    

    virtual void EnableButtons(bool val)=0;


    virtual bool GetButtonsEnabled()const =0;


    virtual bool OnAction(HWND hwnd,GraphicsWindow *gw,IPoint2 hitLoc,IViewportButton::Action action) =0;


    virtual bool OnUpdate(HWND hwnd, ViewExp * vpt)=0;


    virtual bool HitTest(HWND hwnd,GraphicsWindow *gw,IPoint2 stringStartLoc, IPoint2 hitLoc,MSTR &string) = 0;


    virtual bool HitTest(HWND hwnd,GraphicsWindow *gw, IPoint2 hitLoc) = 0;


    virtual void DrawButtons(ViewExp * vpt, Rect * rect = NULL) =0; 

    virtual void RefreshButtonDisplay() = 0;
};