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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreRenderable.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>OgreRenderable.h</h1><a href="OgreRenderable_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://ogre.sourceforge.net/</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 __Renderable_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __Renderable_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="OgreCommon_8h.html">OgreCommon.h</a>"</span>
3900030
4000031 <span class="preprocessor">#include "<a class="code" href="OgreRenderOperation_8h.html">OgreRenderOperation.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgreMatrix4_8h.html">OgreMatrix4.h</a>"</span>
4200033 <span class="preprocessor">#include "<a class="code" href="OgreMaterial_8h.html">OgreMaterial.h</a>"</span>
4300034 <span class="preprocessor">#include "<a class="code" href="OgrePlane_8h.html">OgrePlane.h</a>"</span>
4400035 <span class="preprocessor">#include "<a class="code" href="OgreGpuProgram_8h.html">OgreGpuProgram.h</a>"</span>
4500036 <span class="preprocessor">#include "<a class="code" href="OgreVector4_8h.html">OgreVector4.h</a>"</span>
4600037 <span class="preprocessor">#include "<a class="code" href="OgreException_8h.html">OgreException.h</a>"</span>
4700038
4800039 <span class="keyword">namespace </span>Ogre {
4900040
50<a name="l00052"></a><a class="code" href="classOgre_1_1Renderable.html">00052</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Renderable
5100053     {
5200054     <span class="keyword">public</span>:
53<a name="l00055"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea0">00055</a>         Renderable() : mRenderDetailOverrideable(true) {}
54<a name="l00057"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1Renderablea1">00057</a>         <span class="keyword">virtual</span> ~Renderable() { }
5500063         <span class="keyword">virtual</span> <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> = 0;
56<a name="l00069"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa42">00069</a>         <span class="keyword">virtual</span> <a class="code" href="classOgre_1_1Technique.html">Technique</a>* getTechnique(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> getMaterial()-&gt;getBestTechnique(); }
5700072         <span class="keyword">virtual</span> <span class="keywordtype">void</span> getRenderOperation(<a class="code" href="classOgre_1_1RenderOperation.html">RenderOperation</a>&amp; op) = 0;
5800082         <span class="keyword">virtual</span> <span class="keywordtype">void</span> getWorldTransforms(<a class="code" href="classOgre_1_1Matrix4.html">Matrix4</a>* xform) <span class="keyword">const</span> = 0;
5900088         <span class="keyword">virtual</span> <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;
6000094         <span class="keyword">virtual</span> <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;
6100095
62<a name="l00104"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa43">00104</a>         <span class="keyword">virtual</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> getNumWorldTransforms(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> 1; }
6300105
64<a name="l00114"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa44">00114</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> useIdentityProjection(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
6500115
66<a name="l00124"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa45">00124</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> useIdentityView(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
6700125
6800131         <span class="keyword">virtual</span> <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> = 0;
6900132
70<a name="l00135"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa46">00135</a>         <span class="keyword">virtual</span> <a class="code" href="namespaceOgre.html#a646">SceneDetailLevel</a> getRenderDetail()<span class="keyword"> const </span>{<span class="keywordflow">return</span> <a class="code" href="namespaceOgre.html#a646a102">SDL_SOLID</a>;}
7100136
72<a name="l00138"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa47">00138</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getNormaliseNormals(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
7300139
7400144         <span class="keyword">virtual</span> <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> = 0;
7500145
76<a name="l00146"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa48">00146</a>         <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a410">PlaneList</a>&amp; getClipPlanes()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> msDummyPlaneList; };
7700147
78<a name="l00154"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa49">00154</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getCastsShadows(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
7900155
80<a name="l00171"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa50">00171</a>         <span class="keywordtype">void</span> setCustomParameter(size_t index, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector4.html">Vector4</a>&amp; value)
8100172         {
8200173             mCustomParameters[index] = value;
8300174         }
8400175
85<a name="l00180"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa51">00180</a>         <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector4.html">Vector4</a>&amp; getCustomParameter(size_t index)<span class="keyword"> const</span>
8600181 <span class="keyword">        </span>{
8700182             CustomParameterMap::const_iterator i = mCustomParameters.find(index);
8800183             <span class="keywordflow">if</span> (i != mCustomParameters.end())
8900184             {
9000185                 <span class="keywordflow">return</span> i-&gt;second;
9100186             }
9200187             <span class="keywordflow">else</span>
9300188             {
9400189                 <a class="code" href="OgreException_8h.html#a0">OGRE_EXCEPT</a>(Exception::ERR_ITEM_NOT_FOUND,
9500190                     <span class="stringliteral">"Parameter at the given index was not found."</span>,
9600191                     <span class="stringliteral">"Renderable::getCustomParameter"</span>);
9700192             }
9800193         }
9900194
100<a name="l00219"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa52">00219</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> _updateCustomGpuParameter(
10100220             <span class="keyword">const</span> <a class="code" href="classOgre_1_1GpuProgramParameters_1_1AutoConstantEntry.html">GpuProgramParameters::AutoConstantEntry</a>&amp; constantEntry,
10200221             <a class="code" href="classOgre_1_1GpuProgramParameters.html">GpuProgramParameters</a>* <a class="code" href="OgreGLPrerequisites_8h.html#a74">params</a>)<span class="keyword"> const</span>
10300222 <span class="keyword">        </span>{
10400223             CustomParameterMap::const_iterator i = mCustomParameters.find(constantEntry.<a class="code" href="classOgre_1_1GpuProgramParameters_1_1AutoConstantEntry.html#Ogre_1_1GpuProgramParameters_1_1AutoConstantEntryo2">data</a>);
10500224             <span class="keywordflow">if</span> (i != mCustomParameters.end())
10600225             {
10700226                 <a class="code" href="OgreGLPrerequisites_8h.html#a74">params</a>-&gt;setConstant(constantEntry.<a class="code" href="classOgre_1_1GpuProgramParameters_1_1AutoConstantEntry.html#Ogre_1_1GpuProgramParameters_1_1AutoConstantEntryo1">index</a>, i-&gt;second);
10800227             }
10900228         }
11000229
111<a name="l00235"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa53">00235</a>         <span class="keyword">virtual</span> <span class="keywordtype">void</span> setRenderDetailOverrideable(<span class="keywordtype">bool</span> override)
11200236         {
11300237             mRenderDetailOverrideable = override;
11400238         }
11500239
116<a name="l00243"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxa54">00243</a>         <span class="keyword">virtual</span> <span class="keywordtype">bool</span> getRenderDetailOverrideable(<span class="keywordtype">void</span>)<span class="keyword"> const</span>
11700244 <span class="keyword">        </span>{
11800245             <span class="keywordflow">return</span> mRenderDetailOverrideable;
11900246         }
12000247
12100248
12200249     <span class="keyword">protected</span>:
123<a name="l00250"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxt1">00250</a>         <span class="keyword">static</span> <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a410">PlaneList</a> msDummyPlaneList;
124<a name="l00251"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">00251</a>         <span class="keyword">typedef</span> std::map&lt;size_t, Vector4&gt; <a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">CustomParameterMap</a>;
125<a name="l00252"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp20">00252</a>         <a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxx0">CustomParameterMap</a> mCustomParameters;
126<a name="l00253"></a><a class="code" href="classOgre_1_1Renderable.html#Ogre_1_1WireBoundingBoxp21">00253</a>         <span class="keywordtype">bool</span> mRenderDetailOverrideable;
12700254     };
12800255
12900256
13000257
13100258 }
13200259
13300260 <span class="preprocessor">#endif //__Renderable_H__</span>
134</pre></div><hr>
135<p>
136Copyright &copy; 2000-2005 by The OGRE Team<br />
137<!--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/>
138This 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/>
139                <!--/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#">
140                <Work rdf:about="">
141                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
142        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
143                </Work>
144                <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> -->
145
146Last modified Sun Feb 12 12:59:50 2006
147</p>
148</body>
149</html>
Note: See TracBrowser for help on using the repository browser.