Polygon¶

Bases: Shape_Type

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)

`fromBase(base)` `staticmethod` ¶

Cast a NBOBaseClass to a Polygon.

Parameters:

Name	Type	Description	Default
`base`	`NBOBaseClass`	The base class to cast	required

Returns:

Type	Description
`Polygon`	The casted element, or nullptr if the cast fails

`getTypeName()` ¶

Returns the class type name.

Returns:

Type	Description
`string`	The class type name

`getXMLName()` ¶

Returns the XML element name corresponding to this class.

Returns:

Type	Description
`string`	The XML element name

`getNBOType()` ¶

Returns the NBO Type corresponding to this class.

Returns:

Type	Description
`int`	The NBO Type value

`getChildren()` ¶

Returns a list of all classes derived from this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of derived classes

`getSubElements()` ¶

Returns a list of all child elements contained in this class.

Returns:

Type	Description
`List[NBOBaseClass]`	The list of child classes

`fromJsonFile(path, validate=True)` ¶

Populates this object from a JSON file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the JSON file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromJsonString(json_string, validate=True)` ¶

Populates this object from a JSON string.

Parameters:

Name	Type	Description	Default
`json_string`	`string`	The JSON content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlFile(path, validate=True)` ¶

Populates this object from a XML file.

Parameters:

Name	Type	Description	Default
`path`	`string`	The path to the XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`fromXmlString(xml_string, validate=True)` ¶

Populates this object from a XML string.

Parameters:

Name	Type	Description	Default
`xml_string`	`string`	The XML content as a string	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlFile(filename, validate=True)` ¶

Serializes this object to an XML file.

Parameters:

Name	Type	Description	Default
`filename`	`string`	The path to the output XML file	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`toXmlString(validate=True)` ¶

Serializes this object to an XML string.

Parameters:

Name	Type	Description	Default
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

Returns:

Type	Description
`string`	A string containing the XML representation of this object

`setPoints(value, validate=True)` ¶

Sets the value of the Points 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"

Parameters:

Name	Type	Description	Default
`value`	`string`	The value to set	required
`validate`	`(boolean, optional)`	If true, validates constraints on value. Default is true.	`True`

`getPoints()` ¶

Returns the value of the Points 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"

Returns:

Type	Description
`string`	The value of the attribute

`resetPoints()` ¶

`hasPoints()` ¶

Checks whether the Points attribute is present.

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"

Returns:

Type	Description
`boolean`	true if the attribute has been set, false otherwise

`getPointsAllowedValues()` `staticmethod` ¶

Returns the allowed values for this attribut.

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"

Returns:

Type	Description
`std::set< str,std::less< str >,std::allocator< str > >`	The list of allowed values

Polygon¶

fromBase(base) staticmethod ¶

getTypeName() ¶

getXMLName() ¶

getNBOType() ¶

getChildren() ¶

getSubElements() ¶

fromJsonFile(path, validate=True) ¶

fromJsonString(json_string, validate=True) ¶

fromXmlFile(path, validate=True) ¶

fromXmlString(xml_string, validate=True) ¶

toXmlFile(filename, validate=True) ¶

toXmlString(validate=True) ¶

setPoints(value, validate=True) ¶

getPoints() ¶

resetPoints() ¶

hasPoints() ¶

getPointsAllowedValues() staticmethod ¶

`fromBase(base)` `staticmethod` ¶

`getTypeName()` ¶

`getXMLName()` ¶

`getNBOType()` ¶

`getChildren()` ¶

`getSubElements()` ¶

`fromJsonFile(path, validate=True)` ¶

`fromJsonString(json_string, validate=True)` ¶

`fromXmlFile(path, validate=True)` ¶

`fromXmlString(xml_string, validate=True)` ¶

`toXmlFile(filename, validate=True)` ¶

`toXmlString(validate=True)` ¶

`setPoints(value, validate=True)` ¶

`getPoints()` ¶

`resetPoints()` ¶

`hasPoints()` ¶

`getPointsAllowedValues()` `staticmethod` ¶