1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
- < html >
2
+ < html lang =" en " >
3
3
< head >
4
4
< title > CadQuery Cheatsheet</ title >
5
5
< meta http-equiv ="Content-Type " content ="text/html; charset=utf-8 ">
6
6
< meta name ="viewport " content ="width=device-width, initial-scale=1 ">
7
7
8
8
< style type ="text/css ">
9
+ body {
10
+ margin : 0 ;
11
+ text-align : center;
12
+ }
13
+ # header {
14
+ background-color : # ddd ; padding : 2px ;
15
+ margin-bottom : 10px ;
16
+ }
17
+ # section-container {
18
+ display : flex; flex-wrap : wrap; align-items : flex-start; justify-content : space-around; row-gap : 10px ;
19
+ }
9
20
.section {
10
21
margin : 0.5em ;
11
22
padding : 0px 0.5em 0.5em ;
16
27
.section-subtitle {
17
28
margin-bottom : 4px ;
18
29
}
19
- h2 a , h2 a : visited , . section a , . section a : visited {
30
+ a , a : visited {
20
31
color : # 1f4b8f ;
21
32
font-weight : bold;
22
33
text-decoration : none;
23
-
24
34
}
25
- . column {
26
- float : left ;
35
+ table {
36
+ width : 100 % ;
27
37
}
28
38
tr {
29
39
background-color : # FFFFFF ;
32
42
text-align : center;
33
43
width : 5em ;
34
44
}
45
+ h1 {
46
+ margin : 10px ;
47
+ }
35
48
h2 {
36
49
display : inline;
37
50
}
38
51
</ style >
39
52
</ head >
40
- < body style ="text-align: center ">
41
- < div style ="background-color: #ddd; padding: 2px; ">
42
- < h1 > < img src ="https://cadquery.readthedocs.io/en/latest/_static/cadquery_logo_dark.svg " height =30 > Cheatsheet</ h1 >
43
- < i > A Quick Guide To The Most Commonly Used Functions!
44
- < br />
45
- < sub > For the full API ref < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/apireference.html " target ="_blank "> click here!</ a > </ sub > </ i >
53
+ < body >
54
+ < div id ="header ">
55
+ < h1 > < img src ="https://cadquery.readthedocs.io/en/latest/_static/cadquery_logo_dark.svg " alt ="CadQuery Logo " height =30 > Cheatsheet</ h1 >
56
+ < i >
57
+ A Quick Guide To The Most Commonly Used Functions!
58
+ < br />
59
+ < sub >
60
+ For the full API reference < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/apireference.html "> click here</ a > .
61
+ For examples < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/examples.html "> click here</ a > .
62
+ </ sub >
63
+ </ i >
46
64
</ div >
47
- < div style ="display: flex; flex-wrap: wrap; align-items: flex-start; justify-content: space-around; row-gap: 10px; ">
48
- < div class ="section " hidden >
49
- < h2 > Documentation</ h2 >
50
- < ul style ="background-color:#ffffff;margin-bottom:0px;margin-top:0px; ">
51
- < li > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/ "> CadQuery Documentation</ a > </ li >
52
- < li > < a target ="_blank " href ="https://github.com/CadQuery/cadquery/blob/master/README.md "> CadQuery Readme</ a > </ li >
53
- < li > < a target ="_blank " href ="https://github.com/CadQuery/cadquery/tree/master/examples "> CadQuery Examples</ a > </ li >
54
- < li > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/apireference.html "> CadQuery API Reference</ a > </ li >
55
- </ ul >
56
- </ div >
65
+ < div id ="section-container ">
57
66
< div class ="section ">
58
67
< h2 > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/apireference.html#id1 "> 3D Construction</ a > </ h2 >
59
- < table style =" width:100%; " >
68
+ < table >
60
69
< thead >
61
- < th > Primitives</ th >
62
- < th > Additive</ th >
63
- < th > Subtractive</ th >
70
+ < tr >
71
+ < th > Primitives</ th >
72
+ < th > Additive</ th >
73
+ < th > Subtractive</ th >
74
+ </ tr >
64
75
</ thead >
65
76
< tr >
66
77
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.box "> Workplane.box</ a > < br > (length, width, height)</ td >
67
78
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.extrude "> Workplane.extrude</ a > < br > (until)</ td >
68
79
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.cut "> Workplane.cut</ a > < br > (toCut)</ td >
69
80
</ tr >
70
81
< tr >
71
- < td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.sphere "> Workplane.sphere</ a > < br > (radius)</ li > </ td >
82
+ < td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.sphere "> Workplane.sphere</ a > < br > (radius)</ td >
72
83
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.sweep "> Workplane.sweep</ a > < br > (path)</ td >
73
84
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.cutThruAll "> Workplane.cutThruAll</ a > < br > (until)</ td >
74
85
</ tr >
@@ -86,7 +97,7 @@ <h2><a target="_blank" href="https://cadquery.readthedocs.io/en/latest/apirefere
86
97
</ div >
87
98
< div class ="section ">
88
99
< h2 > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/apireference.html#d-operations "> 2D Construction</ a > </ h2 >
89
- < table style =" width:100%; " >
100
+ < table >
90
101
< tr >
91
102
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.rect "> Workplane.rect</ a > < br > (xLen, yLen)</ td >
92
103
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.circle "> Workplane.circle</ a > < br > (radius)</ td >
@@ -103,15 +114,15 @@ <h2><a target="_blank" href="https://cadquery.readthedocs.io/en/latest/apirefere
103
114
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.polarLine "> Workplane.polarLine</ a > < br > (distance, angle)</ td >
104
115
</ tr >
105
116
< tr >
106
- < td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.vLine "> Workplane.vLine</ a > < br > (distance)</ li > </ td >
117
+ < td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.vLine "> Workplane.vLine</ a > < br > (distance)</ td >
107
118
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.hLine "> Workplane.hLine</ a > < br > (distance)</ td >
108
119
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Workplane.polyline "> Workplane.polyline</ a > < br > (listOfXYTuple)</ td >
109
120
</ tr >
110
121
</ table >
111
122
</ div >
112
123
< div class ="section ">
113
124
< h2 > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/apireference.html#sketch-initialization "> Sketching</ a > </ h2 >
114
- < table style =" width:100%; " >
125
+ < table >
115
126
< tr >
116
127
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.rect "> Sketch.rect</ a > < br > (w, h)</ td >
117
128
< td > < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/classreference.html#cadquery.Sketch.circle "> Sketch.circle</ a > < br > (r)</ td >
@@ -131,7 +142,7 @@ <h2><a target="_blank" href="https://cadquery.readthedocs.io/en/latest/apirefere
131
142
</ div >
132
143
< div class ="section " style ="min-width: 300px; " hidden >
133
144
< h2 > BREP Terminology</ h2 > < br />
134
- < table style =" width:100%; " >
145
+ < table >
135
146
< tr >
136
147
< td style ="width:10%; "> < strong > vertex</ strong > </ td >
137
148
< td style ="width:90%; "> A single point in space</ td >
@@ -166,7 +177,7 @@ <h2>BREP Terminology</h2><br />
166
177
< h2 > Selector String Modifiers</ h2 > < br />
167
178
< div class ="section-subtitle "> See < a target ="_blank " href ="https://cadquery.readthedocs.io/en/latest/selectors.html "> CadQuery String Selectors</ a > for more information.< br />
168
179
Axis Strings are: X, Y, Z, XY, YZ, XZ</ div >
169
- < table style =" width:100%; " >
180
+ < table >
170
181
< tr >
171
182
< th style ="width:10%; "> Modifier</ th >
172
183
< th style ="width:90%; "> Description</ th >
@@ -204,7 +215,7 @@ <h2>Selector String Modifiers</h2><br />
204
215
< div class ="section ">
205
216
< h2 > Selector Methods</ h2 > < br />
206
217
< div class ="section-subtitle "> CadQuery selector strings and classes allow filtering to select objects.</ div >
207
- < table style =" width:100%; " >
218
+ < table >
208
219
< tr >
209
220
< th style ="width:40%; "> Selector Methods</ th >
210
221
< th style ="width:60%; "> Selector Classes
@@ -234,7 +245,7 @@ <h2>Selector Methods</h2><br />
234
245
< div class ="section ">
235
246
< h2 > Named Planes</ h2 > < br />
236
247
< div class ="section-subtitle "> Direction references refer to the global directions.</ div >
237
- < table style =" width:100%; " >
248
+ < table >
238
249
< tr >
239
250
< th style ="width:25%; "> Name</ th >
240
251
< th style ="width:25%; "> xDir</ th >
@@ -300,7 +311,7 @@ <h2>Named Planes</h2><br />
300
311
301
312
< div class ="section " hidden >
302
313
< h2 > Core Classes</ h2 > < br />
303
- < table style =" width:100%; " >
314
+ < table >
304
315
< tr >
305
316
< th style ="width:40%; "> Class</ th >
306
317
< th style ="width:60%; "> Description</ th >
@@ -326,7 +337,7 @@ <h2>Examples of Filtering Faces</h2><br />
326
337
All types of filters work on faces. In most cases, the selector refers to the direction of the normal vector of the face.
327
338
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.
328
339
</ div >
329
- < table style =" width:100%; " >
340
+ < table >
330
341
< tr >
331
342
< th style ="width:10%; "> Selector</ th >
332
343
< th style ="width:40%; "> Selector Class</ th >
@@ -383,7 +394,7 @@ <h2>Examples of Filtering Edges</h2><br />
383
394
Some filter types are not supported for edges. The selector usually refers to the direction of the edge.
384
395
Non-linear edges are not selected for any selectors except type (%). Non-linear edges are never returned when these filters are applied.
385
396
</ div >
386
- < table style =" width:100%; " >
397
+ < table >
387
398
< tr >
388
399
< th style ="width:10%; "> Selector</ th >
389
400
< th style ="width:40%; "> Selector Class</ th >
@@ -437,7 +448,7 @@ <h2>Examples of Filtering Edges</h2><br />
437
448
< div class ="section " style ="max-width: 600px ">
438
449
< h2 > Examples of Filtering Vertices</ h2 > < br />
439
450
< 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 >
440
- < table style =" width:100%; " >
451
+ < table >
441
452
< tr >
442
453
< th style ="width:10%; "> Selector</ th >
443
454
< th style ="width:40%; "> Selector Class</ th >
0 commit comments