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

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

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>Ogre::TexCoordModifierControllerValue 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::TexCoordModifierControllerValue Class Reference</h1>Predefined controller value for getting / setting a texture coordinate modifications (scales and translates). 
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::TexCoordModifierControllerValue:
16<p><center><img src="classOgre_1_1TexCoordModifierControllerValue.png" usemap="#Ogre::TexCoordModifierControllerValue_map" border="0" alt=""></center>
17<map name="Ogre::TexCoordModifierControllerValue_map">
18<area href="classOgre_1_1ControllerValue.html" alt="Ogre::ControllerValue< Real >" shape="rect" coords="0,0,238,24">
19</map>
20<a href="classOgre_1_1TexCoordModifierControllerValue-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_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuea0">TexCoordModifierControllerValue</a> (<a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> *t, bool translateU=false, bool translateV=false, bool scaleU=false, bool scaleV=false, bool rotate=false)</td></tr>
24
25<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#Ogre_1_1TexCoordModifierControllerValuea0"></a><br><br></td></tr>
26<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_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuea1">getValue</a> (void) const </td></tr>
27
28<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuea2">setValue</a> (<a class="el" href="namespaceOgre.html#a465">Real</a> value)</td></tr>
29
30<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
31<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep0">mTransU</a></td></tr>
32
33<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep1">mTransV</a></td></tr>
34
35<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep2">mScaleU</a></td></tr>
36
37<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep3">mScaleV</a></td></tr>
38
39<tr><td class="memItemLeft" nowrap align=right valign=top>bool&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep4">mRotate</a></td></tr>
40
41<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_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep5">mTextureLayer</a></td></tr>
42
43</table>
44<hr><a name="_details"></a><h2>Detailed Description</h2>
45Predefined controller value for getting / setting a texture coordinate modifications (scales and translates).
46<p>
47<dl compact><dt><b>Remarks:</b></dt><dd>Effects can be applied to the scale or the offset of the u or v coordinates, or both. If separate modifications are required to u and v then 2 instances are required to control both independently, or 4 if you ant separate u and v scales as well as separate u and v offsets. </dd></dl>
48<dl compact><dt><b></b></dt><dd>Because of the nature of this value, it can accept values outside the 0..1 parametric range. </dd></dl>
49
50<p>
51
52<p>
53Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00091">91</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.<hr><h2>Constructor &amp; Destructor Documentation</h2>
54<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuea0" doxytag="Ogre::TexCoordModifierControllerValue::TexCoordModifierControllerValue" ></a><p>
55<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
56  <tr>
57    <td class="mdRow">
58      <table cellpadding="0" cellspacing="0" border="0">
59        <tr>
60          <td class="md" nowrap valign="top"> Ogre::TexCoordModifierControllerValue::TexCoordModifierControllerValue </td>
61          <td class="md" valign="top">(&nbsp;</td>
62          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> *&nbsp;</td>
63          <td class="mdname" nowrap> <em>t</em>, </td>
64        </tr>
65        <tr>
66          <td class="md" nowrap align="right"></td>
67          <td></td>
68          <td class="md" nowrap>bool&nbsp;</td>
69          <td class="mdname" nowrap> <em>translateU</em> = false, </td>
70        </tr>
71        <tr>
72          <td class="md" nowrap align="right"></td>
73          <td></td>
74          <td class="md" nowrap>bool&nbsp;</td>
75          <td class="mdname" nowrap> <em>translateV</em> = false, </td>
76        </tr>
77        <tr>
78          <td class="md" nowrap align="right"></td>
79          <td></td>
80          <td class="md" nowrap>bool&nbsp;</td>
81          <td class="mdname" nowrap> <em>scaleU</em> = false, </td>
82        </tr>
83        <tr>
84          <td class="md" nowrap align="right"></td>
85          <td></td>
86          <td class="md" nowrap>bool&nbsp;</td>
87          <td class="mdname" nowrap> <em>scaleV</em> = false, </td>
88        </tr>
89        <tr>
90          <td class="md" nowrap align="right"></td>
91          <td></td>
92          <td class="md" nowrap>bool&nbsp;</td>
93          <td class="mdname" nowrap> <em>rotate</em> = false</td>
94        </tr>
95        <tr>
96          <td></td>
97          <td class="md">)&nbsp;</td>
98          <td class="md" colspan="2"></td>
99        </tr>
100
101      </table>
102    </td>
103  </tr>
104</table>
105<table cellspacing=5 cellpadding=0 border=0>
106  <tr>
107    <td>
108      &nbsp;
109    </td>
110    <td>
111
112<p>
113Constructor.
114<p>
115<dl compact><dt><b>Parameters:</b></dt><dd>
116  <table border="0" cellspacing="2" cellpadding="0">
117    <tr><td valign=top><em>t</em>&nbsp;</td><td><a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a> to apply the modification to. </td></tr>
118    <tr><td valign=top><em>translateU</em>&nbsp;</td><td>If true, the u coordinates will be translated by the modification. </td></tr>
119    <tr><td valign=top><em>translateV</em>&nbsp;</td><td>If true, the v coordinates will be translated by the modification. </td></tr>
120    <tr><td valign=top><em>scaleU</em>&nbsp;</td><td>If true, the u coordinates will be scaled by the modification. </td></tr>
121    <tr><td valign=top><em>scaleV</em>&nbsp;</td><td>If true, the v coordinates will be scaled by the modification. </td></tr>
122    <tr><td valign=top><em>rotate</em>&nbsp;</td><td>If true, the texture will be rotated by the modification. </td></tr>
123  </table>
124</dl>
125    </td>
126  </tr>
127</table>
128<hr><h2>Member Function Documentation</h2>
129<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuea1" doxytag="Ogre::TexCoordModifierControllerValue::getValue" ></a><p>
130<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
131  <tr>
132    <td class="mdRow">
133      <table cellpadding="0" cellspacing="0" border="0">
134        <tr>
135          <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::TexCoordModifierControllerValue::getValue </td>
136          <td class="md" valign="top">(&nbsp;</td>
137          <td class="md" nowrap valign="top">void&nbsp;</td>
138          <td class="mdname1" valign="top" nowrap>          </td>
139          <td class="md" valign="top">&nbsp;)&nbsp;</td>
140          <td class="md" nowrap> const<code> [virtual]</code></td>
141        </tr>
142
143      </table>
144    </td>
145  </tr>
146</table>
147<table cellspacing=5 cellpadding=0 border=0>
148  <tr>
149    <td>
150      &nbsp;
151    </td>
152    <td>
153
154<p>
155
156<p>
157Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea1">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
158  </tr>
159</table>
160<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuea2" doxytag="Ogre::TexCoordModifierControllerValue::setValue" ></a><p>
161<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
162  <tr>
163    <td class="mdRow">
164      <table cellpadding="0" cellspacing="0" border="0">
165        <tr>
166          <td class="md" nowrap valign="top"> void Ogre::TexCoordModifierControllerValue::setValue </td>
167          <td class="md" valign="top">(&nbsp;</td>
168          <td class="md" nowrap valign="top"><a class="el" href="namespaceOgre.html#a465">Real</a>&nbsp;</td>
169          <td class="mdname1" valign="top" nowrap> <em>value</em>          </td>
170          <td class="md" valign="top">&nbsp;)&nbsp;</td>
171          <td class="md" nowrap><code> [virtual]</code></td>
172        </tr>
173
174      </table>
175    </td>
176  </tr>
177</table>
178<table cellspacing=5 cellpadding=0 border=0>
179  <tr>
180    <td>
181      &nbsp;
182    </td>
183    <td>
184
185<p>
186
187<p>
188Implements <a class="el" href="classOgre_1_1ControllerValue.html#Ogre_1_1ControllerValuea2">Ogre::ControllerValue&lt; Real &gt;</a>.    </td>
189  </tr>
190</table>
191<hr><h2>Member Data Documentation</h2>
192<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuep4" doxytag="Ogre::TexCoordModifierControllerValue::mRotate" ></a><p>
193<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
194  <tr>
195    <td class="mdRow">
196      <table cellpadding="0" cellspacing="0" border="0">
197        <tr>
198          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep4">Ogre::TexCoordModifierControllerValue::mRotate</a><code> [protected]</code>
199      </table>
200    </td>
201  </tr>
202</table>
203<table cellspacing=5 cellpadding=0 border=0>
204  <tr>
205    <td>
206      &nbsp;
207    </td>
208    <td>
209
210<p>
211
212<p>
213Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00096">96</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
214  </tr>
215</table>
216<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuep2" doxytag="Ogre::TexCoordModifierControllerValue::mScaleU" ></a><p>
217<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
218  <tr>
219    <td class="mdRow">
220      <table cellpadding="0" cellspacing="0" border="0">
221        <tr>
222          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep2">Ogre::TexCoordModifierControllerValue::mScaleU</a><code> [protected]</code>
223      </table>
224    </td>
225  </tr>
226</table>
227<table cellspacing=5 cellpadding=0 border=0>
228  <tr>
229    <td>
230      &nbsp;
231    </td>
232    <td>
233
234<p>
235
236<p>
237Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00095">95</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
238  </tr>
239</table>
240<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuep3" doxytag="Ogre::TexCoordModifierControllerValue::mScaleV" ></a><p>
241<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
242  <tr>
243    <td class="mdRow">
244      <table cellpadding="0" cellspacing="0" border="0">
245        <tr>
246          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep3">Ogre::TexCoordModifierControllerValue::mScaleV</a><code> [protected]</code>
247      </table>
248    </td>
249  </tr>
250</table>
251<table cellspacing=5 cellpadding=0 border=0>
252  <tr>
253    <td>
254      &nbsp;
255    </td>
256    <td>
257
258<p>
259
260<p>
261Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00095">95</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
262  </tr>
263</table>
264<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuep5" doxytag="Ogre::TexCoordModifierControllerValue::mTextureLayer" ></a><p>
265<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
266  <tr>
267    <td class="mdRow">
268      <table cellpadding="0" cellspacing="0" border="0">
269        <tr>
270          <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* <a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep5">Ogre::TexCoordModifierControllerValue::mTextureLayer</a><code> [protected]</code>
271      </table>
272    </td>
273  </tr>
274</table>
275<table cellspacing=5 cellpadding=0 border=0>
276  <tr>
277    <td>
278      &nbsp;
279    </td>
280    <td>
281
282<p>
283
284<p>
285Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00097">97</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
286  </tr>
287</table>
288<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuep0" doxytag="Ogre::TexCoordModifierControllerValue::mTransU" ></a><p>
289<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
290  <tr>
291    <td class="mdRow">
292      <table cellpadding="0" cellspacing="0" border="0">
293        <tr>
294          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep0">Ogre::TexCoordModifierControllerValue::mTransU</a><code> [protected]</code>
295      </table>
296    </td>
297  </tr>
298</table>
299<table cellspacing=5 cellpadding=0 border=0>
300  <tr>
301    <td>
302      &nbsp;
303    </td>
304    <td>
305
306<p>
307
308<p>
309Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00094">94</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
310  </tr>
311</table>
312<a class="anchor" name="Ogre_1_1TexCoordModifierControllerValuep1" doxytag="Ogre::TexCoordModifierControllerValue::mTransV" ></a><p>
313<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
314  <tr>
315    <td class="mdRow">
316      <table cellpadding="0" cellspacing="0" border="0">
317        <tr>
318          <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep1">Ogre::TexCoordModifierControllerValue::mTransV</a><code> [protected]</code>
319      </table>
320    </td>
321  </tr>
322</table>
323<table cellspacing=5 cellpadding=0 border=0>
324  <tr>
325    <td>
326      &nbsp;
327    </td>
328    <td>
329
330<p>
331
332<p>
333Definition at line <a class="el" href="OgrePredefinedControllers_8h-source.html#l00094">94</a> of file <a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a>.    </td>
334  </tr>
335</table>
336<hr>The documentation for this class was generated from the following file:<ul>
337<li><a class="el" href="OgrePredefinedControllers_8h-source.html">OgrePredefinedControllers.h</a></ul>
338<hr>
339<p>
340Copyright &copy; 2000-2005 by The OGRE Team<br />
341<!--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/>
342This 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/>
343                <!--/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#">
344                <Work rdf:about="">
345                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
346        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
347                </Work>
348                <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> -->
349
350Last modified Sun Mar 12 14:41:44 2006
351</p>
352</body>
353</html>
Note: See TracBrowser for help on using the repository browser.