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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreColourFaderAffector.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>OgreColourFaderAffector.h</h1><a href="OgreColourFaderAffector_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 __ColourFaderAffector_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __ColourFaderAffector_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_1ColourFaderAffector.html">00040</a>     <span class="keyword">class </span><a class="code" href="OgreParticleFXPrerequisites_8h.html#a0">_OgreParticleFXExport</a> ColourFaderAffector : <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_1ColourFaderAffector_1_1CmdRedAdjust.html">00045</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdRedAdjust.html">CmdRedAdjust</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#a426">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#a426">String</a>&amp; val);
5300050         };
5400051
55<a name="l00053"></a><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdGreenAdjust.html">00053</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdGreenAdjust.html">CmdGreenAdjust</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#a426">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#a426">String</a>&amp; val);
6000058         };
6100059
62<a name="l00061"></a><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdBlueAdjust.html">00061</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdBlueAdjust.html">CmdBlueAdjust</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#a426">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#a426">String</a>&amp; val);
6700066         };
6800067
69<a name="l00069"></a><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdAlphaAdjust.html">00069</a>         <span class="keyword">class </span><a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdAlphaAdjust.html">CmdAlphaAdjust</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#a426">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#a426">String</a>&amp; val);
7400074         };
7500075
7600076
7700078         ColourFaderAffector(<a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* psys);
7800079
7900081         <span class="keywordtype">void</span> _affectParticles(<a class="code" href="classOgre_1_1ParticleSystem.html">ParticleSystem</a>* pSystem, <a class="code" href="namespaceOgre.html#a420">Real</a> timeElapsed);
8000082
8100089         <span class="keywordtype">void</span> setAdjust(<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);
8200096         <span class="keywordtype">void</span> setRedAdjust(<span class="keywordtype">float</span> red);
8300097
8400099         <span class="keywordtype">float</span> getRedAdjust(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8500100
8600107         <span class="keywordtype">void</span> setGreenAdjust(<span class="keywordtype">float</span> green);
8700109         <span class="keywordtype">float</span> getGreenAdjust(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8800116         <span class="keywordtype">void</span> setBlueAdjust(<span class="keywordtype">float</span> blue);
8900118         <span class="keywordtype">float</span> getBlueAdjust(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9000119
9100126         <span class="keywordtype">void</span> setAlphaAdjust(<span class="keywordtype">float</span> alpha);
9200128         <span class="keywordtype">float</span> getAlphaAdjust(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9300129
94<a name="l00130"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectors0">00130</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdRedAdjust.html">CmdRedAdjust</a> msRedCmd;
95<a name="l00131"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectors1">00131</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdGreenAdjust.html">CmdGreenAdjust</a> msGreenCmd;
96<a name="l00132"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectors2">00132</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdBlueAdjust.html">CmdBlueAdjust</a> msBlueCmd;
97<a name="l00133"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectors3">00133</a>         <span class="keyword">static</span> <a class="code" href="classOgre_1_1ColourFaderAffector_1_1CmdAlphaAdjust.html">CmdAlphaAdjust</a> msAlphaCmd;
9800134
9900135     <span class="keyword">protected</span>:
100<a name="l00136"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectorp0">00136</a>         <span class="keywordtype">float</span> mRedAdj;
101<a name="l00137"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectorp1">00137</a>         <span class="keywordtype">float</span> mGreenAdj;
102<a name="l00138"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectorp2">00138</a>         <span class="keywordtype">float</span> mBlueAdj;
103<a name="l00139"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectorp3">00139</a>         <span class="keywordtype">float</span> mAlphaAdj;
10400140
105<a name="l00142"></a><a class="code" href="classOgre_1_1ColourFaderAffector.html#Ogre_1_1ColourFaderAffectorb0">00142</a>         <span class="keyword">inline</span> <span class="keywordtype">void</span> applyAdjustWithClamp(<span class="keywordtype">float</span>* pComponent, <span class="keywordtype">float</span> adjust)
10600143         {
10700144             *pComponent += adjust;
10800145             <span class="comment">// Limit to 0</span>
10900146             <span class="keywordflow">if</span> (*pComponent &lt; 0.0)
11000147             {
11100148                 *pComponent = 0.0f;
11200149             }
11300150             <span class="comment">// Limit to 1</span>
11400151             <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*pComponent &gt; 1.0)
11500152             {
11600153                 *pComponent = 1.0f;
11700154             }
11800155         }
11900156
12000157     };
12100158
12200159
12300160 }
12400161
12500162
12600163 <span class="preprocessor">#endif</span>
12700164 <span class="preprocessor"></span>
128</pre></div><hr>
129<p>
130Copyright &copy; 2000-2005 by The OGRE Team<br />
131<!--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/>
132This 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/>
133                <!--/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#">
134                <Work rdf:about="">
135                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
136        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
137                </Work>
138                <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> -->
139
140Last modified Sun Feb 12 12:59:42 2006
141</p>
142</body>
143</html>
Note: See TracBrowser for help on using the repository browser.