cpp
/
GamePlay
zrcadlo https://github.com/gameplay3d/GamePlay


			
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328
							<!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>AIStateMachine Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="custom.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->
<table class="header" border="0">
<tbody>
<tr>
<td id="logo"><a href="http://gameplay3d.io/"><img src="images/logo.png" alt="gameplay" border="0" height="64px"/></a></td>
<td width="100%"/>
<td><a href="http://gameplay3d.io/"><span class="button">overview</span></a></td><td width="12px"/>
<td><a href="https://github.com/gameplay3d/GamePlay/wiki"><span class="button">wiki</span></a></td><td width="12px"/>
<td><a href="http://gameplay3d.github.com/GamePlay/api/index.html"><span class="button">api&nbsp;reference</span></a></td><td width="12px"/>
<td><a href="https://github.com/gameplay3d/GamePlay"><span class="button">download</span></a></td>
</tr>
</tbody>
</table>
<!-- Generated by Doxygen 1.7.6.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>gameplay</b>      </li>
      <li class="navelem"><a class="el" href="classgameplay_1_1_a_i_state_machine.html">AIStateMachine</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">gameplay::AIStateMachine Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="gameplay::AIStateMachine" -->
<p><code>#include &lt;AIStateMachine.h&gt;</code></p>

<p><a href="classgameplay_1_1_a_i_state_machine-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_a_i_agent.html">AIAgent</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#a08ee93ba3ed65aee7a97529dbdff24d8">getAgent</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#a529c47a950791a47c947e5ab312ff8be">addState</a> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#abe55041cba5e256c9ec21c8f49a94853">addState</a> (<a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#aff0cc3defda356f840bd107d57990d0e">removeState</a> (<a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *state)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#ace2bcbc691e632e81c5ea2efc9d882e3">getState</a> (const char *id) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#a1642b512a2c9b145448b44278107fd2a">getActiveState</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#a91750e879146f9f3a40dd576b5ad1f1e">setState</a> (const char *id)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classgameplay_1_1_a_i_state_machine.html#ab413de56ce6a0c982266308a4c7cedfe">setState</a> (<a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *state)</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Defines a simple AI state machine that can be used to program logic for an <a class="el" href="classgameplay_1_1_a_i_agent.html">AIAgent</a> in a game.</p>
<p>A state machine uses <a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> objects to represent different states of an object in the game. The state machine provides access to the current state of an AI agent and it controls state changes as well. When a new state is set, the stateExited event will be called for the previous state, the stateEntered event will be called for the new state and then the stateUpdate event will begin to be called each frame while the new state is active.</p>
<p>Communication of state changes is facilitated through the <a class="el" href="classgameplay_1_1_a_i_message.html">AIMessage</a> class. Messages are dispatched by the <a class="el" href="classgameplay_1_1_a_i_controller.html">AIController</a> and can be used for purposes other than state changes as well. Messages may be sent to the state machines of any other agents in a game and can contain any arbitrary information. This mechanism provides a simple, flexible and easily debuggable method for communicating between AI objects in a game. </p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a529c47a950791a47c947e5ab312ff8be"></a><!-- doxytag: member="gameplay::AIStateMachine::addState" ref="a529c47a950791a47c947e5ab312ff8be" args="(const char *id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>* <a class="el" href="classgameplay_1_1_a_i_state_machine.html#a529c47a950791a47c947e5ab312ff8be">gameplay::AIStateMachine::addState</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>id</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates and adds a new state to the state machine.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>ID of the new state.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The newly created and added state. </dd></dl>

</div>
</div>
<a class="anchor" id="abe55041cba5e256c9ec21c8f49a94853"></a><!-- doxytag: member="gameplay::AIStateMachine::addState" ref="abe55041cba5e256c9ec21c8f49a94853" args="(AIState *state)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgameplay_1_1_a_i_state_machine.html#a529c47a950791a47c947e5ab312ff8be">gameplay::AIStateMachine::addState</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Adds a state to the state machine.</p>
<p>The specified state may be shared by other state machines. Its reference count is increased while it is held by this state machine.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The state to add. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a1642b512a2c9b145448b44278107fd2a"></a><!-- doxytag: member="gameplay::AIStateMachine::getActiveState" ref="a1642b512a2c9b145448b44278107fd2a" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>* <a class="el" href="classgameplay_1_1_a_i_state_machine.html#a1642b512a2c9b145448b44278107fd2a">gameplay::AIStateMachine::getActiveState</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the active state for this state machine.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The active state for this state machine. </dd></dl>

</div>
</div>
<a class="anchor" id="a08ee93ba3ed65aee7a97529dbdff24d8"></a><!-- doxytag: member="gameplay::AIStateMachine::getAgent" ref="a08ee93ba3ed65aee7a97529dbdff24d8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgameplay_1_1_a_i_agent.html">AIAgent</a>* <a class="el" href="classgameplay_1_1_a_i_state_machine.html#a08ee93ba3ed65aee7a97529dbdff24d8">gameplay::AIStateMachine::getAgent</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the <a class="el" href="classgameplay_1_1_a_i_agent.html">AIAgent</a> that owns this state machine.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The <a class="el" href="classgameplay_1_1_a_i_agent.html">AIAgent</a> that owns this state machine. </dd></dl>

</div>
</div>
<a class="anchor" id="ace2bcbc691e632e81c5ea2efc9d882e3"></a><!-- doxytag: member="gameplay::AIStateMachine::getState" ref="ace2bcbc691e632e81c5ea2efc9d882e3" args="(const char *id) const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>* <a class="el" href="classgameplay_1_1_a_i_state_machine.html#ace2bcbc691e632e81c5ea2efc9d882e3">gameplay::AIStateMachine::getState</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>id</em></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns a state registered with this state machine.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>The ID of the state to return.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The state with the given ID, or NULL if no such state exists. </dd></dl>

</div>
</div>
<a class="anchor" id="aff0cc3defda356f840bd107d57990d0e"></a><!-- doxytag: member="gameplay::AIStateMachine::removeState" ref="aff0cc3defda356f840bd107d57990d0e" args="(AIState *state)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classgameplay_1_1_a_i_state_machine.html#aff0cc3defda356f840bd107d57990d0e">gameplay::AIStateMachine::removeState</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Removes a state from the state machine.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The state to remove. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a91750e879146f9f3a40dd576b5ad1f1e"></a><!-- doxytag: member="gameplay::AIStateMachine::setState" ref="a91750e879146f9f3a40dd576b5ad1f1e" args="(const char *id)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a>* <a class="el" href="classgameplay_1_1_a_i_state_machine.html#a91750e879146f9f3a40dd576b5ad1f1e">gameplay::AIStateMachine::setState</a> </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>id</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Changes the state of this state machine to the given state.</p>
<p>If no state with the given ID exists within this state machine, this method does nothing.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">id</td><td>The ID of the new state.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The new state, or NULL if no matching state could be found. </dd></dl>

</div>
</div>
<a class="anchor" id="ab413de56ce6a0c982266308a4c7cedfe"></a><!-- doxytag: member="gameplay::AIStateMachine::setState" ref="ab413de56ce6a0c982266308a4c7cedfe" args="(AIState *state)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classgameplay_1_1_a_i_state_machine.html#a91750e879146f9f3a40dd576b5ad1f1e">gameplay::AIStateMachine::setState</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classgameplay_1_1_a_i_state.html">AIState</a> *&#160;</td>
          <td class="paramname"><em>state</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Changes the state of this state machine to the given state.</p>
<p>If the given state is not registered with this state machine, this method does nothing.</p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">state</td><td>The new state.</td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the state is successfully changed, false otherwise. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerator</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>


<hr class="footer"/><address class="footer"><small>
Generated on Sat Jan 24 2015 15:29:41 for gameplay by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.7.6.1
</small></address>

</body>
</html>