source: OGRE/trunk/ogrenew/Docs/api/html/OgreAnimation_8h-source.html @ 692

Revision 692, 19.5 KB checked in by mattausch, 19 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreAnimation.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.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">Class&nbsp;List</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">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>OgreAnimation.h</h1><a href="OgreAnimation_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025
3500026 <span class="preprocessor">#ifndef __Animation_H__</span>
3600027 <span class="preprocessor"></span><span class="preprocessor">#define __Animation_H__</span>
3700028 <span class="preprocessor"></span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreAnimable_8h.html">OgreAnimable.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreAnimationTrack_8h.html">OgreAnimationTrack.h</a>"</span>
4300034
4400035
4500036 <span class="keyword">namespace </span>Ogre {
4600037
47<a name="l00048"></a><a class="code" href="classOgre_1_1Animation.html">00048</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Animation
4800049     {
4900050
5000051     <span class="keyword">public</span>:
51<a name="l00053"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw10">00053</a>         <span class="keyword">enum</span> InterpolationMode
5200054         {
5300056             IM_LINEAR,
5400058             IM_SPLINE
5500059         };
5600060
57<a name="l00062"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw11">00062</a>         <span class="keyword">enum</span> RotationInterpolationMode
5800063         {
5900067             RIM_LINEAR,
6000071             RIM_SPHERICAL
6100072         };
6200077         Animation(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <a class="code" href="namespaceOgre.html#a465">Real</a> length);
6300078         <span class="keyword">virtual</span> ~Animation();
6400079
6500081         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getName(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6600082
6700084         <a class="code" href="namespaceOgre.html#a465">Real</a> getLength(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6800085
6900090         <a class="code" href="classOgre_1_1NodeAnimationTrack.html">NodeAnimationTrack</a>* createNodeTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle);
7000091
7100096         <a class="code" href="classOgre_1_1NumericAnimationTrack.html">NumericAnimationTrack</a>* createNumericTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle);
7200097
7300105         <a class="code" href="classOgre_1_1VertexAnimationTrack.html">VertexAnimationTrack</a>* createVertexTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle, VertexAnimationType animType);
7400106
7500115         <a class="code" href="classOgre_1_1NodeAnimationTrack.html">NodeAnimationTrack</a>* createNodeTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle, <a class="code" href="classOgre_1_1Node.html">Node</a>* node);
7600116
7700122         <a class="code" href="classOgre_1_1NumericAnimationTrack.html">NumericAnimationTrack</a>* createNumericTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle,
7800123             <span class="keyword">const</span> <a class="code" href="classOgre_1_1SharedPtr.html">AnimableValuePtr</a>&amp; anim);
7900124
8000131         <a class="code" href="classOgre_1_1VertexAnimationTrack.html">VertexAnimationTrack</a>* createVertexTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle,
8100132             <a class="code" href="classOgre_1_1VertexData.html">VertexData</a>* data, VertexAnimationType animType);
8200133
8300135         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> getNumNodeTracks(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8400136
8500138         <a class="code" href="classOgre_1_1NodeAnimationTrack.html">NodeAnimationTrack</a>* getNodeTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle) <span class="keyword">const</span>;
8600139
8700141         <span class="keywordtype">bool</span> hasNodeTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle) <span class="keyword">const</span>;
8800142
8900144         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> getNumNumericTracks(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9000145
9100147         <a class="code" href="classOgre_1_1NumericAnimationTrack.html">NumericAnimationTrack</a>* getNumericTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle) <span class="keyword">const</span>;
9200148
9300150         <span class="keywordtype">bool</span> hasNumericTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle) <span class="keyword">const</span>;
9400151
9500153         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> getNumVertexTracks(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9600154
9700156         <a class="code" href="classOgre_1_1VertexAnimationTrack.html">VertexAnimationTrack</a>* getVertexTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle) <span class="keyword">const</span>;
9800157
9900159         <span class="keywordtype">bool</span> hasVertexTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle) <span class="keyword">const</span>;
10000160         
10100162         <span class="keywordtype">void</span> destroyNodeTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle);
10200163
10300165         <span class="keywordtype">void</span> destroyNumericTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle);
10400166
10500168         <span class="keywordtype">void</span> destroyVertexTrack(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> handle);
10600169
10700171         <span class="keywordtype">void</span> destroyAllTracks(<span class="keywordtype">void</span>);
10800172
10900174         <span class="keywordtype">void</span> destroyAllNodeTracks(<span class="keywordtype">void</span>);
11000176         <span class="keywordtype">void</span> destroyAllNumericTracks(<span class="keywordtype">void</span>);
11100178         <span class="keywordtype">void</span> destroyAllVertexTracks(<span class="keywordtype">void</span>);
11200179
11300190         <span class="keywordtype">void</span> apply(<a class="code" href="namespaceOgre.html#a465">Real</a> timePos, <a class="code" href="namespaceOgre.html#a465">Real</a> weight = 1.0, <span class="keywordtype">bool</span> accumulate = <span class="keyword">false</span>,
11400191             <a class="code" href="namespaceOgre.html#a465">Real</a> scale = 1.0f);
11500192
11600203         <span class="keywordtype">void</span> apply(<a class="code" href="classOgre_1_1Skeleton.html">Skeleton</a>* skeleton, <a class="code" href="namespaceOgre.html#a465">Real</a> timePos, <a class="code" href="namespaceOgre.html#a465">Real</a> weight = 1.0,
11700204             <span class="keywordtype">bool</span> accumulate = <span class="keyword">false</span>, <a class="code" href="namespaceOgre.html#a465">Real</a> scale = 1.0f);
11800205
11900215         <span class="keywordtype">void</span> apply(<a class="code" href="classOgre_1_1Entity.html">Entity</a>* entity, <a class="code" href="namespaceOgre.html#a465">Real</a> timePos, <a class="code" href="namespaceOgre.html#a465">Real</a> weight, <span class="keywordtype">bool</span> software,
12000216             <span class="keywordtype">bool</span> hardware);
12100217
12200230         <span class="keywordtype">void</span> setInterpolationMode(InterpolationMode im);
12300231
12400236         InterpolationMode getInterpolationMode(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12500247         <span class="keywordtype">void</span> setRotationInterpolationMode(RotationInterpolationMode im);
12600248
12700253         RotationInterpolationMode getRotationInterpolationMode(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12800254
12900255         <span class="comment">// Methods for setting the defaults</span>
13000262 <span class="comment"></span>        <span class="keyword">static</span> <span class="keywordtype">void</span> setDefaultInterpolationMode(InterpolationMode im);
13100263
13200265         <span class="keyword">static</span> InterpolationMode getDefaultInterpolationMode(<span class="keywordtype">void</span>);
13300266
13400273         <span class="keyword">static</span> <span class="keywordtype">void</span> setDefaultRotationInterpolationMode(RotationInterpolationMode im);
13500274
13600276         <span class="keyword">static</span> RotationInterpolationMode getDefaultRotationInterpolationMode(<span class="keywordtype">void</span>);
13700277
138<a name="l00278"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw0">00278</a>         <span class="keyword">typedef</span> std::map&lt;unsigned short, NodeAnimationTrack*&gt; <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw0">NodeTrackList</a>;
139<a name="l00279"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw1">00279</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator&lt;NodeTrackList&gt;</a> <a class="code" href="classOgre_1_1ConstMapIterator.html">NodeTrackIterator</a>;
14000280
141<a name="l00281"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw2">00281</a>         <span class="keyword">typedef</span> std::map&lt;unsigned short, NumericAnimationTrack*&gt; <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw2">NumericTrackList</a>;
142<a name="l00282"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw3">00282</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator&lt;NumericTrackList&gt;</a> <a class="code" href="classOgre_1_1ConstMapIterator.html">NumericTrackIterator</a>;
14300283
144<a name="l00284"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw4">00284</a>         <span class="keyword">typedef</span> std::map&lt;unsigned short, VertexAnimationTrack*&gt; <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw4">VertexTrackList</a>;
145<a name="l00285"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw5">00285</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator&lt;VertexTrackList&gt;</a> <a class="code" href="classOgre_1_1ConstMapIterator.html">VertexTrackIterator</a>;
14600286
14700288         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw0">NodeTrackList</a>&amp; _getNodeTrackList(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
14800289
149<a name="l00291"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationa34">00291</a>         <a class="code" href="classOgre_1_1ConstMapIterator.html">NodeTrackIterator</a> getNodeTrackIterator(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
15000292 <span class="keyword">        </span>{ <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">NodeTrackIterator</a>(mNodeTrackList.begin(), mNodeTrackList.end()); }
15100293         
15200295         <span class="keyword">const</span> NumericTrackList&amp; _getNumericTrackList(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
15300296
154<a name="l00298"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationa36">00298</a>         <a class="code" href="classOgre_1_1ConstMapIterator.html">NumericTrackIterator</a> getNumericTrackIterator(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
15500299 <span class="keyword">        </span>{ <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">NumericTrackIterator</a>(mNumericTrackList.begin(), mNumericTrackList.end()); }
15600300
15700302         <span class="keyword">const</span> VertexTrackList&amp; _getVertexTrackList(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
15800303
159<a name="l00305"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationa38">00305</a>         <a class="code" href="classOgre_1_1ConstMapIterator.html">VertexTrackIterator</a> getVertexTrackIterator(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
16000306 <span class="keyword">        </span>{ <span class="keywordflow">return</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">VertexTrackIterator</a>(mVertexTrackList.begin(), mVertexTrackList.end()); }
16100307
16200317         <span class="keywordtype">void</span> optimise(<span class="keywordtype">void</span>);
16300318         
16400319
16500320
16600321     <span class="keyword">protected</span>:
167<a name="l00323"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp0">00323</a>         <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw0">NodeTrackList</a> mNodeTrackList;
168<a name="l00325"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp1">00325</a>         <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw2">NumericTrackList</a> mNumericTrackList;
169<a name="l00327"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp2">00327</a>         <a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationw4">VertexTrackList</a> mVertexTrackList;
170<a name="l00328"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp3">00328</a>         <a class="code" href="namespaceOgre.html#a471">String</a> mName;
17100329
172<a name="l00330"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp4">00330</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mLength;
17300331
174<a name="l00332"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp5">00332</a>         InterpolationMode mInterpolationMode;
175<a name="l00333"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationp6">00333</a>         RotationInterpolationMode mRotationInterpolationMode;
17600334
177<a name="l00335"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationt0">00335</a>         <span class="keyword">static</span> InterpolationMode msDefaultInterpolationMode;
178<a name="l00336"></a><a class="code" href="classOgre_1_1Animation.html#Ogre_1_1Animationt1">00336</a>         <span class="keyword">static</span> RotationInterpolationMode msDefaultRotationInterpolationMode;
17900337
18000338         <span class="keywordtype">void</span> optimiseNodeTracks(<span class="keywordtype">void</span>);
18100339         <span class="keywordtype">void</span> optimiseVertexTracks(<span class="keywordtype">void</span>);
18200340
18300341         
18400342     };
18500343
18600344
18700345 }
18800346
18900347
19000348 <span class="preprocessor">#endif</span>
19100349 <span class="preprocessor"></span>
192</pre></div><hr>
193<p>
194Copyright &copy; 2000-2005 by The OGRE Team<br />
195<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
196This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
197                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
198                <Work rdf:about="">
199                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
200        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
201                </Work>
202                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
203
204Last modified Sun Mar 12 14:37:36 2006
205</p>
206</body>
207</html>
Note: See TracBrowser for help on using the repository browser.