<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>GG: GG::OgreGUIInputPlugin Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GG
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGG.html">GG</a></li><li class="navelem"><a class="el" href="classGG_1_1OgreGUIInputPlugin.html">OgreGUIInputPlugin</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">GG::OgreGUIInputPlugin Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="OgreGUIInputPlugin_8h_source.html">OgreGUIInputPlugin.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for GG::OgreGUIInputPlugin:</div>
<div class="dyncontent">
<div class="center">
<img src="classGG_1_1OgreGUIInputPlugin.png" usemap="#GG::OgreGUIInputPlugin_map" alt=""/>
<map id="GG::OgreGUIInputPlugin_map" name="GG::OgreGUIInputPlugin_map">
<area href="classOISInput.html" title="An Ogre plugin that provides input functionality to OgreGUI using OIS." alt="OISInput" shape="rect" coords="0,56,147,80"/>
</map>
</div></div>
<p><a href="classGG_1_1OgreGUIInputPlugin-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af19f87c5cc6740f963e31e5e2ee7a534"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af19f87c5cc6740f963e31e5e2ee7a534"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1OgreGUIInputPlugin.html#af19f87c5cc6740f963e31e5e2ee7a534">OgreGUIInputPlugin</a> ()</td></tr>
<tr class="memitem:a8f93add9747ff0773bee985528e0e58a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f93add9747ff0773bee985528e0e58a"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1OgreGUIInputPlugin.html#a8f93add9747ff0773bee985528e0e58a">~OgreGUIInputPlugin</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a24ac74063ea14a59d906662e571ea4ed"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1OgreGUIInputPlugin.html#a24ac74063ea14a59d906662e571ea4ed">SetRenderWindow</a> (Ogre::RenderWindow *window)</td></tr>
<tr class="memitem:a650914ac5fbdcbdf98c26a911e139589"><td class="memItemLeft" align="right" valign="top">static Ogre::RenderWindow * </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1OgreGUIInputPlugin.html#a650914ac5fbdcbdf98c26a911e139589">GetRenderWindow</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>The base class for Ogre plugins that provides input functionality to <a class="el" href="classGG_1_1OgreGUI.html" title="This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application...">OgreGUI</a>. </p>
<p>Derived classes must implement HandleWindowResize(), HandleWindowClose(), and HandleSystemEvents(). The last of these is where the input-system specific code resides. This function must obtain mouse moves and clicks, keyboard events, etc., from the underlying system and translate them to the associated <a class="el" href="namespaceGG.html" title="The namespace that encloses all GG classes, functions, typedefs, enums, etc.">GG</a> events. Derived classes must also call ConnectHandlers() sometime in their contructors. See <a class="el" href="classOISInput.html" title="An Ogre plugin that provides input functionality to OgreGUI using OIS.">OISInput</a> for a sample implementation. </p>
<p>Definition at line <a class="el" href="OgreGUIInputPlugin_8h_source.html#l00064">64</a> of file <a class="el" href="OgreGUIInputPlugin_8h_source.html">OgreGUIInputPlugin.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a24ac74063ea14a59d906662e571ea4ed"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static void GG::OgreGUIInputPlugin::SetRenderWindow </td>
<td>(</td>
<td class="paramtype">Ogre::RenderWindow * </td>
<td class="paramname"><em>window</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Overrides the use of the Ogre::Root-autocreated window. </p>
</div>
</div>
<a class="anchor" id="a650914ac5fbdcbdf98c26a911e139589"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static Ogre::RenderWindow* GG::OgreGUIInputPlugin::GetRenderWindow </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the Ogre::RenderWindow in which the <a class="el" href="classGG_1_1OgreGUI.html" title="This is an abstract singleton class that represents the GUI framework of an Ogre OpenGL application...">OgreGUI</a> is operating. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreGUIInputPlugin_8h_source.html">OgreGUIInputPlugin.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 15 2012 15:13:31 for GG by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.1
</small></address>
</body>
</html>
