<html>
<head>
<title>OgreViewport.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.3.6 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
<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>
00002 <span class="comment">-----------------------------------------------------------------------------</span>
00003 <span class="comment">This source file is part of OGRE</span>
00004 <span class="comment"> (Object-oriented Graphics Rendering Engine)</span>
00005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
00006 <span class="comment"></span>
00007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
00008 <span class="comment">Also see acknowledgements in Readme.html</span>
00009 <span class="comment"></span>
00010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
00011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
00012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
00013 <span class="comment">version.</span>
00014 <span class="comment"></span>
00015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
00016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
00017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
00018 <span class="comment"></span>
00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
00020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
00021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
00022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
00023 <span class="comment">-----------------------------------------------------------------------------</span>
00024 <span class="comment">*/</span>
00025 <span class="preprocessor">#ifndef __Viewport_H__</span>
00026 <span class="preprocessor"></span><span class="preprocessor">#define __Viewport_H__</span>
00027 <span class="preprocessor"></span>
00028 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
00029
00030 <span class="preprocessor">#include "<a class="code" href="OgreColourValue_8h.html">OgreColourValue.h</a>"</span>
00031
00032 <span class="keyword">namespace </span>Ogre {
<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#a13">_OgreExport</a> Viewport
00047 {
00048 <span class="keyword">public</span>:
00071 Viewport(
00072 <a class="code" href="classOgre_1_1Camera.html">Camera</a>* camera,
00073 <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* target,
00074 <a class="code" href="namespaceOgre.html#a420">Real</a> left, <a class="code" href="namespaceOgre.html#a420">Real</a> top,
00075 <a class="code" href="namespaceOgre.html#a420">Real</a> width, <a class="code" href="namespaceOgre.html#a420">Real</a> height,
00076 <span class="keywordtype">int</span> ZOrder);
00077
00080 ~Viewport();
00081
00089 <span class="keywordtype">void</span> _updateDimensions(<span class="keywordtype">void</span>);
00090
00093 <span class="keywordtype">void</span> update(<span class="keywordtype">void</span>);
00094
00097 <a class="code" href="classOgre_1_1RenderTarget.html">RenderTarget</a>* getTarget(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00098
00101 <a class="code" href="classOgre_1_1Camera.html">Camera</a>* getCamera(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00102
00104 <span class="keywordtype">void</span> setCamera(<a class="code" href="classOgre_1_1Camera.html">Camera</a>* cam);
00105
00107 <span class="keywordtype">int</span> getZOrder(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00111 <a class="code" href="namespaceOgre.html#a420">Real</a> getLeft(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00112
00116 <a class="code" href="namespaceOgre.html#a420">Real</a> getTop(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00117
00122 <a class="code" href="namespaceOgre.html#a420">Real</a> getWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00127 <a class="code" href="namespaceOgre.html#a420">Real</a> getHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00132 <span class="keywordtype">int</span> getActualLeft(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00137 <span class="keywordtype">int</span> getActualTop(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00141 <span class="keywordtype">int</span> getActualWidth(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00146 <span class="keywordtype">int</span> getActualHeight(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00147
00160 <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);
00161
00165 <span class="keywordtype">void</span> setBackgroundColour(<span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>& colour);
00166
00169 <span class="keyword">const</span> <a class="code" href="classOgre_1_1ColourValue.html">ColourValue</a>& getBackgroundColour(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00170
00178 <span class="keywordtype">void</span> setClearEveryFrame(<span class="keywordtype">bool</span> clear);
00179
00182 <span class="keywordtype">bool</span> getClearEveryFrame(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00183
00186 <span class="keywordtype">void</span> getActualDimensions(
00187 <span class="keywordtype">int</span> &left, <span class="keywordtype">int</span> &top, <span class="keywordtype">int</span> &width, <span class="keywordtype">int</span> &height ) <span class="keyword">const</span>;
00188
00189 <span class="keywordtype">bool</span> _isUpdated(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00190 <span class="keywordtype">void</span> _clearUpdatedFlag(<span class="keywordtype">void</span>);
00191
00194 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> _getNumRenderedFaces(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00195
00206 <span class="keywordtype">void</span> setOverlaysEnabled(<span class="keywordtype">bool</span> enabled);
00207
00210 <span class="keywordtype">bool</span> getOverlaysEnabled(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
00211
00212
00213 <span class="keyword">protected</span>:
<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;
<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;
00216 <span class="comment">// Relative dimensions, irrespective of target dimensions (0..1)</span>
<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;
00218 <span class="comment">// Actual dimensions, based on target dimensions</span>
<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;
<a name="l00221"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp10">00221</a> <span class="keywordtype">int</span> mZOrder;
<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;
<a name="l00224"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp12">00224</a> <span class="keywordtype">bool</span> mClearEveryFrame;
<a name="l00225"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp13">00225</a> <span class="keywordtype">bool</span> mUpdated;
<a name="l00226"></a><a class="code" href="classOgre_1_1Viewport.html#Ogre_1_1Viewportp14">00226</a> <span class="keywordtype">bool</span> mShowOverlays;
00227 };
00228
00229 }
00230
00231 <span class="preprocessor">#endif</span>
</pre></div><p>
Copyright © 2000-2005 by The OGRE Team<br />
Last modified Wed Feb 23 00:19:15 2005
</p>
</body>
</html>
distrib
>
Mandriva
>
10.2
>
i586
>
media
>
contrib
>
by-pkgid
>
04e5d8c10ae76748689b4e7f48e0fa33
>
files
>
912
