compas_plotters.GeometryPlotter

class compas_plotters.GeometryPlotter(view=[(- 8, 16), (- 5, 10)], figsize=(8, 5), dpi=100, bgcolor=(1.0, 1.0, 1.0), show_axes=False)[source]

Bases: object

Plotter for the visualisation of COMPAS geometry.

Parameters
  • view (tuple, optional) – The area of the axes that should be zoomed into view. DEfault is ([-10, 10], [-3, 10]).

  • figsize (tuple, optional) – The size of the figure in inches. Default is (8, 5)

Examples

Notes

Methods

add(item[, artist])

add_as(item, artist_type, **kwargs)

add_from_list(items, **kwargs)

draw([pause])

find(item)

pause(pause)

redraw([pause])

Updates and pauses the plot.

register_listener(listener)

Register a listener for pick events.

save(filepath, **kwargs)

Saves the plot to a file.

show()

Displays the plot.

zoom_extents()

Attributes

artists

list of compas_plotters.artists.Artist

axes

Returns the axes subplot matplotlib object.

bgcolor

Returns the background color.

canvas

Returns the canvas of the figure instance.

figure

Returns the matplotlib figure instance.

title

Returns the title of the plot.

viewbox

The area of the axes that is zoomed into view.