From edfa008a9ea8f1d1c2a9218f8ef5cdbec2b79bd8 Mon Sep 17 00:00:00 2001
From: Roger Maitland <gumyr9@gmail.com>
Date: Thu, 29 Sep 2022 08:58:44 -0400
Subject: [PATCH] More selector docs

---
 docs/selectors.rst | 92 ++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 92 insertions(+)
 create mode 100644 docs/selectors.rst

diff --git a/docs/selectors.rst b/docs/selectors.rst
new file mode 100644
index 0000000..349455a
--- /dev/null
+++ b/docs/selectors.rst
@@ -0,0 +1,92 @@
+#########
+Selectors
+#########
+
+When using a GUI based CAD system the user will often click on a feature to select
+it for some operation. How does a user "click" when CAD is done entirely in code?
+Selectors are recipes for how to isolate a feature from a design using python
+filter and sorting methods typically implemented as a set of custom python
+operations.
+
+***************
+Quick Reference
+***************
+
+The following tables describes the build123d selectors:
+
++-------------+-----------------------------------+-------------------+-------------------+
+| Selector    | Applicability                     | Description       | Example           |
++=============+===================================+===================+===================+
+| vertices()  | BuildLine, BuildSketch, BuildPart | Vertex extraction | `part.vertices()` |
++-------------+-----------------------------------+-------------------+-------------------+
+| edges()     | BuildLine, BuildSketch, BuildPart | Edge extraction   | `part.edges()`    |
++-------------+-----------------------------------+-------------------+-------------------+
+| wires()     | BuildLine, BuildSketch, BuildPart | Wire extraction   | `part.wires()`    |
++-------------+-----------------------------------+-------------------+-------------------+
+| faces()     | BuildSketch, BuildPart            | Face extraction   | `part.faces()`    |
++-------------+-----------------------------------+-------------------+-------------------+
+| solids()    | BuildPart                         | Solid extraction  | `part.solids()`   |
++-------------+-----------------------------------+-------------------+-------------------+
+
++----------+--------------+--------------------------------------------------+----------------------------------+
+| Operator | Operand      | Description                                      | Example                          |
++==========+==============+==================================================+==================================+
+| >        | SortBy, Axis | Sort ShapeList by operand                        | `part.vertices() > Axis.Z`       |
++----------+--------------+--------------------------------------------------+----------------------------------+
+| <        | SortBy, Axis | Reverse sort ShapeList by operand                | `part.faces() < Axis.Z`          |
++----------+--------------+--------------------------------------------------+----------------------------------+
+| >>       | SortBy, Axis | Sort ShapeList by operand and return last value  | `part.solids() >> Axis.X`        |
++----------+--------------+--------------------------------------------------+----------------------------------+
+| <<       | SortBy, Axis | Sort ShapeList by operand and return first value | `part.faces() << Axis.Y`         |
++----------+--------------+--------------------------------------------------+----------------------------------+
+| %        | GeomType     | Filter ShapeList by GeomType                     | `part.edges() % GeomType.CIRCLE` |
++----------+--------------+--------------------------------------------------+----------------------------------+
+| \|       | Axis         | Filter and sort ShapeList by Axis                | `part.faces() \| Axis.Z`         |
++----------+--------------+--------------------------------------------------+----------------------------------+
+| []       |              | Standard python list indexing and slicing        | `part.faces()[-2:]`              |
++----------+--------------+--------------------------------------------------+----------------------------------+
+
+The operand types are described below:
+
+.. py:module:: build_common
+    :noindex:
+
+.. autoclass:: build_common.Axis
+    :members:
+
+.. autoclass:: build_common.SortBy
+    :members:
+
+.. autoclass:: build_common.GeomType
+    :members:
+
+
+***************
+ShapeList Class
+***************
+
+The builders include methods to extract Edges, Faces, Solids, Vertices, or Wires from the objects
+they are building. All of these methods return objects of a subclass of `list`, a `ShapeList` with
+custom filtering and sorting methods and operations as follows.
+
+.. autoclass:: build_common.ShapeList
+    :members:
+    :exclude-members: axis_map
+
+****************************
+Custom Sorting and Filtering
+****************************
+
+It is important to note that standard list methods such as `sorted` or `filtered` can
+be used to easily build complex selectors beyond what is available with the predefined
+sorts and filters. Here is an example of a custom filters:
+
+.. code-block:: python
+
+    with BuildSketch() as din:
+        ...
+        outside_vertices = filter(
+            lambda v: (v.Y == 0.0 or v.Y == height)
+            and -overall_width / 2 < v.X < overall_width / 2,
+            din.vertices(),
+        )