File: CastleResources.T3DResourceAnimation.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 (188 lines) | stat: -rw-r--r-- 12,215 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
 
<!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: CastleResources: Class T3DResourceAnimation</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="T3DResourceAnimation"></a><h1 class="cio">Class T3DResourceAnimation</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="CastleResources.html">CastleResources</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type T3DResourceAnimation = class(TObject)</code></p>
<h2 class="description">Description</h2>
<p>
Animation defined by <a class="normal" href="CastleResources.T3DResource.html">T3DResource</a>.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TObject</li>
<li class="thisitem">T3DResourceAnimation</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="CastleResources.T3DResourceAnimation.html#Create">Create</a></b>(const AOwner: <a  href="CastleResources.T3DResource.html">T3DResource</a>; const AName: string; const ARequired: boolean = true);</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="CastleResources.T3DResourceAnimation.html#BoundingBox">BoundingBox</a></b>: <a  href="CastleBoxes.TBox3D.html">TBox3D</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="CastleResources.T3DResourceAnimation.html#Defined">Defined</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>function <b><a  href="CastleResources.T3DResourceAnimation.html#Scene">Scene</a></b>(const Time: Single; const Loop: boolean): <a  href="CastleScene.TCastleScene.html">TCastleScene</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="CastleResources.T3DResourceAnimation.html#Duration">Duration</a></b>: Single read FDuration;</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="CastleResources.T3DResourceAnimation.html#URL">URL</a></b>: string read FURL write FURL;</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="CastleResources.T3DResourceAnimation.html#TimeSensor">TimeSensor</a></b>: string read FTimeSensor write FTimeSensor;</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="CastleResources.T3DResourceAnimation.html#Name">Name</a></b>: string read FName;</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="CastleResources.T3DResourceAnimation.html#Required">Required</a></b>: boolean read FRequired;</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>(const AOwner: <a  href="CastleResources.T3DResource.html">T3DResource</a>; const AName: string; const ARequired: boolean = true);</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="BoundingBox"></a><code>function <b>BoundingBox</b>: <a  href="CastleBoxes.TBox3D.html">TBox3D</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="Defined"></a><code>function <b>Defined</b>: boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Was the animation state defined in resource.xml file. May be <code>False</code> only if <a class="normal" href="CastleResources.T3DResourceAnimation.html#Required">Required</a> was <code>False</code>, or before we actually read animation info from resource.xml file.</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="Scene"></a><code>function <b>Scene</b>(const Time: Single; const Loop: boolean): <a  href="CastleScene.TCastleScene.html">TCastleScene</a>;</code></td>
</tr>
<tr><td colspan="2">
<p>
Current Scene to render for given time.

<p>Looping is automatically done here, if parameter Loop is <code>True</code>. When it is <code>False</code>, there is no looping, which means that when Time is &lt; 0, we show the first frame, and when Time is &gt; <a class="normal" href="CastleResources.T3DResourceAnimation.html#Duration">Duration</a>, we show the last frame forever.

<p>This looping (or not looping) is done regardless of whether the 3D model wants (or not) looping. For example, in case of kanim files, we ignore their loop boolean attribute. In case of X3D <a class="normal" href="CastleResources.T3DResourceAnimation.html#TimeSensor">TimeSensor</a> node, we ignore TimeSensor.loop field. In other words, any looping settings inside 3D model are ignored. You control looping fully by the Loop parameter to this method.

<p>If we use <a class="normal" href="CastlePrecalculatedAnimation.TCastlePrecalculatedAnimation.html">TCastlePrecalculatedAnimation</a> underneath, then this returns appropriate frame of this animation.

<p>If we use <a class="normal" href="CastleScene.TCastleScene.html">TCastleScene</a> with <a class="normal" href="CastleResources.T3DResourceAnimation.html#TimeSensor">TimeSensor</a> underneath, then this returns the scene with state reflecting given time &mdash; in other words, we'll send proper events to <a class="normal" href="CastleResources.T3DResourceAnimation.html#TimeSensor">TimeSensor</a> to make this Time current.</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="Duration"></a><code>property <b>Duration</b>: Single read FDuration;</code></td>
</tr>
<tr><td colspan="2">
<p>
Duration of the animation. See engine tutorial about how resources animations duration is calculated. Always 0 if not <a class="normal" href="CastleResources.T3DResourceAnimation.html#Defined">Defined</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="URL"></a><code>property <b>URL</b>: string read FURL write FURL;</code></td>
</tr>
<tr><td colspan="2">
<p>
Animation <code>URL</code>, only when each animation is inside a separate 3D file. See [<a  href="http://castle-engine.sourceforge.net/creating_data_resources.php">http://castle-engine.sourceforge.net/creating_data_resources.php</a>] for documentation how you can define creature animations.</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="TimeSensor"></a><code>property <b>TimeSensor</b>: string read FTimeSensor write FTimeSensor;</code></td>
</tr>
<tr><td colspan="2">
<p>
Time sensor name, when animations are started by X3D <code>TimeSensor</code> node. This refers to an X3D <code>TimeSensor</code> node inside animation model (from <a class="normal" href="CastleResources.T3DResourceAnimation.html#URL">URL</a>) or, when not defined, inside whole resource model (from <a class="normal" href="CastleResources.T3DResource.html#ModelURL">T3DResource.ModelURL</a>).

<p>See [<a  href="http://castle-engine.sourceforge.net/creating_data_resources.php">http://castle-engine.sourceforge.net/creating_data_resources.php</a>] for documentation how you can define creature animations.</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="Name"></a><code>property <b>Name</b>: string read FName;</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="Required"></a><code>property <b>Required</b>: boolean read FRequired;</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:11</em>
</span>
</td></tr></table></body></html>