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

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

adding ogre 1.2 and dependencies
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#a465">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#a471">String</a>&amp; name);
6400086
6500089         ~Light();
6600090
6700093         <span class="keywordtype">void</span> setType(LightTypes type);
6800094
6900097         LightTypes getType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7000098
7100108         <span class="keywordtype">void</span> setDiffuseColour(<a class="code" href="namespaceOgre.html#a465">Real</a> red, <a class="code" href="namespaceOgre.html#a465">Real</a> green, <a class="code" href="namespaceOgre.html#a465">Real</a> blue);
7200109
7300119         <span class="keywordtype">void</span> setDiffuseColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour);
7400120
7500123         <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>;
7600124
7700134         <span class="keywordtype">void</span> setSpecularColour(<a class="code" href="namespaceOgre.html#a465">Real</a> red, <a class="code" href="namespaceOgre.html#a465">Real</a> green, <a class="code" href="namespaceOgre.html#a465">Real</a> blue);
7800135
7900145         <span class="keywordtype">void</span> setSpecularColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour);
8000146
8100149         <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>;
8200150
8300170         <span class="keywordtype">void</span> setAttenuation(<a class="code" href="namespaceOgre.html#a465">Real</a> range, <a class="code" href="namespaceOgre.html#a465">Real</a> constant, <a class="code" href="namespaceOgre.html#a465">Real</a> linear, <a class="code" href="namespaceOgre.html#a465">Real</a> quadratic);
8400171
8500174         <a class="code" href="namespaceOgre.html#a465">Real</a> getAttenuationRange(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8600175
8700178         <a class="code" href="namespaceOgre.html#a465">Real</a> getAttenuationConstant(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8800179
8900182         <a class="code" href="namespaceOgre.html#a465">Real</a> getAttenuationLinear(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9000183
9100186         <a class="code" href="namespaceOgre.html#a465">Real</a> getAttenuationQuadric(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9200187
9300194         <span class="keywordtype">void</span> setPosition(<a class="code" href="namespaceOgre.html#a465">Real</a> x, <a class="code" href="namespaceOgre.html#a465">Real</a> y, <a class="code" href="namespaceOgre.html#a465">Real</a> z);
9400195
9500202         <span class="keywordtype">void</span> setPosition(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vec);
9600203
9700208         <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>;
9800209
9900216         <span class="keywordtype">void</span> setDirection(<a class="code" href="namespaceOgre.html#a465">Real</a> x, <a class="code" href="namespaceOgre.html#a465">Real</a> y, <a class="code" href="namespaceOgre.html#a465">Real</a> z);
10000217
10100224         <span class="keywordtype">void</span> setDirection(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vec);
10200225
10300230         <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>;
10400231
10500242         <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#a465">Real</a> falloff = 1.0);
10600243 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
10700244 <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> setSpotlightRange(<a class="code" href="namespaceOgre.html#a465">Real</a> innerAngle, <a class="code" href="namespaceOgre.html#a465">Real</a> outerAngle, <a class="code" href="namespaceOgre.html#a465">Real</a> falloff = 1.0) {
10800245             setSpotlightRange ( <a class="code" href="classOgre_1_1Angle.html">Angle</a>(innerAngle), <a class="code" href="classOgre_1_1Angle.html">Angle</a>(outerAngle), falloff );
10900246         }
11000247 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
11100248 <span class="preprocessor"></span>
11200251         <span class="keyword">const</span> Radian&amp; getSpotlightInnerAngle(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11300252
11400255         <span class="keyword">const</span> Radian&amp; getSpotlightOuterAngle(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11500256
11600259         Real getSpotlightFalloff(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11700260
11800263         <span class="keywordtype">void</span> setSpotlightInnerAngle(<span class="keyword">const</span> Radian&amp; val);
11900264
12000267         <span class="keywordtype">void</span> setSpotlightOuterAngle(<span class="keyword">const</span> Radian&amp; val);
12100268
12200271         <span class="keywordtype">void</span> setSpotlightFalloff(Real val);
12300272
12400280         <span class="keywordtype">void</span> setPowerScale(Real power);
12500281
12600285         Real getPowerScale(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12700286
12800288         <span class="keyword">const</span> AxisAlignedBox&amp; getBoundingBox(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
12900289
13000291         <span class="keywordtype">void</span> _updateRenderQueue(RenderQueue* queue);
13100292
13200294         <span class="keyword">const</span> String&amp; getMovableType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13300295
13400297         <span class="keyword">const</span> Vector3&amp; getDerivedPosition(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13500298
13600300         <span class="keyword">const</span> Vector3&amp; getDerivedDirection(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13700301
13800307         <span class="keywordtype">void</span> setVisible(<span class="keywordtype">bool</span> visible);
13900308
140<a name="l00310"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lighta37">00310</a>         <a class="code" href="namespaceOgre.html#a465">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> }
14100311
14200320         <a class="code" href="classOgre_1_1Vector4.html">Vector4</a> getAs4DVector(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
14300321
14400331         <span class="keyword">virtual</span> <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>;
14500332
14600339         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a454">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>;
14700340
14800342         <a class="code" href="namespaceOgre.html#a455">uint32</a> getTypeFlags(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
14900343
15000345         <a class="code" href="classOgre_1_1SharedPtr.html">AnimableValuePtr</a> createAnimableValue(<span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; valueName);
15100346
15200347     <span class="keyword">protected</span>:
15300349         <span class="keyword">virtual</span> <span class="keywordtype">void</span> update(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
15400350
15500352         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getAnimableDictionaryName(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
15600354         <span class="keywordtype">void</span> initialiseAnimableDictionary(<a class="code" href="namespaceOgre.html#a580">StringVector</a>&amp; vec) <span class="keyword">const</span>;
15700355
158<a name="l00356"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp0">00356</a>         LightTypes mLightType;
159<a name="l00357"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp1">00357</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mPosition;
160<a name="l00358"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp2">00358</a>         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> mDiffuse;
161<a name="l00359"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp3">00359</a>         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> mSpecular;
16200360
163<a name="l00361"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp4">00361</a>         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDirection;
16400362
165<a name="l00363"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp5">00363</a>         <a class="code" href="classOgre_1_1Radian.html">Radian</a> mSpotOuter;
166<a name="l00364"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp6">00364</a>         <a class="code" href="classOgre_1_1Radian.html">Radian</a> mSpotInner;
167<a name="l00365"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp7">00365</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mSpotFalloff;
168<a name="l00366"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp8">00366</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mRange;
169<a name="l00367"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp9">00367</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mAttenuationConst;
170<a name="l00368"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp10">00368</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mAttenuationLinear;
171<a name="l00369"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp11">00369</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mAttenuationQuad;
172<a name="l00370"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp12">00370</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mPowerScale;
17300371
174<a name="l00372"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp13">00372</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDerivedPosition;
175<a name="l00373"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp14">00373</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mDerivedDirection;
176<a name="l00375"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp15">00375</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Quaternion.html">Quaternion</a> mLastParentOrientation;
177<a name="l00376"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp16">00376</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> mLastParentPosition;
17800377
179<a name="l00379"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightt0">00379</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a471">String</a> msMovableType;
18000380
181<a name="l00381"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp17">00381</a>         <span class="keyword">mutable</span> <a class="code" href="classOgre_1_1PlaneBoundedVolume.html">PlaneBoundedVolume</a> mNearClipVolume;
182<a name="l00382"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp18">00382</a>         <span class="keyword">mutable</span> <a class="code" href="namespaceOgre.html#a454">PlaneBoundedVolumeList</a> mFrustumClipVolumes;
183<a name="l00384"></a><a class="code" href="classOgre_1_1Light.html#Ogre_1_1Lightp19">00384</a>         <span class="keyword">mutable</span> <span class="keywordtype">bool</span> mLocalTransformDirty;
18400385
18500386
18600387
18700388     };
18800389
189<a name="l00391"></a><a class="code" href="classOgre_1_1LightFactory.html">00391</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> LightFactory : <span class="keyword">public</span> <a class="code" href="classOgre_1_1MovableObjectFactory.html">MovableObjectFactory</a>
19000392     {
19100393     <span class="keyword">protected</span>:
19200394         <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* createInstanceImpl( <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; name, <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a76">NameValuePairList</a>* params);
19300395     <span class="keyword">public</span>:
194<a name="l00396"></a><a class="code" href="classOgre_1_1LightFactory.html#Ogre_1_1LightFactorya0">00396</a>         LightFactory() {}
195<a name="l00397"></a><a class="code" href="classOgre_1_1LightFactory.html#Ogre_1_1LightFactorya1">00397</a>         ~LightFactory() {}
19600398
197<a name="l00399"></a><a class="code" href="classOgre_1_1LightFactory.html#Ogre_1_1LightFactorys0">00399</a>         <span class="keyword">static</span> <a class="code" href="namespaceOgre.html#a471">String</a> FACTORY_TYPE_NAME;
19800400
19900401         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a471">String</a>&amp; getType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
20000402         <span class="keywordtype">void</span> destroyInstance( <a class="code" href="classOgre_1_1MovableObject.html">MovableObject</a>* obj); 
20100403
20200404     };
20300405
20400406 } <span class="comment">// Namespace</span>
20500407 <span class="preprocessor">#endif</span>
206</pre></div><hr>
207<p>
208Copyright &copy; 2000-2005 by The OGRE Team<br />
209<!--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/>
210This 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/>
211                <!--/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#">
212                <Work rdf:about="">
213                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
214        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
215                </Work>
216                <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> -->
217
218Last modified Sun Mar 12 14:37:43 2006
219</p>
220</body>
221</html>
Note: See TracBrowser for help on using the repository browser.