Generic locator abstracting the location of an image. More...

#include <picture.hpp>

Classes
struct	value

Public Types
enum	type { NONE, FILE, SUB_FILE }

typedef std::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 char filename, const char modifications)

	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

bool	is_data_uri () 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
	Returns true if the locator does not correspond to an actual image. More...

bool	file_exists () const
	Tests whether the file the locator 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
struct	std::hash< value >

Detailed Description

Generic locator abstracting the location of an image.

Constructing locators is somewhat slow, while accessing images through locators is fast. The general idea is that callers should store locators and not strings to construct new ones. (The latter will still work, of course, even if it is slower.)

Definition at line 62 of file picture.hpp.

Member Typedef Documentation

◆ locator_finder_t

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

Definition at line 148 of file picture.hpp.

Member Enumeration Documentation

◆ type

enum image::locator::type

Enumerator
NONE
FILE
SUB_FILE

Definition at line 65 of file picture.hpp.

Constructor & Destructor Documentation

◆ locator() [1/7]

image::locator::locator ( )

Definition at line 299 of file picture.cpp.

◆ locator() [2/7]

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

Definition at line 305 of file picture.cpp.

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

◆ locator() [3/7]

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

Definition at line 318 of file picture.cpp.

References init_index(), and parse_arguments().

◆ locator() [4/7]

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

Definition at line 326 of file picture.cpp.

References init_index(), and parse_arguments().

◆ locator() [5/7]

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

Definition at line 341 of file picture.cpp.

References init_index().

◆ locator() [6/7]

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

Definition at line 334 of file picture.cpp.

References init_index().

◆ locator() [7/7]

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

Definition at line 348 of file picture.cpp.

References init_index().

Member Function Documentation

◆ access_in_cache()

template<typename T >

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

Definition at line 142 of file picture.cpp.

References image::cache_type< T >::get_element().

Referenced by is_void().

◆ add_to_cache()

template<typename T >

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

Definition at line 149 of file picture.cpp.

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

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

◆ file_exists()

bool image::locator::file_exists ( ) const

Tests whether the file the locator points at exists.

is_void does not work before the image is loaded, and also a placeholder is returned instead in debug mode. Thus it's not possible to test for the existence of an actual file without this function.