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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: X3DFields: Class TX3DSimpleMultField</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TX3DSimpleMultField"></a><h1 class="cio">Class TX3DSimpleMultField</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td><a class="section" href="#PasDoc-Fields">Fields</a></td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a href="X3DFields.html">X3DFields</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TX3DSimpleMultField = class(<a class="normal" href="X3DFields.TX3DMultField.html">TX3DMultField</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Field holding multiple values. Remember that such field may always have any number of items, including zero.
<p>Note that we keep MF fields contents in TFPSList or <a class="normal" href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a> instances (<a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a> in this class, also accessible as Items (with more concrete class) in descendants). This means that they are in compact form, easy for reading, or even for feeding the list into OpenGL. That's the main reason why I did not simply implement <code>TX3DSimpleMultField</code> as a descendant of TX3DSingleFieldsList: A long list of vertexes, MFVec3f, would be kept as a list of pointers to a lot of <a class="normal" href="X3DFields.TSFVec3f.html">TSFVec3f</a> instances. This would be quite memory-consuming, and very uncomfortable for access. On the contrary, current implementation keeps all these vertexes inside one <a class="normal" href="CastleVectors.TVector3SingleList.html">TVector3SingleList</a> instance, that internally keeps all items in one continuos piece of memory.
<p><i>Descendants implementors notes</i>: to make new descendant:
<p></p>
<ul class="paragraph_spacing">
<li><p>In <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a> you have to initialize <a class="normal" href="X3DFields.TX3DSimpleMultField.html#fItemClass">FItemClass</a> and create <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a>. In destructor of this class, <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a> are freed, so don't worry about this.</p></li>
<li><p>Override <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItemsAdd">RawItemsAdd</a>.</p></li>
<li><p> If your <a class="normal" href="X3DFields.TX3DSimpleMultField.html#ItemClass">ItemClass</a> doesn't work 100% correctly when it's initialized by <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a>, you may have to override <a class="normal" href="X3DFields.TX3DSimpleMultField.html#CreateItemBeforeParse">CreateItemBeforeParse</a>. Fortunately, VRML specification was careful to choose as multi-valued field types' only fields that can behave nicely when initialized by <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a> (and in fact VRML 2.0 removed the "bad fields" entirely).</p></li>
<li><p>Not strictly required, but usually it's comfortable to have a constructor that allows you to init default field value from some "array of TXxx".</p></li>
</ul>
<p></p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TPersistent</li>
<li class="ancestor"><a class="normal" href="CastleInterfaces.TNonRefCountedInterfacedPersistent.html">TNonRefCountedInterfacedPersistent</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFileItem.html">TX3DFileItem</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DField.html">TX3DField</a></li>
<li class="ancestor"><a class="normal" href="X3DFields.TX3DMultField.html">TX3DMultField</a></li>
<li class="thisitem">TX3DSimpleMultField</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Fields"></a><h3 class="summary">Fields</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code><b><a href="X3DFields.TX3DSimpleMultField.html#fItemClass">fItemClass</a></b>: <a href="X3DFields.html#TX3DSingleFieldClass">TX3DSingleFieldClass</a>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a></b>: TObject;</code></td>
</tr>
</table>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="X3DFields.TX3DSimpleMultField.html#CreateItemBeforeParse">CreateItemBeforeParse</a></b>: <a href="X3DFields.TX3DSingleField.html">TX3DSingleField</a>; virtual;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#RawItemsAdd">RawItemsAdd</a></b>(Item: <a href="X3DFields.TX3DSingleField.html">TX3DSingleField</a>); virtual abstract;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#OnWarning_InvalidIndex">OnWarning_InvalidIndex</a></b>(const Index, ACount: Integer);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#SaveToStreamValue">SaveToStreamValue</a></b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="X3DFields.TX3DSimpleMultField.html#RawItemToString">RawItemToString</a></b>(ItemNum: integer; const Encoding: <a href="X3DLexer.html#TX3DEncoding">TX3DEncoding</a>): string; virtual; abstract;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="X3DFields.TX3DSimpleMultField.html#SaveToStreamDoNewLineAfterRawItem">SaveToStreamDoNewLineAfterRawItem</a></b>(ItemNum: integer): boolean; virtual;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>function <b><a href="X3DFields.TX3DSimpleMultField.html#GetCount">GetCount</a></b>: Integer; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#SetCount">SetCount</a></b>(const Value: Integer); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#Clear">Clear</a></b>;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#ParseValue">ParseValue</a></b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>destructor <b><a href="X3DFields.TX3DSimpleMultField.html#Destroy">Destroy</a></b>; override;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="X3DFields.TX3DSimpleMultField.html#Equals">Equals</a></b>(SecondValue: <a href="X3DFields.TX3DField.html">TX3DField</a>; const EqualityEpsilon: Double): boolean; override;</code></td>
</tr>
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a href="X3DFields.TX3DSimpleMultField.html#ParseXMLAttributeLexer">ParseXMLAttributeLexer</a></b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a href="X3DFields.TX3DSimpleMultField.html#ItemClass">ItemClass</a></b>: <a href="X3DFields.html#TX3DSingleFieldClass">TX3DSingleFieldClass</a> read <a href="X3DFields.TX3DSimpleMultField.html#fItemClass">fItemClass</a>;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Fields</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="fItemClass"></a><code><b>fItemClass</b>: <a href="X3DFields.html#TX3DSingleFieldClass">TX3DSingleFieldClass</a>;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="RawItems"></a><code><b>RawItems</b>: TObject;</code></td>
</tr>
<tr><td colspan="2">
<p>
Items of this field. Either TFPSList or <a class="normal" href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a>.
<p><i>Descendants implementors notes</i>: You have to initialize this field in descendants' constructor, it will be always freed in our destructor.</p>
</td></tr>
</table>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CreateItemBeforeParse"></a><code>function <b>CreateItemBeforeParse</b>: <a href="X3DFields.TX3DSingleField.html">TX3DSingleField</a>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
This creates new instance of class <a class="normal" href="X3DFields.TX3DSimpleMultField.html#ItemClass">ItemClass</a>. It doesn't have to have initialized value (in other words, it can be created by <a class="normal" href="X3DFields.TX3DField.html#CreateUndefined">CreateUndefined</a>), since we'll call his Parse method immediately. Default implementation in this class uses simply ItemClass.CreateUndefined.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="RawItemsAdd"></a><code>procedure <b>RawItemsAdd</b>(Item: <a href="X3DFields.TX3DSingleField.html">TX3DSingleField</a>); virtual abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Add Item at the end of <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a>. It's guaranteed that Item passes here will be of class <a class="normal" href="X3DFields.TX3DSimpleMultField.html#ItemClass">ItemClass</a>. You should copy Item contents as appropriate (remember that Item instance itself may be freed soon, so copy contents, not only some reference).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="OnWarning_InvalidIndex"></a><code>procedure <b>OnWarning_InvalidIndex</b>(const Index, ACount: Integer);</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SaveToStreamValue"></a><code>procedure <b>SaveToStreamValue</b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>SaveToStreamValue</code> overriden for MF fields. This class handles <code>SaveToStreamValue</code> fully, no need to override it again in descendants.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="RawItemToString"></a><code>function <b>RawItemToString</b>(ItemNum: integer; const Encoding: <a href="X3DLexer.html#TX3DEncoding">TX3DEncoding</a>): string; virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
<code>RawItemToString</code>(i) must change <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a>[i] into a string that can be used to store this is text stream. In descendants, you have to override this.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SaveToStreamDoNewLineAfterRawItem"></a><code>function <b>SaveToStreamDoNewLineAfterRawItem</b>(ItemNum: integer): boolean; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
This says when we should do newline when writing this field into a stream. It's has purely aesthetical meaning, nothing more. In this class <code>SaveToStreamDoNewLineAfterRawItem</code> always returns <code>True</code> (although <a class="normal" href="X3DFields.TX3DSimpleMultField.html#SaveToStreamValue">SaveToStreamValue</a> may sometimes ignore it, if it knows better).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="GetCount"></a><code>function <b>GetCount</b>: Integer; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Get or set the number of items. In <a class="normal" href="X3DFields.TX3DSimpleMultField.html">TX3DSimpleMultField</a> descendants, these simply get/set RawItems.Count (you could do it directly as well, since operating on <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItems">RawItems</a> directly is Ok). </p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SetCount"></a><code>procedure <b>SetCount</b>(const Value: Integer); override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="Clear"></a><code>procedure <b>Clear</b>;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ParseValue"></a><code>procedure <b>ParseValue</b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Parse MF field. This class handles parsing fully, usually no need to override this more in descendants. It uses ItemClass.Parse method.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Destroy"></a><code>destructor <b>Destroy</b>; override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Equals"></a><code>function <b>Equals</b>(SecondValue: <a href="X3DFields.TX3DField.html">TX3DField</a>; const EqualityEpsilon: Double): boolean; override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Checks equality between this and SecondValue field. In addition to inherited(Equals), this also checks that Count and <a class="normal" href="X3DFields.TX3DSimpleMultField.html#ItemClass">ItemClass</a> are equal. All descendants must check for equality every item on SecondValue.Items[I] and Items[I].</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ParseXMLAttributeLexer"></a><code>procedure <b>ParseXMLAttributeLexer</b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</a>; Reader: <a href="X3DFields.TX3DReader.html">TX3DReader</a>); override;</code></td>
</tr>
<tr><td colspan="2">
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a href="legend.html"><img src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="ItemClass"></a><code>property <b>ItemClass</b>: <a href="X3DFields.html#TX3DSingleFieldClass">TX3DSingleFieldClass</a> read <a href="X3DFields.TX3DSimpleMultField.html#fItemClass">fItemClass</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
A corresponding SF field class. All items that will be passed to <a class="normal" href="X3DFields.TX3DSimpleMultField.html#RawItemsAdd">RawItemsAdd</a> will be of this class.</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
var _paq = _paq || [];
_paq.push(["trackPageView"]);
_paq.push(["enableLinkTracking"]);
(function() {
var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
_paq.push(["setTrackerUrl", u+"piwik.php"]);
_paq.push(["setSiteId", "1"]);
var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
})();
</script>
<!-- End Piwik Code -->
<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:13</em>
</span>
</td></tr></table></body></html>
|
