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
|
<!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 TTimeDependentNodeHandler</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="TTimeDependentNodeHandler"></a><h1 class="cio">Class TTimeDependentNodeHandler</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="X3DNodes.html">X3DNodes</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TTimeDependentNodeHandler = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Common helper for all X3DTimeDependentNode descendants. This includes things descending from interface <a class="normal" href="X3DNodes.IAbstractTimeDependentNode.html">IAbstractTimeDependentNode</a>, in particular (but not only) descending from class <a class="normal" href="X3DNodes.TAbstractTimeDependentNode.html">TAbstractTimeDependentNode</a>.
<p>It would be cleaner to have Node declared as <a class="normal" href="X3DNodes.IAbstractTimeDependentNode.html">IAbstractTimeDependentNode</a>, and have <a class="normal" href="X3DNodes.IAbstractTimeDependentNode.html">IAbstractTimeDependentNode</a> contain common fields. Then a lot of fields of this class would not be needed, as they would be accessible as <a class="normal" href="X3DNodes.IAbstractTimeDependentNode.html">IAbstractTimeDependentNode</a> fields. TODO: maybe in the future.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">TTimeDependentNodeHandler</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code><b><a href="X3DNodes.TTimeDependentNodeHandler.html#Node">Node</a></b>: <a href="X3DNodes.TX3DNode.html">TX3DNode</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="X3DNodes.TTimeDependentNodeHandler.html#CurrentTime">CurrentTime</a></b>: <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><b><a href="X3DNodes.TTimeDependentNodeHandler.html#OnCycleInterval">OnCycleInterval</a></b>: <a href="X3DNodes.html#TTimeFunction">TTimeFunction</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="X3DNodes.TTimeDependentNodeHandler.html#Fdloop">Fdloop</a></b>: <a href="X3DFields.TSFBool.html">TSFBool</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><b><a href="X3DNodes.TTimeDependentNodeHandler.html#FdpauseTime">FdpauseTime</a></b>: <a href="X3DFields.TSFTime.html">TSFTime</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="X3DNodes.TTimeDependentNodeHandler.html#FdresumeTime">FdresumeTime</a></b>: <a href="X3DFields.TSFTime.html">TSFTime</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><b><a href="X3DNodes.TTimeDependentNodeHandler.html#FdstartTime">FdstartTime</a></b>: <a href="X3DFields.TSFTime.html">TSFTime</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="X3DNodes.TTimeDependentNodeHandler.html#FdstopTime">FdstopTime</a></b>: <a href="X3DFields.TSFTime.html">TSFTime</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><b><a href="X3DNodes.TTimeDependentNodeHandler.html#Fdenabled">Fdenabled</a></b>: <a href="X3DFields.TSFBool.html">TSFBool</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="X3DNodes.TTimeDependentNodeHandler.html#EventelapsedTime">EventelapsedTime</a></b>: <a href="X3DFields.TSFTimeEvent.html">TSFTimeEvent</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><b><a href="X3DNodes.TTimeDependentNodeHandler.html#EventisActive">EventisActive</a></b>: <a href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</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="X3DNodes.TTimeDependentNodeHandler.html#EventisPaused">EventisPaused</a></b>: <a href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</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><b><a href="X3DNodes.TTimeDependentNodeHandler.html#EventcycleTime">EventcycleTime</a></b>: <a href="X3DFields.TSFTimeEvent.html">TSFTimeEvent</a>;</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a href="X3DNodes.TTimeDependentNodeHandler.html#CycleInterval">CycleInterval</a></b>: <a href="X3DTime.html#TFloatTime">TFloatTime</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>function <b><a href="X3DNodes.TTimeDependentNodeHandler.html#SetTime">SetTime</a></b>(const OldValue, NewValue: <a href="X3DTime.TX3DTime.html">TX3DTime</a>; const TimeIncrease: <a href="X3DTime.html#TFloatTime">TFloatTime</a>; const ResetTime: boolean): boolean;</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.TTimeDependentNodeHandler.html#IsActive">IsActive</a></b>: boolean read FIsActive write SetIsActive;</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.TTimeDependentNodeHandler.html#IsPaused">IsPaused</a></b>: boolean read FIsPaused write SetIsPaused;</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.TTimeDependentNodeHandler.html#ElapsedTime">ElapsedTime</a></b>: <a href="X3DTime.html#TFloatTime">TFloatTime</a> read FElapsedTime write SetElapsedTime;</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.TTimeDependentNodeHandler.html#ElapsedTimeInCycle">ElapsedTimeInCycle</a></b>: <a href="X3DTime.html#TFloatTime">TFloatTime</a> read FElapsedTimeInCycle;</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Node"></a><code><b>Node</b>: <a href="X3DNodes.TX3DNode.html">TX3DNode</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="CurrentTime"></a><code><b>CurrentTime</b>: <a href="X3DTime.TX3DTime.html">TX3DTime</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="OnCycleInterval"></a><code><b>OnCycleInterval</b>: <a href="X3DNodes.html#TTimeFunction">TTimeFunction</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Cycle interval for this time-dependent node.</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="Fdloop"></a><code><b>Fdloop</b>: <a href="X3DFields.TSFBool.html">TSFBool</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="FdpauseTime"></a><code><b>FdpauseTime</b>: <a href="X3DFields.TSFTime.html">TSFTime</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="FdresumeTime"></a><code><b>FdresumeTime</b>: <a href="X3DFields.TSFTime.html">TSFTime</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="FdstartTime"></a><code><b>FdstartTime</b>: <a href="X3DFields.TSFTime.html">TSFTime</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="FdstopTime"></a><code><b>FdstopTime</b>: <a href="X3DFields.TSFTime.html">TSFTime</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="Fdenabled"></a><code><b>Fdenabled</b>: <a href="X3DFields.TSFBool.html">TSFBool</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
May be <code>Nil</code> if node doesn't have an "enabled" field.</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="EventelapsedTime"></a><code><b>EventelapsedTime</b>: <a href="X3DFields.TSFTimeEvent.html">TSFTimeEvent</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="EventisActive"></a><code><b>EventisActive</b>: <a href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</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="EventisPaused"></a><code><b>EventisPaused</b>: <a href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</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="EventcycleTime"></a><code><b>EventcycleTime</b>: <a href="X3DFields.TSFTimeEvent.html">TSFTimeEvent</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
May be <code>Nil</code> if node doesn't have a "cycleTime" event.</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="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="CycleInterval"></a><code>function <b>CycleInterval</b>: <a href="X3DTime.html#TFloatTime">TFloatTime</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="SetTime"></a><code>function <b>SetTime</b>(const OldValue, NewValue: <a href="X3DTime.TX3DTime.html">TX3DTime</a>; const TimeIncrease: <a href="X3DTime.html#TFloatTime">TFloatTime</a>; const ResetTime: boolean): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Call this when world time increases. This is the most important method of this class, that basically implements time-dependent nodes operations.
<p>OldValue, NewValue and TimeIncrease must match, as produced by <a class="normal" href="CastleSceneCore.TCastleSceneCore.html#SetTime">TCastleSceneCore.SetTime</a> and friends.
<p>When ResetTime = true, this means that "TimeIncrease value is unknown" (you <i>must</i> pass TimeIncrease = 0 in this case). This can happen only when were called by ResetTime.
<p>In other circumstances, TimeIncrease must be >= 0. (It's allowed to pass TimeIncrease = 0 and ResetTime = false, this doesn't advance the clock, but is a useful trick to force some update, see TVRMScene.ChangedField implementation.)
<p>References: see X3D specification "Time" component, 8.2 ("concepts") for logic behind all those start/stop/pause/resumeTime, <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#CycleInterval">cycleInterval</a>, loop properties.
<p></p>
<h6 class="description_section">Returns</h6>
<p class="return">If some state of time-dependent node changed.</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="IsActive"></a><code>property <b>IsActive</b>: boolean read FIsActive write SetIsActive;</code></td>
</tr>
<tr><td colspan="2">
<p>
These describe current state of this TimeDependentNode, see X3D specification about "Time" component.
<p>Their setting causes appropriate events to be generated (with Time = <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#CurrentTime">CurrentTime</a>, so be sure to update it before changing these properties. <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#SetTime">SetTime</a> automatically does this for you.).
<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="IsPaused"></a><code>property <b>IsPaused</b>: boolean read FIsPaused write SetIsPaused;</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="ElapsedTime"></a><code>property <b>ElapsedTime</b>: <a href="X3DTime.html#TFloatTime">TFloatTime</a> read FElapsedTime write SetElapsedTime;</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="ElapsedTimeInCycle"></a><code>property <b>ElapsedTimeInCycle</b>: <a href="X3DTime.html#TFloatTime">TFloatTime</a> read FElapsedTimeInCycle;</code></td>
</tr>
<tr><td colspan="2">
<p>
Like <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#ElapsedTime">ElapsedTime</a>, but spent in the current cycle. When <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#CycleInterval">cycleInterval</a> = 0, this is always 0. When <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#CycleInterval">cycleInterval</a> <> 0, this is always >= 0 and < <a class="normal" href="X3DNodes.TTimeDependentNodeHandler.html#CycleInterval">cycleInterval</a> .</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:14</em>
</span>
</td></tr></table></body></html>
|
