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

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

#include <codac2_StyleGradientProperties.h>

Inheritance diagram for codac2::StyleGradientProperties:
Collaboration diagram for codac2::StyleGradientProperties:

Public Member Functions

 StyleGradientProperties ()
 Default constructor.
 
 StyleGradientProperties (const std::string &param1, const std::string &param2="", const std::string &param3="")
 Constructor with only optionnal parameters.
 
 StyleGradientProperties (const ColorMap &cmap, const std::string &param1="", const std::string &param2="", const std::string &param3="")
 Constructor from a color map, and three optional parameters.
 
- Public Member Functions inherited from codac2::StylePropertiesBase
 StylePropertiesBase ()
 Default constructor.
 
 StylePropertiesBase (const std::string &param1, const std::string &param2="", const std::string &param3="")
 Constructor with only optionnal parameters.
 
void parse_parameter (const std::string &param)
 Parse a parameter and update the style properties accordingly.
 

Additional Inherited Members

- Static Public Member Functions inherited from codac2::StylePropertiesBase
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 color map, line style, line width and layer.

Constructor & Destructor Documentation

◆ StyleGradientProperties() [1/3]

codac2::StyleGradientProperties::StyleGradientProperties ( )

Default constructor.

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

◆ StyleGradientProperties() [2/3]

codac2::StyleGradientProperties::StyleGradientProperties ( const std::string & param1,
const std::string & param2 = "",
const std::string & param3 = "" )

Constructor with only optionnal parameters.

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

◆ StyleGradientProperties() [3/3]

codac2::StyleGradientProperties::StyleGradientProperties ( const ColorMap & cmap,
const std::string & param1 = "",
const std::string & param2 = "",
const std::string & param3 = "" )

Constructor from a color map, and three optional parameters.

Parameters
cmapColor map
param1Optional parameter, can be layer name, line width or line style
param2Optional parameter, can be layer name, line width or line style
param3Optional parameter, can be layer name, line width or line style

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