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

#include <picture.hpp>

Classes
struct	value

Public Types
enum	type { NONE , FILE , SUB_FILE }

Public Member Functions
	locator ()=default

	locator (locator &&) noexcept=default

	locator (const locator &)=default

template<typename... Args>
	locator (Args &&... args)

locator &	operator= (const locator &a)=default

locator &	operator= (locator &&)=default

locator	clone (const std::string &mods) const
	Returns a copy of this locator with the given IPF. More...

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 >
std::optional< T >	copy_from_cache (cache_type< T > &cache) const

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

std::size_t	hash () const

Private Attributes
value	val_

Friends
struct	std::hash< value >

template<typename T >
class	cache_type

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 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/4]

image::locator::locator ( )

default

◆ locator() [2/4]

image::locator::locator ( locator && )

defaultnoexcept

◆ locator() [3/4]

image::locator::locator ( const locator & )

default

◆ locator() [4/4]

template<typename... Args>

image::locator::locator ( Args &&... args )

inline

Definition at line 72 of file picture.hpp.

Member Function Documentation

◆ access_in_cache()

template<typename T >

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

Definition at line 128 of file picture.cpp.

References image::cache_type< T >::get_element(), image::cache_type< T >::cache_item::item, and val_.

Referenced by image::get_lighted_image(), and image::get_lighted_texture().

◆ add_to_cache()

template<typename T >

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

Definition at line 141 of file picture.cpp.

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

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

◆ clone()

locator image::locator::clone ( const std::string & mods ) const

Returns a copy of this locator with the given IPF.

Definition at line 234 of file picture.cpp.

References image::locator::value::modifications, SUB_FILE, image::locator::value::type, and val_.

Referenced by unit_frame::get_overlaped_hex(), and unit_frame::redraw().

◆ copy_from_cache()

template<typename T >

std::optional< T > image::locator::copy_from_cache ( cache_type< T > & cache ) const

Definition at line 134 of file picture.cpp.

References image::cache_type< T >::get_element(), image::cache_type< T >::cache_item::loaded, and val_.

Referenced by image::get_surface(), image::get_texture(), and image::is_in_hex().

◆ 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.