Skip to content

Commit f990a1c

Browse files
gonzalocasasclaude
andcommitted
Update README and docs for shape support + roadmap
Move Box and the tessellated shapes (Sphere, Cylinder, Cone, Capsule, Torus, Polyhedron) into the supported-objects tables, and rewrite the roadmap to list what actually remains: Brep, Surface, NurbsCurve, VolMesh and Plane. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 26376a1 commit f990a1c

2 files changed

Lines changed: 23 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,21 @@ plotter.show()
4343
| Category | Objects |
4444
|---|---|
4545
| Geometry | `Point`, `Vector`, `Line`, `Polyline`, `Polygon`, `Circle`, `Ellipse`, `Frame` |
46+
| Shapes (drawn as XY projections) | `Box`, `Sphere`, `Cylinder`, `Cone`, `Capsule`, `Torus`, `Polyhedron` |
4647
| Data structures | `Mesh`, `Graph` |
4748

48-
3D shapes (`Box`, `Sphere`, …), `Brep`, `Surface` and `VolMesh` are not yet
49-
supported — see the [roadmap](https://compas.dev/compas_plotters).
49+
`Brep`, `Surface`, `NurbsCurve`, `VolMesh` and `Plane` are not yet supported —
50+
see the [roadmap](#roadmap).
51+
52+
## Roadmap
53+
54+
Planned additions, most likely drawn as XY projections following the existing
55+
`ShapeObject`:
56+
57+
- `Brep` and `Surface` (tessellate to a mesh, then project; `Brep` needs an
58+
optional backend such as `compas_occ`)
59+
- `NurbsCurve` (sampled to a polyline)
60+
- `VolMesh` and `Plane`
5061

5162
## Documentation
5263

docs/index.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,18 @@ plotter.show()
4242
| Category | Objects |
4343
|---|---|
4444
| Geometry | `Point`, `Vector`, `Line`, `Polyline`, `Polygon`, `Circle`, `Ellipse`, `Frame` |
45+
| Shapes (drawn as XY projections) | `Box`, `Sphere`, `Cylinder`, `Cone`, `Capsule`, `Torus`, `Polyhedron` |
4546
| Data structures | `Mesh`, `Graph` |
4647

47-
3D shapes (`Box`, `Sphere`, …), `Brep`, `Surface` and `VolMesh` are not yet
48-
supported. They are on the roadmap and may be added as XY projections.
48+
## Roadmap
49+
50+
The following are not yet supported. They are likely to be added as XY
51+
projections, following the existing `ShapeObject`:
52+
53+
- `Brep` and `Surface` — tessellate to a mesh, then project (`Brep` needs an
54+
optional backend such as `compas_occ`)
55+
- `NurbsCurve` — sampled to a polyline
56+
- `VolMesh` and `Plane`
4957

5058
## Next steps
5159

0 commit comments

Comments
 (0)