cpp
/
JoltPhysics
mirror of https://github.com/jrouwe/JoltPhysics.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330
							<!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.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Jolt Physics: Factory 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
  extensions: ["tex2jax.js"],
  jax: ["input/TeX","output/HTML-CSS"],
});
</script>
<script type="text/javascript" async="async" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js"></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 id="projectrow">
  <td id="projectlogo"><img alt="Logo" src="LogoSmall.png"/></td>
  <td id="projectalign">
   <div id="projectname">Jolt Physics
   </div>
   <div id="projectbrief">A multi core friendly Game Physics Engine</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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',true);
  $(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){initNavTree('class_factory.html',''); initResizable(true); });
/* @license-end */
</script>
<div id="doc-content">
<!-- 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 class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_factory-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">Factory Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>This class is responsible for creating instances of classes based on their name or hash and is mainly used for deserialization of saved data.  
 <a href="#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_factory_8h_source.html">Factory.h</a>&gt;</code></p>
<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:a8952fd138cc4a7625f009fda6d47f078" id="r_a8952fd138cc4a7625f009fda6d47f078"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_memory_8h.html#a91074fb218fe28954a0938c099ddd9e0">JPH_OVERRIDE_NEW_DELETE</a> void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8952fd138cc4a7625f009fda6d47f078">CreateObject</a> (const char *inName)</td></tr>
<tr class="memdesc:a8952fd138cc4a7625f009fda6d47f078"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create an object.  <br /></td></tr>
<tr class="separator:a8952fd138cc4a7625f009fda6d47f078"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87756d7feaaeabb5cf29b95266ea418b" id="r_a87756d7feaaeabb5cf29b95266ea418b"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_r_t_t_i.html">RTTI</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a87756d7feaaeabb5cf29b95266ea418b">Find</a> (const char *inName)</td></tr>
<tr class="memdesc:a87756d7feaaeabb5cf29b95266ea418b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find type info for a specific class by name.  <br /></td></tr>
<tr class="separator:a87756d7feaaeabb5cf29b95266ea418b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a962c9d57a3bce85b649c3ebd1259b9a0" id="r_a962c9d57a3bce85b649c3ebd1259b9a0"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="class_r_t_t_i.html">RTTI</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a962c9d57a3bce85b649c3ebd1259b9a0">Find</a> (<a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a> inHash)</td></tr>
<tr class="memdesc:a962c9d57a3bce85b649c3ebd1259b9a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Find type info for a specific class by hash.  <br /></td></tr>
<tr class="separator:a962c9d57a3bce85b649c3ebd1259b9a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c5c5cba0d5101b5d33302cd102d8546" id="r_a2c5c5cba0d5101b5d33302cd102d8546"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a2c5c5cba0d5101b5d33302cd102d8546">Register</a> (const <a class="el" href="class_r_t_t_i.html">RTTI</a> *inRTTI)</td></tr>
<tr class="memdesc:a2c5c5cba0d5101b5d33302cd102d8546"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register an object with the factory. Returns false on failure.  <br /></td></tr>
<tr class="separator:a2c5c5cba0d5101b5d33302cd102d8546"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad0d9b51fede200c603359bc2ffc8bc8f" id="r_ad0d9b51fede200c603359bc2ffc8bc8f"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad0d9b51fede200c603359bc2ffc8bc8f">Register</a> (const <a class="el" href="class_r_t_t_i.html">RTTI</a> **inRTTIs, <a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a> inNumber)</td></tr>
<tr class="memdesc:ad0d9b51fede200c603359bc2ffc8bc8f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Register a list of objects with the factory. Returns false on failure.  <br /></td></tr>
<tr class="separator:ad0d9b51fede200c603359bc2ffc8bc8f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8797d6707e3873ad2a3482d04782dc6a" id="r_a8797d6707e3873ad2a3482d04782dc6a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8797d6707e3873ad2a3482d04782dc6a">Clear</a> ()</td></tr>
<tr class="memdesc:a8797d6707e3873ad2a3482d04782dc6a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters all types.  <br /></td></tr>
<tr class="separator:a8797d6707e3873ad2a3482d04782dc6a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa67bdc2e09c649caf997ffbe9ce32fa5" id="r_aa67bdc2e09c649caf997ffbe9ce32fa5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_array.html">Array</a>&lt; const <a class="el" href="class_r_t_t_i.html">RTTI</a> * &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aa67bdc2e09c649caf997ffbe9ce32fa5">GetAllClasses</a> () const</td></tr>
<tr class="memdesc:aa67bdc2e09c649caf997ffbe9ce32fa5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get all registered classes.  <br /></td></tr>
<tr class="separator:aa67bdc2e09c649caf997ffbe9ce32fa5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-static-attribs" name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:afdbac3e3e59f7981d7dec696e914e69f" id="r_afdbac3e3e59f7981d7dec696e914e69f"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="class_factory.html">Factory</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afdbac3e3e59f7981d7dec696e914e69f">sInstance</a> = nullptr</td></tr>
<tr class="memdesc:afdbac3e3e59f7981d7dec696e914e69f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Singleton factory instance.  <br /></td></tr>
<tr class="separator:afdbac3e3e59f7981d7dec696e914e69f"><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>This class is responsible for creating instances of classes based on their name or hash and is mainly used for deserialization of saved data. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a8797d6707e3873ad2a3482d04782dc6a" name="a8797d6707e3873ad2a3482d04782dc6a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8797d6707e3873ad2a3482d04782dc6a">&#9670;&#160;</a></span>Clear()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void Factory::Clear </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Unregisters all types. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * Factory::CreateObject </td>
          <td>(</td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>inName</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create an object. </p>

</div>
</div>
<a id="a87756d7feaaeabb5cf29b95266ea418b" name="a87756d7feaaeabb5cf29b95266ea418b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a87756d7feaaeabb5cf29b95266ea418b">&#9670;&#160;</a></span>Find() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="class_r_t_t_i.html">RTTI</a> * Factory::Find </td>
          <td>(</td>
          <td class="paramtype">const char *</td>          <td class="paramname"><span class="paramname"><em>inName</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find type info for a specific class by name. </p>

</div>
</div>
<a id="a962c9d57a3bce85b649c3ebd1259b9a0" name="a962c9d57a3bce85b649c3ebd1259b9a0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a962c9d57a3bce85b649c3ebd1259b9a0">&#9670;&#160;</a></span>Find() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const <a class="el" href="class_r_t_t_i.html">RTTI</a> * Factory::Find </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a8f95e75e58492e87412191fabadd8ca8">uint32</a></td>          <td class="paramname"><span class="paramname"><em>inHash</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Find type info for a specific class by hash. </p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_array.html">Array</a>&lt; const <a class="el" href="class_r_t_t_i.html">RTTI</a> * &gt; Factory::GetAllClasses </td>
          <td>(</td>
          <td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Get all registered classes. </p>

</div>
</div>
<a id="ad0d9b51fede200c603359bc2ffc8bc8f" name="ad0d9b51fede200c603359bc2ffc8bc8f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad0d9b51fede200c603359bc2ffc8bc8f">&#9670;&#160;</a></span>Register() <span class="overload">[1/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Factory::Register </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_r_t_t_i.html">RTTI</a> **</td>          <td class="paramname"><span class="paramname"><em>inRTTIs</em></span>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="_core_8h.html#a69aa29b598b851b0640aa225a9e5d61d">uint</a></td>          <td class="paramname"><span class="paramname"><em>inNumber</em></span>&#160;)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register a list of objects with the factory. Returns false on failure. </p>

</div>
</div>
<a id="a2c5c5cba0d5101b5d33302cd102d8546" name="a2c5c5cba0d5101b5d33302cd102d8546"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c5c5cba0d5101b5d33302cd102d8546">&#9670;&#160;</a></span>Register() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool Factory::Register </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="class_r_t_t_i.html">RTTI</a> *</td>          <td class="paramname"><span class="paramname"><em>inRTTI</em></span></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Register an object with the factory. Returns false on failure. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="afdbac3e3e59f7981d7dec696e914e69f" name="afdbac3e3e59f7981d7dec696e914e69f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afdbac3e3e59f7981d7dec696e914e69f">&#9670;&#160;</a></span>sInstance</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="_core_8h.html#ad14098b68b8c44ea6112601031268405">JPH_NAMESPACE_BEGIN</a> <a class="el" href="class_factory.html">Factory</a> * Factory::sInstance = nullptr</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Singleton factory instance. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>Jolt/Core/<a class="el" href="_factory_8h_source.html">Factory.h</a></li>
<li>Jolt/Core/<a class="el" href="_factory_8cpp.html">Factory.cpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_factory.html">Factory</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0 </li>
  </ul>
</div>
</body>
</html>