mirror of
https://github.com/gumyr/build123d.git
synced 2025-12-06 02:30:55 -08:00
163 lines
2.9 KiB
ReStructuredText
163 lines
2.9 KiB
ReStructuredText
.. _builder_api_reference:
|
|
|
|
#####################
|
|
Builder API Reference
|
|
#####################
|
|
|
|
****************
|
|
Selector Methods
|
|
****************
|
|
|
|
.. automethod:: build_common::Builder.vertices
|
|
.. automethod:: build_common::Builder.faces
|
|
.. automethod:: build_common::Builder.edges
|
|
.. automethod:: build_common::Builder.wires
|
|
.. automethod:: build_common::Builder.solids
|
|
|
|
*****
|
|
Enums
|
|
*****
|
|
|
|
.. py:module:: build_enums
|
|
|
|
.. autoclass:: Align
|
|
.. autoclass:: CenterOf
|
|
.. autoclass:: FontStyle
|
|
.. autoclass:: GeomType
|
|
.. autoclass:: Keep
|
|
.. autoclass:: Kind
|
|
.. autoclass:: Mode
|
|
.. autoclass:: Select
|
|
.. autoclass:: SortBy
|
|
.. autoclass:: Transition
|
|
.. autoclass:: Until
|
|
|
|
**********
|
|
Workplanes
|
|
**********
|
|
|
|
.. py:module:: build_common
|
|
|
|
.. autoclass:: Workplanes
|
|
|
|
*********
|
|
Locations
|
|
*********
|
|
|
|
.. autoclass:: build_common::Locations
|
|
.. autoclass:: build_common::GridLocations
|
|
.. autoclass:: build_common::HexLocations
|
|
.. autoclass:: build_common::PolarLocations
|
|
|
|
******************************
|
|
Generic Objects and Operations
|
|
******************************
|
|
|
|
There are several objects and operations that apply to more than one type
|
|
of builder which are listed here. The builder that these operations apply
|
|
to is determined by context.
|
|
|
|
.. py:module:: build_generic
|
|
|
|
=======
|
|
Objects
|
|
=======
|
|
.. autoclass:: Add
|
|
|
|
==========
|
|
Operations
|
|
==========
|
|
.. autoclass:: BoundingBox
|
|
.. autoclass:: Chamfer
|
|
.. autoclass:: Fillet
|
|
.. autoclass:: Mirror
|
|
.. autoclass:: Offset
|
|
.. autoclass:: Scale
|
|
.. autoclass:: Split
|
|
|
|
*********
|
|
BuildLine
|
|
*********
|
|
.. py:module:: build_line
|
|
|
|
.. autoclass:: BuildLine
|
|
:members:
|
|
|
|
=======
|
|
Objects
|
|
=======
|
|
.. autoclass:: Bezier
|
|
.. autoclass:: CenterArc
|
|
.. autoclass:: EllipticalCenterArc
|
|
.. autoclass:: Helix
|
|
.. autoclass:: JernArc
|
|
.. autoclass:: Line
|
|
.. autoclass:: PolarLine
|
|
.. autoclass:: Polyline
|
|
.. autoclass:: RadiusArc
|
|
.. autoclass:: SagittaArc
|
|
.. autoclass:: Spline
|
|
.. autoclass:: TangentArc
|
|
.. autoclass:: ThreePointArc
|
|
|
|
***********
|
|
BuildSketch
|
|
***********
|
|
|
|
.. py:module:: build_sketch
|
|
|
|
.. autoclass:: BuildSketch
|
|
:members:
|
|
|
|
=======
|
|
Objects
|
|
=======
|
|
.. autoclass:: Circle
|
|
.. autoclass:: Ellipse
|
|
.. autoclass:: Polygon
|
|
.. autoclass:: Rectangle
|
|
.. autoclass:: RectangleRounded
|
|
.. autoclass:: RegularPolygon
|
|
.. autoclass:: SlotArc
|
|
.. autoclass:: SlotCenterPoint
|
|
.. autoclass:: SlotCenterToCenter
|
|
.. autoclass:: SlotOverall
|
|
.. autoclass:: Text
|
|
.. autoclass:: Trapezoid
|
|
|
|
==========
|
|
Operations
|
|
==========
|
|
.. autoclass:: MakeFace
|
|
.. autoclass:: MakeHull
|
|
|
|
*********
|
|
BuildPart
|
|
*********
|
|
|
|
.. py:module:: build_part
|
|
|
|
.. autoclass:: BuildPart
|
|
:members:
|
|
|
|
=======
|
|
Objects
|
|
=======
|
|
.. autoclass:: Box
|
|
.. autoclass:: Cone
|
|
.. autoclass:: Cylinder
|
|
.. autoclass:: Sphere
|
|
.. autoclass:: Torus
|
|
.. autoclass:: Wedge
|
|
|
|
==========
|
|
Operations
|
|
==========
|
|
.. autoclass:: CounterBoreHole
|
|
.. autoclass:: CounterSinkHole
|
|
.. autoclass:: Extrude
|
|
.. autoclass:: Hole
|
|
.. autoclass:: Loft
|
|
.. autoclass:: Revolve
|
|
.. autoclass:: Section
|
|
.. autoclass:: Sweep
|