libdime-doc 0.20030921-2 / usr / share / doc / libdime-doc / html / classdimeLine.html

This file is indexed.

/usr/share/doc/libdime-doc/html/classdimeLine.html is in libdime-doc 0.20030921-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
<HTML>
<HEAD>
<TITLE>DIME Source Code Documentation</TITLE>
<META NAME=description
      CONTENT="Documentation for DIME">
<META NAME=keywords
      CONTENT="DXF, AutoCAD, C++ class library">
</HEAD>
<BODY>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a></div>
<h1>dimeLine Class Reference</h1><!-- doxytag: class="dimeLine" --><!-- doxytag: inherits="dimeExtrusionEntity" -->The dimeLine class handles a LINE <em>entity</em>.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Line_8h-source.html">dime/entities/Line.h</a>&gt;</code>
<p>
<p>Inheritance diagram for dimeLine:
<p><center><img src="classdimeLine.png" usemap="#dimeLine_map" border="0" alt=""></center>
<map name="dimeLine_map">
<area href="classdimeExtrusionEntity.html" alt="dimeExtrusionEntity" shape="rect" coords="0,168,121,192">
<area href="classdimeEntity.html" alt="dimeEntity" shape="rect" coords="0,112,121,136">
<area href="classdimeRecordHolder.html" alt="dimeRecordHolder" shape="rect" coords="0,56,121,80">
<area href="classdimeBase.html" alt="dimeBase" shape="rect" coords="0,0,121,24">
</map>
<a href="classdimeLine-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a0">dimeLine</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1"></a><!-- doxytag: member="dimeLine::getCoords" ref="a1" args="(const int idx) const " -->
const <a class="el" href="classdimeVec3f.html">dimeVec3f</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>getCoords</b> (const int idx) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2"></a><!-- doxytag: member="dimeLine::setCoords" ref="a2" args="(const int idx, const dimeVec3f &amp;v)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>setCoords</b> (const int idx, const <a class="el" href="classdimeVec3f.html">dimeVec3f</a> &amp;v)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classdimeEntity.html">dimeEntity</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a3">copy</a> (<a class="el" href="classdimeModel.html">dimeModel</a> *const model) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a4">getRecord</a> (const int groupcode, <a class="el" href="uniondimeParam.html">dimeParam</a> &amp;param, const int index=0) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a5">getEntityName</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6"></a><!-- doxytag: member="dimeLine::print" ref="a6" args="() const " -->
virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><b>print</b> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a7">write</a> (<a class="el" href="classdimeOutput.html">dimeOutput</a> *const out)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a8">typeId</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a9">countRecords</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual GeometryType&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#a10">extractGeometry</a> (<a class="el" href="classdimeArray.html">dimeArray</a>&lt; <a class="el" href="classdimeVec3f.html">dimeVec3f</a> &gt; &amp;verts, <a class="el" href="classdimeArray.html">dimeArray</a>&lt; int &gt; &amp;indices, <a class="el" href="classdimeVec3f.html">dimeVec3f</a> &amp;extrusionDir, dxfdouble &amp;thickness)</td></tr>

<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classdimeLine.html#b0">handleRecord</a> (const int groupcode, const <a class="el" href="uniondimeParam.html">dimeParam</a> &amp;param, <a class="el" href="classdimeMemHandler.html">dimeMemHandler</a> *const memhandler)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The dimeLine class handles a LINE <em>entity</em>. 
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a0"></a><!-- doxytag: member="dimeLine::dimeLine" ref="a0" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">dimeLine::dimeLine           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructor.    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a3"></a><!-- doxytag: member="dimeLine::copy" ref="a3" args="(dimeModel *const model) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"><a class="el" href="classdimeEntity.html">dimeEntity</a> * dimeLine::copy           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classdimeModel.html">dimeModel</a> *const &nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>model</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Must be implemented by subclasses to return a copy of the entity. <em>model</em> is the model the new entity should belong to.
<p>
Implements <a class="el" href="classdimeEntity.html#a10">dimeEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a9"></a><!-- doxytag: member="dimeLine::countRecords" ref="a9" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int dimeLine::countRecords           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the number of records in the record holder. Should be overloaded by subclasses which should count their records, and then call the parent's method. This method is used to precalculate the number of records to be written. Very useful when progress information is needed during <a class="el" href="classdimeLine.html#a7">write()</a>.
<p>
Reimplemented from <a class="el" href="classdimeExtrusionEntity.html#a8">dimeExtrusionEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="dimeLine::extractGeometry" ref="a10" args="(dimeArray&lt; dimeVec3f &gt; &amp;verts, dimeArray&lt; int &gt; &amp;indices, dimeVec3f &amp;extrusionDir, dxfdouble &amp;thickness)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">dimeEntity::GeometryType dimeLine::extractGeometry           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classdimeArray.html">dimeArray</a>&lt; <a class="el" href="classdimeVec3f.html">dimeVec3f</a> &gt; &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>verts</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classdimeArray.html">dimeArray</a>&lt; int &gt; &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>indices</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classdimeVec3f.html">dimeVec3f</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>extrusionDir</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>dxfdouble &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>thickness</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
A special convenience function, included for your pleasure. Enables the user to ignore the type of entity, and just call this method when extracting geometry. Very useful for 3D viewers that need DXF support. Check out the dxf2vrml directory for an example on how to convert a DXF file to VRML.<p>
Should be overloaded by all subclasses that have geometry, default function returns no geometry. Don't forget to transform vertices by the current transformation matrix if used in a callback from <a class="el" href="classdimeEntity.html#b1">dimeEntity::traverse()</a>.<p>
If there are coordinates, but no indices, this means running indices for the entire vertex array.<p>
Different faces and/or line segments are separated by a <em>-1</em> in the indices array, just as in VRML files.<p>
If <em>thickness</em> != 0.0, the data should, before transformation, be extruded by that length along the extrusion direction. Hence, a point becomes a line, a line becomes a quad, and a polygon becomes an object with a volume.<p>
If <em>thickness</em> == 0.0 and <em>extrusionDir</em> != (0,0,1) all the vertices should be transformed by a matrix that can be created using <a class="el" href="classdimeEntity.html#e5">dimeEntity::generateUCS()</a>. If you are using <a class="el" href="classdimeModel.html#a7">dimeModel::traverseEntities()</a> to extract the geometry, simply right-multiply the UCS matrix with the matrix found in <a class="el" href="classdimeState.html">dimeState</a> to get the correct transformation.
<p>
Reimplemented from <a class="el" href="classdimeEntity.html#a21">dimeEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a5"></a><!-- doxytag: member="dimeLine::getEntityName" ref="a5" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">const char * dimeLine::getEntityName           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Must be implemented by subclasses to return the entity name; e.g. POLYLINE, 3DFACE, etc.
<p>
Implements <a class="el" href="classdimeEntity.html#a7">dimeEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="dimeLine::getRecord" ref="a4" args="(const int groupcode, dimeParam &amp;param, const int index=0) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool dimeLine::getRecord           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const int&nbsp;</td>
          <td class="mdname" nowrap> <em>groupcode</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="uniondimeParam.html">dimeParam</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>param</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const int&nbsp;</td>
          <td class="mdname" nowrap> <em>index</em> = <code>0</code></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Will return the value of the record with group code <em>groupcode</em>. <em>false</em> is returned if the record could not be found. Subclasses should overload this method if one or several records are stored in the class. If the groupcode queried is not stored internally, the subclass should call its parent's method.
<p>
Reimplemented from <a class="el" href="classdimeExtrusionEntity.html#a1">dimeExtrusionEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="b0"></a><!-- doxytag: member="dimeLine::handleRecord" ref="b0" args="(const int groupcode, const dimeParam &amp;param, dimeMemHandler *const memhandler)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool dimeLine::handleRecord           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const int&nbsp;</td>
          <td class="mdname" nowrap> <em>groupcode</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>const <a class="el" href="uniondimeParam.html">dimeParam</a> &amp;&nbsp;</td>
          <td class="mdname" nowrap> <em>param</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap><a class="el" href="classdimeMemHandler.html">dimeMemHandler</a> *const &nbsp;</td>
          <td class="mdname" nowrap> <em>memhandler</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"><code> [protected, virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Handles the callback from dimeEntity::readRecords().
<p>
Reimplemented from <a class="el" href="classdimeExtrusionEntity.html#b0">dimeExtrusionEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a8"></a><!-- doxytag: member="dimeLine::typeId" ref="a8" args="() const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">int dimeLine::typeId           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Must be implemented by all subclasses, and should return an unique id for that class.
<p>
Reimplemented from <a class="el" href="classdimeExtrusionEntity.html#a6">dimeExtrusionEntity</a>.    </td>
  </tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="dimeLine::write" ref="a7" args="(dimeOutput *const out)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">bool dimeLine::write           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classdimeOutput.html">dimeOutput</a> *const &nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>file</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [virtual]</code></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Writes a <em>Line</em> entity.
<p>
Reimplemented from <a class="el" href="classdimeEntity.html#a12">dimeEntity</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="Line_8h-source.html">Line.h</a><li>Line.cpp</ul>
<HR>
<DIV ALIGN=right>
<FONT SIZE=-2><I>
Copyright &copy; 1998-1999, <A HREF=http://www.sim.no/>Systems In Motion</A>
&lt;<A HREF=mailto:sales@sim.no>sales@sim.no</A>&gt;.
All rights reserved.
<BR>
System documentation was generated using
<A HREF=http://www.stack.nl/~dimitri/doxygen/>doxygen</A>.
</I></FONT>
<DIV ALIGN=left>
</BODY>
</HTML>

APT Browse - Built by Thomas Orozco.