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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related 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> |
---|
11 | 00002 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
12 | 00003 <span class="comment">This source file is part of OGRE</span> |
---|
13 | 00004 <span class="comment"> (Object-oriented Graphics Rendering Engine)</span> |
---|
14 | 00005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span> |
---|
15 | 00006 <span class="comment"></span> |
---|
16 | 00007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span> |
---|
17 | 00008 <span class="comment">Also see acknowledgements in Readme.html</span> |
---|
18 | 00009 <span class="comment"></span> |
---|
19 | 00010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span> |
---|
20 | 00011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span> |
---|
21 | 00012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span> |
---|
22 | 00013 <span class="comment">version.</span> |
---|
23 | 00014 <span class="comment"></span> |
---|
24 | 00015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span> |
---|
25 | 00016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span> |
---|
26 | 00017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span> |
---|
27 | 00018 <span class="comment"></span> |
---|
28 | 00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span> |
---|
29 | 00020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span> |
---|
30 | 00021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span> |
---|
31 | 00022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span> |
---|
32 | 00023 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
33 | 00024 <span class="comment">*/</span> |
---|
34 | 00025 |
---|
35 | 00026 <span class="preprocessor">#ifndef __AnimationSet_H__</span> |
---|
36 | 00027 <span class="preprocessor"></span><span class="preprocessor">#define __AnimationSet_H__</span> |
---|
37 | 00028 <span class="preprocessor"></span> |
---|
38 | 00029 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span> |
---|
39 | 00030 |
---|
40 | 00031 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span> |
---|
41 | 00032 <span class="preprocessor">#include "<a class="code" href="OgreController_8h.html">OgreController.h</a>"</span> |
---|
42 | 00033 <span class="preprocessor">#include "<a class="code" href="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span> |
---|
43 | 00034 |
---|
44 | 00035 <span class="keyword">namespace </span>Ogre { |
---|
45 | 00036 |
---|
46 | <a name="l00044"></a><a class="code" href="classOgre_1_1AnimationState.html">00044</a> <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> AnimationState : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerValue.html">ControllerValue</a><Real> |
---|
47 | 00045 { |
---|
48 | 00046 <span class="keyword">public</span>: |
---|
49 | 00048 AnimationState(); |
---|
50 | 00052 <span class="keyword">virtual</span> ~AnimationState(); |
---|
51 | 00053 |
---|
52 | 00055 AnimationState(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>& animName, <a class="code" href="namespaceOgre.html#a420">Real</a> timePos, <a class="code" href="namespaceOgre.html#a420">Real</a> length, <a class="code" href="namespaceOgre.html#a420">Real</a> weight = 1.0, <span class="keywordtype">bool</span> enabled = <span class="keyword">false</span>); |
---|
53 | 00057 <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>& getAnimationName() <span class="keyword">const</span>; |
---|
54 | 00059 <span class="keywordtype">void</span> setAnimationName(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>& name); |
---|
55 | 00061 <a class="code" href="namespaceOgre.html#a420">Real</a> getTimePosition(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
56 | 00063 <span class="keywordtype">void</span> setTimePosition(<a class="code" href="namespaceOgre.html#a420">Real</a> timePos); |
---|
57 | 00065 <a class="code" href="namespaceOgre.html#a420">Real</a> getLength() <span class="keyword">const</span>; |
---|
58 | 00067 <span class="keywordtype">void</span> setLength(<a class="code" href="namespaceOgre.html#a420">Real</a> len); |
---|
59 | 00069 <a class="code" href="namespaceOgre.html#a420">Real</a> getWeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
60 | 00071 <span class="keywordtype">void</span> setWeight(<a class="code" href="namespaceOgre.html#a420">Real</a> weight); |
---|
61 | 00076 <span class="keywordtype">void</span> addTime(<a class="code" href="namespaceOgre.html#a420">Real</a> offset); |
---|
62 | 00077 |
---|
63 | 00079 <span class="keywordtype">bool</span> getEnabled(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
64 | 00081 <span class="keywordtype">void</span> setEnabled(<span class="keywordtype">bool</span> enabled); |
---|
65 | 00082 |
---|
66 | 00084 <span class="keywordtype">bool</span> <a class="code" href="namespaceOgre.html#a618">operator==</a>(<span class="keyword">const</span> AnimationState& rhs) <span class="keyword">const</span>; |
---|
67 | 00085 <span class="comment">// Inequality operator</span> |
---|
68 | 00086 <span class="keywordtype">bool</span> <a class="code" href="namespaceOgre.html#a619">operator!=</a>(<span class="keyword">const</span> AnimationState& rhs) <span class="keyword">const</span>; |
---|
69 | 00087 |
---|
70 | 00089 <a class="code" href="namespaceOgre.html#a420">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>; |
---|
71 | 00090 |
---|
72 | 00092 <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a420">Real</a> value); |
---|
73 | <a name="l00096"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea18">00096</a> <span class="keywordtype">void</span> setLoop(<span class="keywordtype">bool</span> loop) { mLoop = loop; } |
---|
74 | <a name="l00098"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatea19">00098</a> <span class="keywordtype">bool</span> getLoop(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLoop; } |
---|
75 | 00099 |
---|
76 | 00104 <span class="keywordtype">void</span> copyStateFrom(<span class="keyword">const</span> AnimationState& animState); |
---|
77 | 00105 |
---|
78 | 00106 <span class="keyword">protected</span>: |
---|
79 | <a name="l00107"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep0">00107</a> <a class="code" href="namespaceOgre.html#a426">String</a> mAnimationName; |
---|
80 | <a name="l00108"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep1">00108</a> <a class="code" href="namespaceOgre.html#a420">Real</a> mTimePos; |
---|
81 | <a name="l00109"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep2">00109</a> <a class="code" href="namespaceOgre.html#a420">Real</a> mLength; |
---|
82 | <a name="l00110"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep3">00110</a> <a class="code" href="namespaceOgre.html#a420">Real</a> mInvLength; |
---|
83 | <a name="l00111"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep4">00111</a> <a class="code" href="namespaceOgre.html#a420">Real</a> mWeight; |
---|
84 | <a name="l00112"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep5">00112</a> <span class="keywordtype">bool</span> mEnabled; |
---|
85 | <a name="l00113"></a><a class="code" href="classOgre_1_1AnimationState.html#Ogre_1_1AnimationStatep6">00113</a> <span class="keywordtype">bool</span> mLoop; |
---|
86 | 00114 |
---|
87 | 00115 }; |
---|
88 | 00116 |
---|
89 | 00117 <span class="comment">// A set of animation states</span> |
---|
90 | <a name="l00118"></a><a class="code" href="namespaceOgre.html#a0">00118</a> <span class="keyword">typedef</span> std::map<String, AnimationState> <a class="code" href="namespaceOgre.html#a0">AnimationStateSet</a>; |
---|
91 | <a name="l00119"></a><a class="code" href="namespaceOgre.html#a1">00119</a> <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1MapIterator.html">MapIterator<AnimationStateSet></a> <a class="code" href="classOgre_1_1MapIterator.html">AnimationStateIterator</a>; |
---|
92 | 00120 |
---|
93 | 00128 <a class="code" href="class__OgreExport.html">_OgreExport</a> <span class="keywordtype">void</span> <a class="code" href="namespaceOgre.html#a610">CopyAnimationStateSubset</a>(<a class="code" href="namespaceOgre.html#a0">AnimationStateSet</a>& target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a0">AnimationStateSet</a>& source); |
---|
94 | 00129 |
---|
95 | 00130 } |
---|
96 | 00131 |
---|
97 | 00132 <span class="preprocessor">#endif</span> |
---|
98 | 00133 <span class="preprocessor"></span> |
---|
99 | </pre></div><hr> |
---|
100 | <p> |
---|
101 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
102 | <!--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/> |
---|
103 | This 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/> |
---|
104 | <!--/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#"> |
---|
105 | <Work rdf:about=""> |
---|
106 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
107 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
108 | </Work> |
---|
109 | <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> --> |
---|
110 | |
---|
111 | Last modified Sun Feb 12 12:59:41 2006 |
---|
112 | </p> |
---|
113 | </body> |
---|
114 | </html> |
---|