gui2::round_rectangle_shape Class Reference

Definition of a rounded rectangle shape. More...

#include <canvas_private.hpp>

Inheritance diagram for gui2::round_rectangle_shape:

Public Member Functions
	round_rectangle_shape (const config &cfg)
	Constructor. More...
void	draw (surface &canvas, SDL_Renderer *renderer, const SDL_Rect &viewport, wfl::map_formula_callable &variables) override
	Draws the canvas. More...
Public Member Functions inherited from gui2::canvas::shape
	shape (const config &cfg)
virtual	~shape ()
bool	immutable () const

Private Attributes
typed_formula< int >	r_
	The radius of the corners. More...
int	border_thickness_
	Border thickness. More...
typed_formula< color_t >	border_color_
	The border color of the rounded rectangle. More...
typed_formula< color_t >	fill_color_
	The border color of the rounded rectangle. More...

Additional Inherited Members
Protected Member Functions inherited from gui2::rect_bounded_shape
	rect_bounded_shape (const config &cfg)
	Constructor. More...
calculated_rects	calculate_rects (const SDL_Rect &view_bounds, wfl::map_formula_callable &variables) const

Detailed Description

Definition of a rounded rectangle shape.

When drawing a rounded rectangle it doesn't get blended on the surface but replaces the pixels instead. A blitting flag might be added later if needed.

Key	Type	Default	Description
corner_radius	f_unsigned	0	The radius of the rectangle's corners.
border_thickness	unsigned	0	The thickness of the border; if the thickness is zero it's not drawn.
border_color	color	""	The color of the border; if empty it's not drawn.
fill_color	color	""	The color of the interior; if omitted it's not drawn.
debug	string	""	Debug message to show upon creation; this message is not stored.

Definition at line 234 of file canvas_private.hpp.

Constructor & Destructor Documentation

round_rectangle_shape()

gui2::round_rectangle_shape::round_rectangle_shape ( const config &  cfg )

explicit

Constructor.

Parameters

cfg	The config object to define the round rectangle.

Definition at line 361 of file canvas.cpp.

References border_color_, border_thickness_, DBG_GUI_P, debug, and gui2::typed_formula< T >::has_formula().

Member Function Documentation

draw()

void gui2::round_rectangle_shape::draw ( surface &  canvas, SDL_Renderer *  renderer, const SDL_Rect &  view_bounds, wfl::map_formula_callable &  variables  )

overridevirtual

Draws the canvas.

Parameters

canvas	The resulting image will be blitted upon this canvas.
renderer	The SDL_Renderer to use.
view_bounds	Part of the shape to render - this is the location of canvas within the coordinates of the shape.
variables	The canvas can have formulas in it's definition, this parameter contains the values for these formulas.

Implements gui2::canvas::shape.

Definition at line 379 of file canvas.cpp.

References border_color_, border_thickness_, gui2::rect_bounded_shape::calculate_rects(), DBG_GUI_D, fill_color_, h, i, color_t::null(), r_, and w.

Member Data Documentation

border_color_

typed_formula<color_t> gui2::round_rectangle_shape::border_color_

private

The border color of the rounded rectangle.

If the color is fully transparent the border isn't drawn.

Definition at line 263 of file canvas_private.hpp.

Referenced by draw(), and round_rectangle_shape().

border_thickness_

int gui2::round_rectangle_shape::border_thickness_

private

Border thickness.

If 0 the fill color is used for the entire widget.

Definition at line 256 of file canvas_private.hpp.

Referenced by draw(), and round_rectangle_shape().

fill_color_

typed_formula<color_t> gui2::round_rectangle_shape::fill_color_

private

The border color of the rounded rectangle.

If the color is fully transparent the rounded rectangle won't be filled.

Definition at line 270 of file canvas_private.hpp.

Referenced by draw().

r_

typed_formula<int> gui2::round_rectangle_shape::r_

private

The radius of the corners.

Definition at line 249 of file canvas_private.hpp.

Referenced by draw().

---

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

• gui/core/canvas_private.hpp
• gui/core/canvas.cpp