#include <label.hpp>

Public Types
typedef std::map< map_location, terrain_label >	label_map

typedef std::map< std::string, label_map >	team_label_map

Public Member Functions
	map_labels (const map_labels &)

	map_labels (const team *)

	~map_labels ()

map_labels &	operator= (const map_labels &)

void	write (config &res) const

void	read (const config &cfg)

const terrain_label *	get_label (const map_location &loc, const std::string &team_name) const

const terrain_label *	get_label (const map_location &loc) const

const terrain_label *	set_label (const map_location &loc, const t_string &text, const int creator=-1, const std::string &team="", const color_t color=font::NORMAL_COLOR, const bool visible_in_fog=true, const bool visible_in_shroud=false, const bool immutable=false, const std::string &category="", const t_string &tooltip="")

bool	enabled () const

void	enable (bool is_enabled)

void	clear (const std::string &, bool force)

void	recalculate_labels ()

void	recalculate_shroud ()

bool	visible_global_label (const map_location &) const
	Returns whether or not a global (non-team) label can be shown at a specified location. More...

const std::string &	team_name () const

const std::vector< std::string > &	all_categories () const

void	set_team (const team *)

void	clear_all ()

Private Member Functions
template<typename... T>
terrain_label *	add_label (T &&... args)

void	clear_map (label_map &, bool)

terrain_label *	get_label_private (const map_location &loc, const std::string &team_name)

Private Attributes
const team *	team_

team_label_map	labels_

bool	enabled_

std::vector< std::string >	categories

bool	categories_dirty

Detailed Description

Definition at line 32 of file label.hpp.

Member Typedef Documentation

◆ label_map

typedef std::map<map_location, terrain_label> map_labels::label_map

Definition at line 35 of file label.hpp.

◆ team_label_map

typedef std::map<std::string, label_map> map_labels::team_label_map

Definition at line 36 of file label.hpp.

Constructor & Destructor Documentation

◆ map_labels() [1/2]

map_labels::map_labels ( const map_labels & other )

Definition at line 55 of file label.cpp.

References read(), and write().

Referenced by operator=().

◆ map_labels() [2/2]

map_labels::map_labels ( const team * team )

Definition at line 47 of file label.cpp.

◆ ~map_labels()

map_labels::~map_labels ( )

Definition at line 65 of file label.cpp.

References clear_all().

Referenced by operator=().

Member Function Documentation

◆ add_label()

template<typename... T>

terrain_label * map_labels::add_label ( T &&... args )

private

Definition at line 203 of file label.cpp.

References categories_dirty, labels_, and t.

Referenced by read(), and set_label().

◆ all_categories()

const std::vector< std::string > & map_labels::all_categories ( ) const

Definition at line 287 of file label.cpp.

References categories, categories_dirty, resources::gameboard, labels_, and t.

Referenced by gui2::dialogs::label_settings::label_settings().

◆ clear()

void map_labels::clear	(	const std::string &	team_name,
		bool	force
	)

Definition at line 211 of file label.cpp.

References categories_dirty, clear_map(), i, labels_, and team_name().

Referenced by do_replay_handle().

◆ clear_all()

void map_labels::clear_all ( )

Definition at line 240 of file label.cpp.

References labels_.

Referenced by editor::map_context::clear_starting_position_labels(), game_lua_kernel::intf_find_cost_map(), read(), ai::default_recruitment::recruitment::show_important_hexes(), and ~map_labels().

◆ clear_map()

void map_labels::clear_map	(	label_map &	m,
		bool	force
	)

private

Definition at line 226 of file label.cpp.

References categories_dirty, and i.

Referenced by clear().

◆ enable()

void map_labels::enable ( bool is_enabled )

Definition at line 254 of file label.cpp.

References enabled_, and recalculate_labels().

Referenced by editor::context_manager::refresh_on_context_change().

◆ enabled()

bool map_labels::enabled ( ) const

inline

Definition at line 67 of file label.hpp.

References enabled_.

Referenced by terrain_label::viewable().

◆ get_label() [1/2]

const terrain_label * map_labels::get_label ( const map_location & loc ) const

Definition at line 116 of file label.cpp.

References get_label(), and team_name().

◆ get_label() [2/2]

const terrain_label* map_labels::get_label	(	const map_location &	loc,
		const std::string &	team_name
	)		const

inline

Definition at line 48 of file label.hpp.

References get_label_private(), and team_name().

Referenced by editor::mouse_action_map_label::drag_end_left(), get_label(), game_lua_kernel::intf_get_label(), and editor::mouse_action_map_label::up_left().

◆ get_label_private()

terrain_label * map_labels::get_label_private	(	const map_location &	loc,
		const std::string &	team_name
	)

private

Definition at line 103 of file label.cpp.

References labels_, and team_name().

Referenced by get_label(), and set_label().

◆ operator=()

map_labels & map_labels::operator= ( const map_labels & other )

Definition at line 70 of file label.cpp.

References map_labels(), and ~map_labels().

◆ read()

void map_labels::read ( const config & cfg )

Definition at line 92 of file label.cpp.

References add_label(), config::child_range(), clear_all(), i, and recalculate_labels().

Referenced by editor::map_context::load_scenario(), and map_labels().

◆ recalculate_labels()

void map_labels::recalculate_labels ( )

Definition at line 245 of file label.cpp.

References labels_.

Referenced by editor::editor_controller::display_redraw_callback(), editor::editor_controller::do_execute_command(), enable(), display::queue_rerender(), read(), display::set_viewing_team_index(), and display::set_zoom().

◆ recalculate_shroud()

void map_labels::recalculate_shroud ( )

Definition at line 278 of file label.cpp.

References labels_.

Referenced by game_lua_kernel::intf_override_shroud(), game_lua_kernel::intf_toggle_shroud(), actions::shroud_clearer::invalidate_after_clear(), and display::scroll().

◆ set_label()

const terrain_label * map_labels::set_label	(	const map_location &	loc,
		const t_string &	text,
		const int	creator = `-1`,
		const std::string &	team = `""`,
		const color_t	color = `font::NORMAL_COLOR`,
		const bool	visible_in_fog = `true`,
		const bool	visible_in_shroud = `false`,
		const bool	immutable = `false`,
		const std::string &	category = `""`,
		const t_string &	tooltip = `""`
	)