mirror of
https://github.com/gumyr/build123d.git
synced 2025-12-06 02:30:55 -08:00
260 lines
20 KiB
ReStructuredText
260 lines
20 KiB
ReStructuredText
.. _cheat_sheet:
|
|
|
|
###########
|
|
Cheat Sheet
|
|
###########
|
|
|
|
.. card:: Stateful Contexts
|
|
|
|
| :class:`~build_line.BuildLine` :class:`~build_part.BuildPart` :class:`~build_sketch.BuildSketch`
|
|
| :class:`~build_common.GridLocations` :class:`~build_common.HexLocations` :class:`~build_common.Locations` :class:`~build_common.PolarLocations`
|
|
|
|
.. card:: Objects
|
|
|
|
.. grid:: 3
|
|
|
|
.. grid-item-card:: 1D - BuildLine
|
|
|
|
| :class:`~objects_curve.Bezier`
|
|
| :class:`~objects_curve.CenterArc`
|
|
| :class:`~objects_curve.EllipticalCenterArc`
|
|
| :class:`~objects_curve.FilletPolyline`
|
|
| :class:`~objects_curve.Helix`
|
|
| :class:`~objects_curve.IntersectingLine`
|
|
| :class:`~objects_curve.JernArc`
|
|
| :class:`~objects_curve.Line`
|
|
| :class:`~objects_curve.PolarLine`
|
|
| :class:`~objects_curve.Polyline`
|
|
| :class:`~objects_curve.RadiusArc`
|
|
| :class:`~objects_curve.SagittaArc`
|
|
| :class:`~objects_curve.Spline`
|
|
| :class:`~objects_curve.TangentArc`
|
|
| :class:`~objects_curve.ThreePointArc`
|
|
|
|
.. grid-item-card:: 2D - BuildSketch
|
|
|
|
| :class:`~drafting.Arrow`
|
|
| :class:`~drafting.ArrowHead`
|
|
| :class:`~objects_sketch.Circle`
|
|
| :class:`~drafting.DimensionLine`
|
|
| :class:`~objects_sketch.Ellipse`
|
|
| :class:`~drafting.ExtensionLine`
|
|
| :class:`~objects_sketch.Polygon`
|
|
| :class:`~objects_sketch.Rectangle`
|
|
| :class:`~objects_sketch.RectangleRounded`
|
|
| :class:`~objects_sketch.RegularPolygon`
|
|
| :class:`~objects_sketch.SlotArc`
|
|
| :class:`~objects_sketch.SlotCenterPoint`
|
|
| :class:`~objects_sketch.SlotCenterToCenter`
|
|
| :class:`~objects_sketch.SlotOverall`
|
|
| :class:`~objects_sketch.Text`
|
|
| :class:`~drafting.TechnicalDrawing`
|
|
| :class:`~objects_sketch.Trapezoid`
|
|
| :class:`~objects_sketch.Triangle`
|
|
|
|
.. grid-item-card:: 3D - BuildPart
|
|
|
|
| :class:`~objects_part.Box`
|
|
| :class:`~objects_part.Cone`
|
|
| :class:`~objects_part.CounterBoreHole`
|
|
| :class:`~objects_part.CounterSinkHole`
|
|
| :class:`~objects_part.Cylinder`
|
|
| :class:`~objects_part.Hole`
|
|
| :class:`~objects_part.Sphere`
|
|
| :class:`~objects_part.Torus`
|
|
| :class:`~objects_part.Wedge`
|
|
|
|
.. card:: Operations
|
|
|
|
.. grid:: 3
|
|
|
|
.. grid-item-card:: 1D - BuildLine
|
|
|
|
| :func:`~operations_generic.add`
|
|
| :func:`~operations_generic.bounding_box`
|
|
| :func:`~operations_generic.mirror`
|
|
| :func:`~operations_generic.offset`
|
|
| :func:`~operations_generic.scale`
|
|
| :func:`~operations_generic.split`
|
|
|
|
.. grid-item-card:: 2D - BuildSketch
|
|
|
|
| :func:`~operations_generic.add`
|
|
| :func:`~operations_generic.chamfer`
|
|
| :func:`~operations_generic.fillet`
|
|
| :func:`~operations_sketch.full_round`
|
|
| :func:`~operations_sketch.make_face`
|
|
| :func:`~operations_sketch.make_hull`
|
|
| :func:`~operations_generic.mirror`
|
|
| :func:`~operations_generic.offset`
|
|
| :func:`~operations_generic.scale`
|
|
| :func:`~operations_generic.split`
|
|
| :func:`~operations_generic.sweep`
|
|
| :func:`~operations_sketch.trace`
|
|
|
|
.. grid-item-card:: 3D - BuildPart
|
|
|
|
| :func:`~operations_generic.add`
|
|
| :func:`~operations_generic.chamfer`
|
|
| :func:`~operations_part.extrude`
|
|
| :func:`~operations_generic.fillet`
|
|
| :func:`~operations_part.loft`
|
|
| :func:`~operations_part.make_brake_formed`
|
|
| :func:`~operations_generic.mirror`
|
|
| :func:`~operations_generic.offset`
|
|
| :func:`~operations_part.revolve`
|
|
| :func:`~operations_generic.scale`
|
|
| :func:`~operations_part.section`
|
|
| :func:`~operations_generic.split`
|
|
| :func:`~operations_generic.sweep`
|
|
|
|
.. card:: Selectors
|
|
|
|
.. grid:: 3
|
|
|
|
.. grid-item-card:: 1D - BuildLine
|
|
|
|
| :meth:`~build_common.Builder.vertices`
|
|
| :meth:`~build_common.Builder.edges`
|
|
| :meth:`~build_common.Builder.wires`
|
|
|
|
.. grid-item-card:: 2D - BuildSketch
|
|
|
|
| :meth:`~build_common.Builder.vertices`
|
|
| :meth:`~build_common.Builder.edges`
|
|
| :meth:`~build_common.Builder.wires`
|
|
| :meth:`~build_common.Builder.faces`
|
|
|
|
.. grid-item-card:: 3D - BuildPart
|
|
|
|
| :meth:`~build_common.Builder.vertices`
|
|
| :meth:`~build_common.Builder.edges`
|
|
| :meth:`~build_common.Builder.wires`
|
|
| :meth:`~build_common.Builder.faces`
|
|
| :meth:`~build_common.Builder.solids`
|
|
|
|
.. card:: Selector Operators
|
|
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| Operator | Operand | Method |
|
|
+==========+===================================================================================+================================================+
|
|
| > | :class:`~build_enums.SortBy`, :class:`~geometry.Axis` | :meth:`~topology.ShapeList.sort_by` |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| < | :class:`~build_enums.SortBy`, :class:`~geometry.Axis` | :meth:`~topology.ShapeList.sort_by` |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| >> | :class:`~build_enums.SortBy`, :class:`~geometry.Axis` | :meth:`~topology.ShapeList.group_by`\[-1\] |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| << | :class:`~build_enums.SortBy`, :class:`~geometry.Axis` | :meth:`~topology.ShapeList.group_by`\[0\] |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| \| | :class:`~geometry.Axis`, :class:`~geometry.Plane`, :class:`~build_enums.GeomType` | :meth:`~topology.ShapeList.filter_by` |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| [] | | python indexing / slicing |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
| | :class:`~geometry.Axis` | :meth:`~topology.ShapeList.filter_by_position` |
|
|
+----------+-----------------------------------------------------------------------------------+------------------------------------------------+
|
|
|
|
.. card:: Edge and Wire Operators
|
|
|
|
+----------+---------------------+-----------------------------------------+---------------------------------+
|
|
| Operator | Operand | Method | Description |
|
|
+==========+=====================+=========================================+=================================+
|
|
| @ | 0.0 <= float <= 1.0 | :meth:`~topology.Mixin1D.position_at` | Position as Vector along object |
|
|
+----------+---------------------+-----------------------------------------+---------------------------------+
|
|
| % | 0.0 <= float <= 1.0 | :meth:`~topology.Mixin1D.tangent_at` | Tangent as Vector along object |
|
|
+----------+---------------------+-----------------------------------------+---------------------------------+
|
|
| ^ | 0.0 <= float <= 1.0 | :meth:`~topology.Mixin1D.location_at` | Location along object |
|
|
+----------+---------------------+-----------------------------------------+---------------------------------+
|
|
|
|
.. card:: Shape Operators
|
|
|
|
+----------+---------------------+-----------------------------------------+---------------------------------------------+
|
|
| Operator | Operand | Method | Description |
|
|
+==========+=====================+=========================================+=============================================+
|
|
| == | Any | :meth:`~topology.Shape.is_same` | Compare CAD objects not including meta data |
|
|
+----------+---------------------+-----------------------------------------+---------------------------------------------+
|
|
|
|
.. card:: Plane Operators
|
|
|
|
+----------+----------------------------+-----------------------------+
|
|
| Operator | Operand | Description |
|
|
+==========+============================+=============================+
|
|
| == | :class:`~geometry.Plane` | Check for equality |
|
|
+----------+----------------------------+-----------------------------+
|
|
| != | :class:`~geometry.Plane` | Check for inequality |
|
|
+----------+----------------------------+-----------------------------+
|
|
| \- | :class:`~geometry.Plane` | Reverse direction of normal |
|
|
+----------+----------------------------+-----------------------------+
|
|
| \* | :class:`~geometry.Plane` | Relocate by Location |
|
|
+----------+----------------------------+-----------------------------+
|
|
|
|
.. card:: Vector Operators
|
|
|
|
+----------+------------------------------+-------------------------------------+---------------------+
|
|
| Operator | Operand | Method | Description |
|
|
+==========+==============================+=====================================+=====================+
|
|
| \+ | :class:`~geometry.Vector` | :meth:`~geometry.Vector.add` | add |
|
|
+----------+------------------------------+-------------------------------------+---------------------+
|
|
| \- | :class:`~geometry.Vector` | :meth:`~geometry.Vector.sub` | subtract |
|
|
+----------+------------------------------+-------------------------------------+---------------------+
|
|
| \* | ``float`` | :meth:`~geometry.Vector.multiply` | multiply by scalar |
|
|
+----------+------------------------------+-------------------------------------+---------------------+
|
|
| \/ | ``float`` | :meth:`~geometry.Vector.multiply` | divide by scalar |
|
|
+----------+------------------------------+-------------------------------------+---------------------+
|
|
|
|
.. card:: Vertex Operators
|
|
|
|
+----------+-----------------------------+-------------------------------------+
|
|
| Operator | Operand | Method |
|
|
+==========+=============================+=====================================+
|
|
| \+ | :class:`~topology.Vertex` | :meth:`~topology.Vertex.add` |
|
|
+----------+-----------------------------+-------------------------------------+
|
|
| \- | :class:`~topology.Vertex` | :meth:`~topology.Vertex.sub` |
|
|
+----------+-----------------------------+-------------------------------------+
|
|
|
|
.. card:: Enums
|
|
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Align` | MIN, CENTER, MAX |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.ApproxOption` | ARC, NONE, SPLINE |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.AngularDirection` | CLOCKWISE, COUNTER_CLOCKWISE |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.CenterOf` | GEOMETRY, MASS, BOUNDING_BOX |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.FontStyle` | REGULAR, BOLD, ITALIC |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.FrameMethod` | CORRECTED, FRENET |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.GeomType` | BEZIER, BSPLINE, CIRCLE, CONE, CYLINDER, ELLIPSE, EXTRUSION, HYPERBOLA, LINE, OFFSET, OTHER, PARABOLA, PLANE, REVOLUTION, SPHERE, TORUS |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.HeadType` | CURVED, FILLETED, STRAIGHT |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Keep` | TOP, BOTTOM, BOTH |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Kind` | ARC, INTERSECTION, TANGENT |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.LengthMode` | DIAGONAL, HORIZONTAL, VERTICAL |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.MeshType` | OTHER, MODEL, SUPPORT, SOLIDSUPPORT |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Mode` | ADD, SUBTRACT, INTERSECT, REPLACE, PRIVATE |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.NumberDisplay` | DECIMAL, FRACTION |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.PageSize` | A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, LEDGER, LEGAL, LETTER |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.PositionMode` | LENGTH, PARAMETER |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Select` | ALL, LAST |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Side` | BOTH, LEFT, RIGHT |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.SortBy` | LENGTH, RADIUS, AREA, VOLUME, DISTANCE |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Transition` | RIGHT, ROUND, TRANSFORMED |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Unit` | MC, MM, CM, M, IN, FT |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|
|
| :class:`~build_enums.Until` | FIRST, LAST, NEXT, PREVIOUS |
|
|
+----------------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+
|