The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Protected Attributes | List of all members
editor::editor_action_area Class Reference

Base class for area-affecting actions. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_area:

Public Member Functions

 editor_action_area (const std::set< map_location > &area)
void extend (const editor_map &map, const std::set< map_location > &locs) override
 The crux of the extendable contract. More...
const std::string & get_name () const override
- Public Member Functions inherited from editor::editor_action_extendable
 editor_action_extendable ()
- Public Member Functions inherited from editor::editor_action
 editor_action ()
virtual ~editor_action ()
virtual std::unique_ptr< editor_actionclone () const =0
 Action cloning. More...
virtual std::unique_ptr< editor_actionperform (map_context &) const
 Perform the action, returning an undo action that, when performed, shall reverse any effects of this action. More...
virtual void perform_without_undo (map_context &) const =0
 Perform the action without creating an undo action. More...
virtual int action_count () const
virtual std::string get_description () const
 A textual description of the action. More...
int get_id () const
 Debugging aid. More...

Protected Attributes

std::set< map_locationarea_

Additional Inherited Members

- Static Public Member Functions inherited from editor::editor_action
static int get_instance_count ()
 Debugging aid. More...

Detailed Description

Base class for area-affecting actions.

Definition at line 219 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_area()

editor::editor_action_area::editor_action_area ( const std::set< map_location > &  area)

Definition at line 222 of file action.hpp.

Member Function Documentation

◆ extend()

void editor::editor_action_area::extend ( const editor_map map,
const std::set< map_location > &  locs 

The crux of the extendable contract.

This member function must be implemented so that the undo behavior is consistent, exactly the same as would be with separate undo actions for every part of the drag.

Implements editor::editor_action_extendable.

Reimplemented in editor::editor_action_deselect, and editor::editor_action_select.

Definition at line 174 of file action.cpp.

References area_.

◆ get_name()

const std::string& editor::editor_action_area::get_name ( ) const
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action_extendable.

Reimplemented in editor::editor_action_deselect, editor::editor_action_select, editor::editor_action_shuffle_area, and editor::editor_action_paint_area.

Definition at line 229 of file action.hpp.

Member Data Documentation

◆ area_

std::set<map_location> editor::editor_action_area::area_

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