FIFE::ImageLocation Class Reference

#include <image_location.h>

Inheritance diagram for FIFE::ImageLocation:
Inheritance graph
[legend]
Collaboration diagram for FIFE::ImageLocation:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ImageLocation (const std::string &filename)
virtual void setXShift (int xshift)
virtual int getXShift () const
virtual void setYShift (int yshift)
virtual int getYShift () const
virtual void setWidth (unsigned int width)
virtual unsigned int getWidth () const
virtual void setHeight (unsigned int height)
virtual unsigned int getHeight () const
virtual void setParentSource (Image *image)
virtual ImagegetParentSource () const
virtual bool operator== (const ResourceLocation &loc) const
virtual bool operator< (const ResourceLocation &loc) const
virtual ResourceLocationclone () const

Detailed Description

Contains information about the Location of a image.

This class is used to give ResourceProvider the information where to find the data.

Definition at line 46 of file image_location.h.


Constructor & Destructor Documentation

FIFE::ImageLocation::ImageLocation ( const std::string &  filename  ) 

Constructor.

Definition at line 32 of file image_location.cpp.

Referenced by clone().

Here is the caller graph for this function:


Member Function Documentation

ResourceLocation * FIFE::ImageLocation::clone (  )  const [virtual]

Creates copy of this location All derived classes must implement this and return their corresponding instance

Reimplemented from FIFE::ResourceLocation.

Definition at line 111 of file image_location.cpp.

References FIFE::ResourceLocation::getFilename(), and ImageLocation().

virtual unsigned int FIFE::ImageLocation::getHeight (  )  const [inline, virtual]

Gets the height of the Image. Used e.g. with subimages

Definition at line 86 of file image_location.h.

virtual Image* FIFE::ImageLocation::getParentSource (  )  const [inline, virtual]

Gets the parent source of the Image. Used e.g. with subimages

Definition at line 94 of file image_location.h.

virtual unsigned int FIFE::ImageLocation::getWidth (  )  const [inline, virtual]

Gets the width of the Image. Used e.g. with subimages

Definition at line 78 of file image_location.h.

virtual int FIFE::ImageLocation::getXShift (  )  const [inline, virtual]

Gets the X shift of the Image

Returns:
The X shift of the Image

Definition at line 60 of file image_location.h.

virtual int FIFE::ImageLocation::getYShift (  )  const [inline, virtual]

Gets the Y shift of the Image

Parameters:
yshift The Y shift of the Image

Definition at line 70 of file image_location.h.

bool FIFE::ImageLocation::operator< ( const ResourceLocation loc  )  const [virtual]

Compares two ResourceLocations This is needed as the locations should be stored in a std::map

Reimplemented from FIFE::ResourceLocation.

Definition at line 71 of file image_location.cpp.

References FIFE::ResourceLocation::getFilename().

bool FIFE::ImageLocation::operator== ( const ResourceLocation loc  )  const [virtual]

Compares two ResourceLocations for equality.

Reimplemented from FIFE::ResourceLocation.

Definition at line 42 of file image_location.cpp.

References FIFE::ResourceLocation::getFilename().

virtual void FIFE::ImageLocation::setHeight ( unsigned int  height  )  [inline, virtual]

Sets the height of the Image. Used e.g. with subimages

Definition at line 82 of file image_location.h.

virtual void FIFE::ImageLocation::setParentSource ( Image image  )  [inline, virtual]

Sets the parent source of the Image. Used e.g. with subimages

Definition at line 90 of file image_location.h.

virtual void FIFE::ImageLocation::setWidth ( unsigned int  width  )  [inline, virtual]

Sets the width of the Image. Used e.g. with subimages

Definition at line 74 of file image_location.h.

virtual void FIFE::ImageLocation::setXShift ( int  xshift  )  [inline, virtual]

Sets the X shift of the Image.

Parameters:
xshift The X shift of the Image

Definition at line 55 of file image_location.h.

virtual void FIFE::ImageLocation::setYShift ( int  yshift  )  [inline, virtual]

Sets the Y shift of the Image

Parameters:
yshift The Y shift of the Image

Definition at line 65 of file image_location.h.


The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.2-20100208