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

Revision 692, 20.7 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreColourFaderAffector2.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>OgreColourFaderAffector2.h</h1><a href="OgreColourFaderAffector2_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 __ColourFaderAffector2_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __ColourFaderAffector2_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgreParticleFXPrerequisites_8h.html">OgreParticleFXPrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreParticleAffector_8h.html">OgreParticleAffector.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreStringInterface_8h.html">OgreStringInterface.h</a>"</span>
4000031
4100032 <span class="keyword">namespace </span>Ogre {
4200033
4300034
44<a name="l00040"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html">00040</a>     <span class="keyword">class </span><a class="code" href="OgreParticleFXPrerequisites_8h.html#a0">_OgreParticleFXExport</a> ColourFaderAffector2 : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParticleAffector.html">ParticleAffector</a>
4500041     {
4600042     <span class="keyword">public</span>:
4700043
48<a name="l00045"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdRedAdjust1.html">00045</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdRedAdjust1.html">CmdRedAdjust1</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
4900046         {
5000047         <span class="keyword">public</span>:
5100048             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
5200049             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
5300050         };
5400051
55<a name="l00053"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdGreenAdjust1.html">00053</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdGreenAdjust1.html">CmdGreenAdjust1</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
5600054         {
5700055         <span class="keyword">public</span>:
5800056             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
5900057             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
6000058         };
6100059
62<a name="l00061"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdBlueAdjust1.html">00061</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdBlueAdjust1.html">CmdBlueAdjust1</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
6300062         {
6400063         <span class="keyword">public</span>:
6500064             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
6600065             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
6700066         };
6800067
69<a name="l00069"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdAlphaAdjust1.html">00069</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdAlphaAdjust1.html">CmdAlphaAdjust1</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
7000070         {
7100071         <span class="keyword">public</span>:
7200072             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
7300073             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
7400074         };
7500075
76<a name="l00077"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdRedAdjust2.html">00077</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdRedAdjust2.html">CmdRedAdjust2</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
7700078         {
7800079         <span class="keyword">public</span>:
7900080             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
8000081             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
8100082         };
8200083
83<a name="l00085"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdGreenAdjust2.html">00085</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdGreenAdjust2.html">CmdGreenAdjust2</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
8400086         {
8500087         <span class="keyword">public</span>:
8600088             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
8700089             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
8800090         };
8900091
90<a name="l00093"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdBlueAdjust2.html">00093</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdBlueAdjust2.html">CmdBlueAdjust2</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
9100094         {
9200095         <span class="keyword">public</span>:
9300096             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
9400097             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
9500098         };
9600099
97<a name="l00101"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdAlphaAdjust2.html">00101</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdAlphaAdjust2.html">CmdAlphaAdjust2</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
9800102         {
9900103         <span class="keyword">public</span>:
10000104             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
10100105             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
10200106         };
10300107
104<a name="l00109"></a><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdStateChange.html">00109</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdStateChange.html">CmdStateChange</a> : <span class="keyword">public</span> <a class="code" href="classOgre_1_1ParamCommand.html">ParamCommand</a>
10500110         {
10600111         <span class="keyword">public</span>:
10700112             <a class="code" href="namespaceOgre.html#a471">String</a> doGet(<span class="keyword">const</span> <span class="keywordtype">void</span>* target) <span class="keyword">const</span>;
10800113             <span class="keywordtype">void</span> doSet(<span class="keywordtype">void</span>* target, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; val);
10900114         };
11000115
11100116
11200118         ColourFaderAffector2(<a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* psys);
11300119
11400121         <span class="keywordtype">void</span> _affectParticles(<a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* pSystem, <a class="code" href="namespaceOgre.html#a465">Real</a> timeElapsed);
11500122
11600129         <span class="keywordtype">void</span> setAdjust1(<span class="keywordtype">float</span> red, <span class="keywordtype">float</span> green, <span class="keywordtype">float</span> blue, <span class="keywordtype">float</span> alpha = 0.0);
11700130         <span class="keywordtype">void</span> setAdjust2(<span class="keywordtype">float</span> red, <span class="keywordtype">float</span> green, <span class="keywordtype">float</span> blue, <span class="keywordtype">float</span> alpha = 0.0);
11800137         <span class="keywordtype">void</span> setRedAdjust1(<span class="keywordtype">float</span> red);
11900138         <span class="keywordtype">void</span> setRedAdjust2(<span class="keywordtype">float</span> red);
12000139
12100141         <span class="keywordtype">float</span> getRedAdjust1(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12200142         <span class="keywordtype">float</span> getRedAdjust2(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12300143
12400150         <span class="keywordtype">void</span> setGreenAdjust1(<span class="keywordtype">float</span> green);
12500151         <span class="keywordtype">void</span> setGreenAdjust2(<span class="keywordtype">float</span> green);
12600153         <span class="keywordtype">float</span> getGreenAdjust1(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12700154         <span class="keywordtype">float</span> getGreenAdjust2(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12800161         <span class="keywordtype">void</span> setBlueAdjust1(<span class="keywordtype">float</span> blue);
12900162         <span class="keywordtype">void</span> setBlueAdjust2(<span class="keywordtype">float</span> blue);
13000164         <span class="keywordtype">float</span> getBlueAdjust1(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13100165         <span class="keywordtype">float</span> getBlueAdjust2(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13200166
13300173         <span class="keywordtype">void</span> setAlphaAdjust1(<span class="keywordtype">float</span> alpha);
13400174         <span class="keywordtype">void</span> setAlphaAdjust2(<span class="keywordtype">float</span> alpha);
13500176         <span class="keywordtype">float</span> getAlphaAdjust1(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13600177         <span class="keywordtype">float</span> getAlphaAdjust2(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13700178
13800179
13900180         <span class="keywordtype">void</span> setStateChange(<a class="code" href="namespaceOgre.html#a465">Real</a> NewValue );
14000181         <a class="code" href="namespaceOgre.html#a465">Real</a> getStateChange(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
14100182
142<a name="l00183"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s0">00183</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdRedAdjust1.html">CmdRedAdjust1</a> msRedCmd1;
143<a name="l00184"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s1">00184</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdRedAdjust2.html">CmdRedAdjust2</a> msRedCmd2;
144<a name="l00185"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s2">00185</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdGreenAdjust1.html">CmdGreenAdjust1</a> msGreenCmd1;
145<a name="l00186"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s3">00186</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdGreenAdjust2.html">CmdGreenAdjust2</a> msGreenCmd2;
146<a name="l00187"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s4">00187</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdBlueAdjust1.html">CmdBlueAdjust1</a> msBlueCmd1;
147<a name="l00188"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s5">00188</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdBlueAdjust2.html">CmdBlueAdjust2</a> msBlueCmd2;
148<a name="l00189"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s6">00189</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdAlphaAdjust1.html">CmdAlphaAdjust1</a> msAlphaCmd1;
149<a name="l00190"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s7">00190</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdAlphaAdjust2.html">CmdAlphaAdjust2</a> msAlphaCmd2;
150<a name="l00191"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2s8">00191</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector2_1_1CmdStateChange.html">CmdStateChange</a> msStateCmd;
15100192
15200193     <span class="keyword">protected</span>:
153<a name="l00194"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2p1">00194</a>         <span class="keywordtype">float</span> mRedAdj1, mRedAdj2;
154<a name="l00195"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2p3">00195</a>         <span class="keywordtype">float</span> mGreenAdj1,  mGreenAdj2;
155<a name="l00196"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2p5">00196</a>         <span class="keywordtype">float</span> mBlueAdj1, mBlueAdj2;
156<a name="l00197"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2p7">00197</a>         <span class="keywordtype">float</span> mAlphaAdj1, mAlphaAdj2;
157<a name="l00198"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2p8">00198</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> StateChangeVal;
15800199
159<a name="l00201"></a><a class="code" href="classOgre_1_1ColourFaderAffector2.html#Ogre_1_1ColourFaderAffector2b0">00201</a>         <span class="keyword">inline</span> <span class="keywordtype">void</span> applyAdjustWithClamp(<span class="keywordtype">float</span>* pComponent, <span class="keywordtype">float</span> adjust)
16000202         {
16100203             *pComponent += adjust;
16200204             <span class="comment">// Limit to 0</span>
16300205             <span class="keywordflow">if</span> (*pComponent &lt; 0.0)
16400206             {
16500207                 *pComponent = 0.0f;
16600208             }
16700209             <span class="comment">// Limit to 1</span>
16800210             <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*pComponent &gt; 1.0)
16900211             {
17000212                 *pComponent = 1.0f;
17100213             }
17200214         }
17300215
17400216     };
17500217
17600218
17700219 }
17800220
17900221
18000222 <span class="preprocessor">#endif</span>
18100223 <span class="preprocessor"></span>
182</pre></div><hr>
183<p>
184Copyright &copy; 2000-2005 by The OGRE Team<br />
185<!--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/>
186This 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/>
187                <!--/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#">
188                <Work rdf:about="">
189                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
190        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
191                </Work>
192                <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> -->
193
194Last modified Sun Mar 12 14:37:38 2006
195</p>
196</body>
197</html>
Note: See TracBrowser for help on using the repository browser.