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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreAnimationState.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>OgreAnimationState.h</h1><a href="OgreAnimationState_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 __AnimationSet_H__</span>
3600027 <span class="preprocessor"></span><span class="preprocessor">#define __AnimationSet_H__</span>
3700028 <span class="preprocessor"></span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3900030
4000031 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreController_8h.html">OgreController.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
4300034
4400035 <span class="keyword">namespace </span>Ogre {
4500036
46<a name="l00042"></a><a class="code" href="classOgre_1_1AnimationState.html">00042</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> AnimationState
4700043     {
4800044     <span class="keyword">public</span>:
4900046         AnimationState(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; animName, <a class="code" href="classOgre_1_1AnimationStateSet.html">AnimationStateSet</a> *parent,
5000047             <a class="code" href="namespaceOgre.html#a465">Real</a> timePos, <a class="code" href="namespaceOgre.html#a465">Real</a> length, <a class="code" href="namespaceOgre.html#a465">Real</a> weight = 1.0, <span class="keywordtype">bool</span> enabled = <span class="keyword">false</span>);
5100049         AnimationState(<a class="code" href="classOgre_1_1AnimationStateSet.html">AnimationStateSet</a>* parent, <span class="keyword">const</span> AnimationState &amp;rhs);
5200053         <span class="keyword">virtual</span> ~AnimationState();
5300054         
5400056         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getAnimationName() <span class="keyword">const</span>;
5500058         <a class="code" href="namespaceOgre.html#a465">Real</a> getTimePosition(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
5600060         <span class="keywordtype">void</span> setTimePosition(<a class="code" href="namespaceOgre.html#a465">Real</a> timePos);
5700062         <a class="code" href="namespaceOgre.html#a465">Real</a> getLength() <span class="keyword">const</span>;
5800064         <span class="keywordtype">void</span> setLength(<a class="code" href="namespaceOgre.html#a465">Real</a> len);
5900066         <a class="code" href="namespaceOgre.html#a465">Real</a> getWeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6000068         <span class="keywordtype">void</span> setWeight(<a class="code" href="namespaceOgre.html#a465">Real</a> weight);
6100073         <span class="keywordtype">void</span> addTime(<a class="code" href="namespaceOgre.html#a465">Real</a> offset);
6200074
6300076         <span class="keywordtype">bool</span> getEnabled(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6400078         <span class="keywordtype">void</span> setEnabled(<span class="keywordtype">bool</span> enabled);
6500079
6600081         <span class="keywordtype">bool</span> <a class="code" href="namespaceOgre.html#a623">operator==</a>(<span class="keyword">const</span> AnimationState&amp; rhs) <span class="keyword">const</span>;
6700082         <span class="comment">// Inequality operator</span>
6800083         <span class="keywordtype">bool</span> <a class="code" href="namespaceOgre.html#a624">operator!=</a>(<span class="keyword">const</span> AnimationState&amp; rhs) <span class="keyword">const</span>;
6900084
70<a name="l00088"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea15">00088</a>         <span class="keywordtype">void</span> setLoop(<span class="keywordtype">bool</span> loop) { mLoop = loop; }
71<a name="l00090"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea16">00090</a>         <span class="keywordtype">bool</span> getLoop(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLoop; }
7200091     
7300096         <span class="keywordtype">void</span> copyStateFrom(<span class="keyword">const</span> AnimationState&amp; animState);
7400097
75<a name="l00099"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea18">00099</a>         <a class="code" href="classOgre_1_1AnimationStateSet.html">AnimationStateSet</a>* getParent(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mParent; }
7600100
7700101     <span class="keyword">protected</span>:
78<a name="l00102"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep0">00102</a>         <a class="code" href="namespaceOgre.html#a471">String</a> mAnimationName;
79<a name="l00103"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep1">00103</a>         <a class="code" href="classOgre_1_1AnimationStateSet.html">AnimationStateSet</a>* mParent;
80<a name="l00104"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep2">00104</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mTimePos;
81<a name="l00105"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep3">00105</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mLength;
82<a name="l00106"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep4">00106</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mInvLength;
83<a name="l00107"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep5">00107</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mWeight;
84<a name="l00108"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep6">00108</a>         <span class="keywordtype">bool</span> mEnabled;
85<a name="l00109"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep7">00109</a>         <span class="keywordtype">bool</span> mLoop;
8600110
8700111     };
8800112
8900113     <span class="comment">// A map of animation states</span>
90<a name="l00114"></a><a class="code" href="namespaceOgre.html#a1">00114</a>     <span class="keyword">typedef</span> std::map&lt;String, AnimationState*&gt; <a class="code" href="namespaceOgre.html#a1">AnimationStateMap</a>;
91<a name="l00115"></a><a class="code" href="namespaceOgre.html#a2">00115</a>     <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator&lt;AnimationStateMap&gt;</a> <a class="code" href="classOgre_1_1MapIterator.html">AnimationStateIterator</a>;
92<a name="l00116"></a><a class="code" href="namespaceOgre.html#a3">00116</a>     <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstMapIterator&lt;AnimationStateMap&gt;</a> <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstAnimationStateIterator</a>;
9300117     <span class="comment">// A list of enabled animation states</span>
94<a name="l00118"></a><a class="code" href="namespaceOgre.html#a4">00118</a>     <span class="keyword">typedef</span> std::list&lt;AnimationState*&gt; <a class="code" href="namespaceOgre.html#a4">EnabledAnimationStateList</a>;
95<a name="l00119"></a><a class="code" href="namespaceOgre.html#a5">00119</a>     <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1ConstVectorIterator.html">ConstVectorIterator&lt;EnabledAnimationStateList&gt;</a> <a class="code" href="classOgre_1_1ConstVectorIterator.html">ConstEnabledAnimationStateIterator</a>;
9600120
97<a name="l00123"></a><a class="code" href="classOgre_1_1AnimationStateSet.html">00123</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> AnimationStateSet
9800124     {
9900125     <span class="keyword">public</span>:
10000127         AnimationStateSet();
10100129         AnimationStateSet(<span class="keyword">const</span> AnimationStateSet&amp; rhs);
10200130
10300131         ~AnimationStateSet();
10400132
10500140         AnimationState* createAnimationState(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; animName, 
10600141             <a class="code" href="namespaceOgre.html#a465">Real</a> timePos, <a class="code" href="namespaceOgre.html#a465">Real</a> length, <a class="code" href="namespaceOgre.html#a465">Real</a> weight = 1.0, <span class="keywordtype">bool</span> enabled = <span class="keyword">false</span>);
10700143         AnimationState* getAnimationState(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name) <span class="keyword">const</span>;
10800145         <span class="keywordtype">bool</span> hasAnimationState(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name) <span class="keyword">const</span>;
10900147         <span class="keywordtype">void</span> removeAnimationState(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name);
11000149         <span class="keywordtype">void</span> removeAllAnimationStates(<span class="keywordtype">void</span>);
11100150
11200152         <a class="code" href="classOgre_1_1MapIterator.html">AnimationStateIterator</a> getAnimationStateIterator(<span class="keywordtype">void</span>);
11300154         <a class="code" href="classOgre_1_1ConstMapIterator.html">ConstAnimationStateIterator</a> getAnimationStateIterator(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11400156         <span class="keywordtype">void</span> copyMatchingState(AnimationStateSet* target) <span class="keyword">const</span>;
11500158         <span class="keywordtype">void</span> _notifyDirty(<span class="keywordtype">void</span>);
116<a name="l00160"></a><a class="code" href="classOgre_1_1AnimationStateSet.html#Ogre_1_1AnimationStateSeta12">00160</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> getDirtyFrameNumber(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mDirtyFrameNumber; }
11700161
11800163         <span class="keywordtype">void</span> _notifyAnimationStateEnabled(AnimationState* target, <span class="keywordtype">bool</span> enabled);
119<a name="l00165"></a><a class="code" href="classOgre_1_1AnimationStateSet.html#Ogre_1_1AnimationStateSeta14">00165</a>         <span class="keywordtype">bool</span> hasEnabledAnimationState(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !mEnabledAnimationStates.empty(); }
12000167         <a class="code" href="classOgre_1_1ConstVectorIterator.html">ConstEnabledAnimationStateIterator</a> getEnabledAnimationStateIterator(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12100168
12200169     <span class="keyword">protected</span>:
123<a name="l00170"></a><a class="code" href="classOgre_1_1AnimationStateSet.html#Ogre_1_1AnimationStateSetp0">00170</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> mDirtyFrameNumber;
124<a name="l00171"></a><a class="code" href="classOgre_1_1AnimationStateSet.html#Ogre_1_1AnimationStateSetp1">00171</a>         <a class="code" href="namespaceOgre.html#a1">AnimationStateMap</a> mAnimationStates;
125<a name="l00172"></a><a class="code" href="classOgre_1_1AnimationStateSet.html#Ogre_1_1AnimationStateSetp2">00172</a>         <a class="code" href="namespaceOgre.html#a4">EnabledAnimationStateList</a> mEnabledAnimationStates;
12600173
12700174     };
12800175
129<a name="l00184"></a><a class="code" href="classOgre_1_1AnimationStateControllerValue.html">00184</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> AnimationStateControllerValue : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;Real&gt;
13000185     {
13100186     <span class="keyword">protected</span>:
132<a name="l00187"></a><a class="code" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuep0">00187</a>         AnimationState* mTargetAnimationState;
13300188     <span class="keyword">public</span>:
134<a name="l00190"></a><a class="code" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuea0">00190</a>         AnimationStateControllerValue(AnimationState* targetAnimationState)
13500191             : mTargetAnimationState(targetAnimationState) {}
136<a name="l00193"></a><a class="code" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuea1">00193</a>         ~AnimationStateControllerValue() {}
13700195         <a class="code" href="namespaceOgre.html#a465">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13800196
13900198         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a465">Real</a> value);
14000199
14100200     };
14200201
14300202
14400203 }
14500204
14600205 <span class="preprocessor">#endif</span>
14700206 <span class="preprocessor"></span>
148</pre></div><hr>
149<p>
150Copyright &copy; 2000-2005 by The OGRE Team<br />
151<!--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/>
152This 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/>
153                <!--/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#">
154                <Work rdf:about="">
155                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
156        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
157                </Work>
158                <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> -->
159
160Last modified Sun Mar 12 14:37:36 2006
161</p>
162</body>
163</html>
Note: See TracBrowser for help on using the repository browser.