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

Resolve #1019 and other spelling

Browse source
This commit is contained in:
Jonathan Wagenet 2025-06-30 23:11:39 -04:00
parent 742a3dccb3
commit 82d0af35e7
2 changed files with 22 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/examples_1.rst
View file

@ -549,7 +549,7 @@ Stud Wall
.. image:: assets/examples/stud_wall.png .. image:: assets/examples/stud_wall.png
:align: center :align: center
This example demonstrates creatings custom `Part` objects and putting them into This example demonstrates creating custom `Part` objects and putting them into
assemblies. The custom object is a `Stud` used in the building industry while assemblies. The custom object is a `Stud` used in the building industry while
the assembly is a `StudWall` created from copies of `Stud` objects for efficiency. the assembly is a `StudWall` created from copies of `Stud` objects for efficiency.
Both the `Stud` and `StudWall` objects use `RigidJoints` to define snap points which Both the `Stud` and `StudWall` objects use `RigidJoints` to define snap points which
@ -603,7 +603,7 @@ Toy Truck
--------- ---------
.. image:: assets/examples/toy_truck.png .. image:: assets/examples/toy_truck.png
:align: center :align: center
.. image:: assets/examples/toy_truck_picture.jpg .. image:: assets/examples/toy_truck_picture.jpg
:align: center :align: center
@ -613,11 +613,11 @@ Toy Truck
:start-after: [Code] :start-after: [Code]
:end-before: [End] :end-before: [End]
This example demonstrates how to design a toy truck using BuildPart and This example demonstrates how to design a toy truck using BuildPart and
BuildSketch in Builder mode. The model includes a detailed body, cab, grill, BuildSketch in Builder mode. The model includes a detailed body, cab, grill,
and bumper, showcasing techniques like sketch reuse, symmetry, tapered and bumper, showcasing techniques like sketch reuse, symmetry, tapered
extrusions, selective filleting, and the use of joints for part assembly. extrusions, selective filleting, and the use of joints for part assembly.
Ideal for learning complex part construction and hierarchical modeling in Ideal for learning complex part construction and hierarchical modeling in
build123d. build123d.
.. _vase: .. _vase:

30
docs/joints.rst
View file

@ -25,7 +25,7 @@ in pairs - a :class:`~topology.Joint` can only be connected to another :class:`~
Objects may have many joints bound to them each with an identifying label. All :class:`~topology.Joint` Objects may have many joints bound to them each with an identifying label. All :class:`~topology.Joint`
objects have a ``symbol`` property that can be displayed to help visualize objects have a ``symbol`` property that can be displayed to help visualize
their position and orientation (the `ocp-vscode <https://github.com/bernhard-42/vscode-ocp-cad-viewer>`_ viewer their position and orientation (the `ocp-vscode <https://github.com/bernhard-42/vscode-ocp-cad-viewer>`_ viewer
has built-in support for displaying joints). has built-in support for displaying joints).
.. note:: .. note::
@ -41,16 +41,16 @@ The following sections provide more detail on the available joints and describes
Rigid Joint Rigid Joint
*********** ***********
A rigid joint positions two components relative to each another with no freedom of movement. When a A rigid joint positions two components relative to each another with no freedom of movement. When a
:class:`~joints.RigidJoint` is instantiated it's assigned a ``label``, a part to bind to (``to_part``), :class:`~joints.RigidJoint` is instantiated it's assigned a ``label``, a part to bind to (``to_part``),
and a ``joint_location`` which defines both the position and orientation of the joint (see and a ``joint_location`` which defines both the position and orientation of the joint (see
:class:`~geometry.Location`) - as follows: :class:`~geometry.Location`) - as follows:
.. code-block:: python .. code-block:: python
RigidJoint(label="outlet", to_part=pipe, joint_location=path.location_at(1)) RigidJoint(label="outlet", to_part=pipe, joint_location=path.location_at(1))
Once a joint is bound to a part this way, the :meth:`~topology.Joint.connect_to` method can be used to Once a joint is bound to a part this way, the :meth:`~topology.Joint.connect_to` method can be used to
repositioning another part relative to ``self`` which stay fixed - as follows: repositioning another part relative to ``self`` which stay fixed - as follows:
.. code-block:: python .. code-block:: python
@ -74,7 +74,7 @@ flanges are attached to the ends of a curved pipe:
Note how the locations of the joints are determined by the :meth:`~topology.Mixin1D.location_at` method Note how the locations of the joints are determined by the :meth:`~topology.Mixin1D.location_at` method
and how the ``-`` negate operator is used to reverse the direction of the location without changing its and how the ``-`` negate operator is used to reverse the direction of the location without changing its
poosition. Also note that the ``WeldNeckFlange`` class predefines two joints, one at the pipe end and position. Also note that the ``WeldNeckFlange`` class predefines two joints, one at the pipe end and
one at the face end - both of which are shown in the above image (generated by ocp-vscode with the one at the face end - both of which are shown in the above image (generated by ocp-vscode with the
``render_joints=True`` flag set in the ``show`` function). ``render_joints=True`` flag set in the ``show`` function).
@ -105,7 +105,7 @@ Revolute Joint
Component rotates around axis like a hinge. The :ref:`joint_tutorial` covers Revolute Joints in detail. Component rotates around axis like a hinge. The :ref:`joint_tutorial` covers Revolute Joints in detail.
During instantiation of a :class:`~joints.RevoluteJoint` there are three parameters not present with During instantiation of a :class:`~joints.RevoluteJoint` there are three parameters not present with
Rigid Joints: ``axis``, ``angle_reference``, and ``range`` that allow the circular motion to be fully Rigid Joints: ``axis``, ``angle_reference``, and ``range`` that allow the circular motion to be fully
defined. defined.
@ -114,7 +114,7 @@ which allows one to change the relative position of joined parts by changing a s
.. autoclass:: RevoluteJoint .. autoclass:: RevoluteJoint
.. ..
:exclude-members: connect_to :exclude-members: connect_to
.. method:: connect_to(other: RigidJoint, *, angle: float = None) .. method:: connect_to(other: RigidJoint, *, angle: float = None)
@ -151,7 +151,7 @@ of the limits will raise an exception.
.. autoclass:: LinearJoint .. autoclass:: LinearJoint
.. ..
:exclude-members: connect_to :exclude-members: connect_to
.. method:: connect_to(other: RevoluteJoint, *, position: float = None, angle: float = None) .. method:: connect_to(other: RevoluteJoint, *, position: float = None, angle: float = None)
@ -164,10 +164,10 @@ of the limits will raise an exception.
Cylindrical Joint Cylindrical Joint
***************** *****************
A :class:`~joints.CylindricalJoint` allows a component to rotate around and moves along a single axis A :class:`~joints.CylindricalJoint` allows a component to rotate around and moves along a single axis
like a screw combining the functionality of a :class:`~joints.LinearJoint` and a like a screw combining the functionality of a :class:`~joints.LinearJoint` and a
:class:`~joints.RevoluteJoint` joint. The ``connect_to`` for these joints have both ``position`` and :class:`~joints.RevoluteJoint` joint. The ``connect_to`` for these joints have both ``position`` and
``angle`` parameters as shown below extracted from the joint tutorial. ``angle`` parameters as shown below extracted from the joint tutorial.
.. code-block::python .. code-block::python
@ -176,7 +176,7 @@ like a screw combining the functionality of a :class:`~joints.LinearJoint` and a
.. autoclass:: CylindricalJoint .. autoclass:: CylindricalJoint
.. ..
:exclude-members: connect_to :exclude-members: connect_to
.. method:: connect_to(other: RigidJoint, *, position: float = None, angle: float = None) .. method:: connect_to(other: RigidJoint, *, position: float = None, angle: float = None)
@ -195,13 +195,13 @@ is found within a rod end as shown here:
.. literalinclude:: rod_end.py .. literalinclude:: rod_end.py
:emphasize-lines: 40-44,51,53 :emphasize-lines: 40-44,51,53
Note how limits are defined during the instantiation of the ball joint when ensures that the pin or bolt Note how limits are defined during the instantiation of the ball joint when ensures that the pin or bolt
within the rod end does not interfere with the rod end itself. The ``connect_to`` sets the three angles within the rod end does not interfere with the rod end itself. The ``connect_to`` sets the three angles
(only two are significant in this example). (only two are significant in this example).
.. autoclass:: BallJoint .. autoclass:: BallJoint
.. ..
:exclude-members: connect_to :exclude-members: connect_to
.. method:: connect_to(other: RigidJoint, *, angles: RotationLike = None) .. method:: connect_to(other: RigidJoint, *, angles: RotationLike = None)