2014-07-13 21:55:29 -04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2022-07-27 22:58:50 -04:00
< html lang = "en" >
2014-07-13 21:55:29 -04:00
< head >
< title > CadQuery Cheatsheet< / title >
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
2022-07-27 22:41:05 -04:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
2014-07-13 21:55:29 -04:00
< style type = "text/css" >
2022-07-27 22:58:50 -04:00
body {
2022-07-28 23:46:49 -04:00
width: 100vw;
2022-07-27 22:58:50 -04:00
margin: 0;
text-align: center;
}
#header {
background-color: #ddd; padding: 2px;
margin-bottom: 10px;
}
#section-container {
display: flex; flex-wrap: wrap; align-items: flex-start; justify-content: space-around; row-gap: 10px;
2022-07-28 23:59:22 -04:00
overflow: scroll;
2022-07-28 23:46:49 -04:00
width: 100%
2022-07-27 22:58:50 -04:00
}
2014-07-13 21:55:29 -04:00
.section {
margin: 0.5em;
padding: 0px 0.5em 0.5em;
background-color: #EBEBEB;
2022-07-28 23:46:49 -04:00
min-width: 340px;
2022-07-27 22:41:05 -04:00
max-width: min(50vw, 100%);
2022-07-28 23:59:22 -04:00
overflow-x: scroll;
2022-07-27 22:05:43 -04:00
}
2022-07-27 22:41:05 -04:00
.section-subtitle {
margin-bottom: 4px;
2022-07-27 22:05:43 -04:00
}
2022-07-27 22:58:50 -04:00
a, a:visited {
2022-07-27 22:05:43 -04:00
color: #1f4b8f;
font-weight: bold;
text-decoration: none;
2014-07-13 21:55:29 -04:00
}
2022-07-27 22:58:50 -04:00
table {
width: 100%;
2014-07-13 21:55:29 -04:00
}
tr {
background-color: #FFFFFF;
}
td {
text-align: center;
width: 5em;
2022-07-28 21:01:10 -04:00
padding: 3px 4px;
2014-07-13 21:55:29 -04:00
}
2022-07-27 22:58:50 -04:00
h1 {
margin: 10px;
}
2014-07-13 21:55:29 -04:00
h2 {
display: inline;
}
2022-07-28 23:59:22 -04:00
@media only screen and (max-width: 1000px) {
2022-07-28 23:46:49 -04:00
body{
2022-07-28 23:59:22 -04:00
font-size: 75%
}
.section {
max-width: 96%;
2022-07-28 23:46:49 -04:00
}
}
2014-07-13 21:55:29 -04:00
< / style >
< / head >
2022-07-27 22:58:50 -04:00
< body >
< div id = "header" >
< h1 > < img src = "https://cadquery.readthedocs.io/en/latest/_static/cadquery_logo_dark.svg" alt = "CadQuery Logo" height = 30 > Cheatsheet< / h1 >
< i >
A Quick Guide To The Most Commonly Used Functions!
< br / >
< sub >
For the full API reference < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/apireference.html" > click here< / a > .
For examples < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/examples.html" > click here< / a > .
< / sub >
< / i >
2022-07-27 22:05:43 -04:00
< / div >
2022-07-27 22:58:50 -04:00
< div id = "section-container" >
2014-07-18 23:15:43 -04:00
< div class = "section" >
2022-07-27 22:05:43 -04:00
< h2 > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/apireference.html#id1" > 3D Construction< / a > < / h2 >
2022-07-27 22:58:50 -04:00
< table >
2022-07-27 22:05:43 -04:00
< thead >
2022-07-27 22:58:50 -04:00
< tr >
< th > Primitives< / th >
< th > Additive< / th >
< th > Subtractive< / th >
< / tr >
2022-07-27 22:05:43 -04:00
< / thead >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.box" > Workplane.box< / a > < br > (length, width, height)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.extrude" > Workplane.extrude< / a > < br > (until)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.cut" > Workplane.cut< / a > < br > (toCut)< / td >
< / tr >
< tr >
2022-07-27 22:58:50 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.sphere" > Workplane.sphere< / a > < br > (radius)< / td >
2022-07-27 22:05:43 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.sweep" > Workplane.sweep< / a > < br > (path)< / td >
2022-07-28 22:44:54 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.cutThruAll" > Workplane.cutThruAll< / a > < br > ()< / td >
2022-07-27 22:05:43 -04:00
< / tr >
< tr >
2022-07-28 22:57:57 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.cylinder" > Workplane.cylinder< / a > < br > (height, radius)< / td >
2022-07-27 22:05:43 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.loft" > Workplane.loft< / a > < br > (ruled, combine, clean)< / td >
2022-07-28 22:44:54 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.cutBlind" > Workplane.cutBlind< / a > < br > (until)< / td >
2022-07-27 22:05:43 -04:00
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.text" > Workplane.text< / a > < br > (txt, fontsize, distance)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.revolve" > Workplane.revolve< / a > < br > (angleDegrees)< / td >
2022-07-28 22:44:54 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.hole" > Workplane.hole< / a > < br > (diameter, depth)< / td >
2022-07-27 22:05:43 -04:00
< / tr >
2022-07-28 21:01:10 -04:00
< tr >
< td > < / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.union" > Workplane.union< / a > < br > (angleDegrees)< / td >
2022-07-28 22:44:54 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.intersect" > Workplane.intersect< / a > < br > (toIntersect)< / td >
2022-07-28 21:01:10 -04:00
< / tr >
< / table >
2022-07-27 22:05:43 -04:00
< / div >
< div class = "section" >
< h2 > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/apireference.html#d-operations" > 2D Construction< / a > < / h2 >
2022-07-27 22:58:50 -04:00
< table >
2022-07-27 22:05:43 -04:00
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.rect" > Workplane.rect< / a > < br > (xLen, yLen)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.circle" > Workplane.circle< / a > < br > (radius)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.ellipse" > Workplane.ellipse< / a > < br > (x_radius, y_radius)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.center" > Workplane.center< / a > < br > (x, y)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.moveTo" > Workplane.moveTo< / a > < br > (x, y)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.move" > Workplane.move< / a > < br > (xDist, yDist)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.lineTo" > Workplane.lineTo< / a > < br > (x, y)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.line" > Workplane.line< / a > < br > (xDist, yDist)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.polarLine" > Workplane.polarLine< / a > < br > (distance, angle)< / td >
< / tr >
< tr >
2022-07-27 22:58:50 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.vLine" > Workplane.vLine< / a > < br > (distance)< / td >
2022-07-27 22:05:43 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.hLine" > Workplane.hLine< / a > < br > (distance)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.polyline" > Workplane.polyline< / a > < br > (listOfXYTuple)< / td >
< / tr >
< / table >
< h2 > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/apireference.html#sketch-initialization" > Sketching< / a > < / h2 >
2022-07-27 22:58:50 -04:00
< table >
2022-07-27 22:05:43 -04:00
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.rect" > Sketch.rect< / a > < br > (w, h)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.circle" > Sketch.circle< / a > < br > (r)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.ellipse" > Sketch.ellipse< / a > < br > (a1, a2)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.trapezoid" > Sketch.trapezoid< / a > < br > (w, h, a1)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.regularPolygon" > Sketch.regularPolygon< / a > < br > (r, n)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.polygon" > Sketch.polygon< / a > < br > (pts)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.fillet" > Sketch.fillet< / a > < br > (d)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.chamfer" > Sketch.chamfer< / a > < br > (d)< / td >
2022-07-28 23:39:37 -04:00
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.finalize" > Sketch.finalize< / a > < br > ()< / td >
2022-07-27 22:05:43 -04:00
< / tr >
< / table >
< / div >
2022-07-28 21:00:54 -04:00
< div style = "display: flex; flex-direction: column;" >
< div class = "section" >
< h2 > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/apireference.html#file-management-and-export" > Import/Export< / a > < / h2 >
< table >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/importexport.html#cadquery.importers.importDXF" > importers.importDXF< / a > < br > (path, tol)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/importexport.html#importing-step" > importers.importStep< / a > < br > ("path")< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/importexport.html#exporting-stl" > exporters.export< / a > < br > (solid, "path/solid.***")< / td >
< td > Where *** can be: svg, step, stl, amf, vrml, json< / td >
< / tr >
< / table >
< / div >
< div class = "section" >
< h2 > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/apireference.html#assemblies" > Assemblies< / a > < / h2 >
< table >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Assembly" > Assembly(< / a > < br > (obj)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Assembly.add" > Assembly.add< / a > < br > (obj)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/assy.html#constraints" > Assembly.constrain< / a > < br > (***)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Assembly.solve" > Assembly.solve< / a > < br > ()< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Assembly.save" > Assembly.save< / a > < br > ("path/assembly.***")< / td >
< td > Where *** can be: step, xml, gltf, vtkjs, vrml< / td >
< / tr >
< / table >
< / div >
< / div >
2022-07-27 22:05:43 -04:00
< div class = "section" style = "min-width: 300px;" hidden >
2014-07-18 23:15:43 -04:00
< h2 > BREP Terminology< / h2 > < br / >
2022-07-27 22:58:50 -04:00
< table >
2014-07-18 23:15:43 -04:00
< tr >
2014-07-23 00:33:34 -04:00
< td style = "width:10%;" > < strong > vertex< / strong > < / td >
< td style = "width:90%;" > A single point in space< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < strong > edge< / strong > < / td >
< td > A connection between two or more vertices along a particular path (called a curve)< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < strong > wire< / strong > < / td >
< td > A collection of edges that are connected together< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < strong > face< / strong > < / td >
< td > A set of edges or wires that enclose a surface< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < strong > shell< / strong > < / td >
< td > A collection of faces that are connected together along some of their edges< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < strong > solid< / strong > < / td >
< td > A shell that has a closed interior< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < strong > compound< / strong > < / td >
< td > A collection of solids< / td >
2014-07-18 23:15:43 -04:00
< / tr >
< / table >
< / div >
2022-07-27 22:41:05 -04:00
< div class = "section" >
2022-07-28 21:01:10 -04:00
< h2 > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/selectors.html" > Selector String Modifiers< / a > < / h2 >
< h2 > < / h2 > < br / >
< div class = "section-subtitle" > Axis Strings are: X, Y, Z, XY, YZ, XZ< / div >
2022-07-27 22:58:50 -04:00
< table >
2022-07-27 22:41:05 -04:00
< tr >
< th style = "width:10%;" > Modifier< / th >
< th style = "width:90%;" > Description< / th >
< / tr >
< tr >
< td > | < / td >
< td > Parallel to = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.ParallelDirSelector" > ParallelDirSelector< / a > < / td >
< / tr >
< tr >
< td > # < / td >
< td > Perpendicular to = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.PerpendicularDirSelector" > PerpendicularDirSelector< / a > < / td >
< / tr >
< tr >
< td > + < / td >
< td > Positive direction = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.DirectionSelector" > DirectionSelector< / a > < / td >
< / tr >
< tr >
< td > - < / td >
< td > Negative direction = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.DirectionSelector" > DirectionSelector< / a > < / td >
< / tr >
< tr >
< td > > < / td >
< td > Max = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.DirectionMinMaxSelector" > DirectionMinMaxSelector< / a > (directionMax=True)< / td >
< / tr >
< tr >
< td > < < / td >
< td > Min = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.DirectionMinMaxSelector" > DirectionMinMaxSelector< / a > (directionMax=False)< / td >
< / tr >
< tr >
< td > % < / td >
< td > Curve/surface type = < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.TypeSelector" > TypeSelector< / a > < / td >
< / tr >
< / table >
< / div >
< div class = "section" >
< h2 > Selector Methods< / h2 > < br / >
< div class = "section-subtitle" > CadQuery selector strings and classes allow filtering to select objects.< / div >
2022-07-27 22:58:50 -04:00
< table >
2022-07-27 22:41:05 -04:00
< tr >
< th style = "width:40%;" > Selector Methods< / th >
< th style = "width:60%;" > Selector Classes
< / th >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.faces" > CQ.faces< / a > (selector)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.selectors.NearestToPointSelector" > NearestToPointSelector< / a > (pnt)< / td >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.edges" > CQ.edges< / a > (selector)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.selectors.ParallelDirSelector" > ParallelDirSelector< / a > (vector)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.vertices" > CQ.vertices< / a > (selector)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.selectors.DirectionSelector" > DirectionSelector< / a > (vector)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.solids" > CQ.solids< / a > (selector)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.selectors.DirectionMinMaxSelector" > DirectionMinMaxSelector< / a > (vector)< / td >
< / tr >
< tr >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.shells" > CQ.shells< / a > (selector)< / td >
< td > < a target = "_blank" href = "https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.selectors.TypeSelector" > TypeSelector< / a > (typeString)< / td >
< / tr >
< / table >
< / div >
2014-07-13 21:55:29 -04:00
< div class = "section" >
< h2 > Named Planes< / h2 > < br / >
2022-07-27 22:41:05 -04:00
< div class = "section-subtitle" > Direction references refer to the global directions.< / div >
2022-07-27 22:58:50 -04:00
< table >
2014-07-13 21:55:29 -04:00
< tr >
2014-07-23 00:33:34 -04:00
< th style = "width:25%;" > Name< / th >
< th style = "width:25%;" > xDir< / th >
< th style = "width:25%;" > yDir< / th >
< th style = "width:25%;" > zDir< / th >
2014-07-13 21:55:29 -04:00
< / tr >
< tr >
< td > XY< / td >
< td > +x< / td >
< td > +y< / td >
< td > +z< / td >
< / tr >
< tr >
< td > YZ< / td >
< td > +y< / td >
< td > +z< / td >
< td > +x< / td >
< / tr >
< tr >
< td > XZ< / td >
< td > +x< / td >
< td > +z< / td >
< td > -y< / td >
< / tr >
< tr >
< td > front< / td >
< td > +x< / td >
< td > +y< / td >
< td > +z< / td >
< / tr >
< tr >
< td > back< / td >
< td > -x< / td >
< td > +y< / td >
< td > -z< / td >
< / tr >
< tr >
< td > left< / td >
< td > +z< / td >
< td > +y< / td >
< td > -x< / td >
< / tr >
< tr >
< td > right< / td >
< td > -z< / td >
< td > +y< / td >
< td > +x< / td >
< / tr >
< tr >
< td > top< / td >
< td > +x< / td >
< td > -z< / td >
< td > +y< / td >
< / tr >
< tr >
< td > bottom< / td >
< td > +x< / td >
< td > +z< / td >
< td > -y< / td >
< / tr >
< / table >
< / div >
2022-07-27 22:41:05 -04:00
2022-07-27 22:05:43 -04:00
< div class = "section" hidden >
2014-07-28 08:04:06 -04:00
< h2 > Core Classes< / h2 > < br / >
2022-07-27 22:58:50 -04:00
< table >
2014-07-28 08:04:06 -04:00
< tr >
< th style = "width:40%;" > Class< / th >
< th style = "width:60%;" > Description< / th >
< / tr >
< tr >
< td > CQ(obj)< / td >
< td > Provides enhanced functionality for a wrapped CAD primitive.< / td >
< / tr >
< tr >
< td > Plane(origin, xDir, normal)< / td >
< td > A 2d coordinate system in space, with the x-y axes on the a plane, and a particular point as the origin.< / td >
< / tr >
< tr >
< td > Workplane(inPlane[origin, obj])< / td >
2021-08-20 15:44:42 +03:00
< td > Defines a coordinate system in space, in which 2D coordinates can be used.< / td >
2014-07-28 08:04:06 -04:00
< / tr >
< / table >
< / div >
2022-07-27 22:41:05 -04:00
< div class = "section" style = "max-width: 600px" >
2014-07-23 00:33:34 -04:00
< h2 > Examples of Filtering Faces< / h2 > < br / >
2022-07-27 22:41:05 -04:00
< div class = "section-subtitle" >
All types of filters work on faces. In most cases, the selector refers to the direction of the normal vector of the face.
If a face is not planar, selectors are evaluated at the center of mass of the face. This can lead to results that are quite unexpected.
< / div >
2022-07-27 22:58:50 -04:00
< table >
2014-07-23 00:33:34 -04:00
< tr >
< th style = "width:10%;" > Selector< / th >
< th style = "width:40%;" > Selector Class< / th >
< th style = "width:40%;" > Selects< / th >
< th style = "width:10%;" > # Objects Returned< / th >
< / tr >
< tr >
< td > + Z< / td >
< td > DirectionSelector< / td >
< td > Faces with normal in +z direction< / td >
< td > 0 or 1< / td >
< / tr >
< tr >
< td > | Z< / td >
< td > ParallelDirSelector< / td >
< td > Faces parallel to xy plane< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > - X< / td >
< td > DirectionSelector< / td >
< td > Faces with normal in neg x direction< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > # Z< / td >
< td > PerpendicularDirSelector< / td >
< td > Faces perpendicular to z direction< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > % Plane< / td >
< td > TypeSelector< / td >
< td > Faces of type plane< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > > Y< / td >
< td > DirectionMinMaxSelector< / td >
< td > Face farthest in the positive y dir< / td >
< td > 0 or 1< / td >
< / tr >
< tr >
< td > < Y< / td >
< td > DirectionMinMaxSelector< / td >
< td > Face farthest in the negative y dir< / td >
< td > 0 or 1< / td >
< / tr >
< / table >
< / div >
2022-07-27 22:41:05 -04:00
< div class = "section" style = "max-width: 600px" >
2014-07-23 00:33:34 -04:00
< h2 > Examples of Filtering Edges< / h2 > < br / >
2022-07-27 22:41:05 -04:00
< div class = "section-subtitle" >
Some filter types are not supported for edges. The selector usually refers to the direction of the edge.
Non-linear edges are not selected for any selectors except type (%). Non-linear edges are never returned when these filters are applied.
< / div >
2022-07-27 22:58:50 -04:00
< table >
2014-07-23 00:33:34 -04:00
< tr >
< th style = "width:10%;" > Selector< / th >
< th style = "width:40%;" > Selector Class< / th >
< th style = "width:40%;" > Selects< / th >
< th style = "width:10%;" > # Objects Returned< / th >
< / tr >
< tr >
< td > + Z< / td >
< td > DirectionSelector< / td >
< td > Edges aligned in the Z direction< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > | Z< / td >
< td > ParallelDirSelector< / td >
< td > Edges parallel to z direction< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > - X< / td >
< td > DirectionSelector< / td >
< td > Edges aligned in neg x direction< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > # Z< / td >
< td > PerpendicularDirSelector< / td >
< td > Edges perpendicular to z direction< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > % Plane< / td >
< td > TypeSelector< / td >
< td > Edges type line< / td >
< td > 0..many< / td >
< / tr >
< tr >
< td > > Y< / td >
< td > DirectionMinMaxSelector< / td >
< td > Edges farthest in the positive y dir< / td >
< td > 0 or 1< / td >
< / tr >
< tr >
< td > < Y< / td >
< td > DirectionMinMaxSelector< / td >
< td > Edges farthest in the negative y dir< / td >
< td > 0 or 1< / td >
< / tr >
< / table >
< / div >
2022-07-27 22:41:05 -04:00
< div class = "section" style = "max-width: 600px" >
2014-07-23 00:33:34 -04:00
< h2 > Examples of Filtering Vertices< / h2 > < br / >
2022-07-27 22:41:05 -04:00
< div class = "section-subtitle" > Only a few of the filter types apply to vertices. The location of the vertex is the subject of the filter.< / div >
2022-07-27 22:58:50 -04:00
< table >
2014-07-23 00:33:34 -04:00
< tr >
< th style = "width:10%;" > Selector< / th >
< th style = "width:40%;" > Selector Class< / th >
< th style = "width:40%;" > Selects< / th >
2014-07-13 21:55:29 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > > Y< / td >
< td > DirectionMinMaxSelector< / td >
2022-07-27 22:41:05 -04:00
< td > Vertices farthest in the +Y dir< / td >
2014-07-13 21:55:29 -04:00
< / tr >
< tr >
2014-07-23 00:33:34 -04:00
< td > < Y< / td >
< td > DirectionMinMaxSelector< / td >
2022-07-27 22:41:05 -04:00
< td > Vertices farthest in the -Y dir< / td >
< / tr >
< tr >
< td > > > Y[-2]< / td >
< td > CenterNthSelector< / td >
< td > 2nd farthest vertex in the +Y dir< / td >
< / tr >
< tr >
< td > < < Y[0]< / td >
< td > CenterNthSelector< / td >
< td > 1st closest vertex in the Y dir< / td >
2014-07-13 21:55:29 -04:00
< / tr >
< / table >
< / div >
< / div >
< / body >
< / html >
