Mercurial > fife-parpg

comparison engine/core/video/image_location.h @ 0:4a0efb7baf70

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
* Datasets becomes the new trunk and retires after that :-)
author mvbarracuda@33b003aa-7bff-0310-803a-e67f0ece8222
date Sun, 29 Jun 2008 18:44:17 +0000
parents
children 90005975cdbb
comparison
equal deleted inserted replaced
-1:000000000000 0:4a0efb7baf70
1 /***************************************************************************
2 * Copyright (C) 2005-2008 by the FIFE team *
3 * http://www.fifengine.de *
4 * This file is part of FIFE. *
5 * *
6 * FIFE is free software; you can redistribute it and/or modify *
7 * it under the terms of the GNU General Public License as published by *
8 * the Free Software Foundation; either version 2 of the License, or *
9 * (at your option) any later version. *
10 * *
11 * This program 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 *
14 * GNU General Public License for more details. *
15 * *
16 * You should have received a copy of the GNU General Public License *
17 * along with this program; if not, write to the *
18 * Free Software Foundation, Inc., *
19 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA *
20 ***************************************************************************/
21
22 #ifndef FIFE_VIDEO_IMAGE_LOCATION_H
23 #define FIFE_VIDEO_IMAGE_LOCATION_H
24
25 // Standard C++ library includes
26 #include <string>
27 #include <map>
28
29 // 3rd party library includes
30
31 // FIFE includes
32 // These includes are split up in two parts, separated by one empty line
33 // First block: files included from the FIFE root src directory
34 // Second block: files included from the same folder
35 #include "video/image.h"
36 #include "util/resource/resource_location.h"
37
38 namespace FIFE {
39
40 /** Contains information about the Location of a image.
41 *
42 * This class is used to give ResourceProvider the information
43 * where to find the data.
44 *
45 */
46 class ImageLocation: public ResourceLocation {
47 public:
48 /** Constructor.
49 */
50 ImageLocation(const std::string& filename);
51
52 /** Sets the X shift of the Image.
53 * @param xshift The X shift of the Image
54 */
55 virtual void setXShift(int xshift) { m_xshift = xshift; }
56
57 /** Gets the X shift of the Image
58 * @return The X shift of the Image
59 */
60 virtual int getXShift() const { return m_xshift; }
61
62 /** Sets the Y shift of the Image
63 * @param yshift The Y shift of the Image
64 */
65 virtual void setYShift(int yshift) { m_yshift = yshift; }
66
67 /** Gets the Y shift of the Image
68 * @param yshift The Y shift of the Image
69 */
70 virtual int getYShift() const { return m_yshift; }
71
72 /** Sets the width of the Image. Used e.g. with subimages
73 */
74 virtual void setWidth(unsigned int width) { m_width = width; }
75
76 /** Gets the width of the Image. Used e.g. with subimages
77 */
78 virtual unsigned int getWidth() const { return m_width; }
79
80 /** Sets the height of the Image. Used e.g. with subimages
81 */
82 virtual void setHeight(unsigned int height) { m_height = height; }
83
84 /** Gets the height of the Image. Used e.g. with subimages
85 */
86 virtual unsigned int getHeight() const { return m_height; }
87
88 /** Sets the parent source of the Image. Used e.g. with subimages
89 */
90 virtual void setParentSource(Image* image) { m_parent_image = image; }
91
92 /** Gets the parent source of the Image. Used e.g. with subimages
93 */
94 virtual Image* getParentSource() const { return m_parent_image; }
95
96 virtual bool operator ==(const ResourceLocation& loc) const;
97 virtual bool operator <(const ResourceLocation& loc) const;
98 virtual ResourceLocation* clone() const;
99
100 private:
101 unsigned int m_xshift;
102 unsigned int m_yshift;
103 unsigned int m_width;
104 unsigned int m_height;
105 Image* m_parent_image;
106 };
107
108 }; //FIFE
109 #endif
110 /* vim: set noexpandtab: set shiftwidth=2: set tabstop=2: */