<html> <head> <title>Ogre::MouseTarget class Reference - 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>Ogre::MouseTarget Class Reference</h1>Handles the adding and removing of MouseListeners. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="OgreMouseTarget_8h-source.html">OgreMouseTarget.h</a>></code> <p> Inheritance diagram for Ogre::MouseTarget:<p><center><img src="classOgre_1_1MouseTarget__inherit__graph.png" border="0" usemap="#Ogre_1_1MouseTarget__inherit__map" alt="Inheritance graph"></center> <map name="Ogre_1_1MouseTarget__inherit__map"> <area href="classOgre_1_1Cursor.html" shape="rect" coords="7,225,95,243" alt=""> <area href="classOgre_1_1EventProcessor.html" shape="rect" coords="119,225,260,243" alt=""> <area href="classOgre_1_1PositionTarget.html" shape="rect" coords="53,86,187,105" alt=""> <area href="classOgre_1_1EventTarget.html" shape="rect" coords="60,17,180,35" alt=""> </map> <center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1MouseTarget-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td></td></tr> <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargeta0">MouseTarget</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargeta1">~MouseTarget</a> ()</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargeta2">processMouseEvent</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargeta3">addMouseListener</a> (<a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a> *l)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargeta4">removeMouseListener</a> (<a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a> *l)</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargeta5">isMouseWithin</a> () const </td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PositionTarget.html#Ogre_1_1PositionTargeta0">getLeft</a> (void) const=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). <a href="#Ogre_1_1PositionTargeta0"></a><br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="namespaceOgre.html#a420">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PositionTarget.html#Ogre_1_1PositionTargeta1">getTop</a> (void) const=0</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). <a href="#Ogre_1_1PositionTargeta1"></a><br><br></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PositionTarget.html#Ogre_1_1PositionTargeta2">getPositionTargetParent</a> () const=0</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1PositionTarget.html#Ogre_1_1PositionTargeta3">isKeyEnabled</a> () const=0</td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>virtual void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1EventTarget.html#Ogre_1_1PositionTargeta4">processEvent</a> (<a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> *e)=0</td></tr> <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>std::set< <a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a> * > </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargetp0">mMouseListeners</a></td></tr> <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargetp1">mMouseWithin</a></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> Handles the adding and removing of MouseListeners. <p> <dl compact><dt><b>Remarks:</b></dt><dd>Components that process the Mouse Event should subclass this class and call processMouseEvent when that event is identified.</dd></dl> <p> <p> Definition at line <a class="el" href="OgreMouseTarget_8h-source.html#l00052">52</a> of file <a class="el" href="OgreMouseTarget_8h-source.html">OgreMouseTarget.h</a>.<hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="Ogre_1_1MouseTargeta0" doxytag="Ogre::MouseTarget::MouseTarget" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> Ogre::MouseTarget::MouseTarget </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="Ogre_1_1MouseTargeta1" doxytag="Ogre::MouseTarget::~MouseTarget" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual Ogre::MouseTarget::~<a class="el" href="classOgre_1_1MouseTarget.html">MouseTarget</a> </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [virtual]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Definition at line <a class="el" href="OgreMouseTarget_8h-source.html#l00062">62</a> of file <a class="el" href="OgreMouseTarget_8h-source.html">OgreMouseTarget.h</a>. </td> </tr> </table> <hr><h2>Member Function Documentation</h2> <a class="anchor" name="Ogre_1_1MouseTargeta3" doxytag="Ogre::MouseTarget::addMouseListener" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Ogre::MouseTarget::addMouseListener </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a> * </td> <td class="mdname1" valign="top" nowrap> <em>l</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="Ogre_1_1PositionTargeta0" doxytag="Ogre::MouseTarget::getLeft" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::PositionTarget::getLeft </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). <p> <p> Implemented in <a class="el" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora12">Ogre::Cursor</a>, and <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora12">Ogre::EventProcessor</a>. </td> </tr> </table> <a class="anchor" name="Ogre_1_1PositionTargeta2" doxytag="Ogre::MouseTarget::getPositionTargetParent" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* Ogre::PositionTarget::getPositionTargetParent </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Implemented in <a class="el" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora14">Ogre::Cursor</a>, and <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora13">Ogre::EventProcessor</a>. </td> </tr> </table> <a class="anchor" name="Ogre_1_1PositionTargeta1" doxytag="Ogre::MouseTarget::getTop" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual <a class="el" href="namespaceOgre.html#a420">Real</a> Ogre::PositionTarget::getTop </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top">void </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). <p> <p> Implemented in <a class="el" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora13">Ogre::Cursor</a>, and <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora11">Ogre::EventProcessor</a>. </td> </tr> </table> <a class="anchor" name="Ogre_1_1PositionTargeta3" doxytag="Ogre::MouseTarget::isKeyEnabled" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual bool Ogre::PositionTarget::isKeyEnabled </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const<code> [pure virtual, inherited]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Implemented in <a class="el" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora15">Ogre::Cursor</a>, and <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora14">Ogre::EventProcessor</a>. </td> </tr> </table> <a class="anchor" name="Ogre_1_1MouseTargeta5" doxytag="Ogre::MouseTarget::isMouseWithin" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool Ogre::MouseTarget::isMouseWithin </td> <td class="md" valign="top">( </td> <td class="mdname1" valign="top" nowrap> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap> const</td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="Ogre_1_1PositionTargeta4" doxytag="Ogre::MouseTarget::processEvent" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> virtual void Ogre::EventTarget::processEvent </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> * </td> <td class="mdname1" valign="top" nowrap> <em>e</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap><code> [pure virtual, inherited]</code></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Implemented in <a class="el" href="classOgre_1_1Cursor.html#Ogre_1_1Cursora5">Ogre::Cursor</a>, and <a class="el" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora5">Ogre::EventProcessor</a>. </td> </tr> </table> <a class="anchor" name="Ogre_1_1MouseTargeta2" doxytag="Ogre::MouseTarget::processMouseEvent" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Ogre::MouseTarget::processMouseEvent </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> * </td> <td class="mdname1" valign="top" nowrap> <em>e</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <a class="anchor" name="Ogre_1_1MouseTargeta4" doxytag="Ogre::MouseTarget::removeMouseListener" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> void Ogre::MouseTarget::removeMouseListener </td> <td class="md" valign="top">( </td> <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a> * </td> <td class="mdname1" valign="top" nowrap> <em>l</em> </td> <td class="md" valign="top"> ) </td> <td class="md" nowrap></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> </td> </tr> </table> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="Ogre_1_1MouseTargetp0" doxytag="Ogre::MouseTarget::mMouseListeners" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> std::set<<a class="el" href="classOgre_1_1MouseListener.html">MouseListener</a>*> <a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargetp0">Ogre::MouseTarget::mMouseListeners</a><code> [protected]</code> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Definition at line <a class="el" href="OgreMouseTarget_8h-source.html#l00055">55</a> of file <a class="el" href="OgreMouseTarget_8h-source.html">OgreMouseTarget.h</a>. </td> </tr> </table> <a class="anchor" name="Ogre_1_1MouseTargetp1" doxytag="Ogre::MouseTarget::mMouseWithin" ></a><p> <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> <tr> <td class="mdRow"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1MouseTarget.html#Ogre_1_1MouseTargetp1">Ogre::MouseTarget::mMouseWithin</a><code> [protected]</code> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <p> Definition at line <a class="el" href="OgreMouseTarget_8h-source.html#l00058">58</a> of file <a class="el" href="OgreMouseTarget_8h-source.html">OgreMouseTarget.h</a>. </td> </tr> </table> <hr>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="OgreMouseTarget_8h-source.html">OgreMouseTarget.h</a></ul> <p> Copyright © 2000-2005 by The OGRE Team<br /> Last modified Wed Feb 23 00:21:03 2005 </p> </body> </html>