Inscoper::NBO::Polygon¶

Represents the XML element Polygon. More...

#include <Polygon.h>

Inherits from Inscoper::NBO::Shape_Type, NBOBaseClass

Public Functions¶

	Name
	Polygon()
	~Polygon()
virtual std::string	getTypeName() const override Returns the class type name.
std::string	getXMLName() const override Returns the XML element name corresponding to this class.
ENBOType	getNBOType() const override Returns the NBO Type corresponding to this class.
std::vector< NBOBaseClassPtr >	getChildren() const override Returns a list of all classes derived from this class.
std::vector< NBOBaseClassPtr >	getSubElements() const override Returns a list of all child elements contained in this class.
void	fromJsonFile(const std::string & path, bool validate =true) Populates this object from a JSON file.
void	fromJsonString(const std::string & json_string, bool validate =true) Populates this object from a JSON string.
void	fromXmlFile(const std::string & path, bool validate =true) Populates this object from a XML file.
void	fromXmlString(const std::string & xml_string, bool validate =true) Populates this object from a XML string.
void	toXmlFile(const std::string & filename, bool validate =true) const Serializes this object to an XML file.
std::string	toXmlString(bool validate =true) const Serializes this object to an XML string.
void	setPoints(const std::string & value, bool validate =true) Sets the value of the Points attribute.
std::string	getPoints() const Returns the value of the Points attribute.
void	resetPoints() Resets the Points attribute to an unset state.
bool	hasPoints() const Checks whether the Points attribute is present.
std::shared_ptr< Polygon >	fromBase(NBOBaseClassPtr base) Cast a NBOBaseClass to a Polygon.
const std::set< std::string > &	getPointsAllowedValues() Returns the allowed values for this attribut.

Additional inherited members¶

Public Functions inherited from Inscoper::NBO::Shape_Type

	Name
	Shape_Type()
	~Shape_Type()
void	setFillColor(const Inscoper::NBO::Color_TypePtr & value, bool validate =true) Sets the value of the FillColor attribute.
Color_TypePtr	getFillColor() const Returns the value of the FillColor attribute.
void	resetFillColor() Resets the FillColor attribute to an unset state.
bool	hasFillColor() const Checks whether the optional FillColor attribute is present.
void	setFillRule(const std::string & value, bool validate =true) Sets the value of the FillRule attribute.
std::string	getFillRule() const Returns the value of the FillRule attribute.
void	resetFillRule() Resets the FillRule attribute to an unset state.
bool	hasFillRule() const Checks whether the FillRule attribute is present.
void	setStrokeColor(const Inscoper::NBO::Color_TypePtr & value, bool validate =true) Sets the value of the StrokeColor attribute.
Color_TypePtr	getStrokeColor() const Returns the value of the StrokeColor attribute.
void	resetStrokeColor() Resets the StrokeColor attribute to an unset state.
bool	hasStrokeColor() const Checks whether the optional StrokeColor attribute is present.
void	setStrokeWidth(const float & value, bool validate =true) Sets the value of the StrokeWidth attribute.
float	getStrokeWidth() const Returns the value of the StrokeWidth attribute.
void	resetStrokeWidth() Resets the StrokeWidth attribute to an unset state.
bool	hasStrokeWidth() const Checks whether the StrokeWidth attribute is present.
void	setStrokeWidthUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the StrokeWidthUnit attribute.
UnitsLength_TypePtr	getStrokeWidthUnit() const Returns the value of the StrokeWidthUnit attribute.
void	resetStrokeWidthUnit() Resets the StrokeWidthUnit attribute to an unset state.
bool	hasStrokeWidthUnit() const Checks whether the optional StrokeWidthUnit attribute is present.
void	setStrokeDashArray(const std::string & value, bool validate =true) Sets the value of the StrokeDashArray attribute.
std::string	getStrokeDashArray() const Returns the value of the StrokeDashArray attribute.
void	resetStrokeDashArray() Resets the StrokeDashArray attribute to an unset state.
bool	hasStrokeDashArray() const Checks whether the StrokeDashArray attribute is present.
void	setText(const std::string & value, bool validate =true) Sets the value of the Text attribute.
std::string	getText() const Returns the value of the Text attribute.
void	resetText() Resets the Text attribute to an unset state.
bool	hasText() const Checks whether the Text attribute is present.
void	setFontFamily(const std::string & value, bool validate =true) Sets the value of the FontFamily attribute.
std::string	getFontFamily() const Returns the value of the FontFamily attribute.
void	resetFontFamily() Resets the FontFamily attribute to an unset state.
bool	hasFontFamily() const Checks whether the FontFamily attribute is present.
void	setFontSize(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the FontSize attribute.
NonNegativeInt_TypePtr	getFontSize() const Returns the value of the FontSize attribute.
void	resetFontSize() Resets the FontSize attribute to an unset state.
bool	hasFontSize() const Checks whether the optional FontSize attribute is present.
void	setFontSizeUnit(const Inscoper::NBO::UnitsLength_TypePtr & value, bool validate =true) Sets the value of the FontSizeUnit attribute.
UnitsLength_TypePtr	getFontSizeUnit() const Returns the value of the FontSizeUnit attribute.
void	resetFontSizeUnit() Resets the FontSizeUnit attribute to an unset state.
bool	hasFontSizeUnit() const Checks whether the optional FontSizeUnit attribute is present.
void	setFontStyle(const std::string & value, bool validate =true) Sets the value of the FontStyle attribute.
std::string	getFontStyle() const Returns the value of the FontStyle attribute.
void	resetFontStyle() Resets the FontStyle attribute to an unset state.
bool	hasFontStyle() const Checks whether the FontStyle attribute is present.
void	setLocked(const bool & value, bool validate =true) Sets the value of the Locked attribute.
bool	getLocked() const Returns the value of the Locked attribute.
void	resetLocked() Resets the Locked attribute to an unset state.
bool	hasLocked() const Checks whether the Locked attribute is present.
void	setID(const Inscoper::NBO::ShapeID_TypePtr & value, bool validate =true) Sets the value of the ID attribute.
ShapeID_TypePtr	getID() const Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
bool	hasID() const Checks whether the optional ID attribute is present.
void	setTheZ(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the TheZ attribute.
NonNegativeInt_TypePtr	getTheZ() const Returns the value of the TheZ attribute.
void	resetTheZ() Resets the TheZ attribute to an unset state.
bool	hasTheZ() const Checks whether the optional TheZ attribute is present.
void	setTheT(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the TheT attribute.
NonNegativeInt_TypePtr	getTheT() const Returns the value of the TheT attribute.
void	resetTheT() Resets the TheT attribute to an unset state.
bool	hasTheT() const Checks whether the optional TheT attribute is present.
void	setTheC(const Inscoper::NBO::NonNegativeInt_TypePtr & value, bool validate =true) Sets the value of the TheC attribute.
NonNegativeInt_TypePtr	getTheC() const Returns the value of the TheC attribute.
void	resetTheC() Resets the TheC attribute to an unset state.
bool	hasTheC() const Checks whether the optional TheC attribute is present.
void	setTransform(const Inscoper::NBO::AffineTransform_TypePtr & value, bool validate =true) Sets the value of the Transform element.
Inscoper::NBO::AffineTransform_TypePtr	getTransform() const Returns the value of the Transform element.
void	resetTransform() Resets the Transform element to an unset state.
bool	hasTransform() const Checks whether the optional Transform element is present.
void	setAnnotationRef_List(const std::vector< Inscoper::NBO::AnnotationRefPtr > & value, bool validate =true) Sets the list of AnnotationRef elements.
std::vector< Inscoper::NBO::AnnotationRefPtr >	getAnnotationRef_List() const Returns the list of AnnotationRef elements.
void	addToAnnotationRef_List(const Inscoper::NBO::AnnotationRefPtr & value, bool validate =true) Adds a new AnnotationRef element to this object.
void	clearAnnotationRef_List() Clear the list of AnnotationRef.
const std::set< std::string > &	getFillRuleAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getStrokeDashArrayAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getTextAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getFontFamilyAllowedValues() Returns the allowed values for this attribut.
const std::set< std::string > &	getFontStyleAllowedValues() Returns the allowed values for this attribut.

Detailed Description¶

class Inscoper::NBO::Polygon;

Represents the XML element Polygon.

The Polygon defines closed shapes formed of straight lines. Note: Polygon uses counterclockwise winding (this is the default OpenGL behavior)

Public Functions Documentation¶

function Polygon¶

function ~Polygon¶

function getTypeName¶

function getXMLName¶

function getNBOType¶

function getChildren¶

function getSubElements¶

function fromJsonFile¶

void fromJsonFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

function fromJsonString¶

void fromJsonString(
    const std::string & json_string,
    bool validate =true
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

function fromXmlFile¶

void fromXmlFile(
    const std::string & path,
    bool validate =true
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

function fromXmlString¶

void fromXmlString(
    const std::string & xml_string,
    bool validate =true
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

function toXmlFile¶

void toXmlFile(
    const std::string & filename,
    bool validate =true
) const

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

function toXmlString¶

std::string toXmlString(
    bool validate =true
) const

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

function setPoints¶

void setPoints(
    const std::string & value,
    bool validate =true
)

Sets the value of the Points attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The points of the Polygon are defined as a list of comma separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g....................... "0,0 1,2 3,5"

function getPoints¶

std::string getPoints() const

Returns the value of the Points attribute.

Return: The value of the attribute

The points of the Polygon are defined as a list of comma separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g....................... "0,0 1,2 3,5"

function resetPoints¶

void resetPoints()

Resets the Points attribute to an unset state.

The points of the Polygon are defined as a list of comma separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g....................... "0,0 1,2 3,5"

function hasPoints¶

bool hasPoints() const

Checks whether the Points attribute is present.

Return: true if the attribute has been set, false otherwise

The points of the Polygon are defined as a list of comma separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g....................... "0,0 1,2 3,5"

function fromBase¶

static std::shared_ptr< Polygon > fromBase(
    NBOBaseClassPtr base
)

Cast a NBOBaseClass to a Polygon.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

function getPointsAllowedValues¶

static const std::set< std::string > & getPointsAllowedValues()

Returns the allowed values for this attribut.

Return: The list of allowed values

The points of the Polygon are defined as a list of comma separated x,y coordinates seperated by spaces like "x1,y1 x2,y2 x3,y3" e.g....................... "0,0 1,2 3,5"

Updated on 2026-09-23 at 16:50:39 +0200