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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreShadowCaster.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>OgreShadowCaster.h</h1><a href="OgreShadowCaster_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 __ShadowCaster_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __ShadowCaster_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreRenderable_8h.html">OgreRenderable.h</a>"</span>
3900030
4000031
4100032 <span class="keyword">namespace </span>Ogre {
4200033
4300034
44<a name="l00043"></a><a class="code" href="classOgre_1_1ShadowRenderable.html">00043</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> ShadowRenderable : <span class="keyword">public</span> <a class="code" href="classOgre_1_1Renderable.html">Renderable</a>
4500044     {
4600045     <span class="keyword">protected</span>:
47<a name="l00046"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablep3">00046</a>         <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a> mMaterial;
48<a name="l00047"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablep4">00047</a>         <a class="code" href="classOgre_1_1RenderOperation.html">RenderOperation</a> mRenderOp;
49<a name="l00048"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablep5">00048</a>         ShadowRenderable* mLightCap; <span class="comment">// used only if isLightCapSeparate == true</span>
5000049     <span class="keyword">public</span>:
51<a name="l00050"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1ShadowRenderablea0">00050</a>         ShadowRenderable() : mMaterial(0), mLightCap(0) {}
52<a name="l00051"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1ShadowRenderablea1">00051</a>         <span class="keyword">virtual</span> ~ShadowRenderable() { <span class="keyword">delete</span> mLightCap; }
53<a name="l00055"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea7">00055</a>         <span class="keywordtype">void</span> setMaterial(<a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a>&amp; mat) { mMaterial = mat; }
54<a name="l00057"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea8">00057</a>         <span class="keyword">const</span> <a class="code" href="classOgre_1_1MaterialPtr.html">MaterialPtr</a>&amp; getMaterial(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMaterial; }
55<a name="l00059"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea9">00059</a>         <span class="keywordtype">void</span> getRenderOperation(<a class="code" href="classOgre_1_1RenderOperation.html">RenderOperation</a>&amp; op) { op = mRenderOp; }
56<a name="l00061"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea10">00061</a>         <a class="code" href="classOgre_1_1RenderOperation.html">RenderOperation</a>* getRenderOperationForUpdate(<span class="keywordtype">void</span>) {<span class="keywordflow">return</span> &amp;mRenderOp;}
5700063         <span class="keywordtype">void</span> getWorldTransforms(<a class="code" href="classOgre_1_1Matrix4.html">Matrix4</a>* xform) <span class="keyword">const</span> = 0;
5800065         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Quaternion.html">Quaternion</a>&amp; getWorldOrientation(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
5900067         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; getWorldPosition(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
60<a name="l00069"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea11">00069</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> getSquaredViewDepth(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Camera.html">Camera</a>* cam)<span class="keyword"> const</span>{ <span class="keywordflow">return</span> 0; <span class="comment">/* not used */</span>}
6100071         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a59">LightList</a>&amp; getLights(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
62<a name="l00082"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea13">00082</a>         <span class="keywordtype">bool</span> isLightCapSeparate(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLightCap != 0; }
6300083
64<a name="l00085"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea14">00085</a>         ShadowRenderable* getLightCapRenderable(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mLightCap; }
65<a name="l00087"></a><a class="code" href="classOgre_1_1ShadowRenderable.html#Ogre_1_1StaticGeometry_1_1Region_1_1RegionShadowRenderablea15">00087</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isVisible(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }
6600088
6700089     };
6800090
69<a name="l00092"></a><a class="code" href="namespaceOgre.html#a675">00092</a>     <span class="keyword">enum</span> <a class="code" href="namespaceOgre.html#a675">ShadowRenderableFlags</a>
7000093     {
7100095         <a class="code" href="namespaceOgre.html#a675a501">SRF_INCLUDE_LIGHT_CAP</a> = 0x00000001,
7200097         <a class="code" href="namespaceOgre.html#a675a502">SRF_INCLUDE_DARK_CAP</a>  = 0x00000002,
7300099         <a class="code" href="namespaceOgre.html#a675a503">SRF_EXTRUDE_TO_INFINITY</a>  = 0x00000004
7400100     };
7500101
76<a name="l00104"></a><a class="code" href="classOgre_1_1ShadowCaster.html">00104</a>     <span class="keyword">class </span><a class="code" href="class__OgreExport.html">_OgreExport</a> ShadowCaster
7700105     {
7800106     <span class="keyword">public</span>:
79<a name="l00107"></a><a class="code" href="classOgre_1_1ShadowCaster.html#Ogre_1_1ShadowCastera0">00107</a>         <span class="keyword">virtual</span> ~ShadowCaster() { }
8000109         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getCastShadows(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
8100110
8200112         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1EdgeData.html">EdgeData</a>* getEdgeList(<span class="keywordtype">void</span>) = 0;
8300113
8400115         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a>&amp; getWorldBoundingBox(<span class="keywordtype">bool</span> derive = <span class="keyword">false</span>) <span class="keyword">const</span> = 0;
8500117         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a>&amp; getLightCapBounds(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
8600119         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a>&amp; getDarkCapBounds(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Light.html">Light</a>&amp; light, <a class="code" href="namespaceOgre.html#a420">Real</a> dirLightExtrusionDist) <span class="keyword">const</span> = 0;
8700120
88<a name="l00121"></a><a class="code" href="classOgre_1_1ShadowCaster.html#Ogre_1_1WireBoundingBoxw0">00121</a>         <span class="keyword">typedef</span> std::vector&lt;ShadowRenderable*&gt; <a class="code" href="classOgre_1_1ShadowCaster.html#Ogre_1_1WireBoundingBoxw0">ShadowRenderableList</a>;
89<a name="l00122"></a><a class="code" href="classOgre_1_1ShadowCaster.html#Ogre_1_1WireBoundingBoxw1">00122</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1VectorIterator.html">VectorIterator&lt;ShadowRenderableList&gt;</a> <a class="code" href="classOgre_1_1VectorIterator.html">ShadowRenderableListIterator</a>;
9000123
9100139         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1VectorIterator.html">ShadowRenderableListIterator</a> getShadowVolumeRenderableIterator(
9200140             ShadowTechnique shadowTechnique, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Light.html">Light</a>* light,
9300141             <a class="code" href="classOgre_1_1HardwareIndexBufferSharedPtr.html">HardwareIndexBufferSharedPtr</a>* indexBuffer,
9400142             <span class="keywordtype">bool</span> extrudeVertices, <a class="code" href="namespaceOgre.html#a420">Real</a> extrusionDistance, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags = 0 ) = 0;
9500143
9600163         <span class="keyword">static</span> <span class="keywordtype">void</span> extrudeVertices(<a class="code" href="classOgre_1_1HardwareVertexBufferSharedPtr.html">HardwareVertexBufferSharedPtr</a> vertexBuffer,
9700164             size_t originalVertexCount, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector4.html">Vector4</a>&amp; lightPos, <a class="code" href="namespaceOgre.html#a420">Real</a> extrudeDist);
9800166         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a420">Real</a> getPointExtrusionDistance(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Light.html">Light</a>* l) <span class="keyword">const</span> = 0;
9900167     <span class="keyword">protected</span>:
10000169         <a class="code" href="namespaceOgre.html#a420">Real</a> getExtrusionDistance(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; objectPos, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Light.html">Light</a>* light) <span class="keyword">const</span>;
10100177         <span class="keyword">virtual</span> <span class="keywordtype">void</span> updateEdgeListLightFacing(<a class="code" href="classOgre_1_1EdgeData.html">EdgeData</a>* edgeData,
10200178             <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector4.html">Vector4</a>&amp; lightPos);
10300179
10400193         <span class="keyword">virtual</span> <span class="keywordtype">void</span> generateShadowVolume(<a class="code" href="classOgre_1_1EdgeData.html">EdgeData</a>* edgeData,
10500194             <a class="code" href="classOgre_1_1HardwareIndexBufferSharedPtr.html">HardwareIndexBufferSharedPtr</a> indexBuffer, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Light.html">Light</a>* light,
10600195             <a class="code" href="classOgre_1_1ShadowCaster.html#Ogre_1_1WireBoundingBoxw0">ShadowRenderableList</a>&amp; shadowRenderables, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> flags);
10700202         <span class="keyword">virtual</span> <span class="keywordtype">void</span> extrudeBounds(<a class="code" href="classOgre_1_1AxisAlignedBox.html">AxisAlignedBox</a>&amp; box, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector4.html">Vector4</a>&amp; lightPos,
10800203             <a class="code" href="namespaceOgre.html#a420">Real</a> extrudeDist) <span class="keyword">const</span>;
10900204
11000205
11100206     };
11200207 }
11300208
11400209 <span class="preprocessor">#endif</span>
115</pre></div><hr>
116<p>
117Copyright &copy; 2000-2005 by The OGRE Team<br />
118<!--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/>
119This 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/>
120                <!--/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#">
121                <Work rdf:about="">
122                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
123        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
124                </Work>
125                <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> -->
126
127Last modified Sun Feb 12 12:59:52 2006
128</p>
129</body>
130</html>
Note: See TracBrowser for help on using the repository browser.