mirror of
https://github.com/gumyr/build123d.git
synced 2025-12-06 02:30:55 -08:00
136 lines
4.5 KiB
ReStructuredText
136 lines
4.5 KiB
ReStructuredText
..
|
|
build123d readthedocs documentation
|
|
|
|
by: Gumyr
|
|
date: July 13th 2022
|
|
|
|
desc: This is the documentation for build123d on readthedocs
|
|
|
|
license:
|
|
|
|
Copyright 2022 Gumyr
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
|
|
.. highlight:: python
|
|
|
|
.. image:: ./assets/build123d_logo/logo-banner.svg
|
|
:align: center
|
|
:alt: build123d logo
|
|
|
|
Build123d is a python-based, parametric, boundary representation (BREP) modeling
|
|
framework for 2D and 3D CAD. It's built on the Open Cascade geometric kernel and
|
|
allows for the creation of complex models using a simple and intuitive python
|
|
syntax. Build123d can be used to create models for 3D printing, CNC machining,
|
|
laser cutting, and other manufacturing processes. Models can be exported to a
|
|
wide variety of popular CAD tools such as FreeCAD and SolidWorks.
|
|
|
|
Build123d could be considered as an evolution of
|
|
`CadQuery <https://cadquery.readthedocs.io/en/latest/index.html>`_ where the
|
|
somewhat restrictive Fluent API (method chaining) is replaced with stateful
|
|
context managers - i.e. `with` blocks - thus enabling the full python toolbox:
|
|
for loops, references to objects, object sorting and filtering, etc.
|
|
|
|
Note that this documentation is available in
|
|
`pdf <https://build123d.readthedocs.io/_/downloads/en/latest/pdf/>`_ and
|
|
`epub <https://build123d.readthedocs.io/_/downloads/en/latest/epub/>`_ formats
|
|
for reference while offline.
|
|
|
|
########
|
|
Overview
|
|
########
|
|
|
|
build123d uses the standard python context manager - i.e. the ``with`` statement often used when
|
|
working with files - as a builder of the object under construction. Once the object is complete
|
|
it can be extracted from the builders and used in other ways: for example exported as a STEP
|
|
file or used in an Assembly. There are three builders available:
|
|
|
|
* **BuildLine**: a builder of one dimensional objects - those with the property
|
|
of length but not of area or volume - typically used
|
|
to create complex lines used in sketches or paths.
|
|
* **BuildSketch**: a builder of planar two dimensional objects - those with the property
|
|
of area but not of volume - typically used to create 2D drawings that are extruded into 3D parts.
|
|
* **BuildPart**: a builder of three dimensional objects - those with the property of volume -
|
|
used to create individual parts.
|
|
|
|
The three builders work together in a hierarchy as follows:
|
|
|
|
.. code-block:: build123d
|
|
|
|
with BuildPart() as my_part:
|
|
...
|
|
with BuildSketch() as my_sketch:
|
|
...
|
|
with BuildLine() as my_line:
|
|
...
|
|
...
|
|
...
|
|
|
|
where ``my_line`` will be added to ``my_sketch`` once the line is complete and ``my_sketch`` will be
|
|
added to ``my_part`` once the sketch is complete.
|
|
|
|
As an example, consider the design of a tea cup:
|
|
|
|
.. literalinclude:: ../examples/tea_cup.py
|
|
:language: build123d
|
|
:start-after: [Code]
|
|
:end-before: [End]
|
|
|
|
.. raw:: html
|
|
|
|
<script type="module" src="https://unpkg.com/@google/model-viewer/dist/model-viewer.min.js"></script>
|
|
<model-viewer poster="_images/tea_cup.png" src="_static/tea_cup.glb" alt="A tea cup modelled in build123d" auto-rotate camera-controls style="width: 100%; height: 50vh;"></model-viewer>
|
|
|
|
.. note::
|
|
|
|
There is a `Discord <https://discord.com/invite/Bj9AQPsCfx>`_ server (shared with CadQuery) where
|
|
you can ask for help in the build123d channel.
|
|
|
|
#################
|
|
Table Of Contents
|
|
#################
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
introduction.rst
|
|
installation.rst
|
|
key_concepts.rst
|
|
key_concepts_builder.rst
|
|
key_concepts_algebra.rst
|
|
moving_objects.rst
|
|
OpenSCAD.rst
|
|
introductory_examples.rst
|
|
tutorials.rst
|
|
objects.rst
|
|
operations.rst
|
|
topology_selection.rst
|
|
builders.rst
|
|
joints.rst
|
|
assemblies.rst
|
|
tips.rst
|
|
import_export.rst
|
|
advanced.rst
|
|
cheat_sheet.rst
|
|
external.rst
|
|
builder_api_reference.rst
|
|
direct_api_reference.rst
|
|
|
|
==================
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|