File: X3DNodes.TAbstractSequencerNode.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 (197 lines) | stat: -rw-r--r-- 12,894 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
<!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 TAbstractSequencerNode</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="TAbstractSequencerNode"></a><h1 class="cio">Class TAbstractSequencerNode</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 TAbstractSequencerNode = class(<a class="normal" href="X3DNodes.TAbstractChildNode.html">TAbstractChildNode</a>)</code></p>
<h2 class="description">Description</h2>
<div class="nodescription">no description available, TAbstractChildNode description follows</div><div class="nodescription">no description available, TAbstractNode description follows</div><p>
Base X3D node.

<p>Almost all X3D nodes inherit from this. (Exception: X3DMetadataObject. So you cannot have metadata of metadata of...)</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="thisitem">TAbstractSequencerNode</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>function <b><a  href="X3DNodes.TAbstractSequencerNode.html#KeyRange">KeyRange</a></b>(const Fraction: Single): 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="X3DNodes.TAbstractSequencerNode.html#SetCurrentKeyRange">SetCurrentKeyRange</a></b>(const Value: Integer; const Time: <a  href="X3DTime.TX3DTime.html">TX3DTime</a>);</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.TAbstractSequencerNode.html#SendValueChanged">SendValueChanged</a></b>(const ValueIndex: Integer; const Time: <a  href="X3DTime.TX3DTime.html">TX3DTime</a>); virtual; abstract;</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.TAbstractSequencerNode.html#CreateNode">CreateNode</a></b>; 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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><code>property <b><a  href="X3DNodes.TAbstractSequencerNode.html#CurrentKeyRange">CurrentKeyRange</a></b>: Integer read FCurrentKeyRange;</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.TAbstractSequencerNode.html#EventNext">EventNext</a></b>: <a  href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</a> read FEventNext;</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.TAbstractSequencerNode.html#EventPrevious">EventPrevious</a></b>: <a  href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</a> read FEventPrevious;</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.TAbstractSequencerNode.html#EventSet_fraction">EventSet_fraction</a></b>: <a  href="X3DFields.TSFFloatEvent.html">TSFFloatEvent</a> read FEventSet_fraction;</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.TAbstractSequencerNode.html#FdKey">FdKey</a></b>: <a  href="X3DFields.TMFFloat.html">TMFFloat</a> read FFdKey;</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.TAbstractSequencerNode.html#FdForceContinousValue_Changed">FdForceContinousValue_Changed</a></b>: <a  href="X3DFields.TSFBool.html">TSFBool</a> read FFdForceContinousValue_Changed;</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="KeyRange"></a><code>function <b>KeyRange</b>(const Fraction: Single): Integer;</code></td>
</tr>
<tr><td colspan="2">
<p>
Analogous to <a class="normal" href="X3DNodes.TAbstractInterpolatorNode.html#KeyRange">TAbstractInterpolatorNode.KeyRange</a>.</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="SetCurrentKeyRange"></a><code>procedure <b>SetCurrentKeyRange</b>(const Value: Integer; const Time: <a  href="X3DTime.TX3DTime.html">TX3DTime</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="SendValueChanged"></a><code>procedure <b>SendValueChanged</b>(const ValueIndex: Integer; const Time: <a  href="X3DTime.TX3DTime.html">TX3DTime</a>); virtual; abstract;</code></td>
</tr>
<tr><td colspan="2">
<p>
Override this is descendants to actually send value_changed event witk keyValue[ValueIndex]. You are guaranteed that ValueIndex is between 0 and FdKey.Count - 1, but you have to check yourself whether it's also between 0 and FdKeyValue.Count - 1 (although spec requires that key and keyValue fields have the same size, we have to protect against invalid files).</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="CreateNode"></a><code>procedure <b>CreateNode</b>; override;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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="protected.gif" alt="Protected" title="Protected"></a></td>
<td class="itemcode"><a name="CurrentKeyRange"></a><code>property <b>CurrentKeyRange</b>: Integer read FCurrentKeyRange;</code></td>
</tr>
<tr><td colspan="2">
<p>
In what key range we currently are. In other words, which keyValue was last send (passed to <a class="normal" href="X3DNodes.TAbstractSequencerNode.html#SendValueChanged">SendValueChanged</a>).

<p>We have to keep track of this information, per each node, as specification clearly says that value_changed should not be generated continously on each set_fraction, but only when value actually changes. (Although we make an exception for this with our extension <a class="normal" href="X3DNodes.TAbstractSequencerNode.html#FdForceContinousValue_Changed">FdForceContinousValue_Changed</a>).

<p>Valid values here are between -1 and FdKey.Count - 1. Values between 0 and FdKey.Count - 1 indicate which keyValue was last send. Value -1 means that <a class="normal" href="X3DNodes.TAbstractSequencerNode.html#SendValueChanged">SendValueChanged</a> was not yet called, this is the default value (after construction).</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="EventNext"></a><code>property <b>EventNext</b>: <a  href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</a> read FEventNext;</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="EventPrevious"></a><code>property <b>EventPrevious</b>: <a  href="X3DFields.TSFBoolEvent.html">TSFBoolEvent</a> read FEventPrevious;</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="EventSet_fraction"></a><code>property <b>EventSet_fraction</b>: <a  href="X3DFields.TSFFloatEvent.html">TSFFloatEvent</a> read FEventSet_fraction;</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="FdKey"></a><code>property <b>FdKey</b>: <a  href="X3DFields.TMFFloat.html">TMFFloat</a> read FFdKey;</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="FdForceContinousValue_Changed"></a><code>property <b>FdForceContinousValue_Changed</b>: <a  href="X3DFields.TSFBool.html">TSFBool</a> read FFdForceContinousValue_Changed;</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</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:16</em>
</span>
</td></tr></table></body></html>