File: X3DFields.TX3DEvent.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 (269 lines) | stat: -rw-r--r-- 16,888 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
 
<!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 TX3DEvent</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="TX3DEvent"></a><h1 class="cio">Class TX3DEvent</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 TX3DEvent = class(<a class="normal" href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a>)</code></p>
<h2 class="description">Description</h2>
<p>
X3D 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="ancestor"><a class="normal" href="X3DFields.TX3DFieldOrEvent.html">TX3DFieldOrEvent</a></li>
<li class="thisitem">TX3DEvent</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>constructor <b><a  href="X3DFields.TX3DEvent.html#Create">Create</a></b>(AParentNode: <a  href="X3DFields.TX3DFileItem.html">TX3DFileItem</a>; const AName: string; const AFieldClass: <a  href="X3DFields.html#TX3DFieldClass">TX3DFieldClass</a>; const AInEvent: 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>destructor <b><a  href="X3DFields.TX3DEvent.html#Destroy">Destroy</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>procedure <b><a  href="X3DFields.TX3DEvent.html#Parse">Parse</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.TX3DEvent.html#SaveToStream">SaveToStream</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="X3DFields.TX3DEvent.html#SaveToXml">SaveToXml</a></b>: <a  href="X3DFields.html#TSaveToXmlMethod">TSaveToXmlMethod</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="X3DFields.TX3DEvent.html#Send">Send</a></b>(Field: <a  href="X3DFields.TX3DField.html">TX3DField</a>; const Time: <a  href="X3DTime.TX3DTime.html">TX3DTime</a>);</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.TX3DEvent.html#Send">Send</a></b>(Field: <a  href="X3DFields.TX3DField.html">TX3DField</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.TX3DEvent.html#RemoveHandler">RemoveHandler</a></b>(Handler: <a  href="X3DFields.html#TX3DEventReceive">TX3DEventReceive</a>);</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.TX3DEvent.html#SendNeeded">SendNeeded</a></b>: 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>procedure <b><a  href="X3DFields.TX3DEvent.html#Assign">Assign</a></b>(Source: TPersistent); 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.TX3DEvent.html#FieldClass">FieldClass</a></b>: <a  href="X3DFields.html#TX3DFieldClass">TX3DFieldClass</a> read FFieldClass;</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.TX3DEvent.html#InEvent">InEvent</a></b>: boolean read FInEvent;</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.TX3DEvent.html#ParentExposedField">ParentExposedField</a></b>: <a  href="X3DFields.TX3DField.html">TX3DField</a>
      read FParentExposedField write FParentExposedField;</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.TX3DEvent.html#OnReceive">OnReceive</a></b>: <a  href="X3DFields.TX3DEventReceiveList.html">TX3DEventReceiveList</a> read FOnReceive;</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="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; const AFieldClass: <a  href="X3DFields.html#TX3DFieldClass">TX3DFieldClass</a>; const AInEvent: boolean);</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="Destroy"></a><code>destructor <b>Destroy</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="Parse"></a><code>procedure <b>Parse</b>(Lexer: <a  href="X3DLexer.TX3DLexer.html">TX3DLexer</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
This only reads (optional) &quot;IS&quot; clause of the event, as may occur in VRML nodeBodyStatement.</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="SaveToStream"></a><code>procedure <b>SaveToStream</b>(Writer: <a  href="X3DFields.TX3DWriter.html">TX3DWriter</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="SaveToXml"></a><code>function <b>SaveToXml</b>: <a  href="X3DFields.html#TSaveToXmlMethod">TSaveToXmlMethod</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="Send"></a><code>procedure <b>Send</b>(Field: <a  href="X3DFields.TX3DField.html">TX3DField</a>; const Time: <a  href="X3DTime.TX3DTime.html">TX3DTime</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Send a value to event. For input fields, this is used by routes, scripts etc. to send an event to a field. For output fields, this is used by node itself to send event to routes, scripts etc.

<p>Field must be non-nil, of class <a class="normal" href="X3DFields.TX3DEvent.html#FieldClass">FieldClass</a>.

<p>The Field instance doesn't become owned in any way by the <a class="normal" href="X3DFields.TX3DEvent.html">TX3DEvent</a>. That is, it's the caller responsibility to free the Field instance at any comfortable time, possibly right after calling Send.

<p>Overloaded versions without explicit Time parameter just take time from ParentNode.Scene.GetTime. If <a class="normal" href="X3DFields.TX3DFieldOrEvent.html#ParentNode">ParentNode</a> is <code>Nil</code> (which should not happen with normal fields within nodes) or if ParentNode.Scene is <code>Nil</code> (which may happen only if events processing is not turned on, that is <a class="normal" href="CastleSceneCore.TCastleSceneCore.html#ProcessEvents">TCastleSceneCore.ProcessEvents</a> is <code>False</code>) then event is not send.</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="Send"></a><code>procedure <b>Send</b>(Field: <a  href="X3DFields.TX3DField.html">TX3DField</a>);</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="RemoveHandler"></a><code>procedure <b>RemoveHandler</b>(Handler: <a  href="X3DFields.html#TX3DEventReceive">TX3DEventReceive</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Safely remove a callback from <a class="normal" href="X3DFields.TX3DEvent.html#OnReceive">OnReceive</a> list.

<p>Contrary to direct <code>OnReceive.Remove</code> call, this works correctly even if we're right now in the middle of this event's processing. In the latter case, the handler will be actually removed with some delay (when it's safe).</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="SendNeeded"></a><code>function <b>SendNeeded</b>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Is anything actually listening on this events <a class="normal" href="X3DFields.TX3DEvent.html#Send">Send</a>?</p>
<p>


<p>Sometimes, even preparing a value to Send is quite time-consuming (example: CoordinateInterpolator, where a long MFVec3f value has to be computer). Then checking <code>SendNeeded</code> is useful: if <code>SendNeeded</code> = <code>False</code>, you know that there's no point in preparing Value to send, because actually Send will do nothing.

<p>For example, event out to which no ROUTE is connected, and no Script can listen to it.

<p>For now, this simply returns whether any <a class="normal" href="X3DFields.TX3DEvent.html#OnReceive">OnReceive</a> callback is registered.</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="Assign"></a><code>procedure <b>Assign</b>(Source: TPersistent); override;</code></td>
</tr>
<tr><td colspan="2">
<p>
Assign from another event. Note that <a class="normal" href="X3DFields.TX3DEvent.html#FieldClass">FieldClass</a>, <a class="normal" href="X3DFields.TX3DEvent.html#InEvent">InEvent</a> is copied.

<p><a class="normal" href="X3DFields.TX3DEvent.html#OnReceive">OnReceive</a>, <a class="normal" href="X3DFields.TX3DEvent.html#ParentExposedField">ParentExposedField</a> are not copied, since they shouldn't be copied so easily (<a class="normal" href="X3DFields.TX3DEvent.html#ParentExposedField">ParentExposedField</a> is related to hierarchy of containers, and <a class="normal" href="X3DFields.TX3DEvent.html#OnReceive">OnReceive</a> requires some knowledge of the caller when his callback is copied).</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="FieldClass"></a><code>property <b>FieldClass</b>: <a  href="X3DFields.html#TX3DFieldClass">TX3DFieldClass</a> read FFieldClass;</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="InEvent"></a><code>property <b>InEvent</b>: boolean read FInEvent;</code></td>
</tr>
<tr><td colspan="2">
<p>
Is it &quot;in&quot; or &quot;out&quot; event ?</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="ParentExposedField"></a><code>property <b>ParentExposedField</b>: <a  href="X3DFields.TX3DField.html">TX3DField</a>
      read FParentExposedField write FParentExposedField;</code></td>
</tr>
<tr><td colspan="2">
<p>
If this event is an exposed event belonging to some field, this references parent field. Otherwise it's <code>Nil</code>.</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="OnReceive"></a><code>property <b>OnReceive</b>: <a  href="X3DFields.TX3DEventReceiveList.html">TX3DEventReceiveList</a> read FOnReceive;</code></td>
</tr>
<tr><td colspan="2">
<p>
Notifications about receiving an item. For input fields, these are used by node itself to listen to events send to it. For output fields, these are used by routes, scripts to listen to events occuring.

<p>All callbacks here are simply called by <a class="normal" href="X3DFields.TX3DEvent.html#Send">Send</a> method.</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>