#include <image.hpp>

Classes
struct	value

Public Types
enum	type { NONE, FILE, SUB_FILE }

typedef boost::unordered_map < value, int >	locator_finder_t

Public Member Functions
	locator ()

	locator (const locator &a, const std::string &mods="")

	locator (const char *filename)

	locator (const std::string &filename)

	locator (const std::string &filename, const std::string &modifications)

	locator (const std::string &filename, const map_location &loc, int center_x, int center_y, const std::string &modifications="")

locator &	operator= (const locator &a)

bool	operator== (const locator &a) const

bool	operator!= (const locator &a) const

bool	operator< (const locator &a) const

const std::string &	get_filename () const

const map_location &	get_loc () const

int	get_center_x () const

int	get_center_y () const

const std::string &	get_modifications () const

type	get_type () const

bool	is_void () const

bool	file_exists () const
	Tests whether the file the locater points at exists. More...

template<typename T >
bool	in_cache (cache_type< T > &cache) const

template<typename T >
T &	access_in_cache (cache_type< T > &cache) const

template<typename T >
const T &	locate_in_cache (cache_type< T > &cache) const

template<typename T >
void	add_to_cache (cache_type< T > &cache, const T &data) const

Private Member Functions
void	init_index ()

void	parse_arguments ()

Private Attributes
int	index_

value	val_

Friends
size_t	hash_value (const value &)

Detailed Description

Definition at line 35 of file image.hpp.

Member Typedef Documentation

typedef boost::unordered_map<value, int> image::locator::locator_finder_t

Definition at line 67 of file image.hpp.

Member Enumeration Documentation

enum image::locator::type

Enumerator
NONE
FILE
SUB_FILE

Definition at line 38 of file image.hpp.

Constructor & Destructor Documentation

image::locator::locator ( )

Definition at line 247 of file image.cpp.

image::locator::locator	(	const locator &	a,
		const std::string &	mods = `""`
	)

Definition at line 253 of file image.cpp.

References index_, init_index(), image::locator::value::modifications_, SUB_FILE, image::locator::value::type_, and val_.

image::locator::locator ( const char * filename )

Definition at line 265 of file image.cpp.

References init_index(), and parse_arguments().

image::locator::locator ( const std::string & filename )

Definition at line 273 of file image.cpp.

References init_index(), and parse_arguments().

image::locator::locator	(	const std::string &	filename,
		const std::string &	modifications
	)

Definition at line 281 of file image.cpp.

References init_index().

image::locator::locator	(	const std::string &	filename,
		const map_location &	loc,
		int	center_x,
		int	center_y,
		const std::string &	modifications = `""`
	)

Definition at line 288 of file image.cpp.

References init_index().

Member Function Documentation

template<typename T >

T & image::locator::access_in_cache ( cache_type< T > & cache ) const

Definition at line 110 of file image.cpp.

References image::cache_type< T >::get_element(), and index_.

Referenced by image::get_lighted_image().

template<typename T >

void image::locator::add_to_cache	(	cache_type< T > &	cache,
		const T &	data
	)		const

Definition at line 117 of file image.cpp.

References image::cache_type< T >::get_element(), and index_.

Referenced by image::get_hexed(), image::get_image(), image::get_lighted_image(), image::is_empty_hex(), image::is_in_hex(), and image::load_image_sub_file().

bool image::locator::file_exists ( ) const

Tests whether the file the locater points at exists.

is_void doesn't seem to work before the image is loaded and also in debug mode a placeholder is returned. So it's not possible to test for the existence of a file. So this function does that. (Note it tests for existence not whether or not it's a valid image.)