Space

class xgbxml.xgbxml.Space[source]
get_surfaces()[source]

Returns all Surfaces adjacent to the Space.

Return type:

gbCollection(Surfaces)

render(ax=None, set_lims=True, surface_outline_kwargs=None, surface_fill_kwargs=None, opening_outline_kwargs=None, opening_fill_kwargs=None)[source]

Renders the Surfaces of the Space 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.

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

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

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

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

Returns:

The axis instance.

Return type:

matplotlib.axes._subplots.Axes3DSubplot