coUIElement.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_UI_ELEMENT_H
#define CO_UI_ELEMENT_H
 
#ifndef coMax
#define coMax(v1, v2) ((v1) > (v2) ? (v1) : (v2))
#endif
 
#include <util/coTypes.h>
 
#include <OpenVRUI/sginterface/vruiMatrix.h>
#include <util/coTypes.h>
 
#include <string>
 
namespace vrui
{
 
class coUIContainer;
class coUIUserData;
 
class vruiTransformNode;
class vruiUIElementProvider;
 
class OPENVRUIEXPORT coUIElement
{
private:
    coUIContainer *parentContainer; 
    coUIUserData *userData; 
 
    std::string Unique_Name;
 
public:
    // it is the callers' responsibility to delete the returned matrix by calling vruiRendererInterface::the()->deleteMatrix(matrix);
    static vruiMatrix *getMatrixFromPositionHprScale(float x, float y, float z, float h, float p, float r, float scale);
 
    enum Material
    {
        RED = 0,
        GREEN,
        BLUE,
        YELLOW,
        GREY,
        WHITE,
        BLACK,
        DARK_YELLOW,
        WHITE_NL, 
        ITEM_BACKGROUND_NORMAL,
        ITEM_BACKGROUND_HIGHLIGHTED,
        ITEM_BACKGROUND_DISABLED,
        HANDLE_BACKGROUND_NORMAL,
        HANDLE_BACKGROUND_HIGHLIGHTED,
        HANDLE_BACKGROUND_DISABLED,
        BACKGROUND,
        NUM_MATERIALS 
    };
 
    coUIElement();
    virtual ~coUIElement();
 
    virtual void createGeometry();
 
    virtual void setParent(coUIContainer *);
    virtual coUIContainer *getParent();
 
    virtual void setEnabled(bool enabled);
    virtual void setHighlighted(bool highlighted);
    virtual void setVisible(bool visible);
 
    virtual bool isEnabled() const;
    virtual bool isHighlighted() const;
    virtual bool isVisible() const;
 
    virtual float getWidth() const = 0; 
    virtual float getHeight() const = 0; 
    virtual float getDepth() const;
    virtual float getXpos() const = 0; 
    virtual float getYpos() const = 0; 
    virtual float getZpos() const;
 
    virtual void childResized(bool shrink = true);
    virtual void resizeToParent(float, float, float, bool shrink = true);
    virtual void shrinkToMin();
 
    virtual void setPos(float, float, float) = 0;
    virtual void setSize(float, float, float);
    virtual void setSize(float);
    virtual float getResizePref() 
    {
        return 0.0f;
    }
    virtual void setUserData(coUIUserData *);
    virtual coUIUserData *getUserData() const;
 
    virtual vruiTransformNode *getDCS();
 
    virtual vruiUIElementProvider *getUIElementProvider() const
    {
        return uiElementProvider;
    }
 
    enum
    {
        LEFT = 0,
        TOP,
        RIGHT,
        BOTTOM,
        REPLACE
    } Attachments;
 
    virtual void setAttachment(int) 
    {
    }
    virtual int getAttachment() const 
    {
        return LEFT;
    }
 
    void setUniqueName(const char *);
    const char *getUniqueName() const;
 
    virtual const char *getClassName() const;
    virtual bool isOfClassName(const char *) const;
 
protected:
    virtual void resizeGeometry();
 
    float xScaleFactor; 
    float yScaleFactor; 
    float zScaleFactor; 
    bool enabled; 
    bool highlighted; 
    bool visible; 
 
    virtual const vruiMatrix *getTransformMatrix();
 
    vruiUIElementProvider *uiElementProvider;
 
private:
    vruiMatrix *transformMatrix;
};
}
#endif