source: OGRE/trunk/ogrenew/Docs/api/html/OgreLight_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>OgreLight.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>OgreLight.h</h1><a href="OgreLight_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 _LIGHT_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define _LIGHT_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="OgreColourValue_8h.html">OgreColourValue.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreVector3_8h.html">OgreVector3.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreVector4_8h.html">OgreVector4.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreString_8h.html">OgreString.h</a>"</span>
4300034 <span class="preprocessor">#include "<a class="code" href="OgreMovableObject_8h.html">OgreMovableObject.h</a>"</span>
4400035 <span class="preprocessor">#include "<a class="code" href="OgrePlaneBoundedVolume_8h.html">OgrePlaneBoundedVolume.h</a>"</span>
4500036
4600037 <span class="keyword">namespace </span>Ogre {
4700038
4800039
49<a name="l00062"></a><a class="code" href="classOgre_1_1Light.html">00062</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Light : <span class="keyword">public</span> <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>
5000063     {
5100064     <span class="keyword">public</span>:
52<a name="l00066"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lighto0">00066</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> tempSquareDist;
5300067
54<a name="l00069"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightw3">00069</a>         <span class="keyword">enum</span> LightTypes
5500070         {
5600072             LT_POINT,
5700074             LT_DIRECTIONAL,
5800076             LT_SPOTLIGHT
5900077         };
6000078
6100081         Light();
6200082
6300085         Light(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; name);
6400086
6500089         ~Light();
6600090
6700093         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; getName(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6800094
6900097         <span class="keywordtype">void</span> setType(LightTypes type);
7000098
7100101         LightTypes getType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7200102
7300112         <span class="keywordtype">void</span> setDiffuseColour(<a class="code" href="namespaceOgre.html#a420">Real</a> red, <a class="code" href="namespaceOgre.html#a420">Real</a> green, <a class="code" href="namespaceOgre.html#a420">Real</a> blue);
7400113
7500123         <span class="keywordtype">void</span> setDiffuseColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour);
7600124
7700127         <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; getDiffuseColour(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7800128
7900138         <span class="keywordtype">void</span> setSpecularColour(<a class="code" href="namespaceOgre.html#a420">Real</a> red, <a class="code" href="namespaceOgre.html#a420">Real</a> green, <a class="code" href="namespaceOgre.html#a420">Real</a> blue);
8000139
8100149         <span class="keywordtype">void</span> setSpecularColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour);
8200150
8300153         <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; getSpecularColour(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8400154
8500174         <span class="keywordtype">void</span> setAttenuation(<a class="code" href="namespaceOgre.html#a420">Real</a> range, <a class="code" href="namespaceOgre.html#a420">Real</a> constant, <a class="code" href="namespaceOgre.html#a420">Real</a> linear, <a class="code" href="namespaceOgre.html#a420">Real</a> quadratic);
8600175
8700178         <a class="code" href="namespaceOgre.html#a420">Real</a> getAttenuationRange(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8800179
8900182         <a class="code" href="namespaceOgre.html#a420">Real</a> getAttenuationConstant(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9000183
9100186         <a class="code" href="namespaceOgre.html#a420">Real</a> getAttenuationLinear(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9200187
9300190         <a class="code" href="namespaceOgre.html#a420">Real</a> getAttenuationQuadric(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9400191
9500198         <span class="keywordtype">void</span> setPosition(<a class="code" href="namespaceOgre.html#a420">Real</a> x, <a class="code" href="namespaceOgre.html#a420">Real</a> y, <a class="code" href="namespaceOgre.html#a420">Real</a> z);
9600199
9700206         <span class="keywordtype">void</span> setPosition(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vec);
9800207
9900212         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getPosition(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10000213
10100220         <span class="keywordtype">void</span> setDirection(<a class="code" href="namespaceOgre.html#a420">Real</a> x, <a class="code" href="namespaceOgre.html#a420">Real</a> y, <a class="code" href="namespaceOgre.html#a420">Real</a> z);
10200221
10300228         <span class="keywordtype">void</span> setDirection(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vec);
10400229
10500234         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getDirection(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10600235
10700246         <span class="keywordtype">void</span> setSpotlightRange(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Radian.html">Radian</a>&amp; innerAngle, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Radian.html">Radian</a>&amp; outerAngle, <a class="code" href="namespaceOgre.html#a420">Real</a> falloff = 1.0);
10800247 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
10900248 <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> setSpotlightRange(<a class="code" href="namespaceOgre.html#a420">Real</a> innerAngle, <a class="code" href="namespaceOgre.html#a420">Real</a> outerAngle, <a class="code" href="namespaceOgre.html#a420">Real</a> falloff = 1.0) {
11000249             setSpotlightRange ( <a class="code" href="classOgre_1_1Angle.html">Angle</a>(innerAngle), <a class="code" href="classOgre_1_1Angle.html">Angle</a>(outerAngle), falloff );
11100250         }
11200251 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
11300252 <span class="preprocessor"></span>
11400255         <span class="keyword">const</span> Radian&amp; getSpotlightInnerAngle(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11500256
11600259         <span class="keyword">const</span> Radian&amp; getSpotlightOuterAngle(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11700260
11800263         <a class="code" href="namespaceOgre.html#a420">Real</a> getSpotlightFalloff(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11900264
12000266         <span class="keywordtype">void</span> _notifyCurrentCamera(<a class="code" href="classOgre_1_1Camera.html">Camera</a>* cam);
12100267
12200269         <span class="keyword">const</span> AxisAlignedBox&amp; getBoundingBox(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12300270
12400272         <span class="keywordtype">void</span> _updateRenderQueue(RenderQueue* queue);
12500273
12600275         <span class="keyword">const</span> String&amp; getMovableType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12700276
12800278         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getDerivedPosition(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12900279
13000281         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getDerivedDirection(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13100282
13200288         <span class="keywordtype">void</span> setVisible(<span class="keywordtype">bool</span> visible);
13300289
134<a name="l00291"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lighta34">00291</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> getBoundingRadius(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 0; <span class="comment">/* not visible */</span> }
13500292
13600301         <a class="code" href="classOgre_1_1Vector4.html">Vector4</a> getAs4DVector(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13700302
13800312         <span class="keyword">const</span> <a class="code" href="classOgre_1_1PlaneBoundedVolume.html">PlaneBoundedVolume</a>&amp; _getNearClipVolume(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Camera.html">Camera</a>* <span class="keyword">const</span> cam) <span class="keyword">const</span>;
13900313
14000320         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a411">PlaneBoundedVolumeList</a>&amp; _getFrustumClipVolumes(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Camera.html">Camera</a>* <span class="keyword">const</span> cam) <span class="keyword">const</span>;
14100321
14200322
14300323
14400324     <span class="keyword">private</span>:
14500326         <span class="keywordtype">void</span> update(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
146<a name="l00327"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr0">00327</a>         <a class="code" href="namespaceOgre.html#a426">String</a> mName;
14700328
148<a name="l00329"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr1">00329</a>         LightTypes mLightType;
149<a name="l00330"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr2">00330</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mPosition;
150<a name="l00331"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr3">00331</a>         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> mDiffuse;
151<a name="l00332"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr4">00332</a>         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> mSpecular;
15200333
153<a name="l00334"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr5">00334</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDirection;
15400335
155<a name="l00336"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr6">00336</a>         <a class="code" href="classOgre_1_1Radian.html">Radian</a> mSpotOuter;
156<a name="l00337"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr7">00337</a>         <a class="code" href="classOgre_1_1Radian.html">Radian</a> mSpotInner;
157<a name="l00338"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr8">00338</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mSpotFalloff;
158<a name="l00339"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr9">00339</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mRange;
159<a name="l00340"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr10">00340</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mAttenuationConst;
160<a name="l00341"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr11">00341</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mAttenuationLinear;
161<a name="l00342"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr12">00342</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mAttenuationQuad;
16200343
163<a name="l00344"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr13">00344</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDerivedPosition;
164<a name="l00345"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr14">00345</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDerivedDirection;
165<a name="l00347"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr15">00347</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Quaternion.html">Quaternion</a> mLastParentOrientation;
166<a name="l00348"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr16">00348</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mLastParentPosition;
16700349
168<a name="l00351"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightv0">00351</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a426">String</a> msMovableType;
16900352
170<a name="l00353"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr17">00353</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1PlaneBoundedVolume.html">PlaneBoundedVolume</a> mNearClipVolume;
171<a name="l00354"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr18">00354</a>         <span class="keyword">mutable</span> <a class="code" href="namespaceOgre.html#a411">PlaneBoundedVolumeList</a> mFrustumClipVolumes;
172<a name="l00356"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightr19">00356</a>         <span class="keyword">mutable</span> <span class="keywordtype">bool</span> mLocalTransformDirty;
17300357
17400358
17500359
17600360     };
17700361 } <span class="comment">// Namespace</span>
17800362 <span class="preprocessor">#endif</span>
179</pre></div><hr>
180<p>
181Copyright &copy; 2000-2005 by The OGRE Team<br />
182<!--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/>
183This 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/>
184                <!--/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#">
185                <Work rdf:about="">
186                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
187        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
188                </Work>
189                <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> -->
190
191Last modified Sun Feb 12 12:59:47 2006
192</p>
193</body>
194</html>
Note: See TracBrowser for help on using the repository browser.