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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
|
/***************************************************************************
* Copyright (C) 2005-2013 by the FIFE team *
* http://www.fifengine.net *
* This file is part of FIFE. *
* *
* FIFE is free software; you can redistribute it and/or *
* modify it under the terms of the GNU Lesser General Public *
* License as published by the Free Software Foundation; either *
* version 2.1 of the License, or (at your option) any later version. *
* *
* This library 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 *
* Lesser General Public License for more details. *
* *
* You should have received a copy of the GNU Lesser General Public *
* License along with this library; if not, write to the *
* Free Software Foundation, Inc., *
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
#ifndef FIFE_VIEW_VISUAL_H
#define FIFE_VIEW_VISUAL_H
// Standard C++ library includes
// 3rd party library includes
// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "model/metamodel/ivisual.h"
#include "util/math/angles.h"
#include "util/structures/rect.h"
#include "video/animation.h"
namespace FIFE {
class Object;
class Instance;
class Action;
class Image;
class Camera;
/** Base class for all 2 dimensional visual classes
* Visual classes are extensions to visualize the stuff in model (e.g. instances)
* The reason why its separated is to keep model view-agnostic, so that we could
* have e.g. 3d, 2d and character based visualizations to the same data
*/
class Visual2DGfx: public IVisual {
public:
/** Destructor
*/
virtual ~Visual2DGfx();
protected:
/** Constructor
*/
Visual2DGfx();
};
/** Object visual contains data that is needed for visualizing objects
*/
class ObjectVisual: public Visual2DGfx {
public:
/** Constructs and assigns it to the passed item
*/
static ObjectVisual* create(Object* object);
/** Destructor
*/
virtual ~ObjectVisual();
/** Adds new static image with given angle (degrees)
* Static images are used in case there are no actions active in the instance
* There can be several static images for different angles, that are used in
* case view / layer is rotated
* In case there are no exact matches for current view angles, closest one is used
* @param angle angle for image. 0 degrees starts from right and turns counter-clockwise
* (normal math notation)
@param image_index index of image to use for given degress
*/
void addStaticImage(uint32_t angle, int32_t image_index);
/** Returns closest matching static image for given angle
* @return id for static image
*/
int32_t getStaticImageIndexByAngle(int32_t angle);
/** Returns closest matching image angle for given angle
* @return closest matching angle
*/
int32_t getClosestMatchingAngle(int32_t angle);
/** Returns list of available static image angles for this object
*/
void getStaticImageAngles(std::vector<int32_t>& angles);
private:
/** Constructor
*/
ObjectVisual();
type_angle2id m_angle2img;
};
/** Instance visual contains data that is needed to visualize the instance on screen
*/
class InstanceVisual: public Visual2DGfx {
public:
/** Constructs and assigns it to the passed item
*/
static InstanceVisual* create(Instance* instance);
/** Destructor
*/
virtual ~InstanceVisual();
/** Sets transparency value for object to be visualized
* @param transparency set the transparency
*/
void setTransparency(uint8_t transparency);
/** Gets current transparency value (0-255)
* @return current transparency value
*/
uint8_t getTransparency();
/** Sets visibility value for object to be visualized
* @param visible is object visible or not
*/
void setVisible(bool visible);
/** Is instance visible or not
* @return is instance visible or not
*/
bool isVisible();
/** Sets stack position of the instance
* Stack position is used to define the order in which instances residing
* in the same location are drawn
* @param stackposition new stack position
*/
void setStackPosition(int32_t stackposition);
/** Gets current stack position of instance
* @return current stack position
*/
int32_t getStackPosition();
private:
/** Constructor
*/
InstanceVisual();
uint8_t m_transparency;
bool m_visible;
int32_t m_stackposition;
Instance* m_instance;
};
/** Action visual contains data that is needed to visualize different actions on screen
*/
class ActionVisual: public Visual2DGfx {
public:
/** Constructs and assigns it to the passed item
*/
static ActionVisual* create(Action* action);
/** Destructor
*/
virtual ~ActionVisual();
/** Adds new animation with given angle (degrees)
*/
void addAnimation(uint32_t angle, AnimationPtr animationptr);
/** Gets index to animation closest to given angle
* @return animation index, -1 if no animations available
*/
AnimationPtr getAnimationByAngle(int32_t angle);
/** Returns list of available angles for this Action
*/
void getActionImageAngles(std::vector<int32_t>& angles);
private:
/** Constructor
*/
ActionVisual();
// animations associated with this action
typedef std::map<uint32_t, AnimationPtr> AngleAnimationMap;
AngleAnimationMap m_animation_map;
//@fixme need this map to use the getIndexByAngle() function in angles.h
//should fix this
type_angle2id m_map;
};
}
#endif
|
