ImageCollection Class Reference

#include <Image.h>

Inherits SubsystemInterface.

Public Member Functions
	ImageCollection (void)
virtual	~ImageCollection (void)
virtual void	init (void)
virtual void	reset (void)
	initialize system
virtual void	update (void)
	reset system
void	load (Int textureSize)
	update system
const Image *	findImageByName (const AsciiString &name)
	find image based on name
void	addImage (Image *image)
	adds the given image to the collection, transfers ownership to this object
Image *	Enum (unsigned index)
	enumerates the list of existing images
Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()
virtual	~SubsystemInterface ()
virtual void	postProcessLoad ()
virtual void	draw (void)
void	UPDATE (void)
void	DRAW (void)
AsciiString	getName (void)
void	setName (AsciiString name)

Protected Attributes
std::map< unsigned, Image * >	m_imageMap
	maps named keys to images
Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

A collection of images

Definition at line 120 of file Image.h.

Constructor & Destructor Documentation

ImageCollection()

ImageCollection::ImageCollection

(

void

)

Definition at line 199 of file Image.cpp.

~ImageCollection()

ImageCollection::~ImageCollection ( void )

virtual

Definition at line 205 of file Image.cpp.

Member Function Documentation

addImage()

void ImageCollection::addImage

(

Image *

image

)

adds the given image to the collection, transfers ownership to this object

adds the given image to the collection, transfers ownership to this object

Definition at line 214 of file Image.cpp.

Enum()

Image * ImageCollection::Enum ( unsigned index )

inline

enumerates the list of existing images

Definition at line 140 of file Image.h.

findImageByName()

const Image * ImageCollection::findImageByName

(

const AsciiString &

name

)

find image based on name

Find an image given the image name

Definition at line 222 of file Image.cpp.

init()

virtual void ImageCollection::init ( void )

inlinevirtual

• Assign any default values to data required for the class
  • Allocate any memory and resources needed throughout the lifetime of the class

Implements SubsystemInterface.

Definition at line 128 of file Image.h.

load()

void ImageCollection::load

(

Int

textureSize

)

update system

load images

Load this image collection with all the images specified in the INI files for the proper texture size directory

Definition at line 232 of file Image.cpp.

reset()

virtual void ImageCollection::reset ( void )

inlinevirtual

initialize system

Implements SubsystemInterface.

Definition at line 129 of file Image.h.

update()

virtual void ImageCollection::update ( void )

inlinevirtual

reset system

Implements SubsystemInterface.

Definition at line 130 of file Image.h.

Member Data Documentation

m_imageMap

std::map<unsigned,Image *> ImageCollection::m_imageMap

protected

maps named keys to images

Definition at line 149 of file Image.h.

---

The documentation for this class was generated from the following files:

• Code/GameEngine/Include/GameClient/Image.h
• Code/GameEngine/Source/GameClient/System/Image.cpp