FIFE
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
visual.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2005-2013 by the FIFE team *
3  * http://www.fifengine.net *
4  * This file is part of FIFE. *
5  * *
6  * FIFE is free software; you can redistribute it and/or *
7  * modify it under the terms of the GNU Lesser General Public *
8  * License as published by the Free Software Foundation; either *
9  * version 2.1 of the License, or (at your option) any later version. *
10  * *
11  * This library is distributed in the hope that it will be useful, *
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of *
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU *
14  * Lesser General Public License for more details. *
15  * *
16  * You should have received a copy of the GNU Lesser General Public *
17  * License along with this library; if not, write to the *
18  * Free Software Foundation, Inc., *
19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
20  ***************************************************************************/
21 
22 #ifndef FIFE_VIEW_VISUAL_H
23 #define FIFE_VIEW_VISUAL_H
24 
25 // Standard C++ library includes
26 
27 // 3rd party library includes
28 
29 // FIFE includes
30 // These includes are split up in two parts, separated by one empty line
31 // First block: files included from the FIFE root src directory
32 // Second block: files included from the same folder
34 #include "util/math/angles.h"
35 #include "util/structures/rect.h"
36 #include "video/animation.h"
37 
38 
39 namespace FIFE {
40  class Object;
41  class Instance;
42  class Action;
43  class Image;
44  class Camera;
45 
51  class Visual2DGfx: public IVisual {
52  public:
55  virtual ~Visual2DGfx();
56 
57  protected:
60  Visual2DGfx();
61  };
62 
65  class ObjectVisual: public Visual2DGfx {
66  public:
69  static ObjectVisual* create(Object* object);
70 
73  virtual ~ObjectVisual();
74 
84  void addStaticImage(uint32_t angle, int32_t image_index);
85 
89  int32_t getStaticImageIndexByAngle(int32_t angle);
90 
94  int32_t getClosestMatchingAngle(int32_t angle);
95 
98  void getStaticImageAngles(std::vector<int32_t>& angles);
99 
100  private:
103  ObjectVisual();
104 
106  };
107 
108 
111  class InstanceVisual: public Visual2DGfx {
112  public:
115  static InstanceVisual* create(Instance* instance);
116 
119  virtual ~InstanceVisual();
120 
124  void setTransparency(uint8_t transparency);
125 
130 
134  void setVisible(bool visible);
135 
139  bool isVisible();
140 
146  void setStackPosition(int32_t stackposition);
147 
151  int32_t getStackPosition();
152 
153  private:
156  InstanceVisual();
158  bool m_visible;
161  };
162 
165  class ActionVisual: public Visual2DGfx {
166  public:
169  static ActionVisual* create(Action* action);
170 
173  virtual ~ActionVisual();
174 
177  void addAnimation(uint32_t angle, AnimationPtr animationptr);
178 
182  AnimationPtr getAnimationByAngle(int32_t angle);
183 
186  void getActionImageAngles(std::vector<int32_t>& angles);
187 
188  private:
191  ActionVisual();
192 
193  // animations associated with this action
194  typedef std::map<uint32_t, AnimationPtr> AngleAnimationMap;
196 
197  //@fixme need this map to use the getIndexByAngle() function in angles.h
198  //should fix this
200  };
201 
202 }
203 #endif
static InstanceVisual * create(Instance *instance)
Constructs and assigns it to the passed item.
Definition: visual.cpp:98
ObjectVisual()
Constructor.
Definition: visual.cpp:52
AngleAnimationMap m_animation_map
Definition: visual.h:195
int32_t getClosestMatchingAngle(int32_t angle)
Returns closest matching image angle for given angle.
Definition: visual.cpp:76
int32_t getStackPosition()
Gets current stack position of instance.
Definition: visual.cpp:140
Visual2DGfx()
Constructor.
Definition: visual.cpp:46
Object class.
Definition: object.h:51
Instance visual contains data that is needed to visualize the instance on screen. ...
Definition: visual.h:111
ActionVisual()
Constructor.
Definition: visual.cpp:144
Action visual contains data that is needed to visualize different actions on screen.
Definition: visual.h:165
virtual ~Visual2DGfx()
Destructor.
Definition: visual.cpp:49
static ActionVisual * create(Action *action)
Constructs and assigns it to the passed item.
Definition: visual.cpp:147
type_angle2id m_angle2img
Definition: visual.h:105
void setTransparency(uint8_t transparency)
Sets transparency value for object to be visualized.
Definition: visual.cpp:111
int32_t m_stackposition
Definition: visual.h:159
int32_t getStaticImageIndexByAngle(int32_t angle)
Returns closest matching static image for given angle.
Definition: visual.cpp:71
unsigned char uint8_t
Definition: core.h:38
bool isVisible()
Is instance visible or not.
Definition: visual.cpp:129
void setVisible(bool visible)
Sets visibility value for object to be visualized.
Definition: visual.cpp:122
void getActionImageAngles(std::vector< int32_t > &angles)
Returns list of available angles for this Action.
Definition: visual.cpp:169
void getStaticImageAngles(std::vector< int32_t > &angles)
Returns list of available static image angles for this object.
Definition: visual.cpp:82
type_angle2id m_map
Definition: visual.h:199
void addAnimation(uint32_t angle, AnimationPtr animationptr)
Adds new animation with given angle (degrees)
Definition: visual.cpp:159
Instance * m_instance
Definition: visual.h:160
uint8_t m_transparency
Definition: visual.h:157
virtual ~ActionVisual()
Destructor.
Definition: visual.cpp:156
InstanceVisual()
Constructor.
Definition: visual.cpp:91
Object visual contains data that is needed for visualizing objects.
Definition: visual.h:65
static ObjectVisual * create(Object *object)
Constructs and assigns it to the passed item.
Definition: visual.cpp:55
void addStaticImage(uint32_t angle, int32_t image_index)
Adds new static image with given angle (degrees) Static images are used in case there are no actions ...
Definition: visual.cpp:67
AnimationPtr getAnimationByAngle(int32_t angle)
Gets index to animation closest to given angle.
Definition: visual.cpp:164
uint8_t getTransparency()
Gets current transparency value (0-255)
Definition: visual.cpp:118
void setStackPosition(int32_t stackposition)
Sets stack position of the instance Stack position is used to define the order in which instances res...
Definition: visual.cpp:133
virtual ~ObjectVisual()
Destructor.
Definition: visual.cpp:64
std::map< uint32_t, AnimationPtr > AngleAnimationMap
Definition: visual.h:194
virtual ~InstanceVisual()
Destructor.
Definition: visual.cpp:108
std::map< uint32_t, int32_t > type_angle2id
Definition: angles.h:37
unsigned int uint32_t
Definition: core.h:40
An Instance is an &quot;instantiation&quot; of an Object at a Location.
Definition: instance.h:97
Base class for all 2 dimensional visual classes Visual classes are extensions to visualize the stuff ...
Definition: visual.h:51