aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02206.html
blob: e4a88503ff91eea53e0dbc4843bd58243a073dcb (plain)
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
322
323
324
325
326
327
328
329
330
331
332
333
334
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>NeL: NL3D::UAnimation class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex">  <form class="search" action="search.php" method="get">
<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a>  | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
<h1>NL3D::UAnimation Class Reference</h1><code>#include &lt;<a class="el" href="a06592.html">u_animation.h</a>&gt;</code>
<p>
<p>Inheritance diagram for NL3D::UAnimation:
<p><center><img src="a02206.png" usemap="#NL3D::UAnimation_map" border="0" alt=""></center>
<map name="NL3D::UAnimation_map">
<area href="a02205.html" alt="NL3D::CAnimation" shape="rect" coords="0,56,114,80">
</map>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Give manual access to the animation functions.<p>
By this interface, you can load animations, get tracks from this animation with there names, and interpolate manually value from those tracks.<p>
This interface is not made to work with <a class="el" href="a02212.html">UAnimationSet</a> or <a class="el" href="a03089.html">UPlayList</a>. <a class="el" href="a02206.html">UAnimation</a> has its own methods to load / release animations.<p>
<dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p>
Nevrax France </dd></dl>
<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>

<p>

<p>
Definition at line <a class="el" href="a06592.html#l00050">50</a> of file <a class="el" href="a06592.html">u_animation.h</a>.<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02206.html#NL3D_1_1UAnimationa0">allTrackLoop</a> () const=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05363.html#a366">TAnimationTime</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02206.html#NL3D_1_1UAnimationa1">getBeginTime</a> () const=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a05363.html#a366">TAnimationTime</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02206.html#NL3D_1_1UAnimationa2">getEndTime</a> () const=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03881.html">UTrack</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02206.html#NL3D_1_1UAnimationa3">getTrackByName</a> (const char *name)=0</td></tr>

<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02206.html#NL3D_1_1UAnimationa4">releaseTrack</a> (<a class="el" href="a03881.html">UTrack</a> *track)=0</td></tr>

</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="NL3D_1_1UAnimationa0" doxytag="NL3D::UAnimation::allTrackLoop" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual bool NL3D::UAnimation::allTrackLoop </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Say if all track of this animation loop. NB: If no tracks in the animation, return true
<p>
Implemented in <a class="el" href="a02205.html#NL3D_1_1CAnimationz24_0">NL3D::CAnimation</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1UAnimationz1370_0" doxytag="NL3D::UAnimation::createAnimation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> <a class="el" href="a02206.html">UAnimation</a> * NL3D::UAnimation::createAnimation </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>sPath</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Load an animation. This method will use CPath to find the good animation file. (*.anim). You should call releaseAnimation to delete the animation.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>sPath</em>&nbsp;</td><td>is the animation file path. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>NULL if the file is not found. Else return the pointer on the animation interface.</dd></dl>

<p>
Definition at line <a class="el" href="a05443.html#l00259">259</a> of file <a class="el" href="a05443.html">animation.cpp</a>.
<p>
References <a class="el" href="a05538.html#l02654">file</a>, <a class="el" href="a04020.html#a0">NL3D_HAUTO_UI_ANIMATION</a>, and <a class="el" href="a05444.html#l00045">NL3D_MEM_ANIMATION</a>.
<p>
<div class="fragment"><pre>00260 {
00261         <a class="code" href="a04021.html#a0">NL3D_MEM_ANIMATION</a>
00262         <a class="code" href="a04020.html#a0">NL3D_HAUTO_UI_ANIMATION</a>;
00263 
00264         <span class="comment">// Allocate an animation</span>
00265         std::auto_ptr&lt;CAnimation&gt; anim (<span class="keyword">new</span> CAnimation);
00266 
00267         <span class="comment">// Read it</span>
00268         <a class="code" href="a02653.html">NLMISC::CIFile</a> <a class="code" href="a04115.html#a95">file</a>;
00269         <span class="keywordflow">if</span> (<a class="code" href="a04115.html#a95">file</a>.open ( NLMISC::CPath::lookup( sPath ) ) )
00270         {
00271                 <span class="comment">// Serial the animation</span>
00272                 <a class="code" href="a04115.html#a95">file</a>.serial (*anim);
00273 
00274                 <span class="comment">// Return pointer</span>
00275                 CAnimation *ret=anim.release ();
00276 
00277                 <span class="comment">// Return the animation interface</span>
00278                 <span class="keywordflow">return</span> ret;
00279         }
00280         <span class="keywordflow">else</span> 
00281                 <span class="keywordflow">return</span> NULL;
00282 }
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1UAnimationa1" doxytag="NL3D::UAnimation::getBeginTime" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual <a class="el" href="a05363.html#a366">TAnimationTime</a> NL3D::UAnimation::getBeginTime </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get begin time of the animation.<p>
<dl compact><dt><b>Returns:</b></dt><dd>the begin time.</dd></dl>

<p>
Implemented in <a class="el" href="a02205.html#NL3D_1_1CAnimationz24_1">NL3D::CAnimation</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1UAnimationa2" doxytag="NL3D::UAnimation::getEndTime" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual <a class="el" href="a05363.html#a366">TAnimationTime</a> NL3D::UAnimation::getEndTime </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const<code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get end time of the animation.<p>
<dl compact><dt><b>Returns:</b></dt><dd>the end time.</dd></dl>

<p>
Implemented in <a class="el" href="a02205.html#NL3D_1_1CAnimationz24_2">NL3D::CAnimation</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1UAnimationa3" doxytag="NL3D::UAnimation::getTrackByName" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual <a class="el" href="a03881.html">UTrack</a>* NL3D::UAnimation::getTrackByName </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">const char *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>name</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Get an animation track with its name. The track interface should be released with releaseTrack.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>name</em>&nbsp;</td><td>is the name of the track to get. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>NULL if the track is not found, else a pointer on the track interface.</dd></dl>

<p>
Implemented in <a class="el" href="a02205.html#NL3D_1_1CAnimationz24_3">NL3D::CAnimation</a>.    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1UAnimationz1370_1" doxytag="NL3D::UAnimation::releaseAnimation" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> void NL3D::UAnimation::releaseAnimation </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a02206.html">UAnimation</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>animation</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [static]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Release an animation. This animation must have been created will <a class="el" href="a02206.html#NL3D_1_1UAnimationz1370_0">createAnimation()</a>.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>animation</em>&nbsp;</td><td>is the animation to release.</td></tr>
  </table>
</dl>

<p>
Definition at line <a class="el" href="a05443.html#l00286">286</a> of file <a class="el" href="a05443.html">animation.cpp</a>.
<p>
References <a class="el" href="a04020.html#a0">NL3D_HAUTO_UI_ANIMATION</a>, and <a class="el" href="a05444.html#l00045">NL3D_MEM_ANIMATION</a>.
<p>
<div class="fragment"><pre>00287 {
00288         <a class="code" href="a04021.html#a0">NL3D_MEM_ANIMATION</a>
00289         <a class="code" href="a04020.html#a0">NL3D_HAUTO_UI_ANIMATION</a>;
00290 
00291         <span class="comment">// Cast the pointer</span>
00292         CAnimation* release=(CAnimation*)animation;
00293 
00294         <span class="comment">// Delete it</span>
00295         <span class="keyword">delete</span> release;
00296 }
</pre></div>    </td>
  </tr>
</table>
<a class="anchor" name="NL3D_1_1UAnimationa4" doxytag="NL3D::UAnimation::releaseTrack" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> virtual void NL3D::UAnimation::releaseTrack </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="a03881.html">UTrack</a> *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>track</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap><code> [pure virtual]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Relase a track interface.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign=top><em>track</em>&nbsp;</td><td>is a pointer on the track interface to release.</td></tr>
  </table>
</dl>

<p>
Implemented in <a class="el" href="a02205.html#NL3D_1_1CAnimationz24_4">NL3D::CAnimation</a>.    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="a06592.html">u_animation.h</a><li><a class="el" href="a05443.html">animation.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:42:19 2004 for NeL by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 > 
</a>1.3.6 </small></address>
</body>
</html>