373 lines
17 KiB
HTML
373 lines
17 KiB
HTML
<!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"/>
|
|
<title>Unuk: Entity Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<script type="text/javascript" src="resize.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
</script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body onload='searchBox.OnSelectItem(0);'>
|
|
<!-- Generated by Doxygen 1.7.4 -->
|
|
<script type="text/javascript"><!--
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
--></script>
|
|
<div id="top">
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Unuk <span id="projectnumber">1.0</span></div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</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>
|
|
<li id="searchli">
|
|
<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 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>
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
initNavTree('class_entity.html','');
|
|
</script>
|
|
<div id="doc-content">
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">Entity Class Reference</div> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<!-- doxytag: class="Entity" --><!-- doxytag: inherits="Static" -->
|
|
<p><code>#include <<a class="el" href="_entity_8h_source.html">Entity.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for Entity:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="class_entity.png" usemap="#Entity_map" alt=""/>
|
|
<map id="Entity_map" name="Entity_map">
|
|
<area href="class_static.html" alt="Static" shape="rect" coords="0,0,43,24"/>
|
|
</map>
|
|
</div></div>
|
|
|
|
<p><a href="class_entity-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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#af7b7088ca610b9f247110ccf47ed178b">Entity</a> (GameWorld *const gameWorld)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a6e8406be37172eb7f4e89dd3ba674113">~Entity</a> (void)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a0a0be12a8170540fed0ce3de68f46790">Prepare</a> (float dt)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a64da675ba3c24b2e4a3ee89917a5c970">Render</a> (void) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a8d03dea10779e4e91b4aef0fb7f571bc">PostRender</a> (void)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a81982ee7714b5126e09ad3e82207f146">Initialize</a> (void)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a673a3a5c822c734d641e918a7a73f6e7">Shutdown</a> (void)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a2da196bad22f7c5a95d47564c7d0ea04">CanBeRemoved</a> (void) const </td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a71b297ca801c1b3170a885a6f4d481c1">Destroy</a> (void)</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="struct_vector2.html">Vector2</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a26a31288cbf21650596a7b5a0adee7ee">GetPosition</a> (void) const =0</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a8b8556ee6351c6104eb49dcefd78398f">SetPosition</a> (const <a class="el" href="struct_vector2.html">Vector2</a> &position)=0</td></tr>
|
|
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="_entity_type_8h.html#ad79a57ed3105eb60d991a1aeb4a9dc44">EntityType</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_entity.html#a38188cc14a73fbcd0b7e5da55c709e2a">GetType</a> (void) const =0</td></tr>
|
|
</table>
|
|
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
|
|
<div class="textblock">
|
|
<p>Definition at line <a class="el" href="_entity_8h_source.html#l00015">15</a> of file <a class="el" href="_entity_8h_source.html">Entity.h</a>.</p>
|
|
</div><hr/><h2>Constructor & Destructor Documentation</h2>
|
|
<a class="anchor" id="af7b7088ca610b9f247110ccf47ed178b"></a><!-- doxytag: member="Entity::Entity" ref="af7b7088ca610b9f247110ccf47ed178b" args="(GameWorld *const gameWorld)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Entity::Entity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">GameWorld *const </td>
|
|
<td class="paramname"><em>gameWorld</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00003">3</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a6e8406be37172eb7f4e89dd3ba674113"></a><!-- doxytag: member="Entity::~Entity" ref="a6e8406be37172eb7f4e89dd3ba674113" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Entity::~Entity </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td><code> [virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00007">7</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/><h2>Member Function Documentation</h2>
|
|
<a class="anchor" id="a2da196bad22f7c5a95d47564c7d0ea04"></a><!-- doxytag: member="Entity::CanBeRemoved" ref="a2da196bad22f7c5a95d47564c7d0ea04" args="(void) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Entity::CanBeRemoved </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00009">9</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a71b297ca801c1b3170a885a6f4d481c1"></a><!-- doxytag: member="Entity::Destroy" ref="a71b297ca801c1b3170a885a6f4d481c1" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Entity::Destroy </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00013">13</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a26a31288cbf21650596a7b5a0adee7ee"></a><!-- doxytag: member="Entity::GetPosition" ref="a26a31288cbf21650596a7b5a0adee7ee" args="(void) const =0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="struct_vector2.html">Vector2</a> Entity::GetPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a38188cc14a73fbcd0b7e5da55c709e2a"></a><!-- doxytag: member="Entity::GetType" ref="a38188cc14a73fbcd0b7e5da55c709e2a" args="(void) const =0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual <a class="el" href="_entity_type_8h.html#ad79a57ed3105eb60d991a1aeb4a9dc44">EntityType</a> Entity::GetType </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const<code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a81982ee7714b5126e09ad3e82207f146"></a><!-- doxytag: member="Entity::Initialize" ref="a81982ee7714b5126e09ad3e82207f146" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">bool Entity::Initialize </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00029">29</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8d03dea10779e4e91b4aef0fb7f571bc"></a><!-- doxytag: member="Entity::PostRender" ref="a8d03dea10779e4e91b4aef0fb7f571bc" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Entity::PostRender </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0a0be12a8170540fed0ce3de68f46790"></a><!-- doxytag: member="Entity::Prepare" ref="a0a0be12a8170540fed0ce3de68f46790" args="(float dt)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Entity::Prepare </td>
|
|
<td>(</td>
|
|
<td class="paramtype">float </td>
|
|
<td class="paramname"><em>dt</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00017">17</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a64da675ba3c24b2e4a3ee89917a5c970"></a><!-- doxytag: member="Entity::Render" ref="a64da675ba3c24b2e4a3ee89917a5c970" args="(void) const " -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Entity::Render </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td> const</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00021">21</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a8b8556ee6351c6104eb49dcefd78398f"></a><!-- doxytag: member="Entity::SetPosition" ref="a8b8556ee6351c6104eb49dcefd78398f" args="(const Vector2 &position)=0" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual void Entity::SetPosition </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="struct_vector2.html">Vector2</a> & </td>
|
|
<td class="paramname"><em>position</em></td><td>)</td>
|
|
<td><code> [pure virtual]</code></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a673a3a5c822c734d641e918a7a73f6e7"></a><!-- doxytag: member="Entity::Shutdown" ref="a673a3a5c822c734d641e918a7a73f6e7" args="(void)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void Entity::Shutdown </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void </td>
|
|
<td class="paramname"></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>Definition at line <a class="el" href="_entity_8cpp_source.html#l00033">33</a> of file <a class="el" href="_entity_8cpp_source.html">Entity.cpp</a>.</p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following files:<ul>
|
|
<li>src/libUnuk/<a class="el" href="_entity_8h_source.html">Entity.h</a></li>
|
|
<li>src/libUnuk/<a class="el" href="_entity_8cpp_source.html">Entity.cpp</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="class_entity.html">Entity</a> </li>
|
|
<li class="footer">Generated on Wed Nov 2 2011 23:04:27 for Unuk by 
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</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>
|
|
|
|
|
|
</body>
|
|
</html>
|