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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreTechnique.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>OgreTechnique.h</h1><a href="OgreTechnique_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 __Technique_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __Technique_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="OgreIteratorWrappers_8h.html">OgreIteratorWrappers.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreBlendMode_8h.html">OgreBlendMode.h</a>"</span>
4000031 <span class="preprocessor">#include "<a class="code" href="OgreCommon_8h.html">OgreCommon.h</a>"</span>
4100032 <span class="preprocessor">#include "<a class="code" href="OgrePass_8h.html">OgrePass.h</a>"</span>
4200033
4300034 <span class="keyword">namespace </span>Ogre {
44<a name="l00041"></a><a class="code" href="classOgre_1_1Technique.html">00041</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Technique
4500042     {
4600043     <span class="keyword">protected</span>:
4700044         <span class="comment">// illumination pass state type</span>
48<a name="l00045"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquex4">00045</a>         <span class="keyword">enum</span> IlluminationPassesState
4900046         {
5000047             IPS_COMPILE_DISABLED = -1,
5100048             IPS_NOT_COMPILED = 0,
5200049             IPS_COMPILED = 1
5300050         };
5400051
55<a name="l00052"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquex0">00052</a>         <span class="keyword">typedef</span> std::vector&lt;Pass*&gt; <a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquex0">Passes</a>;
56<a name="l00054"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquep0">00054</a>         <a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquex0">Passes</a> mPasses;
57<a name="l00056"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquep1">00056</a>         <a class="code" href="namespaceOgre.html#a358">IlluminationPassList</a> mIlluminationPasses;
58<a name="l00057"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquep2">00057</a>         <a class="code" href="classOgre_1_1Material.html">Material</a>* mParent; <span class="comment">// raw pointer since we don't want child to stop parent's destruction</span>
59<a name="l00058"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquep3">00058</a>         <span class="keywordtype">bool</span> mIsSupported;
60<a name="l00059"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquep4">00059</a>         IlluminationPassesState mIlluminationPassesCompilationPhase;
61<a name="l00060"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquep5">00060</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> mLodIndex;
6200061
6300063         <span class="keywordtype">void</span> clearIlluminationPasses(<span class="keywordtype">void</span>);
6400064     <span class="keyword">public</span>:
6500066         Technique(<a class="code" href="classOgre_1_1Material.html">Material</a>* parent);
6600068         Technique(<a class="code" href="classOgre_1_1Material.html">Material</a>* parent, <span class="keyword">const</span> Technique&amp; oth);
6700069         ~Technique();
6800075         <span class="keywordtype">bool</span> isSupported(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6900077         <span class="keywordtype">void</span> _compile(<span class="keywordtype">bool</span> autoManageTextureUnits);
7000079         <span class="keywordtype">void</span> _compileIlluminationPasses(<span class="keywordtype">void</span>);
7100080
7200081
7300092         <a class="code" href="classOgre_1_1Pass.html">Pass</a>* createPass(<span class="keywordtype">void</span>);
7400094         <a class="code" href="classOgre_1_1Pass.html">Pass</a>* getPass(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);
7500096         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> getNumPasses(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7600098         <span class="keywordtype">void</span> removePass(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);
7700100         <span class="keywordtype">void</span> removeAllPasses(<span class="keywordtype">void</span>);
78<a name="l00101"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquew0">00101</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1VectorIterator.html">VectorIterator&lt;Passes&gt;</a> <a class="code" href="classOgre_1_1VectorIterator.html">PassIterator</a>;
7900103         <span class="keyword">const</span> <a class="code" href="classOgre_1_1VectorIterator.html">PassIterator</a> getPassIterator(<span class="keywordtype">void</span>);
80<a name="l00104"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquew1">00104</a>         <span class="keyword">typedef</span> <a class="code" href="classOgre_1_1VectorIterator.html">VectorIterator&lt;IlluminationPassList&gt;</a> <a class="code" href="classOgre_1_1VectorIterator.html">IlluminationPassIterator</a>;
8100106         <span class="keyword">const</span> <a class="code" href="classOgre_1_1VectorIterator.html">IlluminationPassIterator</a> getIlluminationPassIterator(<span class="keywordtype">void</span>);
82<a name="l00108"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquea13">00108</a>         <a class="code" href="classOgre_1_1Material.html">Material</a>* getParent(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mParent; }
8300109
8400111         Technique&amp; operator=(<span class="keyword">const</span> Technique&amp; rhs);
8500112
8600114         <span class="keyword">const</span> <a class="code" href="namespaceOgre.html#a426">String</a>&amp; getResourceGroup(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8700115
8800124         <span class="keywordtype">bool</span> isTransparent(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8900125
9000127         <span class="keywordtype">void</span> _load(<span class="keywordtype">void</span>);
9100129         <span class="keywordtype">void</span> _unload(<span class="keywordtype">void</span>);
9200130
9300131         <span class="comment">// Is this loaded?</span>
9400132         <span class="keywordtype">bool</span> isLoaded(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9500133
9600135         <span class="keywordtype">void</span> _notifyNeedsRecompile(<span class="keywordtype">void</span>);
9700136
9800137
9900138         <span class="comment">// -------------------------------------------------------------------------------</span>
10000139         <span class="comment">// The following methods are to make migration from previous versions simpler</span>
10100140         <span class="comment">// and to make code easier to write when dealing with simple materials</span>
10200141         <span class="comment">// They set the properties which have been moved to Pass for all Techniques and all Passes</span>
10300142
10400151         <span class="keywordtype">void</span> setAmbient(<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);
10500152
10600161         <span class="keywordtype">void</span> setAmbient(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; ambient);
10700162
10800171         <span class="keywordtype">void</span> setDiffuse(<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, <a class="code" href="namespaceOgre.html#a420">Real</a> alpha);
10900172
11000181         <span class="keywordtype">void</span> setDiffuse(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; diffuse);
11100182
11200191         <span class="keywordtype">void</span> setSpecular(<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, <a class="code" href="namespaceOgre.html#a420">Real</a> alpha);
11300192
11400201         <span class="keywordtype">void</span> setSpecular(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; specular);
11500202
11600211         <span class="keywordtype">void</span> setShininess(<a class="code" href="namespaceOgre.html#a420">Real</a> val);
11700212
11800221         <span class="keywordtype">void</span> setSelfIllumination(<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);
11900222
12000231         <span class="keywordtype">void</span> setSelfIllumination(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; selfIllum);
12100232
12200241         <span class="keywordtype">void</span> setDepthCheckEnabled(<span class="keywordtype">bool</span> enabled);
12300242
12400251         <span class="keywordtype">void</span> setDepthWriteEnabled(<span class="keywordtype">bool</span> enabled);
12500252
12600261         <span class="keywordtype">void</span> setDepthFunction( CompareFunction func );
12700262
12800271         <span class="keywordtype">void</span> setColourWriteEnabled(<span class="keywordtype">bool</span> enabled);
12900272
13000281         <span class="keywordtype">void</span> setCullingMode( CullingMode mode );
13100282
13200291         <span class="keywordtype">void</span> setManualCullingMode( ManualCullingMode mode );
13300292
13400301         <span class="keywordtype">void</span> setLightingEnabled(<span class="keywordtype">bool</span> enabled);
13500302
13600311         <span class="keywordtype">void</span> setShadingMode( ShadeOptions mode );
13700312
13800321         <span class="keywordtype">void</span> setFog(
13900322             <span class="keywordtype">bool</span> overrideScene,
14000323             FogMode mode = FOG_NONE,
14100324             <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour = ColourValue::White,
14200325             <a class="code" href="namespaceOgre.html#a420">Real</a> expDensity = 0.001, <a class="code" href="namespaceOgre.html#a420">Real</a> linearStart = 0.0, <a class="code" href="namespaceOgre.html#a420">Real</a> linearEnd = 1.0 );
14300326
14400335         <span class="keywordtype">void</span> setDepthBias(<a class="code" href="namespaceOgre.html#a422">ushort</a> bias);
14500336
14600345         <span class="keywordtype">void</span> setTextureFiltering(TextureFilterOptions filterType);
14700354         <span class="keywordtype">void</span> setTextureAnisotropy(<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> maxAniso);
14800355
14900364         <span class="keywordtype">void</span> setSceneBlending( <span class="keyword">const</span> SceneBlendType sbt );
15000365
15100374         <span class="keywordtype">void</span> setSceneBlending( <span class="keyword">const</span> SceneBlendFactor sourceFactor, <span class="keyword">const</span> SceneBlendFactor destFactor);
15200375
15300392         <span class="keywordtype">void</span> setLodIndex(<span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> index);
154<a name="l00394"></a><a class="code" href="classOgre_1_1Technique.html#Ogre_1_1Techniquea45">00394</a>         <span class="keywordtype">unsigned</span> <span class="keywordtype">short</span> getLodIndex(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mLodIndex; }
15500395
15600397         <span class="keywordtype">bool</span> isDepthWriteEnabled(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
15700398
15800400         <span class="keywordtype">bool</span> isDepthCheckEnabled(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
15900401
16000402     };
16100403
16200404
16300405 }
16400406 <span class="preprocessor">#endif</span>
165</pre></div><hr>
166<p>
167Copyright &copy; 2000-2005 by The OGRE Team<br />
168<!--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/>
169This 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/>
170                <!--/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#">
171                <Work rdf:about="">
172                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
173        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
174                </Work>
175                <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> -->
176
177Last modified Sun Feb 12 12:59:53 2006
178</p>
179</body>
180</html>
Note: See TracBrowser for help on using the repository browser.