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

introductory_examples.rst -> clarify show and STL import statements and reorganize

Browse source 
also rename to lowercase build123d, and add link to the other file format section
This commit is contained in:
jdegenstein 2024-02-13 16:37:45 -06:00 • committed by GitHub
parent 594e5f8a7c
commit b7c5d0c9e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 10 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docs/introductory_examples.rst
View file

@ -2,22 +2,23 @@
Introductory Examples
#########################
The examples on this page can help you learn how to build objects with Build123d, and are intended as a general overview of Build123d.
The examples on this page can help you learn how to build objects with build123d, and are intended as a general overview of build123d.
They are organized from simple to complex, so working through them in order is the best way to absorb them.
.. note::
Some important lines are omitted below to save space, so you will most likely need to add 1 & 2 or 3 to the provided code below for them to work:
Some important lines are omitted below to save space, so you will most likely need to add 1 & 2 to the provided code below for them to work:
1. ``from build123d import *``
2. If you are using Build123d *context mode*,
2. If you are using build123d *builder mode* or *algebra mode*,
- in *CQ-editor* add e.g. ``show_object(ex15.part)``, ``show_object(ex15.sketch)`` or ``show_object(ex15.line)`` to view parts, sketches or lines.
- in *ocp_vscode* simply use e.g. ``show_object(ex15)`` for parts, sketches and curves.
- in *ocp_vscode* simply use e.g. ``show(ex15)`` to the end of your design to view parts, sketches and curves. `show_all()` can be used to automatically show all objects with their variable names as labels.
- in *CQ-editor* add e.g. ``show_object(ex15.part)``, ``show_object(ex15.sketch)`` or ``show_object(ex15.line)`` to the end of your design to view parts, sketches or lines.
3. If you are using Build123d *algebra mode*, add the line e.g. ``show_object(ex15)`` for parts, sketches and curves at the end.
4. If you want to save your resulting file as an STL, it is currently best to use e.g. ``ex15.part.export_stl("file.stl")``.
3. If you want to save your resulting object as an STL from *builder mode*, you can use e.g. ``ex15.part.export_stl("file.stl")``.
4. If you want to save your resulting object as an STL from *algebra mode*, you can use e.g. ``ex15.export_stl("file.stl")``
5. build123d also supports exporting to multiple other file formats including STEP, see here for further information: `Import/Export Formats <https://build123d.readthedocs.io/en/latest/import_export.html>`_
.. contents:: List of Examples
:backlinks: entry
@ -421,7 +422,7 @@ Counter-sink and counter-bore holes are useful for creating recessed areas for f
14. Position on a line with '\@', '\%' and introduce Sweep
------------------------------------------------------------
Build123d includes a feature for finding the position along a line segment. This
build123d includes a feature for finding the position along a line segment. This
is normalized between 0 and 1 and can be accessed using the :meth:`~topology.Mixin1D.position_at` operator.
Similarly the :meth:`~topology.Mixin1D.tangent_at` operator returns the line direction at a given point.
@ -840,7 +841,7 @@ We are able to create multiple workplanes by looping over the list of faces.
29. The Classic OCC Bottle
---------------------------------------------------
Build123d is based on the OpenCascade.org (OCC) modeling Kernel. Those who are familiar with OCC
build123d is based on the OpenCascade.org (OCC) modeling Kernel. Those who are familiar with OCC
know about the famous ‘bottle’ example. We use a 3D Offset and the openings parameter to create
the bottle opening.