From 2f770ad73f573d30a1ec0dbc4356a3c9ed7e2bbd Mon Sep 17 00:00:00 2001 From: Jeremy Wright Date: Sun, 13 Jul 2014 21:55:29 -0400 Subject: [PATCH] First commit of the cheatsheet. It only has a few items in it currently, but will grow as time goes on. --- doc/cheatsheet/cadquery_cheatsheet.html | 151 ++++++++++++++++++++++++ 1 file changed, 151 insertions(+) create mode 100644 doc/cheatsheet/cadquery_cheatsheet.html diff --git a/doc/cheatsheet/cadquery_cheatsheet.html b/doc/cheatsheet/cadquery_cheatsheet.html new file mode 100644 index 0000000..358b0b7 --- /dev/null +++ b/doc/cheatsheet/cadquery_cheatsheet.html @@ -0,0 +1,151 @@ + + + + CadQuery Cheatsheet + + + + + +
+
+

Documentation

+ +
+
+

Named Planes


+ Available named planes are as follows.
+ Direction references refer to the global
+ directions. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NamexDiryDirzDir
XY+x+y+z
YZ+y+z+x
XZ+x+z-y
front+x+y+z
back-x+y-z
left+z+y-x
right-z+y+x
top+x-z+y
bottom+x+z-y
+
+
+
+
+

Selector String Modifiers


+ Selectors are a complex topic: see CadQuery String Selectors for more information.
+ Axis Strings are: X, Y, Z, XY, YZ, XZ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ModifierDescription
|Parallel to (same as ParallelDirSelector). Can return multiple objects.
#Perpendicular to (same as PerpendicularDirSelector)
+Positive direction (same as DirectionSelector)
-Negative direction (same as DirectionSelector)
>Maximize (same as DirectionMinMaxSelector with directionMax=True)
<Minimize (same as DirectionMinMaxSelector with directionMax=False)
%Curve/surface type (same as TypeSelector)
+
+
+ +