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

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

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreCursor.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>OgreCursor.h</h1><a href="OgreCursor_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
3500026
3600027 <span class="comment">/***************************************************************************</span>
3700028 <span class="comment">OgreCursor.h  -  </span>
3800029 <span class="comment">    The Cursor is an non-visual object that contains a the XYZ values that </span>
3900030 <span class="comment">    are modified by a InputReader.</span>
4000031 <span class="comment">    An InputReader creates and contains a Cursor object that it uses when it </span>
4100032 <span class="comment">    is set to buffered input (using the EventQueue).</span>
4200033 <span class="comment"></span>
4300034 <span class="comment">    To get a graphical representation of the cursor, a CursorGuiElement is</span>
4400035 <span class="comment">    used, which is a MouseMotionListener to the Cursor.</span>
4500036 <span class="comment"></span>
4600037 <span class="comment">-------------------</span>
4700038 <span class="comment">begin                : Nov 19 2002</span>
4800039 <span class="comment">copyright            : (C) 2002 by Kenny Sabir</span>
4900040 <span class="comment">email                : kenny@sparksuit.com</span>
5000041 <span class="comment">***************************************************************************/</span>
5100042
5200043 <span class="preprocessor">#ifndef __Cursor_H__</span>
5300044 <span class="preprocessor"></span><span class="preprocessor">#define __Cursor_H__</span>
5400045 <span class="preprocessor"></span>
5500046 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
5600047 <span class="preprocessor">#include "<a class="code" href="OgreMouseMotionTarget_8h.html">OgreMouseMotionTarget.h</a>"</span>
5700048 <span class="preprocessor">#include "<a class="code" href="OgreMouseTarget_8h.html">OgreMouseTarget.h</a>"</span>
5800049
5900050 <span class="keyword">namespace </span>Ogre {
60<a name="l00060"></a><a class="code" href="classOgre_1_1Cursor.html">00060</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> Cursor : <span class="keyword">public</span> <a class="code" href="classOgre_1_1MouseMotionTarget.html">MouseMotionTarget</a>, <span class="keyword">public</span> <a class="code" href="classOgre_1_1MouseTarget.html">MouseTarget</a>
6100061     {
6200062     <span class="keyword">protected</span>:
63<a name="l00064"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursorp2">00064</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mMouseX, mMouseY, mMouseZ;
6400065
65<a name="l00067"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursorp5">00067</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mRelX, mRelY, mRelZ;
6600068
67<a name="l00070"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursorp10">00070</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mXLowLimit, mXHighLimit, mYLowLimit, mYHighLimit, mZLowLimit, mZHighLimit;
6800071
69<a name="l00074"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursorp12">00074</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> mScale;
7000075
71<a name="l00077"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursorb0">00077</a>         <span class="keyword">inline</span> <a class="code" href="namespaceOgre.html#a420">Real</a> limit(<a class="code" href="namespaceOgre.html#a420">Real</a> val, <a class="code" href="namespaceOgre.html#a420">Real</a> low, <a class="code" href="namespaceOgre.html#a420">Real</a> high)
7200078         {   <span class="keywordflow">return</span> (val &lt; low) ? low: ((val &gt; high) ? high : val); }
7300079     <span class="keyword">public</span> :
7400080         Cursor();
7500081         <span class="keyword">virtual</span> ~Cursor();
7600082
7700084         <span class="keywordtype">void</span> addToX(<a class="code" href="namespaceOgre.html#a420">Real</a> val);
7800085
7900087         <span class="keywordtype">void</span> addToY(<a class="code" href="namespaceOgre.html#a420">Real</a> val);
8000088
8100090         <span class="keywordtype">void</span> addToZ(<a class="code" href="namespaceOgre.html#a420">Real</a> val);
8200091
8300093         <span class="keywordtype">void</span> processEvent(<a class="code" href="classOgre_1_1InputEvent.html">InputEvent</a>* e);
8400094
8500095
8600097         <a class="code" href="namespaceOgre.html#a420">Real</a> getX() <span class="keyword">const</span>;
8700098
8800100         <a class="code" href="namespaceOgre.html#a420">Real</a> getY() <span class="keyword">const</span>;
8900101
9000103         <a class="code" href="namespaceOgre.html#a420">Real</a> getZ() <span class="keyword">const</span>;
9100104
92<a name="l00106"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora9">00106</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> getRelX()<span class="keyword"> const </span>{<span class="keywordflow">return</span> mRelX;}
9300107
94<a name="l00109"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora10">00109</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> getRelY()<span class="keyword"> const </span>{<span class="keywordflow">return</span> mRelY;}
9500110
96<a name="l00112"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora11">00112</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> getRelZ()<span class="keyword"> const </span>{<span class="keywordflow">return</span> mRelZ;}
9700113
9800114
9900115
10000116     <span class="comment">// PositionTarget methods</span>
10100118 <span class="comment"></span>        <a class="code" href="namespaceOgre.html#a420">Real</a> getLeft(<span class="keywordtype">void</span>) <span class="keyword">const</span> ;
10200119
10300121         <a class="code" href="namespaceOgre.html#a420">Real</a> getTop(<span class="keywordtype">void</span>) <span class="keyword">const</span> ;
10400122
10500124         <a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* getPositionTargetParent() <span class="keyword">const</span>;
10600125
107<a name="l00126"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora15">00126</a>         <span class="keyword">inline</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> isKeyEnabled()<span class="keyword"> const</span>
10800127 <span class="keyword">        </span>{ <span class="keywordflow">return</span> <span class="keyword">false</span>; }
10900128
110<a name="l00130"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora16">00130</a>         <a class="code" href="namespaceOgre.html#a420">Real</a> getScale(<span class="keywordtype">void</span>)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mScale; }
111<a name="l00132"></a><a class="code" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora17">00132</a>         <span class="keywordtype">void</span> setScale(<a class="code" href="namespaceOgre.html#a420">Real</a> scale) { mScale = scale; }
11200133         
11300134
11400135     };
11500136
11600137 }
11700138
11800139
11900140 <span class="preprocessor">#endif  // __Cursor_H__</span>
120</pre></div><hr>
121<p>
122Copyright &copy; 2000-2005 by The OGRE Team<br />
123<!--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/>
124This 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/>
125                <!--/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#">
126                <Work rdf:about="">
127                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
128        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
129                </Work>
130                <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> -->
131
132Last modified Sun Feb 12 12:59:43 2006
133</p>
134</body>
135</html>
Note: See TracBrowser for help on using the repository browser.