File: X3DNodes.TInlineNode.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (297 lines) | stat: -rw-r--r-- 18,653 bytes parent folder | download
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
<!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: X3DNodes: Class TInlineNode</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="TInlineNode"></a><h1 class="cio">Class TInlineNode</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="X3DNodes.html">X3DNodes</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TInlineNode = class(<a class="normal" href="X3DNodes.TAbstractGroupingNode.html">TAbstractGroupingNode</a>, <a class="normal" href="X3DNodes.IAbstractBoundedObject.html">IAbstractBoundedObject</a>, <a class="normal" href="X3DNodes.IAbstractUrlObject.html">IAbstractUrlObject</a>)</code></p>
<h2 class="description">Description</h2>
<p>
Inline node.

<p>The loaded inline contents are accessible in the <a class="normal" href="X3DNodes.TInlineNode.html#Inlined">Inlined</a> object. Currently this is also kept in the Children list of this node. Originally, Children list is for VRML 1.0 children, but for inline node this is just used for inlined content (regardless of VRML/X3D version).

<p>This means that most methods, like <a class="normal" href="X3DNodes.TX3DNode.html#EnumerateNodes">TX3DNode.EnumerateNodes</a>, descend into inlined content normally.</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="X3DNodes.TX3DNode.html">TX3DNode</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TAbstractNode.html">TAbstractNode</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TAbstractChildNode.html">TAbstractChildNode</a></li>
<li class="ancestor"><a class="normal" href="X3DNodes.TAbstractGroupingNode.html">TAbstractGroupingNode</a></li>
<li class="thisitem">TInlineNode</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="X3DNodes.TInlineNode.html#BeforeTraverse">BeforeTraverse</a></b>(StateStack: <a  href="X3DNodes.TX3DGraphTraverseStateStack.html">TX3DGraphTraverseStateStack</a>); 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="X3DNodes.TInlineNode.html#AfterTraverse">AfterTraverse</a></b>(StateStack: <a  href="X3DNodes.TX3DGraphTraverseStateStack.html">TX3DGraphTraverseStateStack</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>procedure <b><a  href="X3DNodes.TInlineNode.html#AfterLoadInlined">AfterLoadInlined</a></b>; 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>function <b><a  href="X3DNodes.TInlineNode.html#DeepCopyCore">DeepCopyCore</a></b>(CopyState: <a  href="X3DNodes.TX3DNodeDeepCopyState.html">TX3DNodeDeepCopyState</a>): <a  href="X3DNodes.TX3DNode.html">TX3DNode</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>procedure <b><a  href="X3DNodes.TInlineNode.html#ParseAfter">ParseAfter</a></b>(Reader: <a  href="X3DNodes.TX3DReaderNames.html">TX3DReaderNames</a>); 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>procedure <b><a  href="X3DNodes.TInlineNode.html#CreateNode">CreateNode</a></b>; 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>class function <b><a  href="X3DNodes.TInlineNode.html#ClassNodeTypeName">ClassNodeTypeName</a></b>: string; 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>class function <b><a  href="X3DNodes.TInlineNode.html#URNMatching">URNMatching</a></b>(const URN: string): 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>class function <b><a  href="X3DNodes.TInlineNode.html#VRML1ChildrenSaveToStream">VRML1ChildrenSaveToStream</a></b>: boolean; 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>procedure <b><a  href="X3DNodes.TInlineNode.html#LoadInlined">LoadInlined</a></b>(CanReload: boolean; const CurrentLengthConversionFactor: <a  href="CastleUtils.html#Float">Float</a> = 1.0; Exported: <a  href="X3DNodes.TX3DNodeNames.html">TX3DNodeNames</a> = nil);</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="X3DNodes.TInlineNode.html#UnLoadInlined">UnLoadInlined</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="X3DNodes.TInlineNode.html#LoadedInlineDirectly">LoadedInlineDirectly</a></b>;</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="X3DNodes.TInlineNode.html#FdLoad">FdLoad</a></b>: <a  href="X3DFields.TSFBool.html">TSFBool</a> read FFdLoad;</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="X3DNodes.TInlineNode.html#FdUrl">FdUrl</a></b>: <a  href="X3DFields.TMFString.html">TMFString</a> read FFdUrl;</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="X3DNodes.TInlineNode.html#FdBboxCenter">FdBboxCenter</a></b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a> read FFdBboxCenter;</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="X3DNodes.TInlineNode.html#FdBboxSize">FdBboxSize</a></b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a> read FFdBboxSize;</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="X3DNodes.TInlineNode.html#Inlined">Inlined</a></b>: <a  href="X3DNodes.TX3DRootNode.html">TX3DRootNode</a> read FInlined;</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="BeforeTraverse"></a><code>procedure <b>BeforeTraverse</b>(StateStack: <a  href="X3DNodes.TX3DGraphTraverseStateStack.html">TX3DGraphTraverseStateStack</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="AfterTraverse"></a><code>procedure <b>AfterTraverse</b>(StateStack: <a  href="X3DNodes.TX3DGraphTraverseStateStack.html">TX3DGraphTraverseStateStack</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="AfterLoadInlined"></a><code>procedure <b>AfterLoadInlined</b>; virtual;</code></td>
</tr>
<tr><td colspan="2">
<p>
You can override this to do anything after the Inline children were loaded. It's called only after actual loading occurred, e.g. it's not called when <a class="normal" href="X3DNodes.TInlineNode.html#LoadInlined">LoadInlined</a> was called on the already-loaded node with CanReload = <code>False</code>.</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="DeepCopyCore"></a><code>function <b>DeepCopyCore</b>(CopyState: <a  href="X3DNodes.TX3DNodeDeepCopyState.html">TX3DNodeDeepCopyState</a>): <a  href="X3DNodes.TX3DNode.html">TX3DNode</a>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="ParseAfter"></a><code>procedure <b>ParseAfter</b>(Reader: <a  href="X3DNodes.TX3DReaderNames.html">TX3DReaderNames</a>); override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="CreateNode"></a><code>procedure <b>CreateNode</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="ClassNodeTypeName"></a><code>class function <b>ClassNodeTypeName</b>: string; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="URNMatching"></a><code>class function <b>URNMatching</b>(const URN: string): boolean; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="VRML1ChildrenSaveToStream"></a><code>class function <b>VRML1ChildrenSaveToStream</b>: boolean; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="LoadInlined"></a><code>procedure <b>LoadInlined</b>(CanReload: boolean; const CurrentLengthConversionFactor: <a  href="CastleUtils.html#Float">Float</a> = 1.0; Exported: <a  href="X3DNodes.TX3DNodeNames.html">TX3DNodeNames</a> = nil);</code></td>
</tr>
<tr><td colspan="2">
<p>
Load inlined content <b>now</b>. If <a class="normal" href="X3DNodes.TInlineNode.html#Inlined">Inlined</a> is already loaded: if CanReload = <code>True</code> then it will be freed and loaded again, else (if CanReload = <code>False</code>) nothing will happen.

<p>Note that this has a really simple support for &quot;load&quot; field (this concerns VRML 97 amendment 1 &quot;InlineLoadControl.load&quot; and X3D (actually used also in VRML 97 handling) &quot;Inline.load&quot; fields). It simply doesn't do any loading when &quot;load&quot; = <code>False</code>.

<p>Note that this doesn't perform setting the &quot;load&quot; field, or sending any notifications to Scene about &quot;load&quot; field. It's the caller's job to keep loaded state synchronized with &quot;load&quot; field value.

<p><code>LoadInlined</code>(false) will be called automatically, to ensure the inlined contents are always loaded. It will be called at the end of Parse (this is needed to handle VRML/X3D IMPORT/EXPORT mechanism), it will also be called in <a class="normal" href="X3DNodes.TInlineNode.html#BeforeTraverse">BeforeTraverse</a> (in case you constructed node by code, not by parsing; this also happens when node was made by expanding a PROTO).

<p></p>
<h6 class="description_section">Parameters</h6>
<dl class="parameters">
<dt>Exported</dt>
<dd>If non-nil, we will assign here node names exported from the file. Used to handle IMPORT/EXPORT X3D mechanism.</dd>
</dl>
</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="UnLoadInlined"></a><code>procedure <b>UnLoadInlined</b>;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="LoadedInlineDirectly"></a><code>procedure <b>LoadedInlineDirectly</b>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Call this to indicate that you loaded the inline contents directly, by using AddChild yourself.</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="FdLoad"></a><code>property <b>FdLoad</b>: <a  href="X3DFields.TSFBool.html">TSFBool</a> read FFdLoad;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="FdUrl"></a><code>property <b>FdUrl</b>: <a  href="X3DFields.TMFString.html">TMFString</a> read FFdUrl;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="FdBboxCenter"></a><code>property <b>FdBboxCenter</b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a> read FFdBboxCenter;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="FdBboxSize"></a><code>property <b>FdBboxSize</b>: <a  href="X3DFields.TSFVec3f.html">TSFVec3f</a> read FFdBboxSize;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="Inlined"></a><code>property <b>Inlined</b>: <a  href="X3DNodes.TX3DRootNode.html">TX3DRootNode</a> read FInlined;</code></td>
</tr>
<tr><td colspan="2">
<p>
The inlined content (loaded from inlined url). <code>Nil</code> if not yet loaded, or no loading was successful.

<p>This is also kept in VRML 1.0 children as Children[0], but for future it's better to not depend on that.</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&amp;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:14</em>
</span>
</td></tr></table></body></html>