source: OGRE/trunk/ogrenew/Docs/api/html/classOgre_1_1TextureFrameControllerValue.html @ 657

Revision 657, 9.7 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>Ogre::TextureFrameControllerValue 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::TextureFrameControllerValue Class Reference</h1>Predefined controller value for getting / setting the frame number of a texture layer. 
11<a href="#_details">More...</a>
12<p>
13<code>#include &lt;<a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>&gt;</code>
14<p>
15<p>Inheritance diagram for Ogre::TextureFrameControllerValue:
16<p><center><img src="classOgre_1_1TextureFrameControllerValue.png" usemap="#Ogre::TextureFrameControllerValue_map" border="0" alt=""></center>
17<map name="Ogre::TextureFrameControllerValue_map">
18<area href="classOgre_1_1ControllerValue.html" alt="Ogre::ControllerValue< Real >" shape="rect" coords="0,0,214,24">
19</map>
20<a href="classOgre_1_1TextureFrameControllerValue-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_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuea0">TextureFrameControllerValue</a> (<a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> *t)</td></tr>
24
25<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuea1">getValue</a> (void) const </td></tr>
26
27<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Gets the frame number as a parametric value in the range [0,1].  <a href="#Ogre_1_1TextureFrameControllerValuea1"></a><br><br></td></tr>
28<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuea2">setValue</a> (<a class="el" href="namespaceOgre.html#a420">Real</a> value)</td></tr>
29
30<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Sets the frame number as a parametric value in the range [0,1]; the actual frame number is value * (numFrames-1).  <a href="#Ogre_1_1TextureFrameControllerValuea2"></a><br><br></td></tr>
31<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
32<tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> *&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuep0">mTextureLayer</a></td></tr>
33
34</table>
35<hr><a name="_details"></a><h2>Detailed Description</h2>
36Predefined controller value for getting / setting the frame number of a texture layer.
37<p>
38
39<p>
40Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00064">64</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
41<a class="anchor" name="Ogre_1_1TextureFrameControllerValuea0" doxytag="Ogre::TextureFrameControllerValue::TextureFrameControllerValue" ></a><p>
42<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
43  <tr>
44    <td class="mdRow">
45      <table cellpadding="0" cellspacing="0" border="0">
46        <tr>
47          <td class="md" nowrap valign="top"> Ogre::TextureFrameControllerValue::TextureFrameControllerValue </td>
48          <td class="md" valign="top">(&nbsp;</td>
49          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> *&nbsp;</td>
50          <td class="mdname1" valign="top" nowrap> <em>t</em>          </td>
51          <td class="md" valign="top">&nbsp;)&nbsp;</td>
52          <td class="md" nowrap></td>
53        </tr>
54
55      </table>
56    </td>
57  </tr>
58</table>
59<table cellspacing=5 cellpadding=0 border=0>
60  <tr>
61    <td>
62      &nbsp;
63    </td>
64    <td>
65
66<p>
67    </td>
68  </tr>
69</table>
70<hr><h2>Member Function Documentation</h2>
71<a class="anchor" name="Ogre_1_1TextureFrameControllerValuea1" doxytag="Ogre::TextureFrameControllerValue::getValue" ></a><p>
72<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
73  <tr>
74    <td class="mdRow">
75      <table cellpadding="0" cellspacing="0" border="0">
76        <tr>
77          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::TextureFrameControllerValue::getValue </td>
78          <td class="md" valign="top">(&nbsp;</td>
79          <td class="md" nowrap valign="top">void&nbsp;</td>
80          <td class="mdname1" valign="top" nowrap>          </td>
81          <td class="md" valign="top">&nbsp;)&nbsp;</td>
82          <td class="md" nowrap> const<code> [virtual]</code></td>
83        </tr>
84
85      </table>
86    </td>
87  </tr>
88</table>
89<table cellspacing=5 cellpadding=0 border=0>
90  <tr>
91    <td>
92      &nbsp;
93    </td>
94    <td>
95
96<p>
97Gets the frame number as a parametric value in the range [0,1].
98<p>
99
100<p>
101Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
102  </tr>
103</table>
104<a class="anchor" name="Ogre_1_1TextureFrameControllerValuea2" doxytag="Ogre::TextureFrameControllerValue::setValue" ></a><p>
105<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
106  <tr>
107    <td class="mdRow">
108      <table cellpadding="0" cellspacing="0" border="0">
109        <tr>
110          <td class="md" nowrap valign="top"> void Ogre::TextureFrameControllerValue::setValue </td>
111          <td class="md" valign="top">(&nbsp;</td>
112          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a420">Real</a>&nbsp;</td>
113          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
114          <td class="md" valign="top">&nbsp;)&nbsp;</td>
115          <td class="md" nowrap><code> [virtual]</code></td>
116        </tr>
117
118      </table>
119    </td>
120  </tr>
121</table>
122<table cellspacing=5 cellpadding=0 border=0>
123  <tr>
124    <td>
125      &nbsp;
126    </td>
127    <td>
128
129<p>
130Sets the frame number as a parametric value in the range [0,1]; the actual frame number is value * (numFrames-1).
131<p>
132
133<p>
134Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea2">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
135  </tr>
136</table>
137<hr><h2>Member Data Documentation</h2>
138<a class="anchor" name="Ogre_1_1TextureFrameControllerValuep0" doxytag="Ogre::TextureFrameControllerValue::mTextureLayer" ></a><p>
139<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
140  <tr>
141    <td class="mdRow">
142      <table cellpadding="0" cellspacing="0" border="0">
143        <tr>
144          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* <a class="el" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuep0">Ogre::TextureFrameControllerValue::mTextureLayer</a><code> [protected]</code>
145      </table>
146    </td>
147  </tr>
148</table>
149<table cellspacing=5 cellpadding=0 border=0>
150  <tr>
151    <td>
152      &nbsp;
153    </td>
154    <td>
155
156<p>
157
158<p>
159Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00067">67</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
160  </tr>
161</table>
162<hr>The documentation for this class was generated from the following file:<ul>
163<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a></ul>
164<hr>
165<p>
166Copyright &copy; 2000-2005 by The OGRE Team<br />
167<!--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/>
168This 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/>
169                <!--/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#">
170                <Work rdf:about="">
171                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
172        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
173                </Work>
174                <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> -->
175
176Last modified Sun Feb 12 13:02:10 2006
177</p>
178</body>
179</html>
Note: See TracBrowser for help on using the repository browser.