You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/tutorial/plotters.rst
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,10 @@ The COMPAS plotters (:mod:`compas_plotters`) provide an easy-to-use inteface for
6
6
of COMPAS objects based on matplotlib.
7
7
8
8
The package contains four types of plotters:
9
-
:class:`~compas_plotters.GeometryPlotter`,
10
-
:class:`~compas_plotters.NetworkPlotter`,
11
-
:class:`~compas_plotters.MeshPlotter`, and ... :class:`~compas_plotters.Plotter`.
12
-
The first three are deprecated in favour of :class:`~compas_plotters.Plotter`, which is therefore the only one that will be described in this tutorial.
9
+
:class:`compas_plotters.GeometryPlotter`,
10
+
:class:`compas_plotters.NetworkPlotter`,
11
+
:class:`compas_plotters.MeshPlotter`, and ... :class:`compas_plotters.Plotter`.
12
+
The first three are deprecated in favour of :class:`compas_plotters.Plotter`, which is therefore the only one that will be described in this tutorial.
13
13
14
14
15
15
Example
@@ -49,7 +49,7 @@ Example
49
49
Basic Usage
50
50
===========
51
51
52
-
Using :class:`~compas_plotters.Plotter` is very simple.
52
+
Using :class:`compas_plotters.Plotter` is very simple.
53
53
54
54
1. Create a plotter instance.
55
55
2. Add Objects.
@@ -95,13 +95,13 @@ Geometry Objects
95
95
Most of the geometry primitives are supported
96
96
and can be added to a plotter instance as described above:
97
97
98
-
* :class:`~compas.geometry.Point`
99
-
* :class:`~compas.geometry.Vector`
100
-
* :class:`~compas.geometry.Line`
101
-
* :class:`~compas.geometry.Circle`
102
-
* :class:`~compas.geometry.Ellipse`
103
-
* :class:`~compas.geometry.Polyline`
104
-
* :class:`~compas.geometry.Polygon`
98
+
* :class:`compas.geometry.Point`
99
+
* :class:`compas.geometry.Vector`
100
+
* :class:`compas.geometry.Line`
101
+
* :class:`compas.geometry.Circle`
102
+
* :class:`compas.geometry.Ellipse`
103
+
* :class:`compas.geometry.Polyline`
104
+
* :class:`compas.geometry.Polygon`
105
105
106
106
Bezier curves and pointclouds are currently not available yet, but will be added as well.
107
107
Note that in all cases, the ``z`` coordinates of the objects are simply ignored, and only a 2D representation is depicted.
0 commit comments