TorqueEngine
/
Torque2D
mirror da https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: CursorManager 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="class_cursor_manager-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">CursorManager Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;platformInput.h&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_cursor_manager_1_1cursors.html">cursors</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-types" name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a0944a4353780132eeab7b06e3e42291d" id="r_a0944a4353780132eeab7b06e3e42291d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291da8eded07c2f9502cc7be791ce02377b00">curArrow</a> = 0
, <a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291dab90d8d74075ae9b82e5d2cd9f53a7a7c">curWait</a>
, <a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291dab6f1242eb7bd234d9b1fb41219879ef4">curPlus</a>
, <a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291dac57fd0a756fdbc65651fa629921505b3">curResizeVert</a>
, <br />
&#160;&#160;<a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291da4ce409db123c9b90e6247a819900758a">curResizeHorz</a>
, <a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291da7b1841a4817746a255270a320deef61d">curResizeAll</a>
, <a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291dae66bf72c64f6a96c8fa064acec1f106a">curIBeam</a>
, <a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291da7ab455ba2caabc84dda8d9822d563f8f">curResizeNESW</a>
, <br />
&#160;&#160;<a class="el" href="class_cursor_manager.html#a0944a4353780132eeab7b06e3e42291da8315133664b5b7c64a106e5aadbe63d8">curResizeNWSE</a>
<br />
 }</td></tr>
<tr class="separator:a0944a4353780132eeab7b06e3e42291d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a498bfcda46f961c085d7a116396dc34f" id="r_a498bfcda46f961c085d7a116396dc34f"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor_manager.html#a498bfcda46f961c085d7a116396dc34f">pushCursor</a> (S32 cursorID)</td></tr>
<tr class="separator:a498bfcda46f961c085d7a116396dc34f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4fb89633afe3380457f509b0590c6923" id="r_a4fb89633afe3380457f509b0590c6923"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor_manager.html#a4fb89633afe3380457f509b0590c6923">popCursor</a> ()</td></tr>
<tr class="memdesc:a4fb89633afe3380457f509b0590c6923"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pop a Cursor from the Stack.  <br /></td></tr>
<tr class="separator:a4fb89633afe3380457f509b0590c6923"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b13f19a9eb61b86050f617beda5b0ab" id="r_a6b13f19a9eb61b86050f617beda5b0ab"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor_manager.html#a6b13f19a9eb61b86050f617beda5b0ab">refreshCursor</a> ()</td></tr>
<tr class="memdesc:a6b13f19a9eb61b86050f617beda5b0ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Refresh the Cursor.  <br /></td></tr>
<tr class="separator:a6b13f19a9eb61b86050f617beda5b0ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-methods" name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a993526b666c9b9d17f97fc1128f9dc82" id="r_a993526b666c9b9d17f97fc1128f9dc82"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor_manager.html#a993526b666c9b9d17f97fc1128f9dc82">changeCursorShape</a> (S32 cursorID)</td></tr>
<tr class="memdesc:a993526b666c9b9d17f97fc1128f9dc82"><td class="mdescLeft">&#160;</td><td class="mdescRight">Change the Current Cursor Shape.  <br /></td></tr>
<tr class="separator:a993526b666c9b9d17f97fc1128f9dc82"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pro-attribs" name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ae0d56dca6a73b3d7905967205f8e3168" id="r_ae0d56dca6a73b3d7905967205f8e3168"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_vector.html">Vector</a>&lt; <a class="el" href="struct_cursor_manager_1_1cursors.html">cursors</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_cursor_manager.html#ae0d56dca6a73b3d7905967205f8e3168">mCursors</a></td></tr>
<tr class="memdesc:ae0d56dca6a73b3d7905967205f8e3168"><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="el" href="class_vector.html">Vector</a> of <a class="el" href="struct_platform.html">Platform</a> Cursors.  <br /></td></tr>
<tr class="separator:ae0d56dca6a73b3d7905967205f8e3168"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A Singleton LIFO stack of platform cursor shapes</p>
<p>The <a class="el" href="class_cursor_manager.html">CursorManager</a> class manages a LIFO stack of platform cursor shapes with a standard platform cursor at the bottom, usually an Arrow Cursor. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a id="a0944a4353780132eeab7b06e3e42291d" name="a0944a4353780132eeab7b06e3e42291d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0944a4353780132eeab7b06e3e42291d">&#9670;&#160;</a></span>anonymous enum</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">anonymous enum</td>
        </tr>
      </table>
</div><div class="memdoc">
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291da8eded07c2f9502cc7be791ce02377b00" name="a0944a4353780132eeab7b06e3e42291da8eded07c2f9502cc7be791ce02377b00"></a>curArrow&#160;</td><td class="fielddoc"><p>Default Cursor. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291dab90d8d74075ae9b82e5d2cd9f53a7a7c" name="a0944a4353780132eeab7b06e3e42291dab90d8d74075ae9b82e5d2cd9f53a7a7c"></a>curWait&#160;</td><td class="fielddoc"><p>Hourglass Cursor. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291dab6f1242eb7bd234d9b1fb41219879ef4" name="a0944a4353780132eeab7b06e3e42291dab6f1242eb7bd234d9b1fb41219879ef4"></a>curPlus&#160;</td><td class="fielddoc"><p>Arrow Plus. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291dac57fd0a756fdbc65651fa629921505b3" name="a0944a4353780132eeab7b06e3e42291dac57fd0a756fdbc65651fa629921505b3"></a>curResizeVert&#160;</td><td class="fielddoc"><p>Resize Vertical. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291da4ce409db123c9b90e6247a819900758a" name="a0944a4353780132eeab7b06e3e42291da4ce409db123c9b90e6247a819900758a"></a>curResizeHorz&#160;</td><td class="fielddoc"><p>Resize Horizontal. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291da7b1841a4817746a255270a320deef61d" name="a0944a4353780132eeab7b06e3e42291da7b1841a4817746a255270a320deef61d"></a>curResizeAll&#160;</td><td class="fielddoc"><p>Resize All. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291dae66bf72c64f6a96c8fa064acec1f106a" name="a0944a4353780132eeab7b06e3e42291dae66bf72c64f6a96c8fa064acec1f106a"></a>curIBeam&#160;</td><td class="fielddoc"><p>IBeam Used for Text Entry. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291da7ab455ba2caabc84dda8d9822d563f8f" name="a0944a4353780132eeab7b06e3e42291da7ab455ba2caabc84dda8d9822d563f8f"></a>curResizeNESW&#160;</td><td class="fielddoc"><p>Resize NESW. </p>
</td></tr>
<tr><td class="fieldname"><a id="a0944a4353780132eeab7b06e3e42291da8315133664b5b7c64a106e5aadbe63d8" name="a0944a4353780132eeab7b06e3e42291da8315133664b5b7c64a106e5aadbe63d8"></a>curResizeNWSE&#160;</td><td class="fielddoc"><p>Resize NWSE. </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a993526b666c9b9d17f97fc1128f9dc82" name="a993526b666c9b9d17f97fc1128f9dc82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a993526b666c9b9d17f97fc1128f9dc82">&#9670;&#160;</a></span>changeCursorShape()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void changeCursorShape </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>cursorID</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Change the Current Cursor Shape. </p>

</div>
</div>
<a id="a4fb89633afe3380457f509b0590c6923" name="a4fb89633afe3380457f509b0590c6923"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4fb89633afe3380457f509b0590c6923">&#9670;&#160;</a></span>popCursor()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void popCursor </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pop a Cursor from the Stack. </p>

</div>
</div>
<a id="a498bfcda46f961c085d7a116396dc34f" name="a498bfcda46f961c085d7a116396dc34f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a498bfcda46f961c085d7a116396dc34f">&#9670;&#160;</a></span>pushCursor()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void pushCursor </td>
          <td>(</td>
          <td class="paramtype">S32&#160;</td>
          <td class="paramname"><em>cursorID</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Push a Cursor onto the Stack </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cursorID</td><td>The Cursor ID to use </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a6b13f19a9eb61b86050f617beda5b0ab" name="a6b13f19a9eb61b86050f617beda5b0ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6b13f19a9eb61b86050f617beda5b0ab">&#9670;&#160;</a></span>refreshCursor()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void refreshCursor </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Refresh the Cursor. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae0d56dca6a73b3d7905967205f8e3168" name="ae0d56dca6a73b3d7905967205f8e3168"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0d56dca6a73b3d7905967205f8e3168">&#9670;&#160;</a></span>mCursors</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_vector.html">Vector</a>&lt;<a class="el" href="struct_cursor_manager_1_1cursors.html">cursors</a>&gt; mCursors</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>A <a class="el" href="class_vector.html">Vector</a> of <a class="el" href="struct_platform.html">Platform</a> Cursors. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>platform/<b>platformInput.h</b></li>
<li>platform/<b>CursorManager.cc</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>