Object.h

///
/// The base object.
///

#ifndef __OBJECT_H__
#define __OBJECT_H__

#include "Position.h"           ///< Objects need a location.
#include "Box.h"                ///< Objects have a bounding box.
#include "Event.h"              ///< Objects can handle events.
#include "Sprite.h"             ///< Objects (often) have sprites.

class Object {

 private:
  int id;                       ///< Globally unique id of object
  bool is_visible;              ///< If true, object gets drawn.
  bool is_persistent;           ///< If true, object are active all levels.

 protected:
  string type;                  ///< User-defined identification.
  Position pos;                 ///< Position in the game world.
  Sprite *p_sprite;             ///< The sprite associated with this object.
  bool sprite_center;           ///< True if sprite is centered on object.
  int sprite_index;             ///< Current index frame for sprite.
  int sprite_slowdown;          ///< Slowdown rate (1 = no slowdown, 0 = stop).
  int sprite_slowdown_count;    ///< Slowdown counter.
  Box box;                      ///< Box for sprite boundary & collisions.
  
 public:
  Object();
  virtual ~Object();
  void setId(int new_id);
  int getId();
  void setType(string new_type);
  string getType();
  void setBox(Box new_box);
  Box getBox();
  void setPosition(Position new_pos);
  Position getPosition();

  /// Set persistence of object.  Returns 0.
  virtual int setPersistence(bool persistent);

  /// Return persistence of object. Persistent objects are active across all
  /// levels. 
  bool isPersistent();

  /// Set visibility of object.  Objects not visible are not drawn.
  /// Return 0.
  virtual int setVisibility(bool visible);

  /// Return visibility of object.  Objects not visible are not drawn.
  bool isVisible();

  /// Handle event (default is to ignore everything).
  /// Return 0 if ignored, else 1
  virtual int eventHandler(Event *p_event);

  /// Draw single sprite frame.
  /// Drawing accounts for: centering, slowdown,
  /// advancing Sprite Frame (as appropriate for each).
  virtual void draw();

  /// Set Sprite associated with this object to new one.
  /// Set bounding box to size of sprite.
  void setSprite(Sprite *p_new_sprite);

  /// Set object Sprite to new one.
  /// If set_box is true, set bounding box to size of Sprite.
  void setSprite(Sprite *p_new_sprite, bool set_box);

  /// Return pointer to Sprite associated with this object.
  Sprite *getSprite();

  /// Indicates if sprite is centered at object Position (pos).
  bool isCentered();

  /// Indicate sprite is to centered at object Position (pos).
  void setCentered(bool centered);

  /// Return the index of current Sprite frame to be displayed.
  int getSpriteIndex();

  /// Set index of current Sprite frame to be displayed.
  void setSpriteIndex(int new_sprite_index);

  /// Slows down sprite animations.
  /// new_sprite_slowdown is in multiples of WorldManager frame time.
  void setSpriteSlowdown(int new_sprite_slowdown);
  int getSpriteSlowdown();
  void setSpriteSlowdownCount(int new_sprite_slowdown_count);
  int getSpriteSlowdownCount();
};
 
#endif // __OBJECT_H__