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
|
<!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 TX3DFieldOrEvent</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="TX3DFieldOrEvent"></a><h1 class="cio">Class TX3DFieldOrEvent</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>Fields</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 TX3DFieldOrEvent = class(<a class="normal" href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Base class for VRML/X3D field or event.</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="thisitem">TX3DFieldOrEvent</li></ul><h2 class="overview">Overview</h2>
<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>procedure <b><a href="X3DFields.TX3DFieldOrEvent.html#FieldOrEventAssignCommon">FieldOrEventAssignCommon</a></b>(Source: <a href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</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>constructor <b><a href="X3DFields.TX3DFieldOrEvent.html#Create">Create</a></b>(AParentNode: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string);</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.TX3DFieldOrEvent.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.TX3DFieldOrEvent.html#IsClauseNamesCount">IsClauseNamesCount</a></b>: Integer;</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.TX3DFieldOrEvent.html#IsClauseNamesAssign">IsClauseNamesAssign</a></b>(const SourceIsClauseNames: <a href="CastleStringUtils.TCastleStringList.html">TCastleStringList</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>procedure <b><a href="X3DFields.TX3DFieldOrEvent.html#IsClauseNamesAdd">IsClauseNamesAdd</a></b>(const S: string);</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.TX3DFieldOrEvent.html#ParseIsClause">ParseIsClause</a></b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</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>procedure <b><a href="X3DFields.TX3DFieldOrEvent.html#AddAlternativeName">AddAlternativeName</a></b>(const AlternativeName: string; VrmlMajorVersion: Integer); virtual;</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>function <b><a href="X3DFields.TX3DFieldOrEvent.html#IsName">IsName</a></b>(const S: string): boolean;</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.TX3DFieldOrEvent.html#NameForVersion">NameForVersion</a></b>(Version: <a href="X3DLexer.TX3DVersion.html">TX3DVersion</a>): string; overload;</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>function <b><a href="X3DFields.TX3DFieldOrEvent.html#NameForVersion">NameForVersion</a></b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>): string; overload;</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.TX3DFieldOrEvent.html#NiceName">NiceName</a></b>: string;</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.TX3DFieldOrEvent.html#SaveToStreamClassicIsClauses">SaveToStreamClassicIsClauses</a></b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>);</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.TX3DFieldOrEvent.html#Name">Name</a></b>: string read FName;</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>property <b><a href="X3DFields.TX3DFieldOrEvent.html#ParentNode">ParentNode</a></b>: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a> read FParentNode;</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>property <b><a href="X3DFields.TX3DFieldOrEvent.html#IsClauseNames">IsClauseNames</a></b>[constIndex:Integer]: string read GetIsClauseNames;</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>property <b><a href="X3DFields.TX3DFieldOrEvent.html#ParentInterfaceDeclaration">ParentInterfaceDeclaration</a></b>: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>
read FParentInterfaceDeclaration write FParentInterfaceDeclaration;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<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="FieldOrEventAssignCommon"></a><code>procedure <b>FieldOrEventAssignCommon</b>(Source: <a href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</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="Create"></a><code>constructor <b>Create</b>(AParentNode: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string);</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="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="IsClauseNamesCount"></a><code>function <b>IsClauseNamesCount</b>: 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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="IsClauseNamesAssign"></a><code>procedure <b>IsClauseNamesAssign</b>(const SourceIsClauseNames: <a href="CastleStringUtils.TCastleStringList.html">TCastleStringList</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="IsClauseNamesAdd"></a><code>procedure <b>IsClauseNamesAdd</b>(const S: string);</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="ParseIsClause"></a><code>procedure <b>ParseIsClause</b>(Lexer: <a href="X3DLexer.TX3DLexer.html">TX3DLexer</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Parse only "IS" clause, if it's not present — don't do nothing. For example, for the <a class="normal" href="X3DFields.TX3DField.html">TX3DField</a> descendant, this does not try to parse field value.</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="AddAlternativeName"></a><code>procedure <b>AddAlternativeName</b>(const AlternativeName: string; VrmlMajorVersion: Integer); virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
Add alternative name for the same field/event, to be used in different VRML version.
<p>When VRML major version is exactly equal VrmlMajorVersion, the AlternativeName should be used — for both reading and writing of this field/event. In some cases, when reading, we may also allow all versions (both original and alternative), but this is mostly for implementation simplicity — don't count on it.
<p>A special value 0 for VrmlMajorVersion means that this is just an alternative name, that should be allowed when reading (as alternative to normal Name), and never used when writing.
<p>Alternative names is a very handy mechanism for cases when the only thing that changed between VRML versions is the field name. Example: Switch node's children/choice, LOD node's children/level, Polyline2D lineSegments/point.
<p>Note that this also works for ExposedEvents with exposed <a class="normal" href="X3DFields.TX3DField.html">TX3DField</a>: if a field has alternative names, then it's exposed events always also have appropriate alternative names.</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="IsName"></a><code>function <b>IsName</b>(const S: string): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Returns if S matches current Name or one of the alternative names. Think about it like simple test "Name = S", but actually this checks also names added by <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#AddAlternativeName">AddAlternativeName</a> 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="NameForVersion"></a><code>function <b>NameForVersion</b>(Version: <a href="X3DLexer.TX3DVersion.html">TX3DVersion</a>): string; overload;</code></td>
</tr>
<tr><td colspan="2">
<p>
Return how this field should be named for given VRML version. In almost all cases, this simply returns current Name. But it can also return a name added by <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#AddAlternativeName">AddAlternativeName</a> 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="NameForVersion"></a><code>function <b>NameForVersion</b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>): string; overload;</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="NiceName"></a><code>function <b>NiceName</b>: string;</code></td>
</tr>
<tr><td colspan="2">
<p>
Nice and concise field description for user. Describes parent node type, name and field/event's name.</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="SaveToStreamClassicIsClauses"></a><code>procedure <b>SaveToStreamClassicIsClauses</b>(Writer: <a href="X3DFields.TX3DWriter.html">TX3DWriter</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Save IS clauses to stream, only for classic encoding. For each IS clause, writeln field/event name followed by "IS" clause.</p>
</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="Name"></a><code>property <b>Name</b>: string read FName;</code></td>
</tr>
<tr><td colspan="2">
<p>
Name of the field or event.
<p>Normal fields/events are inside some VRML node, and then they should have a name <> ''. But in some special cases I use fields without a name, then this is ''.
<p>Note that you cannot change this after object creation, since Name is used for various purposes (like to generate names for <a class="normal" href="X3DFields.TX3DField.html#ExposedEvents">TX3DField.ExposedEvents</a>).</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="ParentNode"></a><code>property <b>ParentNode</b>: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a> read FParentNode;</code></td>
</tr>
<tr><td colspan="2">
<p>
VRML node containing this field/event. This must always contain an instance of <a class="normal" href="X3DNodes.TX3DNode.html">TX3DNode</a> class (although it cannot be declared such, since <a class="normal" href="X3DFields.html">X3DFields</a> unit cannot depend on <a class="normal" href="X3DNodes.html">X3DNodes</a> interface).
<p>It may be <code>Nil</code> for special fields/events when parent node is unknown.</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="IsClauseNames"></a><code>property <b>IsClauseNames</b>[constIndex:Integer]: string read GetIsClauseNames;</code></td>
</tr>
<tr><td colspan="2">
<p>
"IS" clauses of this field/event, used when this field/event is inside prototype definition.
<p>This is an array, as one item may have many "IS" clauses (for a field, only one "IS" clause should refer to another field; but you can have many "IS" clauses connecting events, also exposedField may have "IS" clause that should be interpreted actually as links to it's exposed events). See e.g. <code>demo_models/x3d/proto_events_test_3.x3dv</code>.
<p>Note that having "IS" clauses doesn't mean that the field should be considered "without any value". This is not a good way of thinking, as an exposed field may have an "IS" clause, but linking it to an event, and thus such field has it's value (default value, if not specified in the file), event though it also has an "IS" clause. Although there is <a class="normal" href="X3DFields.TX3DField.html#ValueFromIsClause">TX3DField.ValueFromIsClause</a>, which indicates whether current value was obtained from "IS" clause.
<p>To be able to significantly optimize memory, we do not expose <code>IsClauseNames</code> as <a class="normal" href="CastleStringUtils.TCastleStringList.html">TCastleStringList</a>. Instead operate on them only using below functions. Note that <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#IsClauseNamesAssign">IsClauseNamesAssign</a> can also accept <code>Nil</code> as parameter.
<p></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="ParentInterfaceDeclaration"></a><code>property <b>ParentInterfaceDeclaration</b>: <a href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>
read FParentInterfaceDeclaration write FParentInterfaceDeclaration;</code></td>
</tr>
<tr><td colspan="2">
<p>
For fields contained in <a class="normal" href="X3DNodes.TX3DInterfaceDeclaration.html">TX3DInterfaceDeclaration</a>.
<p>This should always be <code>Nil</code> (if the field is normal, standard field, not coming from interface declaration in VRML file) or an instance of <a class="normal" href="X3DNodes.TX3DInterfaceDeclaration.html">TX3DInterfaceDeclaration</a>. (But it cannot be declared such, since <a class="normal" href="X3DNodes.TX3DInterfaceDeclaration.html">TX3DInterfaceDeclaration</a> is not known in this unit).</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>
|
