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

Paint the same terrain on a number of locations on the map. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_paint_area:

Public Member Functions

 editor_action_paint_area (const std::set< map_location > &area, const t_translation::terrain_code &t, bool one_layer=false)
std::unique_ptr< editor_actionclone () const override
 Action cloning. More...
std::unique_ptr< editor_actionperform (map_context &mc) const override
 Perform the action, returning an undo action that, when performed, shall reverse any effects of this action. More...
void perform_without_undo (map_context &mc) const override
 Perform the action without creating an undo action. More...
const std::string & get_name () const override
- Public Member Functions inherited from editor::editor_action_area
 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...
- 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 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

t_translation::terrain_code t_
bool one_layer_
- Protected Attributes inherited from editor::editor_action_area
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

Paint the same terrain on a number of locations on the map.

Definition at line 265 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_paint_area()

editor::editor_action_paint_area::editor_action_paint_area ( const std::set< map_location > &  area,
const t_translation::terrain_code t,
bool  one_layer = false 

Member Function Documentation

◆ clone()

std::unique_ptr<editor_action> editor::editor_action_paint_area::clone ( ) const

Action cloning.

Implements editor::editor_action.

◆ get_name()

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

Reimplemented from editor::editor_action_area.

◆ perform()

std::unique_ptr< editor_action > editor::editor_action_paint_area::perform ( map_context mc) const

Perform the action, returning an undo action that, when performed, shall reverse any effects of this action.

The undo action object is owned by the caller. Default behavior is to create a whole-map undo, call the perform_without_undo function and return the undo object.

Reimplemented from editor::editor_action.

Definition at line 204 of file action.cpp.

References editor::editor_action_chain::perform_without_undo().

◆ perform_without_undo()

void editor::editor_action_paint_area::perform_without_undo ( map_context ) const

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 213 of file action.cpp.

References editor::map_context::draw_terrain(), IMPLEMENT_ACTION, and editor::map_context::set_needs_terrain_rebuild().

Member Data Documentation

◆ one_layer_

bool editor::editor_action_paint_area::one_layer_

Definition at line 284 of file action.hpp.

◆ t_

t_translation::terrain_code editor::editor_action_paint_area::t_

Definition at line 282 of file action.hpp.

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