Add an Actor class to replace the Sprite class

The Actor class manages the Map reference, position vector, and alpha float.
These are the common parts from it's children.

1 files changed, 131 insertions, 0 deletions

diff --git a/src/actor.h b/src/actor.h
new file mode 100644
index 00000000..59e29b88
--- /dev/null
+++ b/src/actor.h
@@ -0,0 +1,131 @@
+/*
+ *  The Mana Client
+ *  Copyright (C) 2010  The Mana Developers
+ *
+ *  This file is part of The Mana Client.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef ACTOR_H
+#define ACTOR_H
+
+#include "vector.h"
+
+#include <list>
+
+class Actor;
+class Graphics;
+class Image;
+class Map;
+
+typedef std::list<Actor*> Actors;
+
+class Actor
+{
+public:
+    Actor();
+
+    virtual ~Actor();
+
+    /**
+     * Draws the Actor to the given graphics context.
+     *
+     * Note: this function could be simplified if the graphics context
+     * would support setting a translation offset. It already does this
+     * partly with the clipping rectangle support.
+     */
+    virtual void draw(Graphics *graphics, int offsetX, int offsetY) const = 0;
+
+    /**
+     * Returns the horizontal size of the actors graphical representation
+     * in pixels or 0 when it is undefined.
+     */
+    virtual int getWidth() const
+    { return 0; }
+
+    /**
+     * Returns the vertical size of the actors graphical representation
+     * in pixels or 0 when it is undefined.
+     */
+    virtual int getHeight() const
+    { return 0; }
+
+    /**
+     * Returns the pixel position of this actor.
+     */
+    const Vector &getPosition() const
+    { return mPos; }
+
+    /**
+     * Sets the pixel position of this actor.
+     */
+    virtual void setPosition(const Vector &pos)
+    { mPos = pos; }
+
+    /**
+     * Returns the pixels X coordinate of the actor.
+     */
+    int getPixelX() const
+    { return (int) mPos.x; }
+
+    /**
+     * Returns the pixel Y coordinate of the actor.
+     */
+    virtual int getPixelY() const
+    { return (int) mPos.y; }
+
+    /**
+     * Returns the x coordinate in tiles of the actor.
+     */
+    virtual int getTileX() const;
+
+    /**
+     * Returns the y coordinate in tiles of the actor.
+     */
+    virtual int getTileY() const;
+
+    /**
+     * Returns the number of Image layers used to draw the actor.
+     */
+    virtual int getNumberOfLayers() const
+    { return 0; }
+
+    /**
+     * Returns the current alpha value used to draw the actor.
+     */
+    virtual float getAlpha() const
+    { return mAlpha; }
+
+    /**
+     * Sets the alpha value used to draw the actor.
+     */
+    virtual void setAlpha(float alpha)
+    { mAlpha = alpha; }
+
+    void setMap(Map *map);
+
+    Map* getMap() const
+    { return mMap; }
+
+protected:
+    Map *mMap;
+    Vector mPos;                /**< Position in pixels relative to map. */
+    float mAlpha;
+
+private:
+    Actors::iterator mMapActor;
+};
+
+#endif // ACTOR_H