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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgrePredefinedControllers.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>OgrePredefinedControllers.h</h1><a href="OgrePredefinedControllers_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 <span class="preprocessor">#ifndef __PredefinedControllers_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __PredefinedControllers_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029
3900030 <span class="preprocessor">#include "<a class="code" href="OgreCommon_8h.html">OgreCommon.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreController_8h.html">OgreController.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreFrameListener_8h.html">OgreFrameListener.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreGpuProgram_8h.html">OgreGpuProgram.h</a>"</span>
4300034
4400035 <span class="keyword">namespace </span>Ogre {
4500036
4600037     <span class="comment">//-----------------------------------------------------------------------</span>
4700038     <span class="comment">// Controller Values</span>
4800039     <span class="comment">//-----------------------------------------------------------------------</span>
49<a name="l00042"></a><a class="code" href="classOgre_1_1FrameTimeControllerValue.html">00042</a> <span class="comment"></span>    <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> FrameTimeControllerValue : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;Real&gt;, <span class="keyword">public</span> <a class="code" href="classOgre_1_1FrameListener.html">FrameListener</a>
5000043     {
5100044     <span class="keyword">protected</span>:
52<a name="l00045"></a><a class="code" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep0">00045</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mFrameTime;
53<a name="l00046"></a><a class="code" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep1">00046</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mTimeFactor;
54<a name="l00047"></a><a class="code" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep2">00047</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mElapsedTime;
5500048
5600049     <span class="keyword">public</span>:
5700050         FrameTimeControllerValue();
5800051         <span class="keywordtype">bool</span> frameEnded(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
5900052         <span class="keywordtype">bool</span> frameStarted(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
6000053         <a class="code" href="namespaceOgre.html#a420">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6100054         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a420">Real</a> value);
6200055         <a class="code" href="namespaceOgre.html#a420">Real</a> getTimeFactor(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6300056         <span class="keywordtype">void</span> setTimeFactor(<a class="code" href="namespaceOgre.html#a420">Real</a> tf);
6400057         <a class="code" href="namespaceOgre.html#a420">Real</a> getElapsedTime(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6500058         <span class="keywordtype">void</span> setElapsedTime(<a class="code" href="namespaceOgre.html#a420">Real</a> elapsedTime);
6600059     };
6700060
6800061     <span class="comment">//-----------------------------------------------------------------------</span>
69<a name="l00064"></a><a class="code" href="classOgre_1_1TextureFrameControllerValue.html">00064</a> <span class="comment"></span>    <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> TextureFrameControllerValue : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;Real&gt;
7000065     {
7100066     <span class="keyword">protected</span>:
72<a name="l00067"></a><a class="code" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuep0">00067</a>         <a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* mTextureLayer;
7300068     <span class="keyword">public</span>:
7400069         TextureFrameControllerValue(<a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* t);
7500070
7600073         <a class="code" href="namespaceOgre.html#a420">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7700076         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a420">Real</a> value);
7800077
7900078     };
8000079     <span class="comment">//-----------------------------------------------------------------------</span>
81<a name="l00088"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html">00088</a> <span class="comment"></span>    <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> TexCoordModifierControllerValue : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;Real&gt;
8200089     {
8300090     <span class="keyword">protected</span>:
84<a name="l00091"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep1">00091</a>         <span class="keywordtype">bool</span> mTransU, mTransV;
85<a name="l00092"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep3">00092</a>         <span class="keywordtype">bool</span> mScaleU, mScaleV;
86<a name="l00093"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep4">00093</a>         <span class="keywordtype">bool</span> mRotate;
87<a name="l00094"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep5">00094</a>         <a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* mTextureLayer;
8800095     <span class="keyword">public</span>:
8900110         TexCoordModifierControllerValue(<a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* t, <span class="keywordtype">bool</span> translateU = <span class="keyword">false</span>, <span class="keywordtype">bool</span> translateV = <span class="keyword">false</span>,
9000111             <span class="keywordtype">bool</span> scaleU = <span class="keyword">false</span>, <span class="keywordtype">bool</span> scaleV = <span class="keyword">false</span>, <span class="keywordtype">bool</span> rotate = <span class="keyword">false</span> );
9100112
9200113         <a class="code" href="namespaceOgre.html#a420">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9300114         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a420">Real</a> value);
9400115
9500116     };
9600117
9700118     <span class="comment">//-----------------------------------------------------------------------</span>
98<a name="l00131"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html">00131</a> <span class="comment"></span>    <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> FloatGpuParameterControllerValue : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerValue.html">ControllerValue</a>&lt;Real&gt;
9900132     {
10000133     <span class="keyword">protected</span>:
101<a name="l00135"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep0">00135</a>         <a class="code" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a>* mParams;
102<a name="l00137"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep1">00137</a>         size_t mParamIndex;
10300138     <span class="keyword">public</span>:
10400145         FloatGpuParameterControllerValue(<a class="code" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a>* <a class="code" href="OgreGLPrerequisites_8h.html#a74">params</a>,
10500146                 size_t index );
10600147
107<a name="l00148"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea1">00148</a>         ~FloatGpuParameterControllerValue() {}
10800149
10900150         <a class="code" href="namespaceOgre.html#a420">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11000151         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a420">Real</a> value);
11100152
11200153     };
11300154     <span class="comment">//-----------------------------------------------------------------------</span>
11400155     <span class="comment">// Controller functions</span>
11500156     <span class="comment">//-----------------------------------------------------------------------</span>
11600157
117<a name="l00160"></a><a class="code" href="classOgre_1_1AnimationControllerFunction.html">00160</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> AnimationControllerFunction : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;Real&gt;
11800161     {
11900162     <span class="keyword">protected</span>:
120<a name="l00163"></a><a class="code" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp0">00163</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mSeqTime;
121<a name="l00164"></a><a class="code" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp1">00164</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mTime;
12200165     <span class="keyword">public</span>:
12300172         AnimationControllerFunction(<a class="code" href="namespaceOgre.html#a420">Real</a> sequenceTime, <a class="code" href="namespaceOgre.html#a420">Real</a> timeOffset = 0.0f);
12400173
12500176         <a class="code" href="namespaceOgre.html#a420">Real</a> calculate(<a class="code" href="namespaceOgre.html#a420">Real</a> source);
12600177     };
12700178
12800179     <span class="comment">//-----------------------------------------------------------------------</span>
129<a name="l00182"></a><a class="code" href="classOgre_1_1ScaleControllerFunction.html">00182</a> <span class="comment"></span>    <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> ScaleControllerFunction : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;Real&gt;
13000183     {
13100184     <span class="keyword">protected</span>:
132<a name="l00185"></a><a class="code" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctionp0">00185</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mScale;
13300186     <span class="keyword">public</span>:
13400194         ScaleControllerFunction(<a class="code" href="namespaceOgre.html#a420">Real</a> scalefactor, <span class="keywordtype">bool</span> deltaInput);
13500195
13600198         <a class="code" href="namespaceOgre.html#a420">Real</a> calculate(<a class="code" href="namespaceOgre.html#a420">Real</a> source);
13700199
13800200     };
13900201
14000202     <span class="comment">//-----------------------------------------------------------------------</span>
141<a name="l00221"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html">00221</a> <span class="comment"></span>    <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> WaveformControllerFunction : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;Real&gt;
14200222     {
14300223     <span class="keyword">protected</span>:
144<a name="l00224"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp0">00224</a>         <a class="code" href="namespaceOgre.html#a645">WaveformType</a> mWaveType;
145<a name="l00225"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp1">00225</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mBase;
146<a name="l00226"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp2">00226</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mFrequency;
147<a name="l00227"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp3">00227</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mPhase;
148<a name="l00228"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp4">00228</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mAmplitude;
14900229
15000231         <a class="code" href="namespaceOgre.html#a420">Real</a> getAdjustedInput(<a class="code" href="namespaceOgre.html#a420">Real</a> input);
15100232
15200233     <span class="keyword">public</span>:
15300239         WaveformControllerFunction(WaveformType wType, <a class="code" href="namespaceOgre.html#a420">Real</a> base = 0, <a class="code" href="namespaceOgre.html#a420">Real</a> frequency = 1, <a class="code" href="namespaceOgre.html#a420">Real</a> phase = 0, <a class="code" href="namespaceOgre.html#a420">Real</a> amplitude = 1, <span class="keywordtype">bool</span> deltaInput = <span class="keyword">true</span>);
15400240
15500243         <a class="code" href="namespaceOgre.html#a420">Real</a> calculate(<a class="code" href="namespaceOgre.html#a420">Real</a> source);
15600244
15700245     };
15800246     <span class="comment">//-----------------------------------------------------------------------</span>
15900247
16000248 }
16100249
16200250 <span class="preprocessor">#endif</span>
163</pre></div><hr>
164<p>
165Copyright &copy; 2000-2005 by The OGRE Team<br />
166<!--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/>
167This 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/>
168                <!--/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#">
169                <Work rdf:about="">
170                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
171        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
172                </Work>
173                <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> -->
174
175Last modified Sun Feb 12 12:59:50 2006
176</p>
177</body>
178</html>
Note: See TracBrowser for help on using the repository browser.