1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
|
/*
* The ManaPlus Client
* Copyright (C) 2004-2009 The Mana World Development Team
* Copyright (C) 2009-2010 The Mana Developers
* Copyright (C) 2011-2020 The ManaPlus Developers
* Copyright (C) 2020-2023 The ManaVerse 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 "enums/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);
int calcMemoryLocal() const override final;
int calcMemoryChilds(const int level) const override final;
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) const;
private:
/**
* Constructor.
*/
SpriteDef() :
Resource(),
mImageSets(),
mActions(),
mProcessedFiles()
{ }
/**
* Destructor.
*/
~SpriteDef() override final;
/**
* Loads a sprite element.
*/
void loadSprite(XmlNodeConstPtr spriteNode,
const int variant,
const std::string &palettes);
/**
* Loads an imageset element.
*/
void loadImageSet(XmlNodeConstPtr node,
const std::string &palettes);
/**
* Loads an action element.
*/
void loadAction(XmlNodeConstPtr node,
const int variant_offset);
/**
* Loads an animation element.
*/
void loadAnimation(XmlNodeConstPtr animationNode,
Action *const action,
const ImageSet *const imageSet,
const int variant_offset) const;
/**
* Include another sprite into this one.
*/
void includeSprite(XmlNodeConstPtr includeNode,
const int variant);
const ImageSet *getImageSet(const std::string &imageSetName) const;
/**
* 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 ImageSets::const_iterator ImageSetCIterator;
typedef std::map<std::string, Action*> ActionMap;
typedef std::map<unsigned, ActionMap*> Actions;
typedef Actions::const_iterator ActionsConstIter;
typedef Actions::iterator ActionsIter;
typedef Actions::const_iterator ActionsCIter;
ImageSets mImageSets;
Actions mActions;
std::set<std::string> mProcessedFiles;
};
#endif // RESOURCES_SPRITE_SPRITEDEF_H
|
