wb::highlighter Class Reference

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 ()
void	set_selection_candidate (unit_ptr candidate)

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

secondary_highlights_t

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

Definition at line 58 of file highlighter.hpp.

Constructor & Destructor Documentation

highlighter()

wb::highlighter::highlighter

(

side_actions_ptr

side_actions

)

Definition at line 46 of file highlighter.cpp.

~highlighter()

wb::highlighter::~highlighter ( )

virtual

Definition at line 58 of file highlighter.cpp.

References game_display::get_singleton(), owner_unit_, and unhighlight().

Member Function Documentation

clear()

void wb::highlighter::clear

(

)

Definition at line 118 of file highlighter.cpp.

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

Referenced by set_mouseover_hex().

find_main_highlight()

void wb::highlighter::find_main_highlight ( )

private

Definition at line 200 of file highlighter.cpp.

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

Referenced by highlight().

find_secondary_highlights()

void wb::highlighter::find_secondary_highlights ( )

private

Definition at line 215 of file highlighter.cpp.

References wb::find_actions_of(), main_highlight_, owner_unit_, gui2::dialogs::tip::remove(), and secondary_highlights_.

Referenced by highlight().

get_bump_target()

action_ptr wb::highlighter::get_bump_target

(

)

Definition at line 252 of file highlighter.cpp.

References selected_action_.

get_delete_target()

action_ptr wb::highlighter::get_delete_target

(

)

Definition at line 243 of file highlighter.cpp.

References selected_action_, and side_actions_.

get_execute_target()

action_ptr wb::highlighter::get_execute_target

(

)

Definition at line 235 of file highlighter.cpp.

References selected_action_, and side_actions_.

get_main_highlight()

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

get_mouseover_hex()

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

inline

Definition at line 46 of file highlighter.hpp.

References mouseover_hex_.

get_secondary_highlights()

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

get_selection_target()

unit_ptr wb::highlighter::get_selection_target

(

)

Definition at line 257 of file highlighter.cpp.

References owner_unit_, and selection_candidate_.

get_unit_map()

unit_map & wb::highlighter::get_unit_map ( )

private

Definition at line 346 of file highlighter.cpp.

References resources::gameboard, and game_board::units().

Referenced by set_mouseover_hex().

highlight()

void wb::highlighter::highlight

(

)

Definition at line 127 of file highlighter.cpp.

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

last_action_redraw()

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

private

Redraw the given move action when needed.

Definition at line 181 of file highlighter.cpp.

References wb::side_actions::begin(), wb::side_actions::end(), wb::side_actions::find_last_action_of(), resources::gameboard, wb::move::get_fake_unit(), wb::move::get_unit_id(), wb::action::team_index(), and game_board::teams().

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

set_mouseover_hex()

void wb::highlighter::set_mouseover_hex

(

const map_location &

hex

)

Todo:

"is_numbering_hex" is not the "correct" criterion by which to select the highlighted/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 67 of file highlighter.cpp.

References clear(), unit_map::find(), resources::gameboard, unit_map::iterator_base< iter_types >::get_shared_ptr(), get_unit_map(), mouseover_hex_, owner_unit_, utils::reversed_view(), selected_action_, selection_candidate_, side_actions_, and map_location::valid().

set_selection_candidate()

void wb::highlighter::set_selection_candidate ( unit_ptr  candidate )

inline

Definition at line 62 of file highlighter.hpp.

References selection_candidate_.

unhighlight()

void wb::highlighter::unhighlight ( )

private

Definition at line 158 of file highlighter.cpp.

References wb::action::accept(), exclusive_display_hexes_, display::get_singleton(), main(), main_highlight_, display::remove_exclusive_draw(), and secondary_highlights_.

Referenced by clear(), and ~highlighter().

Member Data Documentation

exclusive_display_hexes_

std::set<map_location> wb::highlighter::exclusive_display_hexes_

private

Definition at line 83 of file highlighter.hpp.

Referenced by highlight(), unhighlight(), and wb::highlighter::highlight_main_visitor::visit().

main_highlight_

weak_action_ptr wb::highlighter::main_highlight_

private

Definition at line 88 of file highlighter.hpp.

Referenced by clear(), find_main_highlight(), find_secondary_highlights(), get_main_highlight(), highlight(), and unhighlight().

mouseover_hex_

map_location wb::highlighter::mouseover_hex_

private

Definition at line 82 of file highlighter.hpp.

Referenced by find_main_highlight(), get_mouseover_hex(), and set_mouseover_hex().

owner_unit_

unit_ptr wb::highlighter::owner_unit_

private

Definition at line 84 of file highlighter.hpp.

Referenced by clear(), find_main_highlight(), find_secondary_highlights(), get_selection_target(), highlight(), set_mouseover_hex(), and ~highlighter().

secondary_highlights_

secondary_highlights_t wb::highlighter::secondary_highlights_

private

Definition at line 89 of file highlighter.hpp.

Referenced by clear(), find_secondary_highlights(), get_secondary_highlights(), highlight(), and unhighlight().

selected_action_

weak_action_ptr wb::highlighter::selected_action_

private

Definition at line 87 of file highlighter.hpp.

Referenced by clear(), get_bump_target(), get_delete_target(), get_execute_target(), and set_mouseover_hex().

selection_candidate_

unit_ptr wb::highlighter::selection_candidate_

private

Definition at line 85 of file highlighter.hpp.

Referenced by get_selection_target(), set_mouseover_hex(), and set_selection_candidate().

side_actions_

side_actions_ptr wb::highlighter::side_actions_

private

Definition at line 91 of file highlighter.hpp.

Referenced by get_delete_target(), get_execute_target(), and set_mouseover_hex().

---

The documentation for this class was generated from the following files:

• whiteboard/highlighter.hpp
• whiteboard/highlighter.cpp