coMenu.h

Go to the documentation of this file.

/* This file is part of COVISE.
 
   You can use it under the terms of the GNU Lesser General Public License
   version 2.1 or later, see lgpl-2.1.txt.
 
 * License: LGPL 2+ */
 
#ifndef CO_MENU_H
#define CO_MENU_H
 
#include <OpenVRUI/coUpdateManager.h>
#include <OpenVRUI/coMenuItem.h>
#include <OpenVRUI/coAction.h>
 
#include <util/coTypes.h>
 
#include <list>
#include <vector>
#include <string>
 
namespace vrui
{
 
class coMenuItem;
class coGenericSubMenuItem;
class coCombinedButtonInteraction;
 
class vruiMatrix;
 
typedef std::vector<coMenuItem *> coMenuItemVector;
 
class OPENVRUIEXPORT coMenuFocusListener
{
public:
    virtual ~coMenuFocusListener()
    {
    }
    virtual void focusEvent(bool focus, coMenu *menu) = 0;
};
 
class OPENVRUIEXPORT coMenu : public coAction, public coUpdateable
{
public:
    coMenu(coMenu *parentMenu, const std::string &name);
    virtual ~coMenu();
 
    virtual void setTransformMatrix(vruiMatrix *matrix) = 0;
    virtual void setTransformMatrix(vruiMatrix *matrix, float scale) = 0;
    //       virtual vruiMatrix* getTransformMatrixLocal() = 0;
    //       virtual void setOffsetMatrix(vruiMatrix * matrix) = 0;
 
    virtual void setScale(float s) = 0; 
    virtual float getScale() const = 0; 
    virtual void add(coMenuItem *item);
    virtual void insert(coMenuItem *item, int location);
    virtual void setMenuListener(coMenuFocusListener *listener);
    virtual int hit(vruiHit *hit);
    virtual void miss();
    virtual coUIElement *getUIElement();
    virtual void setVisible(bool);
    virtual void positionAllSubmenus();
    virtual void remove(coMenuItem *item);
    virtual void removeAll();
    virtual int getItemCount() const;
    virtual void closeMenu();
 
    virtual void selected(bool select); 
    virtual void doActionPress(); 
    virtual void doActionRelease(); 
    virtual void doSecondActionPress(); 
    virtual void doSecondActionRelease(); 
    virtual void makeVisible(coMenuItem *); 
 
    virtual vruiTransformNode *getDCS() = 0; 
 
    virtual bool isInteractionActive() const;
    coCombinedButtonInteraction *getInteraction() const;
    coCombinedButtonInteraction *getMoveInteraction() const;
 
    // Functions to Show and Hide the Menu
    virtual void show() = 0; 
    virtual void hide() = 0; 
 
    enum 
    {
        MENU_ONOFF = 0,
        MENU_SLIDE
    };
 
    void setShowMode(int mode);
    int getShowMode() const;
 
    virtual void setSubMenuItem(coGenericSubMenuItem *item);
    coGenericSubMenuItem *getSubMenuItem();
 
    virtual const char *getClassName() const;
    virtual bool isOfClassName(const char *) const;
 
    void closeAllOtherMenus(coMenuItem *leave = 0);
 
    void removeAllAfter(coMenuItem *last);
 
    bool isVisible() const;
 
    const char *getName() const;
 
    // get my menu's items
    coMenuItemVector getAllItems();
 
    coMenuItem *getItemByName(const char *name);
 
    // check if menu contains item, return position in menu or -1
    int index(const coMenuItem *item);
 
    // test change parent
    void setParent(coMenu *newParent)
    {
        parent = newParent;
    };
    const coMenu *getParent()
    {
        return parent;
    };
 
    virtual void setAttachment(int att);
    virtual int getAttachment() const
    {
        return attachment_;
    };
 
    bool wasMoved() const;
    void setMoved(bool flag);
 
protected:
    std::list<coMenuItem *> items; 
    coMenu *parent; 
 
    coGenericSubMenuItem *myMenuItem;
    coMenuFocusListener *listener; 
 
    int showMode; 
    bool visible;
    std::string name;
    coCombinedButtonInteraction *interaction;
    coCombinedButtonInteraction *moveInteraction;
    coCombinedButtonInteraction *wheelInteraction; 
 
    float scale_;
    vruiMatrix *matrix_;
 
    int attachment_;
    bool wasMoved_ = false;
};
}
#endif