From a4ed7b1be2ab2d7c23acc2c20084ede9bfdb9b55 Mon Sep 17 00:00:00 2001 From: Roger Maitland Date: Thu, 6 Oct 2022 13:30:18 -0400 Subject: [PATCH] Adding missing cheat sheet --- docs/cheat_sheet.rst | 162 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 162 insertions(+) create mode 100644 docs/cheat_sheet.rst diff --git a/docs/cheat_sheet.rst b/docs/cheat_sheet.rst new file mode 100644 index 0000000..c3db01c --- /dev/null +++ b/docs/cheat_sheet.rst @@ -0,0 +1,162 @@ +.. _cheat_sheet: + +########### +Cheat Sheet +########### + +.. tabularcolumns:: |c| + ++---------------------------------------+ +| 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` | ++---------------------------------------+ +| :class:`~build_common.Workplanes` | ++---------------------------------------+ + ++-----------------------------------------------------------------------------------------------------------------------+ +| Objects | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| 1D - BuildLine | 2D - BuildSketch | 3D - BuildPart | ++=====================================+===========================================+=====================================+ +| :class:`~build_generic.Add` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.CenterArc` | :class:`~build_sketch.Circle` | :class:`~build_part.Box` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.Helix` | :class:`~build_sketch.Ellipse` | :class:`~build_part.Cone` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.Line` | :class:`~build_sketch.Polygon` | :class:`~build_part.Cylinder` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.PolarLine` | :class:`~build_sketch.Rectangle` | :class:`~build_part.Sphere` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.Polyline` | :class:`~build_sketch.RegularPolygon` | :class:`~build_part.Torus` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.RadiusArc` | :class:`~build_sketch.SlotArc` | :class:`~build_part.Wedge` | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.SagittaArc` | :class:`~build_sketch.SlotCenterPoint` | | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.Spline` | :class:`~build_sketch.SlotCenterToCenter` | | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.SagittaArc` | :class:`~build_sketch.SlotOverall` | | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.TangentArc` | :class:`~build_sketch.Text` | | ++-------------------------------------+-------------------------------------------+-------------------------------------+ +| :class:`~build_line.ThreePointArc` | :class:`~build_sketch.Trapezoid` | | ++-------------------------------------+-------------------------------------------+-------------------------------------+ + ++---------------------------------------------------------------------------------------------------+ +| Operations | ++----------------+-------------------------------------------+--------------------------------------+ +| 1D - BuildLine | 2D - BuildSketch | 3D - BuildPart | ++================+===========================================+======================================+ +| | :class:`~build_generic.BoundingBox` | ++----------------+-------------------------------------------+--------------------------------------+ +| | :class:`~build_sketch.BuildFace` | | ++----------------+-------------------------------------------+--------------------------------------+ +| | :class:`~build_sketch.BuildHull` | | ++----------------+-------------------------------------------+--------------------------------------+ +| | :class:`~build_generic.Chamfer` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.CounterBoreHole` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.CounterSinkHole` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.Extrude` | ++----------------+-------------------------------------------+--------------------------------------+ +| | :class:`~build_generic.Fillet` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.Hole` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.Loft` | ++----------------+-------------------------------------------+--------------------------------------+ +| :class:`~build_generic.Mirror` | ++----------------+-------------------------------------------+--------------------------------------+ +| :class:`~build_generic.Offset` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.Revolve` | ++----------------+-------------------------------------------+--------------------------------------+ +| :class:`~build_generic.Scale` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.Section` | ++----------------+-------------------------------------------+--------------------------------------+ +| :class:`~build_generic.Split` | ++----------------+-------------------------------------------+--------------------------------------+ +| | | :class:`~build_part.Sweep` | ++----------------+-------------------------------------------+--------------------------------------+ + ++------------------------------------------------------------------------------------------------+ +| Selectors | ++----------------+--------------------------------------+----------------------------------------+ +| 1D - BuildLine | 2D - BuildSketch | 3D - BuildPart | ++================+======================================+========================================+ +| :meth:`~build_common.Builder.vertices` | ++------------------------------------------------------------------------------------------------+ +| :meth:`~build_common.Builder.edges` | ++------------------------------------------------------------------------------------------------+ +| :meth:`~build_common.Builder.wires` | ++----------------+-------------------------------------------------------------------------------+ +| | :meth:`~build_common.Builder.faces` | ++----------------+--------------------------------------+----------------------------------------+ +| | :meth:`~build_part.BuildPart.solids` | ++-------------------------------------------------------+----------------------------------------+ + ++----------------------------------------------------------------------------------------------------------------------------+ +| Selectors | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| Operator | Operand | Method | ++==========+============================================================+====================================================+ +| > | :class:`~build_common.SortBy`, :class:`~build_common.Axis` | :meth:`~build_common.ShapeList.sort_by` | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| < | :class:`~build_common.SortBy`, :class:`~build_common.Axis` | :meth:`~build_common.ShapeList.sort_by` | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| >> | :class:`~build_common.SortBy`, :class:`~build_common.Axis` | :meth:`~build_common.ShapeList.sort_by`\[-1\] | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| << | :class:`~build_common.SortBy`, :class:`~build_common.Axis` | :meth:`~build_common.ShapeList.sort_by`\[0\] | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| % | :class:`~build_common.GeomType` | :meth:`~build_common.ShapeList.filter_by_type` | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| \| | :class:`~build_common.Axis` | :meth:`~build_common.ShapeList.filter_by_axis` | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| [] | | python indexing / slicing | ++----------+------------------------------------------------------------+----------------------------------------------------+ +| | :class:`~build_common.Axis` | :meth:`~build_common.ShapeList.filter_by_position` | ++----------+------------------------------------------------------------+----------------------------------------------------+ + ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| Enums | Values | ++===================================+=========================================================================================================================================+ +| :class:`~build_common.FontStyle` | REGULAR, BOLD, ITALIC | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.GeomType` | BEZIER, BSPLINE, CIRCLE, CONE, CYLINDER, ELLIPSE, EXTRUSION, HYPERBOLA, LINE, OFFSET, OTHER, PARABOLA, PLANE, REVOLUTION, SPHERE, TORUS | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Halign` | CENTER, LEFT, RIGHT | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Keep` | TOP, BOTTOM, BOTH | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Kind` | ARC, INTERSECTION, TANGENT | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Mode` | ADD, SUBTRACT, INTERSECT, REPLACE, PRIVATE | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Select` | ALL, LAST | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.SortBy` | LENGTH, RADIUS, AREA, VOLUME, DISTANCE | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Transition` | RIGHT, ROUND, TRANSFORMED | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Until` | NEXT, LAST | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +| :class:`~build_common.Valign` | CENTER, TOP, BOTTOM | ++-----------------------------------+-----------------------------------------------------------------------------------------------------------------------------------------+ +