source: OGRE/trunk/ogrenew/Docs/api/html/OgreRefAppCollideCamera_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>OgreRefAppCollideCamera.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>OgreRefAppCollideCamera.h</h1><a href="OgreRefAppCollideCamera_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 the OGRE Reference Application, a layer built</span>
1300004 <span class="comment">on top of OGRE(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 __REFAPP_COLLIDECAMERA_H__</span>
3500026 <span class="preprocessor"></span><span class="preprocessor">#define __REFAPP_COLLIDECAMERA_H__</span>
3600027 <span class="preprocessor"></span>
3700028 <span class="preprocessor">#include "<a class="code" href="OgreRefAppPrerequisites_8h.html">OgreRefAppPrerequisites.h</a>"</span>
3800029 <span class="preprocessor">#include "<a class="code" href="OgreCamera_8h.html">OgreCamera.h</a>"</span>
3900030 <span class="preprocessor">#include "<a class="code" href="OgreRefAppApplicationObject_8h.html">OgreRefAppApplicationObject.h</a>"</span>
4000031
4100032 <span class="keyword">namespace </span>OgreRefApp {
4200033
43<a name="l00035"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html">00035</a>     <span class="keyword">class </span><a class="code" href="OgreRefAppPrerequisites_8h.html#a0">_OgreRefAppExport</a> CollideCamera : <span class="keyword">public</span> <a class="code" href="classOgreRefApp_1_1ApplicationObject.html">ApplicationObject</a>
4400036     {
4500037     <span class="keyword">protected</span>:
4600039         <span class="comment">/* Note that I choose to contain Camera rather than subclass because the</span>
4700040 <span class="comment">           multiple inheritence would get very nasty (lots of method name clashes)</span>
4800041 <span class="comment">           and it's better that we can hide a few non-relevant methods this way.</span>
4900042 <span class="comment">           ApplicationObject needs to be the top-level interface anyway. */</span>
50<a name="l00043"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCamerap0">00043</a>         <a class="code" href="classOgre_1_1Camera.html">Camera</a> *mCamera;
5100045         <span class="keywordtype">void</span> setUp(<span class="keyword">const</span> String&amp; name);
5200047         <span class="keywordtype">void</span> nearDistChanged(<span class="keywordtype">void</span>);
5300048     <span class="keyword">public</span>:
5400049         CollideCamera(<span class="keyword">const</span> String&amp; name);
5500050
56<a name="l00052"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCameraa1">00052</a>         <a class="code" href="classOgre_1_1Camera.html">Camera</a>* getRealCamera(<span class="keywordtype">void</span>) { <span class="keywordflow">return</span> mCamera; }
5700053
5800054         <span class="comment">// ----------------------------------------------</span>
5900055         <span class="comment">// Overridden methods from ApplicationObject</span>
6000056         <span class="comment">// Note that we position the camera using the node</span>
6100057         <span class="comment">// But we orient the camera on it's own rotation</span>
6200058         <span class="comment">// ----------------------------------------------</span>
6300059       
6400062         <span class="keywordtype">void</span> _notifyCollided(<a class="code" href="structOgre_1_1SceneQuery_1_1WorldFragment.html">SceneQuery::WorldFragment</a>* wf, <span class="keyword">const</span> CollisionInfo&amp; info);
6500064         <span class="keywordtype">void</span> setOrientation(<span class="keyword">const</span> Quaternion&amp; orientation);
6600066         <span class="keyword">const</span> Quaternion&amp; getOrientation(<span class="keywordtype">void</span>);
6700067
6800075         <span class="keywordtype">void</span> translate(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; d);
6900078         <span class="keywordtype">void</span> roll(<span class="keyword">const</span> Radian&amp; angle);
7000079 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
71<a name="l00080"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCameraa7">00080</a> <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> roll(<a class="code" href="namespaceOgre.html#a420">Real</a> angleunits) {
7200081             roll ( Angle(angleunits) );
7300082         }
7400083 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
7500084 <span class="preprocessor"></span>
7600087         <span class="keywordtype">void</span> pitch(<span class="keyword">const</span> Radian&amp; angle);
7700088 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
78<a name="l00089"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCameraa9">00089</a> <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> pitch(<a class="code" href="namespaceOgre.html#a420">Real</a> angleunits) {
7900090             pitch ( Angle(angleunits) );
8000091         }
8100092 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
8200093 <span class="preprocessor"></span>
8300096         <span class="keywordtype">void</span> yaw(<span class="keyword">const</span> Radian&amp; angle);
8400097 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
85<a name="l00098"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCameraa11">00098</a> <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> yaw(<a class="code" href="namespaceOgre.html#a420">Real</a> angleunits) {
8600099             yaw ( Angle(angleunits) );
8700100         }
8800101 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
8900102 <span class="preprocessor"></span>
9000105         <span class="keywordtype">void</span> rotate(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; axis, <span class="keyword">const</span> Radian&amp; angle);
9100106 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
92<a name="l00107"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCameraa13">00107</a> <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> rotate(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; axis, <a class="code" href="namespaceOgre.html#a420">Real</a> angleunits) {
9300108             rotate ( axis, Angle(angleunits) );
9400109         }
9500110 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
9600111 <span class="preprocessor"></span>
9700114         <span class="keywordtype">void</span> rotate(<span class="keyword">const</span> Quaternion&amp; q);
9800115
9900116         <span class="comment">// ----------------------------------------------</span>
10000117         <span class="comment">// The following are methods delegated to Camera</span>
10100118         <span class="comment">// ----------------------------------------------</span>
10200119
10300122         <span class="keywordtype">void</span> setProjectionType(ProjectionType pt);
10400123
10500126         <a class="code" href="namespaceOgre.html#a651">ProjectionType</a> getProjectionType(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
10600127
10700135         <span class="keywordtype">void</span> setDetailLevel(SceneDetailLevel sd);
10800136
10900139         <a class="code" href="namespaceOgre.html#a646">SceneDetailLevel</a> getDetailLevel(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11000140
11100146         <span class="keywordtype">void</span> setDirection(<a class="code" href="namespaceOgre.html#a420">Real</a> x, <a class="code" href="namespaceOgre.html#a420">Real</a> y, <a class="code" href="namespaceOgre.html#a420">Real</a> z);
11200147
11300150         <span class="keywordtype">void</span> setDirection(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vec);
11400151
11500152         <span class="comment">/* Gets the camera's direction.</span>
11600153 <span class="comment">        */</span>
11700154         <a class="code" href="classOgre_1_1Vector3.html">Vector3</a> getDirection(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
11800155
11900156
12000165         <span class="keywordtype">void</span> lookAt( <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; targetPoint );
12100178         <span class="keywordtype">void</span> lookAt(<a class="code" href="namespaceOgre.html#a420">Real</a> x, <a class="code" href="namespaceOgre.html#a420">Real</a> y, <a class="code" href="namespaceOgre.html#a420">Real</a> z);
12200179
12300194         <span class="keywordtype">void</span> setFixedYawAxis( <span class="keywordtype">bool</span> useFixed, <span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; fixedAxis = Vector3::UNIT_Y );
12400195
12500208         <span class="keywordtype">void</span> setFOVy(<span class="keyword">const</span> Radian&amp; fovy);
12600209 <span class="preprocessor">#ifndef OGRE_FORCE_ANGLE_TYPES</span>
127<a name="l00210"></a><a class="code" href="classOgreRefApp_1_1CollideCamera.html#OgreRefApp_1_1CollideCameraa26">00210</a> <span class="preprocessor"></span>        <span class="keyword">inline</span> <span class="keywordtype">void</span> setFOVy(<a class="code" href="namespaceOgre.html#a420">Real</a> fovy) {
12800211             setFOVy ( Angle(fovy) );
12900212         }
13000213 <span class="preprocessor">#endif//OGRE_FORCE_ANGLE_TYPES</span>
13100214 <span class="preprocessor"></span>
13200217         <span class="keyword">const</span> Radian&amp; getFOVy(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13300218
13400230         <span class="keywordtype">void</span> setNearClipDistance(<a class="code" href="namespaceOgre.html#a420">Real</a> nearDist);
13500231
13600234         <a class="code" href="namespaceOgre.html#a420">Real</a> getNearClipDistance(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
13700235
13800252         <span class="keywordtype">void</span> setFarClipDistance(<a class="code" href="namespaceOgre.html#a420">Real</a> farDist);
13900253
14000256         <a class="code" href="namespaceOgre.html#a420">Real</a> getFarClipDistance(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
14100257
14200266         <span class="keywordtype">void</span> setAspectRatio(<a class="code" href="namespaceOgre.html#a420">Real</a> ratio);
14300267
14400270         <a class="code" href="namespaceOgre.html#a420">Real</a> getAspectRatio(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
14500271
14600276         <span class="keyword">const</span> Plane&amp; getFrustumPlane( FrustumPlane plane );
14700277
14800289         <span class="keywordtype">bool</span> isVisible(<span class="keyword">const</span> AxisAlignedBox&amp; bound, FrustumPlane* culledBy = 0);
14900290
15000302         <span class="keywordtype">bool</span> isVisible(<span class="keyword">const</span> Sphere&amp; bound, FrustumPlane* culledBy = 0);
15100303
15200315         <span class="keywordtype">bool</span> isVisible(<span class="keyword">const</span> <a class="code" href="classOgre_1_1Vector3.html">Vector3</a>&amp; vert, FrustumPlane* culledBy = 0);
15300316
15400317     };
15500318
15600319 }
15700320
15800321 <span class="preprocessor">#endif</span>
159</pre></div><hr>
160<p>
161Copyright &copy; 2000-2005 by The OGRE Team<br />
162<!--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/>
163This 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/>
164                <!--/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#">
165                <Work rdf:about="">
166                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
167        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
168                </Work>
169                <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> -->
170
171Last modified Sun Feb 12 12:59:50 2006
172</p>
173</body>
174</html>
Note: See TracBrowser for help on using the repository browser.