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

#include <layer_fog.h>

+ Inheritance diagram for freeciv::layer_fog:
+ Collaboration diagram for freeciv::layer_fog:

Public Member Functions

 layer_fog (struct tileset *ts, fog_style style, darkness_style darkness)
 
virtual ~layer_fog ()=default
 
void load_sprites () override
 Loads all sprites that do not depend on the ruleset. 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 Attributes

fog_style m_style
 
darkness_style m_darkness
 
QPixmap * m_fog_sprite
 
std::vector< QPixmap * > m_darkness_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 29 of file layer_fog.h.

Constructor & Destructor Documentation

◆ layer_fog()

freeciv::layer_fog::layer_fog ( struct tileset ts,
fog_style  style,
darkness_style  darkness 
)
explicit

Definition at line 14 of file layer_fog.cpp.

◆ ~layer_fog()

virtual freeciv::layer_fog::~layer_fog ( )
virtualdefault

Member Function Documentation

◆ fill_sprite_array()

std::vector< drawn_sprite > freeciv::layer_fog::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 45 of file layer_fog.cpp.

◆ load_sprites()

void freeciv::layer_fog::load_sprites ( )
overridevirtual

Loads all sprites that do not depend on the ruleset.

Reimplemented from freeciv::layer.

Definition at line 20 of file layer_fog.cpp.

Member Data Documentation

◆ m_darkness

darkness_style freeciv::layer_fog::m_darkness
private

Definition at line 44 of file layer_fog.h.

Referenced by fill_sprite_array(), and load_sprites().

◆ m_darkness_sprites

std::vector<QPixmap *> freeciv::layer_fog::m_darkness_sprites
private

Definition at line 46 of file layer_fog.h.

Referenced by fill_sprite_array(), and load_sprites().

◆ m_fog_sprite

QPixmap* freeciv::layer_fog::m_fog_sprite
private

Definition at line 45 of file layer_fog.h.

Referenced by load_sprites().

◆ m_style

fog_style freeciv::layer_fog::m_style
private

Definition at line 43 of file layer_fog.h.

Referenced by fill_sprite_array().