codac 2.0.0
Loading...
Searching...
No Matches
codac2::StyleProperties Struct Reference

Style properties structure, to specify the style of a shape. More...

#include <codac2_StyleProperties.h>

Collaboration diagram for codac2::StyleProperties:

Public Member Functions

 StyleProperties ()
 Default constructor.
 
 StyleProperties (const Color &stroke_color, const std::string &param1="", const std::string &param2="", const std::string &param3="")
 Constructor from a stroke color, and two optional parameters.
 
 StyleProperties (std::initializer_list< Color > colors, const std::string &param1="", const std::string &param2="", const std::string &param3="")
 Constructor from a stroke and eventually a fill color, and two optional parameters.
 
void parse_parameter (const std::string &param)
 Parse a parameter and update the style properties accordingly.
 

Static Public Member Functions

static StyleProperties inside ()
 Predefined "inside" style, dark gray edge and green fill.
 
static StyleProperties outside ()
 Predefined "outside" style, dark gray edge and light blue fill.
 
static StyleProperties boundary ()
 Predefined "boundary" style, dark gray edge and yellow fill.
 
static std::set< std::string > available_line_styles ()
 Set of available line styles.
 

Detailed Description

Style properties structure, to specify the style of a shape.

This class is used to specify the style of a shape, including the stroke color, fill color, line style and layer.

Constructor & Destructor Documentation

◆ StyleProperties() [1/3]

codac2::StyleProperties::StyleProperties ( )

Default constructor.

Black stroke color, transparent fill color, solid line style and layer "alpha"

◆ StyleProperties() [2/3]

codac2::StyleProperties::StyleProperties ( const Color & stroke_color,
const std::string & param1 = "",
const std::string & param2 = "",
const std::string & param3 = "" )

Constructor from a stroke color, and two optional parameters.

Parameters
stroke_colorStroke color
param1Optional parameter, can be layer name or line style
param2Optional parameter, can be layer name or line style
param3Optional parameter, can be layer name or line style

◆ StyleProperties() [3/3]

codac2::StyleProperties::StyleProperties ( std::initializer_list< Color > colors,
const std::string & param1 = "",
const std::string & param2 = "",
const std::string & param3 = "" )

Constructor from a stroke and eventually a fill color, and two optional parameters.

Parameters
colorslist of colors (stroke color and eventually fill color)
param1Optional parameter, can be layer name or line style
param2Optional parameter, can be layer name or line style
param3Optional parameter, can be layer name or line style

Member Function Documentation

◆ parse_parameter()

void codac2::StyleProperties::parse_parameter ( const std::string & param)

Parse a parameter and update the style properties accordingly.

Parameters
paramParameter to parse, can be a line style, line width or layer name

The documentation for this struct was generated from the following file: