Skip to content

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)

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)

Populates this object from a JSON file.

Parameters:

Name Type Description Default
path string

The path to the JSON file

required

fromJsonString(json_string)

Populates this object from a JSON string.

Parameters:

Name Type Description Default
json_string string

The JSON content as a string

required

fromXmlFile(path)

Populates this object from a XML file.

Parameters:

Name Type Description Default
path string

The path to the XML file

required

fromXmlString(xml_string)

Populates this object from a XML string.

Parameters:

Name Type Description Default
xml_string string

The XML content as a string

required

toXmlFile(filename)

Serializes this object to an XML file.

Parameters:

Name Type Description Default
filename string

The path to the output XML file

required

toXmlString()

Serializes this object to an XML string.

Returns:

Type Description
string

A string containing the XML representation of this object

setPoints(value)

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

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