Added particle containers and refactored beings to use them (to clean up responsibilities a little)

1 files changed, 106 insertions, 0 deletions

diff --git a/src/particlecontainer.h b/src/particlecontainer.h
new file mode 100644
index 00000000..a6a1b1c8
--- /dev/null
+++ b/src/particlecontainer.h
@@ -0,0 +1,106 @@
+/*
+ *  The Mana World
+ *  Copyright 2008 The Mana World Development Team
+ *
+ *  This file is part of The Mana World.
+ *
+ *  The Mana World 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.
+ *
+ *  The Mana World 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 The Mana World; if not, write to the Free Software
+ *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ */
+
+#ifndef _PARTICLE_CONTAINER_H
+#define _PARTICLE_CONTAINER_H
+
+#include <list>
+#include <vector>
+
+#include "particle.h"
+
+
+/**
+ * Set of particle effects.  May be stacked with other ParticleContainers.  All
+ * operations herein affect such stacked containers, unless the operations end
+ * in `Locally'.
+ */
+class ParticleContainer
+{
+public:
+    /**
+     * Constructs a new particle container and assumes responsibility for
+     * its parent (for all operations defined herein, except when ending in `Locally')
+     *
+     * delParent means that the destructor should also free the parent.
+     */
+     ParticleContainer(ParticleContainer *parent = NULL, bool delParent = true);
+    ~ParticleContainer();
+
+    /**
+     * Takes control of and adds a particle
+     */
+    void addLocally(Particle *);
+
+    /**
+     * `kills' and removes a particle
+     */
+    void removeLocally(Particle *);
+
+    /**
+     * Kills and removes all particle effects
+     */
+    void clear();
+
+    /**
+     * Kills and removes all particle effects (only in this container)
+     */
+    virtual void clearLocally();
+
+    /**
+     * Sets the positions of all elements
+     */
+    virtual void setPositions(float x, float y);
+
+protected:
+    bool mDelParent;			/**< Delete mNext in destructor */
+    std::list<Particle *> mElements;	/**< Contained particle effects */
+    ParticleContainer *mNext;		/**< Contained container, if any */
+};
+
+
+/**
+ * Particle container with indexing facilities
+ */
+class ParticleVector : public ParticleContainer
+{
+public:
+    ParticleVector(ParticleContainer *parent = NULL, bool delParent = true);
+
+    /**
+     * Sets a particle at a specified index.  Kills the previous particle
+     * there, if needed.
+     */
+    virtual void setLocally(int index, Particle *particle);
+
+    /**
+     * Removes a particle at a specified index
+     */
+    virtual void delLocally(int index);
+
+    virtual void clearLocally();
+    virtual void setPositions(float x, float y);
+
+protected:
+    std::vector<Particle *> mIndexedElements;
+};
+
+#endif