The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
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:
Inheritance graph

Public Member Functions

 editor_action_paint_area (const std::set< map_location > &area, const t_translation::t_terrain &t, bool one_layer=false)
 
editor_action_paint_areaclone () const
 Action cloning. More...
 
editor_action_pasteperform (map_context &mc) const
 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
 Perform the action without creating an undo action. More...
 
const char * get_name () const
 
- 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)
 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::t_terrain 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 244 of file action.hpp.

Constructor & Destructor Documentation

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

Definition at line 247 of file action.hpp.

Referenced by clone().

Member Function Documentation

editor_action_paint_area * editor::editor_action_paint_area::clone ( ) const
virtual

Action cloning.

Implements editor::editor_action.

Definition at line 181 of file action.cpp.

References editor_action_paint_area().

const char* editor::editor_action_paint_area::get_name ( ) const
inlinevirtual
Returns
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action_area.

Definition at line 255 of file action.hpp.

editor_action_paste * editor::editor_action_paint_area::perform ( map_context mc) const
virtual

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 185 of file action.cpp.

References editor::editor_action_area::area_, editor::map_context::get_map(), and perform_without_undo().

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 192 of file action.cpp.

References editor::editor_action_area::area_, editor::map_context::draw_terrain(), one_layer_, editor::map_context::set_needs_terrain_rebuild(), and t_.

Referenced by perform().

Member Data Documentation

bool editor::editor_action_paint_area::one_layer_
protected

Definition at line 258 of file action.hpp.

Referenced by perform_without_undo().

t_translation::t_terrain editor::editor_action_paint_area::t_
protected

Definition at line 257 of file action.hpp.

Referenced by perform_without_undo().


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