Freeciv21
Develop your civilization from humble roots to a global empire
freeciv::layer_darkness Class Reference

#include <layer_darkness.h>

+ Inheritance diagram for freeciv::layer_darkness:
+ Collaboration diagram for freeciv::layer_darkness:

Public Member Functions

 layer_darkness (struct tileset *ts, darkness_style style)
 
virtual ~layer_darkness ()=default
 
void load_sprites () override
 Loads all the sprites needed to draw the darkness. More...
 
std::vector< drawn_spritefill_sprite_array (const tile *ptile, const tile_edge *pedge, const tile_corner *pcorner, const unit *punit) const override
 Returns the list of sprites drawn by this layer somewhere on the map. More...
 
- Public Member Functions inherited from freeciv::layer
 layer (struct tileset *ts, mapview_layer layer)
 Constructor. More...
 
virtual ~layer ()=default
 Destructor. More...
 
virtual void initialize_player (const player *player)
 Initializes data specific to one player. More...
 
virtual void free_player (int player_id)
 Frees data initialized by initialize_player. More...
 
virtual void initialize_city_style (const citystyle &style, int index)
 Initializes data for a city style. More...
 
virtual void initialize_extra (const extra_type *extra, const QString &tag, extrastyle_id style)
 Initializes extra-specific data. More...
 
virtual void initialize_terrain (const terrain *terrain)
 Initializes terrain-specific data. More...
 
virtual void reset_ruleset ()
 Resets cached data that depends on the ruleset. More...
 
mapview_layer type () const
 

Private Member Functions

void set_sprite (std::size_t index, const QPixmap &p)
 Sets one of the sprites used to draw the darkness. More...
 

Private Attributes

darkness_style m_style
 
std::array< QPixmap, MAX_INDEX_CARDINALm_sprites
 

Additional Inherited Members

- Protected Member Functions inherited from freeciv::layer
struct tilesettileset () const
 
bool do_draw_unit (const tile *ptile, const unit *punit) const
 Whether a unit should be drawn. More...
 
bool solid_background (const tile *ptile, const unit *punit, const city *pcity) const
 Whether a solid background should be drawn on a tile instead of its terrain. More...
 
QPixmap * load_sprite (const QStringList &possible_names, bool required=false, bool verbose=true) const
 Shortcut to load a sprite from the tileset. More...
 

Detailed Description

Definition at line 46 of file layer_darkness.h.

Constructor & Destructor Documentation

◆ layer_darkness()

freeciv::layer_darkness::layer_darkness ( struct tileset ts,
darkness_style  style 
)
explicit

Definition at line 24 of file layer_darkness.cpp.

◆ ~layer_darkness()

virtual freeciv::layer_darkness::~layer_darkness ( )
virtualdefault

Member Function Documentation

◆ fill_sprite_array()

std::vector< drawn_sprite > freeciv::layer_darkness::fill_sprite_array ( const tile ptile,
const tile_edge pedge,
const tile_corner pcorner,
const unit punit 
) const
overridevirtual

Returns the list of sprites drawn by this layer somewhere on the map.

Only one of ptile, pedge, or pcorner should be non-null.

Reimplemented from freeciv::layer.

Definition at line 92 of file layer_darkness.cpp.

◆ load_sprites()

void freeciv::layer_darkness::load_sprites ( )
overridevirtual

Loads all the sprites needed to draw the darkness.

Reimplemented from freeciv::layer.

Definition at line 29 of file layer_darkness.cpp.

◆ set_sprite()

void freeciv::layer_darkness::set_sprite ( std::size_t  index,
const QPixmap &  p 
)
inlineprivate

Sets one of the sprites used to draw the darkness.

Definition at line 65 of file layer_darkness.h.

Referenced by load_sprites().

Member Data Documentation

◆ m_sprites

std::array<QPixmap, MAX_INDEX_CARDINAL> freeciv::layer_darkness::m_sprites
private

Definition at line 73 of file layer_darkness.h.

Referenced by fill_sprite_array(), and set_sprite().

◆ m_style

darkness_style freeciv::layer_darkness::m_style
private

Definition at line 70 of file layer_darkness.h.

Referenced by fill_sprite_array(), and load_sprites().