Documentation

BREP Terminology


vertex A single point in space
edge A connection between two or more vertices along a particular path (called a curve)
wire A collection of edges that are connected together
face A set of edges or wires that enclose a surface
shell A collection of faces that are connected together along some of their edges
solid A shell that has a closed interior
compound A collection of solids

Named Planes


Available named planes are as follows.
Direction references refer to the global
directions.
Name xDir yDir zDir
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
Modifier Description
| 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)