summaryrefslogtreecommitdiff
path: root/src/resources/sprite/spritedef.h
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2015-12-20 17:55:49 +0300
committerAndrei Karas <akaras@inbox.ru>2015-12-20 17:55:49 +0300
commit2a506c72f0690b1b73034ce1d6911a1abba74029 (patch)
tree0bfffb22e4b8e58932f3f7bd5805cd7efcac343b /src/resources/sprite/spritedef.h
parentfc34c84d4ef4a51b49297dabffc8c3aa936c9588 (diff)
downloadplus-2a506c72f0690b1b73034ce1d6911a1abba74029.tar.gz
plus-2a506c72f0690b1b73034ce1d6911a1abba74029.tar.bz2
plus-2a506c72f0690b1b73034ce1d6911a1abba74029.tar.xz
plus-2a506c72f0690b1b73034ce1d6911a1abba74029.zip
Move spritedef into sprite directory.
Diffstat (limited to 'src/resources/sprite/spritedef.h')
-rw-r--r--src/resources/sprite/spritedef.h159
1 files changed, 159 insertions, 0 deletions
diff --git a/src/resources/sprite/spritedef.h b/src/resources/sprite/spritedef.h
new file mode 100644
index 000000000..02ce98ff9
--- /dev/null
+++ b/src/resources/sprite/spritedef.h
@@ -0,0 +1,159 @@
+/*
+ * The ManaPlus Client
+ * Copyright (C) 2004-2009 The Mana World Development Team
+ * Copyright (C) 2009-2010 The Mana Developers
+ * Copyright (C) 2011-2015 The ManaPlus Developers
+ *
+ * This file is part of The ManaPlus 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 RESOURCES_SPRITE_SPRITEDEF_H
+#define RESOURCES_SPRITE_SPRITEDEF_H
+
+#include "resources/resource.h"
+
+#include "resources/spritedirection.h"
+
+#include "utils/xml.h"
+
+#include <map>
+#include <set>
+
+class Action;
+class Animation;
+class ImageSet;
+
+/**
+ * Defines a class to load an animation.
+ */
+class SpriteDef final : public Resource
+{
+ public:
+ A_DELETE_COPY(SpriteDef)
+
+ /**
+ * Loads a sprite definition file.
+ */
+ static SpriteDef *load(const std::string &file,
+ const int variant,
+ const bool prot) A_WARN_UNUSED;
+
+ /**
+ * Returns the specified action.
+ */
+ const Action *getAction(const std::string &action,
+ const unsigned num) const A_WARN_UNUSED;
+
+ unsigned findNumber(const unsigned num) const A_WARN_UNUSED;
+
+ /**
+ * Converts a string into a SpriteDirection enum.
+ */
+ static SpriteDirection::Type
+ makeSpriteDirection(const std::string &direction) A_WARN_UNUSED;
+
+ void addAction(const unsigned hp, const std::string &name,
+ Action *const action);
+
+ static bool addSequence(const int start,
+ const int end,
+ const int delay,
+ const int offsetX,
+ const int offsetY,
+ const int variant_offset,
+ int repeat,
+ const int rand,
+ const ImageSet *const imageSet,
+ Animation *const animation);
+
+ private:
+ /**
+ * Constructor.
+ */
+ SpriteDef() :
+ Resource(),
+ mImageSets(),
+ mActions(),
+ mProcessedFiles()
+ { }
+
+ /**
+ * Destructor.
+ */
+ ~SpriteDef();
+
+ /**
+ * Loads a sprite element.
+ */
+ void loadSprite(const XmlNodePtr spriteNode,
+ const int variant,
+ const std::string &palettes = "");
+
+ /**
+ * Loads an imageset element.
+ */
+ void loadImageSet(const XmlNodePtr node,
+ const std::string &palettes);
+
+ /**
+ * Loads an action element.
+ */
+ void loadAction(const XmlNodePtr node,
+ const int variant_offset);
+
+ /**
+ * Loads an animation element.
+ */
+ void loadAnimation(const XmlNodePtr animationNode,
+ Action *const action,
+ const ImageSet *const imageSet,
+ const int variant_offset) const;
+
+ /**
+ * Include another sprite into this one.
+ */
+ void includeSprite(const XmlNodePtr includeNode, const int variant);
+
+ /**
+ * Complete missing actions by copying existing ones.
+ */
+ void substituteActions();
+
+ /**
+ * Fix bad timeout in last dead action frame
+ */
+ void fixDeadAction();
+
+ /**
+ * When there are no animations defined for the action "complete", its
+ * animations become a copy of those of the action "with".
+ */
+ void substituteAction(const std::string &restrict complete,
+ const std::string &restrict with);
+
+ typedef std::map<std::string, ImageSet*> ImageSets;
+ typedef ImageSets::iterator ImageSetIterator;
+ typedef std::map<std::string, Action*> ActionMap;
+ typedef std::map<unsigned, ActionMap*> Actions;
+ typedef Actions::const_iterator ActionsConstIter;
+ typedef Actions::iterator ActionsIter;
+
+ ImageSets mImageSets;
+ Actions mActions;
+ std::set<std::string> mProcessedFiles;
+};
+
+#endif // RESOURCES_SPRITE_SPRITEDEF_H