The Battle for Wesnoth  1.15.0-dev
Public Member Functions | Private Attributes | List of all members
gui2::circle_shape Class Reference

Definition of a circle shape. More...

#include <canvas_private.hpp>

Inheritance diagram for gui2::circle_shape:
Inheritance graph

Public Member Functions

 circle_shape (const config &cfg)
 Constructor. More...
 
void draw (const int canvas_w, const int canvas_h, SDL_Renderer *renderer, wfl::map_formula_callable &variables) override
 Implement shape::draw(). More...
 
- Public Member Functions inherited from gui2::canvas::shape
 shape (const config &cfg)
 
virtual ~shape ()
 
bool immutable () const
 

Private Attributes

typed_formula< unsigned > x_
 The center x coordinate of the circle. More...
 
typed_formula< unsigned > y_
 The center y coordinate of the circle. More...
 
typed_formula< unsigned > radius_
 The radius of the circle. More...
 
typed_formula< color_tborder_color_
 The border color of the circle. More...
 
typed_formula< color_tfill_color_
 The fill color of the circle. More...
 
unsigned int border_thickness_
 The border thickness of the circle. More...
 

Detailed Description

Definition of a circle shape.

Definition at line 153 of file canvas_private.hpp.

Constructor & Destructor Documentation

◆ circle_shape()

gui2::circle_shape::circle_shape ( const config cfg)
explicit

Constructor.

Parameters
cfgThe config object to define the circle see https://www.wesnoth.org/wiki/GUICanvasWML#Circle for more information.

Definition at line 877 of file canvas.cpp.

References DBG_GUI_P, and debug.

Member Function Documentation

◆ draw()

void gui2::circle_shape::draw ( const int  canvas_w,
const int  canvas_h,
SDL_Renderer *  renderer,
wfl::map_formula_callable variables 
)
overridevirtual

Implement shape::draw().

Todo:
formulas are now recalculated every draw cycle which is a bit silly unless there has been a resize. So to optimize we should use an extra flag or do the calculation in a separate routine.

Implements gui2::canvas::shape.

Definition at line 892 of file canvas.cpp.

References _(), border_color_, border_thickness_, DBG_GUI_D, fill_color_, i, color_t::null(), radius_, VALIDATE_WITH_DEV_MESSAGE, x_, and y_.

Member Data Documentation

◆ border_color_

typed_formula<color_t> gui2::circle_shape::border_color_
private

The border color of the circle.

Definition at line 177 of file canvas_private.hpp.

Referenced by draw().

◆ border_thickness_

unsigned int gui2::circle_shape::border_thickness_
private

The border thickness of the circle.

Definition at line 180 of file canvas_private.hpp.

Referenced by draw().

◆ fill_color_

typed_formula<color_t> gui2::circle_shape::fill_color_
private

The fill color of the circle.

Definition at line 177 of file canvas_private.hpp.

Referenced by draw().

◆ radius_

typed_formula<unsigned> gui2::circle_shape::radius_
private

The radius of the circle.

Definition at line 172 of file canvas_private.hpp.

Referenced by draw().

◆ x_

typed_formula<unsigned> gui2::circle_shape::x_
private

The center x coordinate of the circle.

Definition at line 172 of file canvas_private.hpp.

Referenced by draw().

◆ y_

typed_formula<unsigned> gui2::circle_shape::y_
private

The center y coordinate of the circle.

Definition at line 172 of file canvas_private.hpp.

Referenced by draw().


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