Unuk/Docs/html/_entity_8h_source.html

157 lines
11 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: src/libUnuk/Entity.h Source File</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&#160;<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&#160;Page</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>File&#160;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('_entity_8h.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">src/libUnuk/Entity.h</div> </div>
</div>
<div class="contents">
<a href="_entity_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="preprocessor">#ifndef _ENTITY_H_</span>
<a name="l00002"></a>00002 <span class="preprocessor"></span><span class="preprocessor">#define _ENTITY_H_</span>
<a name="l00003"></a>00003 <span class="preprocessor"></span><span class="preprocessor">#include &quot;<a class="code" href="_geometry_8h.html">Geometry.h</a>&quot;</span>
<a name="l00004"></a>00004 <span class="preprocessor">#include &quot;<a class="code" href="_entity_type_8h.html">EntityType.h</a>&quot;</span>
<a name="l00005"></a>00005 <span class="preprocessor">#include &quot;<a class="code" href="_static_8h.html">Static.h</a>&quot;</span>
<a name="l00006"></a>00006
<a name="l00007"></a>00007 <span class="keyword">class </span>GameWorld;
<a name="l00008"></a>00008
<a name="l00009"></a>00009 <span class="comment">/*</span>
<a name="l00010"></a>00010 <span class="comment"> * Entity is static because we will mainly be handling</span>
<a name="l00011"></a>00011 <span class="comment"> * pointers (that can be copied around) but we want</span>
<a name="l00012"></a>00012 <span class="comment"> * all entities to be initiaized by the gameworld.</span>
<a name="l00013"></a>00013 <span class="comment"> */</span>
<a name="l00014"></a>00014
<a name="l00015"></a><a class="code" href="class_entity.html">00015</a> <span class="keyword">class </span><a class="code" href="class_entity.html">Entity</a> : <span class="keyword">private</span> <a class="code" href="class_static.html">Static</a> {
<a name="l00016"></a>00016 <span class="keyword">public</span>:
<a name="l00017"></a>00017 <a class="code" href="class_entity.html#af7b7088ca610b9f247110ccf47ed178b">Entity</a>(GameWorld* <span class="keyword">const</span> gameWorld);
<a name="l00018"></a>00018 <span class="keyword">virtual</span> <a class="code" href="class_entity.html#a6e8406be37172eb7f4e89dd3ba674113">~Entity</a>(<span class="keywordtype">void</span>);
<a name="l00019"></a>00019
<a name="l00020"></a>00020 <span class="keywordtype">void</span> <a class="code" href="class_entity.html#a0a0be12a8170540fed0ce3de68f46790">Prepare</a>(<span class="keywordtype">float</span> dt);
<a name="l00021"></a>00021 <span class="keywordtype">void</span> <a class="code" href="class_entity.html#a64da675ba3c24b2e4a3ee89917a5c970">Render</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00022"></a>00022 <span class="keywordtype">void</span> <a class="code" href="class_entity.html#a8d03dea10779e4e91b4aef0fb7f571bc">PostRender</a>(<span class="keywordtype">void</span>);
<a name="l00023"></a>00023 <span class="keywordtype">bool</span> <a class="code" href="class_entity.html#a81982ee7714b5126e09ad3e82207f146">Initialize</a>(<span class="keywordtype">void</span>);
<a name="l00024"></a>00024 <span class="keywordtype">void</span> <a class="code" href="class_entity.html#a673a3a5c822c734d641e918a7a73f6e7">Shutdown</a>(<span class="keywordtype">void</span>);
<a name="l00025"></a>00025 <span class="keywordtype">bool</span> <a class="code" href="class_entity.html#a2da196bad22f7c5a95d47564c7d0ea04">CanBeRemoved</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span>;
<a name="l00026"></a>00026 <span class="keywordtype">void</span> <a class="code" href="class_entity.html#a71b297ca801c1b3170a885a6f4d481c1">Destroy</a>(<span class="keywordtype">void</span>);
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">virtual</span> <a class="code" href="struct_vector2.html">Vector2</a> <a class="code" href="class_entity.html#a26a31288cbf21650596a7b5a0adee7ee">GetPosition</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
<a name="l00029"></a>00029 <span class="comment">//virtual Vector2 GetVelocity() const = 0;</span>
<a name="l00030"></a>00030 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_entity.html#a8b8556ee6351c6104eb49dcefd78398f">SetPosition</a>(<span class="keyword">const</span> <a class="code" href="struct_vector2.html">Vector2</a>&amp; position) = 0;
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">virtual</span> <a class="code" href="_entity_type_8h.html#ad79a57ed3105eb60d991a1aeb4a9dc44">EntityType</a> <a class="code" href="class_entity.html#a38188cc14a73fbcd0b7e5da55c709e2a">GetType</a>(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">private</span>:
<a name="l00035"></a>00035 <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnPrepare(<span class="keywordtype">float</span> dt) = 0;
<a name="l00036"></a>00036 <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnRender(<span class="keywordtype">void</span>) <span class="keyword">const</span> = 0;
<a name="l00037"></a>00037 <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnPostRender(<span class="keywordtype">void</span>) = 0;
<a name="l00038"></a>00038 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> OnInitiaize(<span class="keywordtype">void</span>) = 0;
<a name="l00039"></a>00039 <span class="keyword">virtual</span> <span class="keywordtype">void</span> OnShutdown(<span class="keywordtype">void</span>) = 0;
<a name="l00040"></a>00040
<a name="l00041"></a>00041 <span class="keywordtype">bool</span> m_canBeRemoved;
<a name="l00042"></a>00042
<a name="l00043"></a>00043 GameWorld* m_world;
<a name="l00044"></a>00044 };
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="preprocessor">#endif</span>
</pre></div></div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="_entity_8h.html">Entity.h</a> </li>
<li class="footer">Generated on Wed Nov 2 2011 23:04:26 for Unuk by&#160;
<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">&#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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</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>