PolyLoop

class xgbxml.xgbxml.PolyLoop[source]
create_CartesianPoints(*points_coordinates)[source]

Creates CartesianPoint child elements with Coordinate subelements.

Parameters:

points_coordinates (tuple) – An argument list of tuple where each tuple is the (x,y,(z)) coordinates of a CartesianPoint.

Returns:

The newly creeated CartesianPoint elements.

Return type:

list(CartesianPoints)

get_area()[source]
Returns:

The area of the PolyLoop

Return type:

float

get_coordinates()[source]

Returns the coordinates of the CartesianPoint child elements.

Returns:

Point_coordinates where each point_coordinate is a tuple of the (x,y,(z)) coordinates of a CartesianPoint.

Return type:

tuple(tuple(float))

get_shell()[source]

Returns the shell of the Polyloop.

Return type:

tuple(tuple(float))

render(ax=None, set_lims=True, outline_kwargs=None, fill_kwargs=None)[source]

Renders the PolyLoop in 3D using matplotlib.

Parameters:

  • ax (matplotlib.axes._subplots.Axes3DSubplot) – A matplotlib 3D Axes instance. Optional, if not supplied then an axis is created and returned.

  • set_lims (bool) – If True, then the x, y and z axis limits are set automatically based on the geometry being rendered.

  • outline_kwargs – matplotlib keywork arguments for formatting the outlines (passed to ax.plot method).

  • fill_kwargs – matplotlib keywork arguments for formatting the fill (passed to Poly3DCollection method).

Returns:

The axis instance.

Return type:

matplotlib.axes._subplots.Axes3DSubplot