-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclassshape.html
246 lines (230 loc) · 13.5 KB
/
classshape.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AngelCAD: shape Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="angel_48x48.bmp"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">AngelCAD
 <span id="projectnumber">1.5-00</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classshape-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">shape Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Abstract base for all primitives and booleans.
<a href="classshape.html#details">More...</a></p>
<p><code>#include <<a class="el" href="angelcad_8h_source.html">angelcad.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for shape:</div>
<div class="dyncontent">
<div class="center">
<img src="classshape.png" usemap="#shape_map" alt=""/>
<map id="shape_map" name="shape_map">
<area href="classshape2d.html" title="Abstract base for 2d primitives and booleans. " alt="shape2d" shape="rect" coords="0,56,114,80"/>
<area href="classsolid.html" title="Abstract base for 3d primitives and booleans. " alt="solid" shape="rect" coords="248,56,362,80"/>
<area href="classcircle.html" title="circle, centered at origin " alt="circle" shape="rect" coords="124,112,238,136"/>
<area href="classdifference2d.html" title="2d difference boolean operation " alt="difference2d" shape="rect" coords="124,168,238,192"/>
<area href="classfill2d.html" title="2d fill operation, filling holes in input shapes " alt="fill2d" shape="rect" coords="124,224,238,248"/>
<area href="classhull2d.html" title="2d hull operation, enclosing the input shapes " alt="hull2d" shape="rect" coords="124,280,238,304"/>
<area href="classintersection2d.html" title="2d intersection boolean operation " alt="intersection2d" shape="rect" coords="124,336,238,360"/>
<area href="classminkowski2d.html" title="2d Minkowski sum operation " alt="minkowski2d" shape="rect" coords="124,392,238,416"/>
<area href="classoffset2d.html" title="2d profile offset " alt="offset2d" shape="rect" coords="124,448,238,472"/>
<area href="classpolygon.html" title="polygon, vertices in CCW order " alt="polygon" shape="rect" coords="124,504,238,528"/>
<area href="classprojection2d.html" title="Project from 3d to 2d. " alt="projection2d" shape="rect" coords="124,560,238,584"/>
<area href="classrectangle.html" title="rectangle, by default located in 1st quadrant touching origin " alt="rectangle" shape="rect" coords="124,616,238,640"/>
<area href="classsquare.html" title="square, by default located in 1st quadrant touching origin " alt="square" shape="rect" coords="124,672,238,696"/>
<area href="classunion2d.html" title="2d union boolean operation " alt="union2d" shape="rect" coords="124,728,238,752"/>
<area href="classcone.html" title="cone with axis in z-direction, by default extending from origin " alt="cone" shape="rect" coords="372,112,486,136"/>
<area href="classcube.html" title="cube, by default in 1st octant with one corner toucing origin " alt="cube" shape="rect" coords="372,168,486,192"/>
<area href="classcuboid.html" title="cuboid, by default in 1st octant with one corner toucing origin " alt="cuboid" shape="rect" coords="372,224,486,248"/>
<area href="classcylinder.html" title="cylinder with axis in z-direction, by default extending from origin " alt="cylinder" shape="rect" coords="372,280,486,304"/>
<area href="classdifference3d.html" title="3d difference boolean operation " alt="difference3d" shape="rect" coords="372,336,486,360"/>
<area href="classhull3d.html" title="3d hull operation, enclosing the input solids " alt="hull3d" shape="rect" coords="372,392,486,416"/>
<area href="classintersection3d.html" title="3d intersection boolean operation " alt="intersection3d" shape="rect" coords="372,448,486,472"/>
<area href="classlinear__extrude.html" title="Extrude 2d shape in z direction into 3d solid. " alt="linear_extrude" shape="rect" coords="372,504,486,528"/>
<area href="classminkowski3d.html" title="3d Minkowski sum operation " alt="minkowski3d" shape="rect" coords="372,560,486,584"/>
<area href="classpolyhedron.html" title="Closed polyhedron volume defined by vertices and planar faces. " alt="polyhedron" shape="rect" coords="372,616,486,640"/>
<area href="classrotate__extrude.html" title="Extrude 2d shape CCW in XZ plane into 3d solid. " alt="rotate_extrude" shape="rect" coords="372,672,486,696"/>
<area href="classsphere.html" title="sphere, centered at origin " alt="sphere" shape="rect" coords="372,728,486,752"/>
<area href="classsweep.html" title="Sweep 2d shape along path curve to create 3d solid. " alt="sweep" shape="rect" coords="372,784,486,808"/>
<area href="classtransform__extrude.html" title="Extrude from botton to top shapes using transform. " alt="transform_extrude" shape="rect" coords="372,840,486,864"/>
<area href="classunion3d.html" title="3d union boolean operation " alt="union3d" shape="rect" coords="372,896,486,920"/>
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a9511e310496d8d70c26cf0c4b59b0200"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classboundingbox.html">boundingbox</a>@ </td><td class="memItemRight" valign="bottom"><a class="el" href="classshape.html#a9511e310496d8d70c26cf0c4b59b0200">box</a> () const</td></tr>
<tr class="memdesc:a9511e310496d8d70c26cf0c4b59b0200"><td class="mdescLeft"> </td><td class="mdescRight">Return bounding box of object. <a href="#a9511e310496d8d70c26cf0c4b59b0200">More...</a><br /></td></tr>
<tr class="separator:a9511e310496d8d70c26cf0c4b59b0200"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac03192d7f3b961b3ae84cb5821daf508"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classtmatrix.html">tmatrix</a>@ </td><td class="memItemRight" valign="bottom"><a class="el" href="classshape.html#ac03192d7f3b961b3ae84cb5821daf508">transform</a> () const</td></tr>
<tr class="memdesc:ac03192d7f3b961b3ae84cb5821daf508"><td class="mdescLeft"> </td><td class="mdescRight">Return transformation matrix of object. <a href="#ac03192d7f3b961b3ae84cb5821daf508">More...</a><br /></td></tr>
<tr class="separator:ac03192d7f3b961b3ae84cb5821daf508"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a68ad904d40735fce93feda3786512be6"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classshape.html#a68ad904d40735fce93feda3786512be6">write_csg</a> (<a class="el" href="classstring.html">string</a> path)</td></tr>
<tr class="memdesc:a68ad904d40735fce93feda3786512be6"><td class="mdescLeft"> </td><td class="mdescRight">Write object to OpenSCAD .csg file. <a href="#a68ad904d40735fce93feda3786512be6">More...</a><br /></td></tr>
<tr class="separator:a68ad904d40735fce93feda3786512be6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a360c3c312d757f8385fc36cb7ec940e0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classshape.html#a360c3c312d757f8385fc36cb7ec940e0">write_xcsg</a> (<a class="el" href="classstring.html">string</a> path, double secant_tolerance=- 1.0)</td></tr>
<tr class="memdesc:a360c3c312d757f8385fc36cb7ec940e0"><td class="mdescLeft"> </td><td class="mdescRight">Write object to .xcsg file for processing by xcsg program. <a href="#a360c3c312d757f8385fc36cb7ec940e0">More...</a><br /></td></tr>
<tr class="separator:a360c3c312d757f8385fc36cb7ec940e0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Abstract base for all primitives and booleans. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a9511e310496d8d70c26cf0c4b59b0200"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9511e310496d8d70c26cf0c4b59b0200">◆ </a></span>box()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classboundingbox.html">boundingbox</a>@ shape::box </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return bounding box of object. </p>
<dl class="section return"><dt>Returns</dt><dd>boundingbox@ </dd></dl>
</div>
</div>
<a id="ac03192d7f3b961b3ae84cb5821daf508"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac03192d7f3b961b3ae84cb5821daf508">◆ </a></span>transform()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classtmatrix.html">tmatrix</a>@ shape::transform </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Return transformation matrix of object. </p>
<dl class="section return"><dt>Returns</dt><dd>tmatrix@ </dd></dl>
</div>
</div>
<a id="a68ad904d40735fce93feda3786512be6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a68ad904d40735fce93feda3786512be6">◆ </a></span>write_csg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shape::write_csg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstring.html">string</a> </td>
<td class="paramname"><em>path</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write object to OpenSCAD .csg file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>string </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a360c3c312d757f8385fc36cb7ec940e0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a360c3c312d757f8385fc36cb7ec940e0">◆ </a></span>write_xcsg()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void shape::write_xcsg </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classstring.html">string</a> </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">double </td>
<td class="paramname"><em>secant_tolerance</em> = <code>- 1.0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write object to .xcsg file for processing by xcsg program. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>string <br />
</td></tr>
<tr><td class="paramname">secant_tolerance</td><td>double </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="angelcad_8h_source.html">angelcad.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 15 2020 14:41:21 for AngelCAD by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>