ViewObject.h

///
/// The view object.
///

#ifndef __VIEW_OBJECT_H__
#define __VIEW_OBJECT_H__

#include <string>

using namespace std;

#include "GameObject.h"
#include "Event.h"              

/// General location of ViewObject on screen.
enum ViewObjectLocation {
  TOP_LEFT,
  TOP_CENTER,
  TOP_RIGHT,
  BOTTOM_LEFT,
  BOTTOM_CENTER,
  BOTTOM_RIGHT,
};

class ViewObject : public Object {

 protected:
  string view_string;           ///< Label for value (e.g. "Points")
  int value;                    ///< Value displayed (e.g. points)
  bool border;                  ///< True if border around display
  int color;                    ///< Color for text

 public:
  /// Construct ViewObject. 
  /// Defaults: border, top_center, default color, current level.
  ViewObject(int on_level = -1);
  virtual ~ViewObject();

  /// Draw view string and value.
  virtual void draw();

  /// Handle "view" event if tag matches view_string (others ignored).
  /// Return 0 if ignored, else 1
  virtual int eventHandler(Event *p_event);

  /// General location of the ViewObject on the screen.
  void setLocation(ViewObjectLocation new_location);

  // Set persistence of object. Persistent objects are active across all
  // levels.  Return 0 if ok, else -1.
  int setPersistence(bool persistent);

  // Set visibility of object.  Objects not visible are not drawn.
  // Return 0 if ok, else -1.
  int setVisibility(bool visible);

  void setValue(int new_value);
  int getValue();
  void setBorder(bool new_border);
  bool getBorder();
  void setColor(int new_color);
  int getColor();
  void setViewString(string new_view_string);
  string getViewString();
};
#endif // __VIEW_OBJECT_H__