aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/animation_8h-source.html
blob: 9f44bfd5a3ca3bca997d33727bcc6082d161f8af (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
<!doctype html public "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">
<HTML>
<HEAD>
	<TITLE>nevrax.org : docs</TITLE>
	<LINK REL=stylesheet TYPE="text/css" HREF="http://www.nevrax.org/inc/css/nevrax.css">
	<link href="doxygen.css" rel="stylesheet" type="text/css">
</HEAD>
<BODY MARGINHEIGHT="0" MARGINWIDTH="0">

<!-- uplinks -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0>
 <TR>
        <TD WIDTH=16><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=140 BGCOLOR=#dddddd><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD WIDTH=16><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
        <TD><IMG width=6 height=14 SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.org><b>Home</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
        <TD><IMG  width=6 height=14  SRC="http://www.nevrax.org/inc/img/reddots.gif" ALT="#" VSPACE=2 HSPACE=2 BORDER=0 ></TD><TD VALIGN=middle>&nbsp;<A CLASS=uplinks HREF=http://www.nevrax.com><b>nevrax.com</B></FONT></A>&nbsp;&nbsp;&nbsp;</TD>
 </TR>
</TABLE> 

<!-- banner Nevrax -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 WIDTH=100%>
 <TR><TD  BGCOLOR="#000000" BACKGROUND="http://www.nevrax.org/inc/img/black_banner.jpg"><A HREF="http://www.nevrax.org"><IMG  SRC="http://www.nevrax.org/inc/img/nevrax.gif" WIDTH="170" HEIGHT="45" BORDER=0 ALT="Nevrax" ></A></TD></TR>
</TABLE>

<!-- main table -->
<TABLE CELLSPACING=0 CELLPADDING=0  BORDER=0 height=100%>
 <TR>
	<TD WIDTH=16><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="10" BORDER=0 ALT=""></TD>
	<TD WIDTH=140   BGCOLOR=#dddddd VALIGN=TOP ALIGN=middle><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

		<!------ Begin Box ------>
		<TABLE BORDER=0 CELLSPACING=0 CELLPADDING=0 BGCOLOR=black><TR><TD><TABLE border=0  cellspacing=2 cellpadding=0 width=120><tr><TD ALIGN=middle bgcolor=black>
		<FONT COLOR=white FACE="sans-serif"><B>Nevrax.org</B></FONT></TD></TR><tr><td  colspan=2 bgcolor=#FFFFFF>
		<TABLE cellspacing=0 cellpadding=1 border=0>
			<tr><td ALIGN=middle><a  class='linkbox' href="http://www.nevrax.org/news/" TITLE="Rubrique news"><img width=13 height=15  hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-news.gif ALT=#></A></td><td><a  class='linkbox' href="http://www.nevrax.org/news/" TITLE="News">News</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Rubrique mail"><img width=15 height=11  hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-mail.gif ALT=#></A></td><td><a  class='linkbox' href="http://www.nevrax.org/mail/" TITLE="Mailing list archive">Mailing-list</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Rubrique docs"><img width=14 height=16  hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-docs.gif ALT=#></A></td><td><a  class='linkbox' href="http://www.nevrax.org/docs/" TITLE="Documentation">Documentation</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="Rubrique cvs"><img width=13 height=17  hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-cvs.gif ALT=#></A></td><td><a  class='linkbox' href="http://www.nevrax.org/cvs/" TITLE="CVS Web">CVS</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Rubrique bugs"><img width=20 height=16  hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-bugs.gif ALT=#></A></td><td><a  class='linkbox' href="http://www.nevrax.org/bugs/" TITLE="Bugtracking">Bugs</a></td></tr>
			<tr><td ALIGN=middle><a  class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="Rubrique license"><img  width=18 height=12   hspace=5 border=0 src=http://www.nevrax.org/inc/img/picto-gpl.gif ALT=#></A></td><td><a  class='linkbox' href="http://www.nevrax.org/GPL.php3" TITLE="License">License</a></td></tr>
		</TABLE>
		</TD></TR></TABLE></TD></TR></TABLE>
		<!------ End Box  ------>

	</TD>
	<TD WIDTH=15><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="16" HEIGHT="16" BORDER=0 ALT=""></TD>
	<TD ALIGN=left valign=top><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="140" HEIGHT="10" BORDER=0 ALT="">

<!-- title -->
<TABLE  background="http://www.nevrax.org/inc/img/redline.gif" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td>
<A HREF="http://www.nevrax.org/docs/"><img src="http://www.nevrax.org/inc/img/t_docs.gif" ALT="Docs" HEIGHT=20 BORDER=0></A>
</td><td><IMG  SRC="http://www.nevrax.org/inc/img/pixel.gif" WIDTH="1" HEIGHT="1" BORDER=0 ALT="">
</td></tr></table>
&nbsp;

<!-- block -->
<TABLE  bgcolor="#dddddd" CELLSPACING=0 CELLPADDING=0  BORDER=0 width=100%><tr><td width=1% valign=middle><img width=6 height=14 hspace=2 vspace=2 src="http://www.nevrax.org/inc/img/reddots.gif"></TD>
	<TD><B>Documentation</B></TD>
	<TD ALIGN=RIGHT>&nbsp;</td>
</tr></table>
<!-- Generated by Doxygen 1.2.14 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; <a class="qindexRef" doxygen="_cgi:http://www.nevrax.org/cgi-bin/nel-search.cgi" href="http://www.nevrax.org/cgi-bin/nel-search.cgi">Search</a> &nbsp; </center>
<hr><h1>animation.h</h1><a href="animation_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 
00007 <font class="comment">/* Copyright, 2001 Nevrax Ltd.</font>
00008 <font class="comment"> *</font>
00009 <font class="comment"> * This file is part of NEVRAX NEL.</font>
00010 <font class="comment"> * NEVRAX NEL is free software; you can redistribute it and/or modify</font>
00011 <font class="comment"> * it under the terms of the GNU General Public License as published by</font>
00012 <font class="comment"> * the Free Software Foundation; either version 2, or (at your option)</font>
00013 <font class="comment"> * any later version.</font>
00014 <font class="comment"></font>
00015 <font class="comment"> * NEVRAX NEL is distributed in the hope that it will be useful, but</font>
00016 <font class="comment"> * WITHOUT ANY WARRANTY; without even the implied warranty of</font>
00017 <font class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</font>
00018 <font class="comment"> * General Public License for more details.</font>
00019 <font class="comment"></font>
00020 <font class="comment"> * You should have received a copy of the GNU General Public License</font>
00021 <font class="comment"> * along with NEVRAX NEL; see the file COPYING. If not, write to the</font>
00022 <font class="comment"> * Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,</font>
00023 <font class="comment"> * MA 02111-1307, USA.</font>
00024 <font class="comment"> */</font>
00025 
00026 <font class="preprocessor">#ifndef NL_ANIMATION_H</font>
00027 <font class="preprocessor"></font><font class="preprocessor">#define NL_ANIMATION_H</font>
00028 <font class="preprocessor"></font>
00029 <font class="preprocessor">#include "<a class="code" href="types__nl_8h.html">nel/misc/types_nl.h</a>"</font>
00030 
00031 <font class="preprocessor">#include "<a class="code" href="animation__time_8h.html">nel/3d/animation_time.h</a>"</font>
00032 <font class="preprocessor">#include "<a class="code" href="u__animation_8h.html">nel/3d/u_animation.h</a>"</font>
00033 
00034 <font class="preprocessor">#include &lt;memory&gt;</font>
00035 <font class="preprocessor">#include &lt;map&gt;</font>
00036 <font class="preprocessor">#include &lt;set&gt;</font>
00037 <font class="preprocessor">#include &lt;vector&gt;</font>
00038 
00039 <font class="keyword">namespace </font>NLMISC
00040 {
00041 <font class="keyword">class </font>IStream;
00042 <font class="keyword">struct </font>EStream;
00043 }
00044 
<a name="l00045"></a><a class="code" href="animation_8h.html#a0">00045</a> <font class="preprocessor">#define NL3D_MEM_ANIMATION                                              NL_ALLOC_CONTEXT( 3dAnim )</font>
00046 <font class="preprocessor"></font>
00047 <font class="keyword">namespace </font>NL3D 
00048 {
00049 
00050 <font class="keyword">class </font>ITrack;
00051 
<a name="l00060"></a><a class="code" href="classNL3D_1_1CAnimation.html">00060</a> <font class="keyword">class </font>CAnimation : <font class="keyword">public</font> UAnimation
00061 {
00062 <font class="keyword">public</font>:
00064         <a class="code" href="classNL3D_1_1CAnimation.html#a0">CAnimation</a>();
00066         <font class="keyword">virtual</font> <a class="code" href="classNL3D_1_1CAnimation.html#a1">~CAnimation</a> ();
00067 
00069 
00070         <font class="keyword">enum</font> { <a class="code" href="classNL3D_1_1CAnimation.html#s1s0">NotFound</a>=0xffffffff };
00071 
<a name="l00077"></a><a class="code" href="classNL3D_1_1CAnimation.html#a2">00077</a>         uint <a class="code" href="classNL3D_1_1CAnimation.html#a2">getIdTrackByName</a> (<font class="keyword">const</font> std::string&amp; name)<font class="keyword"> const</font>
00078 <font class="keyword">        </font>{
00079                 <a class="code" href="animation_8h.html#a0">NL3D_MEM_ANIMATION</a>
00080                 <font class="comment">// Find an entry in the name/id map</font>
00081                 TMapStringUInt::const_iterator ite=<a class="code" href="classNL3D_1_1CAnimation.html#o1">_IdByName</a>.find (name);
00082 
00083                 <font class="comment">// Not found ?</font>
00084                 <font class="keywordflow">if</font> (ite==<a class="code" href="classNL3D_1_1CAnimation.html#o1">_IdByName</a>.end ())
00085                         <font class="comment">// yes, error</font>
00086                         <font class="keywordflow">return</font> <a class="code" href="classNL3D_1_1CAnimation.html#s1s0">NotFound</a>;
00087                 <font class="keywordflow">else</font>
00088                         <font class="comment">// no, return track ID</font>
00089                         <font class="keywordflow">return</font> (uint)ite-&gt;second;
00090         }
00091 
00097         <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CAnimation.html#a3">getTrackNames</a> (std::set&lt;std::string&gt;&amp; setString) <font class="keyword">const</font>;
00098 
<a name="l00103"></a><a class="code" href="classNL3D_1_1CAnimation.html#a4">00103</a>         <font class="keyword">const</font> ITrack* <a class="code" href="classNL3D_1_1CAnimation.html#a4">getTrack</a> (uint trackId)<font class="keyword"> const</font>
00104 <font class="keyword">        </font>{
00105                 <a class="code" href="animation_8h.html#a0">NL3D_MEM_ANIMATION</a>
00106                 <font class="comment">// Get the trackId-th track pointer</font>
00107                 <font class="keywordflow">return</font> <a class="code" href="classNL3D_1_1CAnimation.html#o2">_TrackVector</a>[trackId];
00108         }
00109 
<a name="l00114"></a><a class="code" href="classNL3D_1_1CAnimation.html#a5">00114</a>         ITrack* <a class="code" href="classNL3D_1_1CAnimation.html#a4">getTrack</a> (uint trackId)
00115         {
00116                 <a class="code" href="animation_8h.html#a0">NL3D_MEM_ANIMATION</a>
00117                 <font class="comment">// Get the trackId-th track pointer</font>
00118                 <font class="keywordflow">return</font> <a class="code" href="classNL3D_1_1CAnimation.html#o2">_TrackVector</a>[trackId];
00119         }
00120 
00127         <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CAnimation.html#a6">addTrack</a> (<font class="keyword">const</font> std::string&amp; name, ITrack* pChannel);
00128 
00130         <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CAnimation.html#a7">serial</a> (<a class="code" href="classNLMISC_1_1IStream.html">NLMISC::IStream</a>&amp; f);
00131 
00133         <font class="keywordtype">void</font> <a class="code" href="classNL3D_1_1CAnimation.html#a8">setMinEndTime</a> (<a class="code" href="namespaceNL3D.html#a1">TAnimationTime</a> minEndTime);
00134 
00136         <font class="comment">// @{</font>
00137 
00138         <font class="keyword">virtual</font> UTrack*         <a class="code" href="classNL3D_1_1CAnimation.html#z377_0">getTrackByName</a> (<font class="keyword">const</font> <font class="keywordtype">char</font>* name);
00139         <font class="keyword">virtual</font> <font class="keywordtype">void</font>            <a class="code" href="classNL3D_1_1CAnimation.html#z377_1">releaseTrack</a> (UTrack* track);
00140         <font class="keyword">virtual</font> <a class="code" href="namespaceNL3D.html#a1">TAnimationTime</a>  <a class="code" href="classNL3D_1_1CAnimation.html#z377_2">getBeginTime</a> () <font class="keyword">const</font>;
00141         <font class="keyword">virtual</font> <a class="code" href="namespaceNL3D.html#a1">TAnimationTime</a>  <a class="code" href="classNL3D_1_1CAnimation.html#z377_3">getEndTime</a> () <font class="keyword">const</font>;
00142         <font class="keyword">virtual</font> <font class="keywordtype">bool</font>                    <a class="code" href="classNL3D_1_1CAnimation.html#z377_4">allTrackLoop</a>() <font class="keyword">const</font>;
00143 
00144         <font class="comment">// @}</font>
00145 
00146 
00147 <font class="keyword">private</font>:
<a name="l00149"></a><a class="code" href="classNL3D_1_1CAnimation.html#u0">00149</a>         <font class="keyword">typedef</font> std::map&lt;std::string, uint32&gt; <a class="code" href="classNL3D_1_1CAnimation.html#u0">TMapStringUInt</a>;
<a name="l00150"></a><a class="code" href="classNL3D_1_1CAnimation.html#u1">00150</a>         <font class="keyword">typedef</font> std::vector&lt;ITrack* &gt; <a class="code" href="classNL3D_1_1CAnimation.html#u1">TVectAPtrTrack</a>;
00151 
00152         <font class="comment">// Animation name</font>
<a name="l00153"></a><a class="code" href="classNL3D_1_1CAnimation.html#o0">00153</a>         std::string                     <a class="code" href="classNL3D_1_1CAnimation.html#o0">_Name</a>;
00154 
00155         <font class="comment">// Map to get a channel id with a name.</font>
<a name="l00156"></a><a class="code" href="classNL3D_1_1CAnimation.html#o1">00156</a>         <a class="code" href="classNL3D_1_1CAnimation.html#u0">TMapStringUInt</a>          <a class="code" href="classNL3D_1_1CAnimation.html#o1">_IdByName</a>;
00157 
00158         <font class="comment">// Vector of channel pointer.</font>
<a name="l00159"></a><a class="code" href="classNL3D_1_1CAnimation.html#o2">00159</a>         <a class="code" href="classNL3D_1_1CAnimation.html#u1">TVectAPtrTrack</a>          <a class="code" href="classNL3D_1_1CAnimation.html#o2">_TrackVector</a>;
00160 
00161         <font class="comment">// Force animation min end time</font>
<a name="l00162"></a><a class="code" href="classNL3D_1_1CAnimation.html#o3">00162</a>         <a class="code" href="namespaceNL3D.html#a1">TAnimationTime</a>          <a class="code" href="classNL3D_1_1CAnimation.html#o3">_MinEndTime</a>;
00163 
00165         <font class="comment">// @{</font>
<a name="l00166"></a><a class="code" href="classNL3D_1_1CAnimation.html#z378_0">00166</a>                 <font class="keyword">mutable</font> <a class="code" href="namespaceNL3D.html#a1">TAnimationTime</a>          <a class="code" href="classNL3D_1_1CAnimation.html#z378_0">_BeginTime</a>;     
<a name="l00167"></a><a class="code" href="classNL3D_1_1CAnimation.html#z378_1">00167</a>                 <font class="keyword">mutable</font> <a class="code" href="namespaceNL3D.html#a1">TAnimationTime</a>          <a class="code" href="classNL3D_1_1CAnimation.html#z378_1">_EndTime</a>;
<a name="l00168"></a><a class="code" href="classNL3D_1_1CAnimation.html#z378_2">00168</a>                 <font class="keyword">mutable</font> <font class="keywordtype">bool</font>                            <a class="code" href="classNL3D_1_1CAnimation.html#z378_2">_AnimLoop</a>;
<a name="l00169"></a><a class="code" href="classNL3D_1_1CAnimation.html#z378_3">00169</a>                 <font class="keyword">mutable</font> <font class="keywordtype">bool</font>                            <a class="code" href="classNL3D_1_1CAnimation.html#z378_3">_BeginTimeTouched</a>;
<a name="l00170"></a><a class="code" href="classNL3D_1_1CAnimation.html#z378_4">00170</a>                 <font class="keyword">mutable</font> <font class="keywordtype">bool</font>                            <a class="code" href="classNL3D_1_1CAnimation.html#z378_4">_EndTimeTouched</a>;
<a name="l00171"></a><a class="code" href="classNL3D_1_1CAnimation.html#z378_5">00171</a>                 <font class="keyword">mutable</font> <font class="keywordtype">bool</font>                            <a class="code" href="classNL3D_1_1CAnimation.html#z378_5">_AnimLoopTouched</a>;
00172         <font class="comment">// @}</font>
00173 };
00174 
00175 
00176 } <font class="comment">// NL3D</font>
00177 
00178 
00179 <font class="preprocessor">#endif // NL_ANIMATION_H</font>
00180 <font class="preprocessor"></font>
00181 <font class="comment">/* End of animation.h */</font>
</pre></div>

<!-- footer -->
<BR><FONT Size=+5>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; </FONT>
</TD>
<TD WIDTH=15><IMG  SRC=http://www.nevrax.org/inc/img/pixel.gif WIDTH=15 HEIGHT=15 BORDER=0 ALT=""></TD>
</TR>
</TABLE>
</BODY>
</HTML>