TorqueEngine
/
Torque2D
miroir de https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214
							<!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.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Torque2D Reference: ResourceInstance 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/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.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="projectalign">
   <div id="projectname">Torque2D Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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" 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');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- 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><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="class_resource_instance-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">ResourceInstance Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;resourceManager.h&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for ResourceInstance:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
 <div class="center">
  <img src="class_resource_instance.png" usemap="#ResourceInstance_map" alt=""/>
  <map id="ResourceInstance_map" name="ResourceInstance_map">
<area href="class_audio_buffer.html" alt="AudioBuffer" shape="rect" coords="0,56,113,80"/>
<area href="class_g_bitmap.html" alt="GBitmap" shape="rect" coords="123,56,236,80"/>
<area href="class_g_font.html" alt="GFont" shape="rect" coords="246,56,359,80"/>
  </map>
</div></div>
<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:a60f6680bb78492eb8b97d3e36514a139" id="r_a60f6680bb78492eb8b97d3e36514a139"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_resource_instance.html#a60f6680bb78492eb8b97d3e36514a139">ResourceInstance</a> ()</td></tr>
<tr class="separator:a60f6680bb78492eb8b97d3e36514a139"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6684f1419b225f2ccd7dfd495fd19bb3" id="r_a6684f1419b225f2ccd7dfd495fd19bb3"><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_resource_instance.html#a6684f1419b225f2ccd7dfd495fd19bb3">~ResourceInstance</a> ()</td></tr>
<tr class="separator:a6684f1419b225f2ccd7dfd495fd19bb3"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:abdc28331c98eadf7e51f9ce3595ea557" id="r_abdc28331c98eadf7e51f9ce3595ea557"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_resource_object.html">ResourceObject</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_resource_instance.html#abdc28331c98eadf7e51f9ce3595ea557">mSourceResource</a></td></tr>
<tr class="memdesc:abdc28331c98eadf7e51f9ce3595ea557"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pointer to the <a class="el" href="class_resource_object.html">ResourceObject</a> that stores all our book-keeping data.  <br /></td></tr>
<tr class="separator:abdc28331c98eadf7e51f9ce3595ea557"><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>The base class for all resources.</p>
<p>This must be subclassed to implement a resource that can be managed.</p>
<p>Creating a new resource type is very simple. First, you need a function which can create a new instance of the resource given a stream:</p>
<div class="fragment"><div class="line"><a class="code hl_class" href="class_resource_instance.html">ResourceInstance</a>* constructBitmapPNG(<a class="code hl_class" href="class_stream.html">Stream</a> &amp;stream)</div>
<div class="line">{</div>
<div class="line">   <a class="code hl_class" href="class_g_bitmap.html">GBitmap</a> *bmp = <span class="keyword">new</span> <a class="code hl_class" href="class_g_bitmap.html">GBitmap</a>;</div>
<div class="line">   <span class="keywordflow">if</span>(bmp-&gt;<a class="code hl_function" href="class_g_bitmap.html#a774d522d2929606364b95b535119f51a">readPNG</a>(stream))</div>
<div class="line">      <span class="keywordflow">return</span> bmp;</div>
<div class="line">   <span class="keywordflow">else</span></div>
<div class="line">   {</div>
<div class="line">      <span class="keyword">delete</span> bmp;</div>
<div class="line">      <span class="keywordflow">return</span> NULL;</div>
<div class="line">   }</div>
<div class="line">}</div>
<div class="ttc" id="aclass_g_bitmap_html"><div class="ttname"><a href="class_g_bitmap.html">GBitmap</a></div><div class="ttdef"><b>Definition</b> gBitmap.h:54</div></div>
<div class="ttc" id="aclass_g_bitmap_html_a774d522d2929606364b95b535119f51a"><div class="ttname"><a href="class_g_bitmap.html#a774d522d2929606364b95b535119f51a">GBitmap::readPNG</a></div><div class="ttdeci">bool readPNG(Stream &amp;io_rStream)</div><div class="ttdef"><b>Definition</b> bitmapPng.cc:125</div></div>
<div class="ttc" id="aclass_resource_instance_html"><div class="ttname"><a href="class_resource_instance.html">ResourceInstance</a></div><div class="ttdef"><b>Definition</b> resourceManager.h:103</div></div>
<div class="ttc" id="aclass_stream_html"><div class="ttname"><a href="class_stream.html">Stream</a></div><div class="ttdoc">Base stream class for streaming data across a specific media.</div><div class="ttdef"><b>Definition</b> stream.h:73</div></div>
</div><!-- fragment --><p>Then you need to register the extension of your resource type with the resource manager:</p>
<div class="fragment"><div class="line">ResourceManager-&gt;<a class="code hl_function" href="class_res_manager.html#a0036ffad373b2d87df5abf674cb4cda1">registerExtension</a>(<span class="stringliteral">&quot;.png&quot;</span>, constructBitmapPNG);</div>
<div class="ttc" id="aclass_res_manager_html_a0036ffad373b2d87df5abf674cb4cda1"><div class="ttname"><a href="class_res_manager.html#a0036ffad373b2d87df5abf674cb4cda1">ResManager::registerExtension</a></div><div class="ttdeci">void registerExtension(const char *extension, RESOURCE_CREATE_FN create_fn)</div><div class="ttdoc">Tells the resource manager what to do with a resource that it loads.</div><div class="ttdef"><b>Definition</b> resourceManager.cc:712</div></div>
</div><!-- fragment --><p>And, of course, you need to provide a subclass of <a class="el" href="class_resource_instance.html">ResourceInstance</a>:</p>
<div class="fragment"><div class="line"><span class="keyword">class </span><a class="code hl_class" href="class_g_bitmap.html">GBitmap</a> : <a class="code hl_class" href="class_resource_instance.html">ResourceInstance</a> {</div>
<div class="line">   ... whatever you need <span class="keywordflow">for</span> your resource goes in here ...</div>
<div class="line">}</div>
</div><!-- fragment --><p><a class="el" href="class_resource_instance.html">ResourceInstance</a> imposes very few requirements on you as the resource type implementor. All you "have" to provide is a destructor to deallocate whatever storage your resource might allocate. The ResourceManager will ensure that there is only one instance of the <a class="el" href="class_resource_instance.html">ResourceInstance</a> for each file, and that it is only destroyed when no more references to it remain.</p>
<dl class="section see"><dt>See also</dt><dd>TerrainFile, <a class="el" href="class_g_bitmap.html">GBitmap</a>, <a class="el" href="class_audio_buffer.html">AudioBuffer</a> for more examples. </dd></dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a60f6680bb78492eb8b97d3e36514a139" name="a60f6680bb78492eb8b97d3e36514a139"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a60f6680bb78492eb8b97d3e36514a139">&#9670;&#160;</a></span>ResourceInstance()</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="class_resource_instance.html">ResourceInstance</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

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

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual ~<a class="el" href="class_resource_instance.html">ResourceInstance</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="abdc28331c98eadf7e51f9ce3595ea557" name="abdc28331c98eadf7e51f9ce3595ea557"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdc28331c98eadf7e51f9ce3595ea557">&#9670;&#160;</a></span>mSourceResource</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_resource_object.html">ResourceObject</a>* mSourceResource</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Pointer to the <a class="el" href="class_resource_object.html">ResourceObject</a> that stores all our book-keeping data. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>io/resource/<b>resourceManager.h</b></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>