source: orxonox.OLD/orxonox/trunk/src/lib/graphics/render2D/element_2d.h @ 4848

/*!
 * @file element_2d.h
 * @brief Definition of the 2D elements rendered on top through the GraphicsEngine
*/

#ifndef _ELEMENT_2D_H
#define _ELEMENT_2D_H

#include "base_object.h"

// FORWARD DECLARATION
class PNode;

//!< An enumerator defining the Depth of a 2D-element.
typedef enum
{
  E2D_TOP,                             //!< Will be rendered on top of everything else
  E2D_MEDIUM,                          //!< Will be rendered on the medium Layer.
  E2D_BOTTOM,                          //!< Will be rendered on the bottom Layer
  E2D_BELOW_ALL,                       //!< Will be rendered below the 3D-scene. @todo make this work.

  E2D_LAYER_COUNT                      //!< The count of Layers.
} E2DLayer;


typedef enum
{
  E2D_ALIGN_NONE,
  E2D_ALIGN_LEFT,
  E2D_ALIGN_RIGHT,
  E2D_ALIGN_CENTER,
  E2D_ALIGN_SCREEN_CENTER
} E2D_ALIGNMENT;

//! A Struct defining the Position of an Element in 2D-space
struct Position2D
{
  float       x;                 //!< The x-coordinate.
  float       y;                 //!< The y-coordinate.
  float       depth;             //!< The distance from the viewing plane.

};

//! A class for ...
class Element2D : public BaseObject {

 public:
  Element2D();
  virtual ~Element2D();

  void setPosition(int xCoord, int yCoord);
  void setLayer(E2DLayer layer);
  /** @param visible true if the Element should be visible false otherwise (will not be rendered) */
  inline void setVisibility(bool visible) { this->visible = visible; };
  /** @param bindNode the Node this 2D-element should follow. if NULL the Element will not follow anything */
  inline void setBindNode(const PNode* bindNode) { this->bindNode = bindNode; };

  /** @returns the visibility state */
  inline bool isVisible() { return this->visible; };

  void positioning();
  virtual void tick(float dt);
  virtual void draw() const = NULL;

  private:
    void init();

 private:
   bool                    visible;
   int                     relPos2D[2];      //!< X-coord, Y-Coord (relative to the Coordinates of the alignment if given.)
   Position2D              absPos2D;         //!< The absolute position of the 2D-Element.
   E2DLayer                layer;

   E2D_ALIGNMENT           alignment;        //!< How the Element is aligned around its Position
   const PNode*            bindNode;         //!< a node over which to display this 2D-element
};


#endif /* _ELEMENT_2D_H */