diff options
Diffstat (limited to 'classyage_1_1EntityManager.html')
-rw-r--r-- | classyage_1_1EntityManager.html | 260 |
1 files changed, 260 insertions, 0 deletions
diff --git a/classyage_1_1EntityManager.html b/classyage_1_1EntityManager.html new file mode 100644 index 00000000..fb4b9662 --- /dev/null +++ b/classyage_1_1EntityManager.html @@ -0,0 +1,260 @@ +<!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"/> +<meta name="generator" content="Doxygen 1.8.6"/> +<title>YAGE: yage::EntityManager 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/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</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 id="projectlogo"><img alt="Logo" src="yage.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">YAGE +  <span id="projectnumber">v0.1.4.0</span> + </div> + <div id="projectbrief">Yet Another Game Engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.6 --> +<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 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> + <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 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> +<!-- 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>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</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"><a class="el" href="namespaceyage.html">yage</a></li><li class="navelem"><a class="el" href="classyage_1_1EntityManager.html">EntityManager</a></li> </ul> +</div> +</div><!-- top --> +<div class="header"> + <div class="summary"> +<a href="#pub-methods">Public Member Functions</a> | +<a href="classyage_1_1EntityManager-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">yage::EntityManager Class Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>Manages entities in a space. + <a href="classyage_1_1EntityManager.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="entitymanager_8h_source.html">entitymanager.h</a>></code></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a255fa9aff3e6b208eea0c38d8caf08f8"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1EntityManager.html#a255fa9aff3e6b208eea0c38d8caf08f8">EntityManager</a> ()=default</td></tr> +<tr class="memdesc:a255fa9aff3e6b208eea0c38d8caf08f8"><td class="mdescLeft"> </td><td class="mdescRight">Default instance of an <a class="el" href="classyage_1_1EntityManager.html" title="Manages entities in a space. ">EntityManager</a>. <a href="#a255fa9aff3e6b208eea0c38d8caf08f8">More...</a><br/></td></tr> +<tr class="separator:a255fa9aff3e6b208eea0c38d8caf08f8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0099fe0038967007891d2b7575090915"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1EntityManager.html#a0099fe0038967007891d2b7575090915">EntityManager</a> (<a class="el" href="classyage_1_1Space.html">Space</a> *space)</td></tr> +<tr class="memdesc:a0099fe0038967007891d2b7575090915"><td class="mdescLeft"> </td><td class="mdescRight">Creates an instance of the entity manager, which refers back to the space it was created in and belongs to. <a href="#a0099fe0038967007891d2b7575090915">More...</a><br/></td></tr> +<tr class="separator:a0099fe0038967007891d2b7575090915"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af1644095d96e43ac000375ba7f7ee021"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1EntityManager.html#af1644095d96e43ac000375ba7f7ee021">EntityManager</a> (<a class="el" href="classyage_1_1Space.html">Space</a> *space, std::size_t n)</td></tr> +<tr class="memdesc:af1644095d96e43ac000375ba7f7ee021"><td class="mdescLeft"> </td><td class="mdescRight">Creates an instance of the entitiy manager with an initial size. <a href="#af1644095d96e43ac000375ba7f7ee021">More...</a><br/></td></tr> +<tr class="separator:af1644095d96e43ac000375ba7f7ee021"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:acdd054a1235fb03452089d9f419a7e2b"><td class="memItemLeft" align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1EntityManager.html#acdd054a1235fb03452089d9f419a7e2b">createEntity</a> ()</td></tr> +<tr class="memdesc:acdd054a1235fb03452089d9f419a7e2b"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classyage_1_1Entity.html" title="Entity convenience class. ">Entity</a> and returns the handle to the entity, which can then be used by the user to do operations on it. <a href="#acdd054a1235fb03452089d9f419a7e2b">More...</a><br/></td></tr> +<tr class="separator:acdd054a1235fb03452089d9f419a7e2b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a188f3bc252781f9f3a7b4da417f0d7de"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classyage_1_1Entity.html">Entity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classyage_1_1EntityManager.html#a188f3bc252781f9f3a7b4da417f0d7de">createEntityInstance</a> ()</td></tr> +<tr class="memdesc:a188f3bc252781f9f3a7b4da417f0d7de"><td class="mdescLeft"> </td><td class="mdescRight">Creates an <a class="el" href="classyage_1_1Entity.html" title="Entity convenience class. ">Entity</a> and returns it. <a href="#a188f3bc252781f9f3a7b4da417f0d7de">More...</a><br/></td></tr> +<tr class="separator:a188f3bc252781f9f3a7b4da417f0d7de"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><p>Manages entities in a space. </p> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a class="anchor" id="a255fa9aff3e6b208eea0c38d8caf08f8"></a> +<div class="memitem"> +<div class="memproto"> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">yage::EntityManager::EntityManager </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">default</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +<p>Default instance of an <a class="el" href="classyage_1_1EntityManager.html" title="Manages entities in a space. ">EntityManager</a>. </p> + +</div> +</div> +<a class="anchor" id="a0099fe0038967007891d2b7575090915"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">yage::EntityManager::EntityManager </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classyage_1_1Space.html">Space</a> * </td> + <td class="paramname"><em>space</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates an instance of the entity manager, which refers back to the space it was created in and belongs to. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space</td><td>Current space that the <a class="el" href="classyage_1_1EntityManager.html" title="Manages entities in a space. ">EntityManager</a> belongs to. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<a class="anchor" id="af1644095d96e43ac000375ba7f7ee021"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">yage::EntityManager::EntityManager </td> + <td>(</td> + <td class="paramtype"><a class="el" href="classyage_1_1Space.html">Space</a> * </td> + <td class="paramname"><em>space</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>n</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates an instance of the entitiy manager with an initial size. </p> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">space</td><td>Current space that the <a class="el" href="classyage_1_1EntityManager.html" title="Manages entities in a space. ">EntityManager</a> belongs to. </td></tr> + <tr><td class="paramname">n</td><td>Initial size of the <a class="el" href="classyage_1_1EntityManager.html" title="Manages entities in a space. ">EntityManager</a>. </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a class="anchor" id="acdd054a1235fb03452089d9f419a7e2b"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">unsigned yage::EntityManager::createEntity </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates an <a class="el" href="classyage_1_1Entity.html" title="Entity convenience class. ">Entity</a> and returns the handle to the entity, which can then be used by the user to do operations on it. </p> +<dl class="section return"><dt>Returns</dt><dd>The handle to the entity that was created in the space. </dd></dl> + +</div> +</div> +<a class="anchor" id="a188f3bc252781f9f3a7b4da417f0d7de"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classyage_1_1Entity.html">Entity</a> yage::EntityManager::createEntityInstance </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> + +<p>Creates an <a class="el" href="classyage_1_1Entity.html" title="Entity convenience class. ">Entity</a> and returns it. </p> +<dl class="section return"><dt>Returns</dt><dd>The entity that was created by the entity manager in the current space. </dd></dl> + +</div> +</div> +<hr/>The documentation for this class was generated from the following files:<ul> +<li>yage/engine/<a class="el" href="entitymanager_8h_source.html">entitymanager.h</a></li> +<li>yage/engine/<a class="el" href="entitymanager_8cpp.html">entitymanager.cpp</a></li> +</ul> +</div><!-- contents --> +<!-- start footer part --> +<hr class="footer"/><address class="footer"><small> +Generated on Wed Jan 10 2018 18:44:07 for YAGE by  <a href="http://www.doxygen.org/index.html"> +<img class="footer" src="doxygen.png" alt="doxygen"/> +</a> 1.8.6 +</small></address> +</body> +</html> |