mirrors/build123d
1
Fork 0
mirror of https://github.com/gumyr/build123d.git synced 2025-12-06 02:30:55 -08:00
Code Issues Projects Releases Packages Wiki Activity Actions

Adding draft to operations list

Browse source
This commit is contained in:
gumyr 2025-05-25 19:13:44 -04:00
parent e842b321f3
commit 8dd1336948
1 changed files with 48 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

93
docs/operations.rst
View file

@ -21,51 +21,53 @@ The following table summarizes all of the available operations. Operations marke
applicable to BuildLine and Algebra Curve, 2D to BuildSketch and Algebra Sketch, 3D to applicable to BuildLine and Algebra Curve, 2D to BuildSketch and Algebra Sketch, 3D to
BuildPart and Algebra Part. BuildPart and Algebra Part.
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| Operation | Description | 0D | 1D | 2D | 3D | Example | | Operation | Description | 0D | 1D | 2D | 3D | Example |
+==============================================+====================================+====+====+====+====+========================+ +==============================================+====================================+====+====+====+====+===================================+
| :func:`~operations_generic.add` | Add object to builder | | ✓ | ✓ | ✓ | :ref:`16 <ex 16>` | | :func:`~operations_generic.add` | Add object to builder | | ✓ | ✓ | ✓ | :ref:`16 <ex 16>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.bounding_box` | Add bounding box as Shape | | ✓ | ✓ | ✓ | | | :func:`~operations_generic.bounding_box` | Add bounding box as Shape | | ✓ | ✓ | ✓ | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.chamfer` | Bevel Vertex or Edge | | | ✓ | ✓ | :ref:`9 <ex 9>` | | :func:`~operations_generic.chamfer` | Bevel Vertex or Edge | | | ✓ | ✓ | :ref:`9 <ex 9>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.extrude` | Draw 2D Shape into 3D | | | | ✓ | :ref:`3 <ex 3>` | | :func:`~operations_part.draft` | Add a draft taper to a part | | | | ✓ | :ref:`examples-cast_bearing_unit` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.fillet` | Radius Vertex or Edge | | | ✓ | ✓ | :ref:`9 <ex 9>` | | :func:`~operations_part.extrude` | Draw 2D Shape into 3D | | | | ✓ | :ref:`3 <ex 3>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_sketch.full_round` | Round-off Face along given Edge | | | ✓ | | :ref:`ttt-24-spo-06` | | :func:`~operations_generic.fillet` | Radius Vertex or Edge | | | ✓ | ✓ | :ref:`9 <ex 9>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.loft` | Create 3D Shape from sections | | | | ✓ | :ref:`24 <ex 24>` | | :func:`~operations_sketch.full_round` | Round-off Face along given Edge | | | ✓ | | :ref:`ttt-24-spo-06` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.make_brake_formed` | Create sheet metal parts | | | | ✓ | | | :func:`~operations_part.loft` | Create 3D Shape from sections | | | | ✓ | :ref:`24 <ex 24>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_sketch.make_face` | Create a Face from Edges | | | ✓ | | :ref:`4 <ex 4>` | | :func:`~operations_part.make_brake_formed` | Create sheet metal parts | | | | ✓ | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_sketch.make_hull` | Create Convex Hull from Edges | | | ✓ | | | | :func:`~operations_sketch.make_face` | Create a Face from Edges | | | ✓ | | :ref:`4 <ex 4>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.mirror` | Mirror about Plane | | ✓ | ✓ | ✓ | :ref:`15 <ex 15>` | | :func:`~operations_sketch.make_hull` | Create Convex Hull from Edges | | | ✓ | | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.offset` | Inset or outset Shape | | ✓ | ✓ | ✓ | :ref:`25 <ex 25>` | | :func:`~operations_generic.mirror` | Mirror about Plane | | ✓ | ✓ | ✓ | :ref:`15 <ex 15>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.project` | Project points, lines or Faces | ✓ | ✓ | ✓ | | | | :func:`~operations_generic.offset` | Inset or outset Shape | | ✓ | ✓ | ✓ | :ref:`25 <ex 25>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.project_workplane` | Create workplane for projection | | | | | | | :func:`~operations_generic.project` | Project points, lines or Faces | ✓ | ✓ | ✓ | | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.revolve` | Swing 2D Shape about Axis | | | | ✓ | :ref:`23 <ex 23>` | | :func:`~operations_part.project_workplane` | Create workplane for projection | | | | | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.scale` | Change size of Shape | | ✓ | ✓ | ✓ | | | :func:`~operations_part.revolve` | Swing 2D Shape about Axis | | | | ✓ | :ref:`23 <ex 23>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.section` | Generate 2D slices from 3D Shape | | | | ✓ | | | :func:`~operations_generic.scale` | Change size of Shape | | ✓ | ✓ | ✓ | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.split` | Divide object by Plane | | ✓ | ✓ | ✓ | :ref:`27 <ex 27>` | | :func:`~operations_part.section` | Generate 2D slices from 3D Shape | | | | ✓ | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_generic.sweep` | Extrude 1/2D section(s) along path | | | ✓ | ✓ | :ref:`14 <ex 14>` | | :func:`~operations_generic.split` | Divide object by Plane | | ✓ | ✓ | ✓ | :ref:`27 <ex 27>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_part.thicken` | Expand 2D section(s) | | | | ✓ | | | :func:`~operations_generic.sweep` | Extrude 1/2D section(s) along path | | | ✓ | ✓ | :ref:`14 <ex 14>` |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_sketch.trace` | Convert lines to faces | | | ✓ | | | | :func:`~operations_part.thicken` | Expand 2D section(s) | | | | ✓ | |
+----------------------------------------------+------------------------------------+----+----+----+----+------------------------+ +----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
| :func:`~operations_sketch.trace` | Convert lines to faces | | | ✓ | | |
+----------------------------------------------+------------------------------------+----+----+----+----+-----------------------------------+
The following table summarizes all of the selectors that can be used within The following table summarizes all of the selectors that can be used within
the scope of a Builder. Note that they will extract objects from the builder that is the scope of a Builder. Note that they will extract objects from the builder that is
@ -104,6 +106,7 @@ Reference
.. autofunction:: operations_generic.add .. autofunction:: operations_generic.add
.. autofunction:: operations_generic.bounding_box .. autofunction:: operations_generic.bounding_box
.. autofunction:: operations_generic.chamfer .. autofunction:: operations_generic.chamfer
.. autofunction:: operations_part.draft
.. autofunction:: operations_part.extrude .. autofunction:: operations_part.extrude
.. autofunction:: operations_generic.fillet .. autofunction:: operations_generic.fillet
.. autofunction:: operations_sketch.full_round .. autofunction:: operations_sketch.full_round