widgets.h

Go to the documentation of this file.

/*
 * widgets.h
 *
 *  Created on: Jan 8, 2013
 *      Author: sushil
 */

#ifndef WIDGETS_H_
#define WIDGETS_H_

#include <OgreVector2.h>
#include <OgreColourValue.h>
#include <OgreOverlayManager.h>
#include <OgreOverlayContainer.h>
#include <OgreOverlayElement.h>
#include <OgreTextAreaOverlayElement.h>
#include <OISMouse.h>


#include <inputHandlers.h>
#include "commandFactory.h"
#include "GraphicsInteractionManager.h"




namespace OgreGFX
{

static std::string DEFAULT_PANEL_MATERIAL = "ECSLENT/navy/material/shipInfo/overlay";
static Ogre::Vector2 DEFAULT_LABEL_SIZE = Ogre::Vector2(100, 20);

enum Placement
{
    Below = 0,
    Right = 1
};

class GraphicsInteractionManager;

class Widget
{
public:
    Ogre::Vector2 pos; 
    Ogre::Vector2 size; 
    Widget *parent; 
    GraphicsInteractionManager *gfx; 
    Ogre::GuiMetricsMode mode;
    std::string desc; 
    Widget(GraphicsInteractionManager *gim, Widget *aParent = 0, Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::GuiMetricsMode
    defaultMode = Ogre::GMM_RELATIVE);
    ~Widget();

    Ogre::Vector2 screenPos();

    bool cursonInMe(const Ogre::Vector2 &pos);

    virtual void posChanged()
    {
    };

    virtual void show()
    {
    };

    virtual void hide()
    {
    };

    virtual Ogre::OverlayElement* getOverlayElementToAdd()
    {
        return 0;
    };

};

class UIOutline : public Widget
{
public:

    Ogre::OverlayManager *overlayManagerPtr;
    Ogre::Overlay* overlay;
    virtual void show();
    virtual void hide();

    UIOutline(GraphicsInteractionManager *gim);
    ~UIOutline();

};

class FEProgressBar : public Widget
{
private:

public:
    FEProgressBar(GraphicsInteractionManager *gim, std::string name = "FEProgressBar", Widget* aParent = 0,
            Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
            std::string barMaterial = DEFAULT_PANEL_MATERIAL, std::string fillMaterial = DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE); //: Widget(gim) {};
    ~FEProgressBar();

    //Ogre::Overlay* overlayPtr;
    Ogre::OverlayManager* overlayManagerPtr;
    Ogre::OverlayContainer *progressBar;
    //Ogre::OverlayContainer *progressFill;
    std::string barMaterial; 
    std::string fillMaterial; 
    std::string name; 
    double percentFull;
    
    void UpdateFillPercent();
    virtual void show();
    virtual void hide();
    virtual void posChanged();
    virtual Ogre::OverlayElement* getOverlayElementToAdd();

};

class FEPanel : public Widget
{
private:

public:
    FEPanel(GraphicsInteractionManager *gim, std::string name = "FEPanel", Widget* aParent = 0,
            Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize = Ogre::Vector2::NEGATIVE_UNIT_X,
            std::string material = DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE); //: Widget(gim) {};
    ~FEPanel();

    Ogre::Overlay* overlayPtr;
    Ogre::OverlayManager* overlayManagerPtr;
    Ogre::OverlayContainer *panel;
    //Ogre::TextAreaOverlayElement *textArea; /*! The visual element used to display text */
    std::string material; 
    std::string name; 
    Ogre::Vector2 belowPos; 
    Ogre::Vector2 rightPos; 
    Ogre::Vector2 gap; 
    std::list<Widget*> items; 
    std::list<Ogre::OverlayElement*> separators; 
    int separatorHeight; 
    virtual void show();
    virtual void hide();
    virtual void posChanged();

    void addItem(Widget *item, Placement placement = Below);

    //          void getItems();
    //          void getOverlayElementToAdd();

    void addSep(int separation);

    void adjustSeparators();
    Ogre::OverlayElement* makeSep();

    virtual Ogre::OverlayElement* getOverlayElementToAdd();

};

class FELabel : public Widget
{
public:
    FELabel(GraphicsInteractionManager *gim, std::string caption = "FELabel",
            Widget *aParent = 0, Ogre::ColourValue color = Ogre::ColourValue::Red,
            Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize = DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE);
    ~FELabel();

    Ogre::OverlayManager* overlayManagerPtr;
    std::string caption; 
    Ogre::ColourValue color; 
    Ogre::Vector2 offset; 
    Ogre::TextAreaOverlayElement* textArea; 
    virtual void setCaption(std::string val);

    virtual void show();
    virtual void hide();
    virtual void posChanged();
    virtual Ogre::OverlayElement* getOverlayElementToAdd();

};

class FELineWrapLabel : public FELabel
{
public:
    FELineWrapLabel(GraphicsInteractionManager *gim, std::string caption = "FELineWrapLabel",
            Widget *aParent = 0, Ogre::ColourValue color = Ogre::ColourValue::Red,
            Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X, Ogre::Vector2 defaultSize = DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE, double lines = 1);
            
    ~FELineWrapLabel();
    virtual void setCaption(std::string val);
    
    double lines;
    
};

class FEButton : public FEPanel, public MouseHandler, public KeyHandler
{
public:
    FEButton(GraphicsInteractionManager *gim, const OIS::KeyCode keyCode,
             const std::set<OIS::KeyCode> *modifierKeys, const OIS::MouseButtonID oisMouseButtonId,
             std::string name = "FEButton", FastEcslent::CommandFactory* command = NULL,
             Widget *aParent = 0,
             Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
             Ogre::Vector2 defaultSize = DEFAULT_LABEL_SIZE,std::string material = DEFAULT_PANEL_MATERIAL, std::string desc = "BLANK", Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE);
    ~FEButton();

    FastEcslent::CommandFactory* commandFactory; 
    bool pressed; 
    bool enabled; 
    virtual void handleMouseEvent(const OIS::MouseEvent &args);
    virtual void handleKeyEvent();
    virtual void show();
    virtual void hide();
    bool processButtonFirstEvent(bool buttonActivated);
    bool processButtonSecondEvent(bool buttonActivated);
};

// * a mouse click occurs inside its area. If a mouse event does occur in its area,
// * a function associated with that button is called. Buttons consume the mouse click,
// * so the mouse click doesn't get passed on to any units that might exist beneath the overlay. 
// */
//
//class FEButton : public FEPanel, public MouseHandler
//{
//public:
//    /*!
//     * Constructor for a Button widget, which displays some text. Clicking on the text causes a function to be called to perform some task.
//     * @param gim a pointer to the global Graphics Interaction Manager, to display widget.
//     * @param modifierKeys Pointer to a configuration of keyboard keys that must all be pressed for the button handler to be called.
//     * @param oisMouseButtonId The ID of the mouse button that must be pressed for the button handler to be called.
//     * @param caption The text to display in the panel
//     * @param aParent A pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
//     * @param color The color of the displayed text. Defaults to red
//     * @param defaultPos Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
//     * @param defaultSize length and height of the widget.
//     * @param pClickFunction Pointer to a function, which is called when the button handler is called.
//     * @see ~FEButton()
//     */
//    FEButton(GraphicsInteractionManager *gim,
//             const std::set<OIS::KeyCode> *modifierKeys, const OIS::MouseButtonID oisMouseButtonId,
//             std::string name = "FEButton",
//             Widget *aParent = 0, Ogre::ColourValue color = Ogre::ColourValue::Red,
//             Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
//             Ogre::Vector2 defaultSize = DEFAULT_LABEL_SIZE, bool (*pClickFunction)() = NULL, std::string material = DEFAULT_PANEL_MATERIAL, std::string = "BLANK", Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE);
//    ~FEButton();
//
//    bool (*pClickFunction)();
//    bool pressed; /*! Stores if the button has been clicked since last update */
//    bool enabled; /*! Stores if the button is available to be clicked or not. If false, clicking the button does not result in the associated function being called. */
//    /*!
//     * Mouse handler called when a mouse event occurs.
//     * @param args Information about the mouse state (mouse button, cursor position, etc).
//     * @return void
//     */
//    virtual void handleMouseEvent(const OIS::MouseEvent &args);
//    virtual void show();
//    virtual void hide();
//};
//
// */
//class FESCVButton : public FEButton
//{
//public:
//    /*!
//     * Constructor for a SCV button, which builds an SCV near the selected structure.
//     * @param gim a pointer to the global Graphics Interaction Manager, to display widget.
//     * @param modifierKeys Pointer to a configuration of keyboard keys that must all be pressed for the button handler to be called.
//     * @param oisMouseButtonId The ID of the mouse button that must be pressed for the button handler to be called.
//     * @param caption The text to display in the panel
//     * @param aParent A pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
//     * @param color The color of the displayed text. Defaults to red
//     * @param defaultPos Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
//     * @param defaultSize length and height of the widget.
//     * @see ~FESCVButton()
//     */
//    FESCVButton(GraphicsInteractionManager *gim,
//                const std::set<OIS::KeyCode> *modifierKeys, const OIS::MouseButtonID oisMouseButtonId,
//                std::string caption = "FEButton",
//                Widget *aParent = 0, Ogre::ColourValue color = Ogre::ColourValue::Red,
//                Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
//                Ogre::Vector2 defaultSize = DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE);
//    ~FESCVButton();
//
//    virtual void handleMouseEvent(const OIS::MouseEvent &args);
//};
//
// */
//class FEMarineButton : public FEButton
//{
//public:
//    /*!
//     * Constructor for a Marine button, which builds an Marine near the selected structure.
//     * @param gim a pointer to the global Graphics Interaction Manager, to display widget.
//     * @param modifierKeys Pointer to a configuration of keyboard keys that must all be pressed for the button handler to be called.
//     * @param oisMouseButtonId The ID of the mouse button that must be pressed for the button handler to be called.
//     * @param caption The text to display in the panel
//     * @param aParent A pointer to the parent node, if any (null if this is a root element, or pointer to another widget if this is a child of that widget). Defaults to NULL.
//     * @param color The color of the displayed text. Defaults to red
//     * @param defaultPos Upper-right corner position of the widget, in absolute coordinates if this is a parent node, or relative to the parent node if this is a child node.
//     * @param defaultSize length and height of the widget.
//     * @see ~FEMarineButton()
//     */
//    FEMarineButton(GraphicsInteractionManager *gim,
//                   const std::set<OIS::KeyCode> *modifierKeys, const OIS::MouseButtonID oisMouseButtonId,
//                   std::string caption = "FEButton",
//                   Widget *aParent = 0, Ogre::ColourValue color = Ogre::ColourValue::Red,
//                   Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
//                   Ogre::Vector2 defaultSize = DEFAULT_LABEL_SIZE, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE);
//    ~FEMarineButton();
//
//    virtual void handleMouseEvent(const OIS::MouseEvent &args);
//};

class FELabelPair : public FEPanel
{
public:
    FELabelPair(GraphicsInteractionManager *gim, std::string caption1 = "Key", std::string caption2 = "Value",
                Widget *aParent = 0, Ogre::ColourValue color = Ogre::ColourValue::Green,
                Ogre::Vector2 defaultPos = Ogre::Vector2::NEGATIVE_UNIT_X,
                Ogre::Vector2 defaultColumnWidths = Ogre::Vector2(100, 200), int columnHeight = DEFAULT_LABEL_SIZE.y,
                std::string materialName = DEFAULT_PANEL_MATERIAL, Ogre::GuiMetricsMode defaultMode = Ogre::GMM_RELATIVE);

    /*dimensions/positions are in pixels */
    ~FELabelPair()
    {
    };

    FELabel *left, *right;

    virtual void show();
    virtual void hide();

    void setLeft(std::string val);

    void setRight(std::string val);

};


}


#endif /* WIDGETS_H_ */

---