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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreViewport.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>OgreViewport.h</h1><a href="OgreViewport_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 __Viewport_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __Viewport_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
4100032 <span class="keyword">namespace </span>Ogre {
42<a name="l00046"></a><a class="code" href="classOgre_1_1Viewport.html">00046</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Viewport
4300047     {
4400048     <span class="keyword">public</span>:
4500071         Viewport(
4600072             <a class="code" href="classOgre_1_1Camera.html">Camera</a>* camera,
4700073             <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* target,
4800074             <a class="code" href="namespaceOgre.html#a420">Real</a> left, <a class="code" href="namespaceOgre.html#a420">Real</a> top,
4900075             <a class="code" href="namespaceOgre.html#a420">Real</a> width, <a class="code" href="namespaceOgre.html#a420">Real</a> height,
5000076             <span class="keywordtype">int</span> ZOrder);
5100077
5200080         ~Viewport();
5300081
5400089         <span class="keywordtype">void</span> _updateDimensions(<span class="keywordtype">void</span>);
5500090
5600093         <span class="keywordtype">void</span> update(<span class="keywordtype">void</span>);
5700094
5800097         <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* getTarget(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
5900098
6000101         <a class="code" href="classOgre_1_1Camera.html">Camera</a>* getCamera(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6100102
6200104         <span class="keywordtype">void</span> setCamera(<a class="code" href="classOgre_1_1Camera.html">Camera</a>* cam);
6300105
6400107         <span class="keywordtype">int</span> getZOrder(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6500111         <a class="code" href="namespaceOgre.html#a420">Real</a> getLeft(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6600112
6700116         <a class="code" href="namespaceOgre.html#a420">Real</a> getTop(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
6800117
6900122         <a class="code" href="namespaceOgre.html#a420">Real</a> getWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7000127         <a class="code" href="namespaceOgre.html#a420">Real</a> getHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7100132         <span class="keywordtype">int</span> getActualLeft(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7200137         <span class="keywordtype">int</span> getActualTop(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7300141         <span class="keywordtype">int</span> getActualWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7400146         <span class="keywordtype">int</span> getActualHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
7500147
7600160         <span class="keywordtype">void</span> setDimensions(<a class="code" href="namespaceOgre.html#a420">Real</a> left, <a class="code" href="namespaceOgre.html#a420">Real</a> top, <a class="code" href="namespaceOgre.html#a420">Real</a> width, <a class="code" href="namespaceOgre.html#a420">Real</a> height);
7700161
7800165         <span class="keywordtype">void</span> setBackgroundColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; colour);
7900166
8000169         <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>&amp; getBackgroundColour(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8100170
8200178         <span class="keywordtype">void</span> setClearEveryFrame(<span class="keywordtype">bool</span> clear);
8300179
8400182         <span class="keywordtype">bool</span> getClearEveryFrame(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
8500183
8600186         <span class="keywordtype">void</span> getActualDimensions(
8700187             <span class="keywordtype">int</span> &amp;left, <span class="keywordtype">int</span> &amp;top, <span class="keywordtype">int</span> &amp;width, <span class="keywordtype">int</span> &amp;height ) <span class="keyword">const</span>;
8800188
8900189         <span class="keywordtype">bool</span> _isUpdated(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9000190         <span class="keywordtype">void</span> _clearUpdatedFlag(<span class="keywordtype">void</span>);
9100191
9200194         <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _getNumRenderedFaces(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9300195
9400206         <span class="keywordtype">void</span> setOverlaysEnabled(<span class="keywordtype">bool</span> enabled);
9500207
9600210         <span class="keywordtype">bool</span> getOverlaysEnabled(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
9700211
9800212
9900213     <span class="keyword">protected</span>:
100<a name="l00214"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp0">00214</a>         <a class="code" href="classOgre_1_1Camera.html">Camera</a>* mCamera;
101<a name="l00215"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp1">00215</a>         <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* mTarget;
10200216         <span class="comment">// Relative dimensions, irrespective of target dimensions (0..1)</span>
103<a name="l00217"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp4">00217</a>         <span class="keywordtype">float</span> mRelLeft, mRelTop, mRelWidth, mRelHeight;
10400218         <span class="comment">// Actual dimensions, based on target dimensions</span>
105<a name="l00219"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp8">00219</a>         <span class="keywordtype">int</span> mActLeft, mActTop, mActWidth, mActHeight;
106<a name="l00221"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp10">00221</a>         <span class="keywordtype">int</span> mZOrder;
107<a name="l00223"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp11">00223</a>         <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a> mBackColour;
108<a name="l00224"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp12">00224</a>         <span class="keywordtype">bool</span> mClearEveryFrame;
109<a name="l00225"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp13">00225</a>         <span class="keywordtype">bool</span> mUpdated;
110<a name="l00226"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp14">00226</a>         <span class="keywordtype">bool</span> mShowOverlays;
11100227     };
11200228
11300229 }
11400230
11500231 <span class="preprocessor">#endif</span>
116</pre></div><hr>
117<p>
118Copyright &copy; 2000-2005 by The OGRE Team<br />
119<!--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/>
120This 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/>
121                <!--/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#">
122                <Work rdf:about="">
123                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
124        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
125                </Work>
126                <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> -->
127
128Last modified Sun Feb 12 12:59:54 2006
129</p>
130</body>
131</html>
Note: See TracBrowser for help on using the repository browser.