Class that handles highlighting planned actions as you hover over them and determine the right target for contextual execution. More...

#include <highlighter.hpp>

Classes
class	highlight_main_visitor

class	highlight_secondary_visitor

class	unhighlight_visitor

Public Types
typedef std::deque < weak_action_ptr >	secondary_highlights_t

Public Member Functions
	highlighter (side_actions_ptr side_actions)

virtual	~highlighter ()

void	set_mouseover_hex (const map_location &hex)

const map_location &	get_mouseover_hex () const

void	highlight ()

void	clear ()

action_ptr	get_execute_target ()

action_ptr	get_delete_target ()

action_ptr	get_bump_target ()

unit_ptr	get_selection_target ()

weak_action_ptr	get_main_highlight ()

secondary_highlights_t	get_secondary_highlights ()

Private Member Functions
unit_map &	get_unit_map ()

void	unhighlight ()

void	find_main_highlight ()

void	find_secondary_highlights ()

void	last_action_redraw (move_ptr)
	Redraw the given move action when needed. More...

Private Attributes
map_location	mouseover_hex_

std::set< map_location >	exclusive_display_hexes_

unit_ptr	owner_unit_

unit_ptr	selection_candidate_

weak_action_ptr	selected_action_

weak_action_ptr	main_highlight_

secondary_highlights_t	secondary_highlights_

side_actions_ptr	side_actions_

Detailed Description

Class that handles highlighting planned actions as you hover over them and determine the right target for contextual execution.

Definition at line 38 of file highlighter.hpp.

Member Typedef Documentation

typedef std::deque<weak_action_ptr> wb::highlighter::secondary_highlights_t

Definition at line 58 of file highlighter.hpp.

Constructor & Destructor Documentation

wb::highlighter::highlighter ( side_actions_ptr side_actions )

Definition at line 53 of file highlighter.cpp.

wb::highlighter::~highlighter ( )

virtual

Definition at line 65 of file highlighter.cpp.

References owner_unit_, resources::screen, and unhighlight().

Member Function Documentation

void wb::highlighter::clear ( )

Definition at line 125 of file highlighter.cpp.

References main_highlight_, owner_unit_, secondary_highlights_, selected_action_, and unhighlight().

Referenced by set_mouseover_hex().

void wb::highlighter::find_main_highlight ( )

private

Definition at line 206 of file highlighter.cpp.

References wb::find_action_at(), main(), main_highlight_, mouseover_hex_, and owner_unit_.

Referenced by highlight().

void wb::highlighter::find_secondary_highlights ( )

private

Definition at line 221 of file highlighter.cpp.

References wb::find_actions_of(), main_highlight_, owner_unit_, schema_validation::remove, and secondary_highlights_.

Referenced by highlight().

action_ptr wb::highlighter::get_bump_target ( )

Definition at line 258 of file highlighter.cpp.

References selected_action_.

action_ptr wb::highlighter::get_delete_target ( )

Definition at line 249 of file highlighter.cpp.

References selected_action_, and side_actions_.

action_ptr wb::highlighter::get_execute_target ( )

Definition at line 241 of file highlighter.cpp.

References selected_action_, and side_actions_.

weak_action_ptr wb::highlighter::get_main_highlight ( )

inline

Returns: the action that currently receives the highlight focus

Definition at line 57 of file highlighter.hpp.

References main_highlight_.

const map_location& wb::highlighter::get_mouseover_hex ( ) const

inline

Definition at line 46 of file highlighter.hpp.

References mouseover_hex_.

secondary_highlights_t wb::highlighter::get_secondary_highlights ( )

inline

Returns: the collection of actions that are highlighted but don't have the focus

Definition at line 60 of file highlighter.hpp.

References secondary_highlights_.

unit_ptr wb::highlighter::get_selection_target ( )

Definition at line 263 of file highlighter.cpp.

References owner_unit_, and selection_candidate_.

unit_map & wb::highlighter::get_unit_map ( )

private

Definition at line 352 of file highlighter.cpp.

References resources::units.

Referenced by set_mouseover_hex().

void wb::highlighter::highlight ( )

Definition at line 134 of file highlighter.cpp.

References wb::action::accept(), display::add_exclusive_draw(), exclusive_display_hexes_, find_main_highlight(), find_secondary_highlights(), main(), main_highlight_, owner_unit_, resources::screen, and secondary_highlights_.

void wb::highlighter::last_action_redraw ( move_ptr move )

private

Redraw the given move action when needed.

Definition at line 188 of file highlighter.cpp.

References wb::side_actions::begin(), wb::side_actions::end(), wb::side_actions::find_last_action_of(), and resources::teams.

Referenced by wb::highlighter::highlight_main_visitor::visit().

void wb::highlighter::set_mouseover_hex ( const map_location & hex )

Todo:: "is_numbering_hex" is not the "correct" criterion by which to select the hightlighted/selected action. It's just convenient for me to use at the moment since it happens to coincide with the "correct" criterion, which is to use find_main_highlight.

Definition at line 74 of file highlighter.cpp.

References schema_validation::at(), clear(), unit_map::find(), unit_map::iterator_base< iter_types >::get_shared_ptr(), get_unit_map(), itor, mouseover_hex_, owner_unit_, selected_action_, selection_candidate_, side_actions_, resources::teams, and map_location::valid().