<!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::TextureCursor 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_1TextureCursor.html">TextureCursor</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">GG::TextureCursor Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include <<a class="el" href="Cursor_8h_source.html">Cursor.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for GG::TextureCursor:</div>
<div class="dyncontent">
<div class="center">
<img src="classGG_1_1TextureCursor.png" usemap="#GG::TextureCursor_map" alt=""/>
<map id="GG::TextureCursor_map" name="GG::TextureCursor_map">
<area href="classGG_1_1Cursor.html" title="Cursor is the base class for GUI-renderable cursors." alt="GG::Cursor" shape="rect" coords="0,0,117,24"/>
</map>
</div></div>
<p><a href="classGG_1_1TextureCursor-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr class="memitem:afaea95f48adfd283f1587a3fd635c22a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afaea95f48adfd283f1587a3fd635c22a"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Cursor.html#afaea95f48adfd283f1587a3fd635c22a">Cursor</a> ()</td></tr>
<tr class="memitem:a1c95dae973324329cefc653e5080b619"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1c95dae973324329cefc653e5080b619"></a>
virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1Cursor.html#a1c95dae973324329cefc653e5080b619">~Cursor</a> ()</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Structors</h2></td></tr>
<tr class="memitem:afeea4fb1e22b89c64aff7e112eb8bfc3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1TextureCursor.html#afeea4fb1e22b89c64aff7e112eb8bfc3">TextureCursor</a> (const boost::shared_ptr< <a class="el" href="classGG_1_1Texture.html">Texture</a> > &texture, const <a class="el" href="structGG_1_1Pt.html">Pt</a> &hotspot=<a class="el" href="structGG_1_1Pt.html">Pt</a>())</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Accessors</h2></td></tr>
<tr class="memitem:a3c06f277c365efd552522d92840713db"><td class="memItemLeft" align="right" valign="top">const boost::shared_ptr<br class="typebreak"/>
< <a class="el" href="classGG_1_1Texture.html">Texture</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1TextureCursor.html#a3c06f277c365efd552522d92840713db">GetTexture</a> () const </td></tr>
<tr class="memitem:a78d4e3a607abc59cce573ed262b07351"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structGG_1_1Pt.html">Pt</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1TextureCursor.html#a78d4e3a607abc59cce573ed262b07351">Hotspot</a> () const </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="member-group"></a>
Mutators</h2></td></tr>
<tr class="memitem:a23f10bd04e59da4556a23f713df7c2ae"><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classGG_1_1TextureCursor.html#a23f10bd04e59da4556a23f713df7c2ae">Render</a> (const <a class="el" href="structGG_1_1Pt.html">Pt</a> &pt)</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classGG_1_1TextureCursor.html" title="TextureCursor is a very simple subclass of Cursor.">TextureCursor</a> is a very simple subclass of <a class="el" href="classGG_1_1Cursor.html" title="Cursor is the base class for GUI-renderable cursors.">Cursor</a>. </p>
<p>It renders a texture such that the point within the texture that represents the hotspot of the cursor is rendered at the click-point of the cursor. </p>
<p>Definition at line <a class="el" href="Cursor_8h_source.html#l00066">66</a> of file <a class="el" href="Cursor_8h_source.html">Cursor.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="afeea4fb1e22b89c64aff7e112eb8bfc3"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GG::TextureCursor::TextureCursor </td>
<td>(</td>
<td class="paramtype">const boost::shared_ptr< <a class="el" href="classGG_1_1Texture.html">Texture</a> > & </td>
<td class="paramname"><em>texture</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="structGG_1_1Pt.html">Pt</a> & </td>
<td class="paramname"><em>hotspot</em> = <code><a class="el" href="structGG_1_1Pt.html">Pt</a>()</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ctor. <em>texture</em> is the texture to render and <em>hotspot</em> is the offset within <em>texture</em> where the click-point is located. <em>hotspot</em> is clamped to <em>texture's</em> valid area. </p>
</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a3c06f277c365efd552522d92840713db"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const boost::shared_ptr<<a class="el" href="classGG_1_1Texture.html">Texture</a>>& GG::TextureCursor::GetTexture </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the texture used to render this <a class="el" href="classGG_1_1TextureCursor.html" title="TextureCursor is a very simple subclass of Cursor.">TextureCursor</a>. </p>
</div>
</div>
<a class="anchor" id="a78d4e3a607abc59cce573ed262b07351"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="structGG_1_1Pt.html">Pt</a>& GG::TextureCursor::Hotspot </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the position within Texture() of the cursor hotspot. </p>
</div>
</div>
<a class="anchor" id="a23f10bd04e59da4556a23f713df7c2ae"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual void GG::TextureCursor::Render </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="structGG_1_1Pt.html">Pt</a> & </td>
<td class="paramname"><em>pt</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Renders the cursor at the specified location. Subclasses should take care to ensure that the cursor's "hotspot" is rendered at <em>pt</em>. </p>
<p>Implements <a class="el" href="classGG_1_1Cursor.html#a133fe9a4ea8a14d3d60b03866bc3ac59">GG::Cursor</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Cursor_8h_source.html">Cursor.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>
