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

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

adding ogre 1.2 and dependencies
RevLine 
[692]1<html>
2<head>
3<title>Ogre::AnimationStateControllerValue class Reference - 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>Ogre::AnimationStateControllerValue Class Reference</h1><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> wrapper class for <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a>. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::AnimationStateControllerValue:
16<p><center><img src="classOgre_1_1AnimationStateControllerValue.png" usemap="#Ogre::AnimationStateControllerValue_map" border="0" alt=""></center>
17<map name="Ogre::AnimationStateControllerValue_map">
18<area href="classOgre_1_1ControllerValue.html" alt="Ogre::ControllerValue< Real >" shape="rect" coords="0,0,219,24">
19</map>
20<a href="classOgre_1_1AnimationStateControllerValue-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
21<tr><td></td></tr>
22<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
23<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuea0">AnimationStateControllerValue</a> (<a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> *targetAnimationState)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor, pass in the target animation state.  <a href="#Ogre_1_1AnimationStateControllerValuea0"></a><br><br></td></tr>
26<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuea1">~AnimationStateControllerValue</a> ()</td></tr>
27
28<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor (parent already virtual).  <a href="#Ogre_1_1AnimationStateControllerValuea1"></a><br><br></td></tr>
29<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuea2">getValue</a> (void) const </td></tr>
30
31<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.  <a href="#Ogre_1_1AnimationStateControllerValuea2"></a><br><br></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuea3">setValue</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> value)</td></tr>
33
34<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.  <a href="#Ogre_1_1AnimationStateControllerValuea3"></a><br><br></td></tr>
35<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
36<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuep0">mTargetAnimationState</a></td></tr>
37
38</table>
39<hr><a name="_details"></a><h2>Detailed Description</h2>
40<a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> wrapper class for <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a>.
41<p>
42<dl compact><dt><b>Remarks:</b></dt><dd>In Azathoth and earlier, <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> was a <a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> but this actually causes memory problems since Controllers delete their values automatically when there are no further references to them, but <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> is deleted explicitly elsewhere so this causes double-free problems. This wrapper acts as a bridge and it is this which is destroyed automatically.</dd></dl>
43
44<p>
45
46<p>
47Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00184">184</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
48<a class="anchor" name="Ogre_1_1AnimationStateControllerValuea0" doxytag="Ogre::AnimationStateControllerValue::AnimationStateControllerValue" ></a><p>
49<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
50  <tr>
51    <td class="mdRow">
52      <table cellpadding="0" cellspacing="0" border="0">
53        <tr>
54          <td class="md" nowrap valign="top"> Ogre::AnimationStateControllerValue::AnimationStateControllerValue </td>
55          <td class="md" valign="top">(&nbsp;</td>
56          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a> *&nbsp;</td>
57          <td class="mdname1" valign="top" nowrap> <em>targetAnimationState</em>          </td>
58          <td class="md" valign="top">&nbsp;)&nbsp;</td>
59          <td class="md" nowrap></td>
60        </tr>
61
62      </table>
63    </td>
64  </tr>
65</table>
66<table cellspacing=5 cellpadding=0 border=0>
67  <tr>
68    <td>
69      &nbsp;
70    </td>
71    <td>
72
73<p>
74Constructor, pass in the target animation state.
75<p>
76
77<p>
78Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00190">190</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.    </td>
79  </tr>
80</table>
81<a class="anchor" name="Ogre_1_1AnimationStateControllerValuea1" doxytag="Ogre::AnimationStateControllerValue::~AnimationStateControllerValue" ></a><p>
82<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
83  <tr>
84    <td class="mdRow">
85      <table cellpadding="0" cellspacing="0" border="0">
86        <tr>
87          <td class="md" nowrap valign="top"> Ogre::AnimationStateControllerValue::~<a class="el" href="classOgre_1_1AnimationStateControllerValue.html">AnimationStateControllerValue</a> </td>
88          <td class="md" valign="top">(&nbsp;</td>
89          <td class="mdname1" valign="top" nowrap>          </td>
90          <td class="md" valign="top">&nbsp;)&nbsp;</td>
91          <td class="md" nowrap></td>
92        </tr>
93
94      </table>
95    </td>
96  </tr>
97</table>
98<table cellspacing=5 cellpadding=0 border=0>
99  <tr>
100    <td>
101      &nbsp;
102    </td>
103    <td>
104
105<p>
106Destructor (parent already virtual).
107<p>
108
109<p>
110Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00193">193</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.    </td>
111  </tr>
112</table>
113<hr><h2>Member Function Documentation</h2>
114<a class="anchor" name="Ogre_1_1AnimationStateControllerValuea2" doxytag="Ogre::AnimationStateControllerValue::getValue" ></a><p>
115<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
116  <tr>
117    <td class="mdRow">
118      <table cellpadding="0" cellspacing="0" border="0">
119        <tr>
120          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::AnimationStateControllerValue::getValue </td>
121          <td class="md" valign="top">(&nbsp;</td>
122          <td class="md" nowrap valign="top">void&nbsp;</td>
123          <td class="mdname1" valign="top" nowrap>          </td>
124          <td class="md" valign="top">&nbsp;)&nbsp;</td>
125          <td class="md" nowrap> const<code> [virtual]</code></td>
126        </tr>
127
128      </table>
129    </td>
130  </tr>
131</table>
132<table cellspacing=5 cellpadding=0 border=0>
133  <tr>
134    <td>
135      &nbsp;
136    </td>
137    <td>
138
139<p>
140<a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.
141<p>
142
143<p>
144Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
145  </tr>
146</table>
147<a class="anchor" name="Ogre_1_1AnimationStateControllerValuea3" doxytag="Ogre::AnimationStateControllerValue::setValue" ></a><p>
148<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
149  <tr>
150    <td class="mdRow">
151      <table cellpadding="0" cellspacing="0" border="0">
152        <tr>
153          <td class="md" nowrap valign="top"> void Ogre::AnimationStateControllerValue::setValue </td>
154          <td class="md" valign="top">(&nbsp;</td>
155          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
156          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
157          <td class="md" valign="top">&nbsp;)&nbsp;</td>
158          <td class="md" nowrap><code> [virtual]</code></td>
159        </tr>
160
161      </table>
162    </td>
163  </tr>
164</table>
165<table cellspacing=5 cellpadding=0 border=0>
166  <tr>
167    <td>
168      &nbsp;
169    </td>
170    <td>
171
172<p>
173<a class="el" href="classOgre_1_1ControllerValue.html">ControllerValue</a> implementation.
174<p>
175
176<p>
177Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea2">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
178  </tr>
179</table>
180<hr><h2>Member Data Documentation</h2>
181<a class="anchor" name="Ogre_1_1AnimationStateControllerValuep0" doxytag="Ogre::AnimationStateControllerValue::mTargetAnimationState" ></a><p>
182<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
183  <tr>
184    <td class="mdRow">
185      <table cellpadding="0" cellspacing="0" border="0">
186        <tr>
187          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1AnimationState.html">AnimationState</a>* <a class="el" href="classOgre_1_1AnimationStateControllerValue.html#Ogre_1_1AnimationStateControllerValuep0">Ogre::AnimationStateControllerValue::mTargetAnimationState</a><code> [protected]</code>
188      </table>
189    </td>
190  </tr>
191</table>
192<table cellspacing=5 cellpadding=0 border=0>
193  <tr>
194    <td>
195      &nbsp;
196    </td>
197    <td>
198
199<p>
200
201<p>
202Definition at line <a class="el" href="OgreAnimationState_8h-source.html#l00187">187</a> of file <a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a>.    </td>
203  </tr>
204</table>
205<hr>The documentation for this class was generated from the following file:<ul>
206<li><a class="el" href="OgreAnimationState_8h-source.html">OgreAnimationState.h</a></ul>
207<hr>
208<p>
209Copyright &copy; 2000-2005 by The OGRE Team<br />
210<!--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/>
211This 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/>
212                <!--/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#">
213                <Work rdf:about="">
214                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
215        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
216                </Work>
217                <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> -->
218
219Last modified Sun Mar 12 14:38:04 2006
220</p>
221</body>
222</html>
Note: See TracBrowser for help on using the repository browser.