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

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

adding ogre 1.2 and dependencies
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#a465">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#a465">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#a465">Real</a> mElapsedTime;
55<a name="l00048"></a><a class="code" href="classOgre_1_1FrameTimeControllerValue.html#Ogre_1_1FrameTimeControllerValuep3">00048</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mFrameDelay;
5600049
5700050     <span class="keyword">public</span>:
5800051         FrameTimeControllerValue();
5900052         <span class="keywordtype">bool</span> frameEnded(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
6000053         <span class="keywordtype">bool</span> frameStarted(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a> &amp;evt);
6100054         <a class="code" href="namespaceOgre.html#a465">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6200055         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a465">Real</a> value);
6300056         <a class="code" href="namespaceOgre.html#a465">Real</a> getTimeFactor(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6400057         <span class="keywordtype">void</span> setTimeFactor(<a class="code" href="namespaceOgre.html#a465">Real</a> tf);
6500058         <a class="code" href="namespaceOgre.html#a465">Real</a> getFrameDelay(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6600059         <span class="keywordtype">void</span> setFrameDelay(<a class="code" href="namespaceOgre.html#a465">Real</a> fd);
6700060         <a class="code" href="namespaceOgre.html#a465">Real</a> getElapsedTime(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6800061         <span class="keywordtype">void</span> setElapsedTime(<a class="code" href="namespaceOgre.html#a465">Real</a> elapsedTime);
6900062     };
7000063
7100064     <span class="comment">//-----------------------------------------------------------------------</span>
72<a name="l00067"></a><a class="code" href="classOgre_1_1TextureFrameControllerValue.html">00067</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;
7300068     {
7400069     <span class="keyword">protected</span>:
75<a name="l00070"></a><a class="code" href="classOgre_1_1TextureFrameControllerValue.html#Ogre_1_1TextureFrameControllerValuep0">00070</a>         <a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* mTextureLayer;
7600071     <span class="keyword">public</span>:
7700072         TextureFrameControllerValue(<a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* t);
7800073
7900076         <a class="code" href="namespaceOgre.html#a465">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8000079         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a465">Real</a> value);
8100080
8200081     };
8300082     <span class="comment">//-----------------------------------------------------------------------</span>
84<a name="l00091"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html">00091</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;
8500092     {
8600093     <span class="keyword">protected</span>:
87<a name="l00094"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep1">00094</a>         <span class="keywordtype">bool</span> mTransU, mTransV;
88<a name="l00095"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep3">00095</a>         <span class="keywordtype">bool</span> mScaleU, mScaleV;
89<a name="l00096"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep4">00096</a>         <span class="keywordtype">bool</span> mRotate;
90<a name="l00097"></a><a class="code" href="classOgre_1_1TexCoordModifierControllerValue.html#Ogre_1_1TexCoordModifierControllerValuep5">00097</a>         <a class="code" href="classOgre_1_1TextureUnitState.html">TextureUnitState</a>* mTextureLayer;
9100098     <span class="keyword">public</span>:
9200113         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>,
9300114             <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> );
9400115
9500116         <a class="code" href="namespaceOgre.html#a465">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9600117         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a465">Real</a> value);
9700118
9800119     };
9900120
10000121     <span class="comment">//-----------------------------------------------------------------------</span>
101<a name="l00134"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html">00134</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;
10200135     {
10300136     <span class="keyword">protected</span>:
104<a name="l00138"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep0">00138</a>         <a class="code" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a>* mParams;
105<a name="l00140"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuep1">00140</a>         size_t mParamIndex;
10600141     <span class="keyword">public</span>:
10700148         FloatGpuParameterControllerValue(<a class="code" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a>* params,
10800149                 size_t index );
10900150
110<a name="l00151"></a><a class="code" href="classOgre_1_1FloatGpuParameterControllerValue.html#Ogre_1_1FloatGpuParameterControllerValuea1">00151</a>         ~FloatGpuParameterControllerValue() {}
11100152
11200153         <a class="code" href="namespaceOgre.html#a465">Real</a> getValue(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11300154         <span class="keywordtype">void</span> setValue(<a class="code" href="namespaceOgre.html#a465">Real</a> value);
11400155
11500156     };
11600157     <span class="comment">//-----------------------------------------------------------------------</span>
11700158     <span class="comment">// Controller functions</span>
11800159     <span class="comment">//-----------------------------------------------------------------------</span>
11900160
120<a name="l00164"></a><a class="code" href="classOgre_1_1PassthroughControllerFunction.html">00164</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> PassthroughControllerFunction : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ControllerFunction.html">ControllerFunction</a>&lt;Real&gt;
12100165     {
12200166     <span class="keyword">public</span>:
12300173         PassthroughControllerFunction(<span class="keywordtype">bool</span> deltaInput = <span class="keyword">false</span>);
12400174
12500177         <a class="code" href="namespaceOgre.html#a465">Real</a> calculate(<a class="code" href="namespaceOgre.html#a465">Real</a> source);
12600178     };
12700179
128<a name="l00182"></a><a class="code" href="classOgre_1_1AnimationControllerFunction.html">00182</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;
12900183     {
13000184     <span class="keyword">protected</span>:
131<a name="l00185"></a><a class="code" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp0">00185</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mSeqTime;
132<a name="l00186"></a><a class="code" href="classOgre_1_1AnimationControllerFunction.html#Ogre_1_1AnimationControllerFunctionp1">00186</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mTime;
13300187     <span class="keyword">public</span>:
13400194         AnimationControllerFunction(<a class="code" href="namespaceOgre.html#a465">Real</a> sequenceTime, <a class="code" href="namespaceOgre.html#a465">Real</a> timeOffset = 0.0f);
13500195
13600198         <a class="code" href="namespaceOgre.html#a465">Real</a> calculate(<a class="code" href="namespaceOgre.html#a465">Real</a> source);
13700199     };
13800200
13900201     <span class="comment">//-----------------------------------------------------------------------</span>
140<a name="l00204"></a><a class="code" href="classOgre_1_1ScaleControllerFunction.html">00204</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;
14100205     {
14200206     <span class="keyword">protected</span>:
143<a name="l00207"></a><a class="code" href="classOgre_1_1ScaleControllerFunction.html#Ogre_1_1ScaleControllerFunctionp0">00207</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mScale;
14400208     <span class="keyword">public</span>:
14500216         ScaleControllerFunction(<a class="code" href="namespaceOgre.html#a465">Real</a> scalefactor, <span class="keywordtype">bool</span> deltaInput);
14600217
14700220         <a class="code" href="namespaceOgre.html#a465">Real</a> calculate(<a class="code" href="namespaceOgre.html#a465">Real</a> source);
14800221
14900222     };
15000223
15100224     <span class="comment">//-----------------------------------------------------------------------</span>
152<a name="l00244"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html">00244</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;
15300245     {
15400246     <span class="keyword">protected</span>:
155<a name="l00247"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp0">00247</a>         <a class="code" href="namespaceOgre.html#a648">WaveformType</a> mWaveType;
156<a name="l00248"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp1">00248</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mBase;
157<a name="l00249"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp2">00249</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mFrequency;
158<a name="l00250"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp3">00250</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mPhase;
159<a name="l00251"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp4">00251</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mAmplitude;
160<a name="l00252"></a><a class="code" href="classOgre_1_1WaveformControllerFunction.html#Ogre_1_1WaveformControllerFunctionp5">00252</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mDutyCycle;
16100253
16200255         <a class="code" href="namespaceOgre.html#a465">Real</a> getAdjustedInput(<a class="code" href="namespaceOgre.html#a465">Real</a> input);
16300256
16400257     <span class="keyword">public</span>:
16500265         WaveformControllerFunction(WaveformType wType, <a class="code" href="namespaceOgre.html#a465">Real</a> base = 0, <a class="code" href="namespaceOgre.html#a465">Real</a> frequency = 1, <a class="code" href="namespaceOgre.html#a465">Real</a> phase = 0, <a class="code" href="namespaceOgre.html#a465">Real</a> amplitude = 1, <span class="keywordtype">bool</span> deltaInput = <span class="keyword">true</span>, <a class="code" href="namespaceOgre.html#a465">Real</a> dutyCycle = 0.5);
16600266
16700269         <a class="code" href="namespaceOgre.html#a465">Real</a> calculate(<a class="code" href="namespaceOgre.html#a465">Real</a> source);
16800270
16900271     };
17000272     <span class="comment">//-----------------------------------------------------------------------</span>
17100273
17200274 }
17300275
17400276 <span class="preprocessor">#endif</span>
175</pre></div><hr>
176<p>
177Copyright &copy; 2000-2005 by The OGRE Team<br />
178<!--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/>
179This 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/>
180                <!--/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#">
181                <Work rdf:about="">
182                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
183        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
184                </Work>
185                <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> -->
186
187Last modified Sun Mar 12 14:37:46 2006
188</p>
189</body>
190</html>
Note: See TracBrowser for help on using the repository browser.