image_location.h

00001 /***************************************************************************
00002  *   Copyright (C) 2005-2008 by the FIFE team                              *
00003  *   http://www.fifengine.de                                               *
00004  *   This file is part of FIFE.                                            *
00005  *                                                                         *
00006  *   FIFE is free software; you can redistribute it and/or                 *
00007  *   modify it under the terms of the GNU Lesser General Public            *
00008  *   License as published by the Free Software Foundation; either          *
00009  *   version 2.1 of the License, or (at your option) any later version.    *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful,       *
00012  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the                 *
00018  *   Free Software Foundation, Inc.,                                       *
00019  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
00020  ***************************************************************************/
00021 
00022 #ifndef FIFE_VIDEO_IMAGE_LOCATION_H
00023 #define FIFE_VIDEO_IMAGE_LOCATION_H
00024 
00025 // Standard C++ library includes
00026 #include <string>
00027 #include <map>
00028 
00029 // 3rd party library includes
00030 
00031 // FIFE includes
00032 // These includes are split up in two parts, separated by one empty line
00033 // First block: files included from the FIFE root src directory
00034 // Second block: files included from the same folder
00035 #include "video/image.h"
00036 #include "util/resource/resource_location.h"
00037 
00038 namespace FIFE {
00039 
00046     class ImageLocation: public ResourceLocation {
00047     public:
00050         ImageLocation(const std::string& filename);
00051 
00055         virtual void setXShift(int xshift) { m_xshift = xshift; }
00056 
00060         virtual int getXShift() const { return m_xshift; }
00061 
00065         virtual void setYShift(int yshift) { m_yshift = yshift; }
00066 
00070         virtual int getYShift() const { return m_yshift; }
00071 
00074         virtual void setWidth(unsigned int width) { m_width = width; }
00075 
00078         virtual unsigned int getWidth() const { return m_width; }
00079 
00082         virtual void setHeight(unsigned int height) { m_height = height; }
00083 
00086         virtual unsigned int getHeight() const { return m_height; }
00087 
00090         virtual void setParentSource(Image* image) { m_parent_image = image; }
00091 
00094         virtual Image* getParentSource() const { return m_parent_image; }
00095 
00096         virtual bool operator ==(const ResourceLocation& loc) const;
00097         virtual bool operator <(const ResourceLocation& loc) const;
00098         virtual ResourceLocation* clone() const;
00099 
00100     private:
00101         unsigned int m_xshift;
00102         unsigned int m_yshift;
00103         unsigned int m_width;
00104         unsigned int m_height;
00105         Image* m_parent_image;
00106     };
00107 
00108 }; //FIFE
00109 #endif
00110 /* vim: set noexpandtab: set shiftwidth=2: set tabstop=2: */