Files
SpaghettiKart/classModelLoader.html
T

331 lines
16 KiB
HTML

<!-- HTML header for doxygen 1.10.0-->
<!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.13.2"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Mario Kart 64: ModelLoader 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>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<link href="docs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
</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">Mario Kart 64
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.13.2 -->
<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('classModelLoader.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="#nested-classes">Data Structures</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pri-methods">Private Member Functions</a> &#124;
<a href="#pri-attribs">Private Attributes</a> </div>
<div class="headertitle"><div class="title">ModelLoader Class Reference</div></div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="ModelLoader_8h_source.html">ModelLoader.h</a>&gt;</code></p>
<div class="dynheader">
Collaboration diagram for ModelLoader:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classModelLoader__coll__graph.svg" width="262" height="139"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structModelLoader_1_1CourseMap.html">CourseMap</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a18c419163ab2330838a5968a6749da38" id="r_a18c419163ab2330838a5968a6749da38"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a18c419163ab2330838a5968a6749da38">Add</a> (<a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a> list)</td></tr>
<tr class="separator:a18c419163ab2330838a5968a6749da38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab578b63a565352c0c270bc4ebbc07653" id="r_ab578b63a565352c0c270bc4ebbc07653"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab578b63a565352c0c270bc4ebbc07653">Load</a> ()</td></tr>
<tr class="separator:ab578b63a565352c0c270bc4ebbc07653"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-methods" name="pri-methods"></a>
Private Member Functions</h2></td></tr>
<tr class="memitem:a4be93e4e4c67207ac012298c9388c6d7" id="r_a4be93e4e4c67207ac012298c9388c6d7"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4be93e4e4c67207ac012298c9388c6d7">Extract</a> (std::shared_ptr&lt; <a class="el" href="classCourse.html">Course</a> &gt; course)</td></tr>
<tr class="separator:a4be93e4e4c67207ac012298c9388c6d7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab2f0c139d0f7218aac0ce4344a545df8" id="r_ab2f0c139d0f7218aac0ce4344a545df8"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ab2f0c139d0f7218aac0ce4344a545df8">UpdateVtx</a> (<a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a> list)</td></tr>
<tr class="separator:ab2f0c139d0f7218aac0ce4344a545df8"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pri-attribs" name="pri-attribs"></a>
Private Attributes</h2></td></tr>
<tr class="memitem:aeaa8872de5fca9aa3dfbb41e4282e98f" id="r_aeaa8872de5fca9aa3dfbb41e4282e98f"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aeaa8872de5fca9aa3dfbb41e4282e98f">_deferredList</a></td></tr>
<tr class="separator:aeaa8872de5fca9aa3dfbb41e4282e98f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f7ba45f61f5452b11f168a002b4c197" id="r_a1f7ba45f61f5452b11f168a002b4c197"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1f7ba45f61f5452b11f168a002b4c197">_hasRan</a> = false</td></tr>
<tr class="separator:a1f7ba45f61f5452b11f168a002b4c197"><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>Lists are deferred until load time so that models that use the same course may all use the same extraction</p>
<p><a class="el" href="structNote.html">Note</a> ensure that the buffers passed to <a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a> are big enough for the requested data.</p>
<p>This class should only be ran once.</p>
<p>Usage: </p><pre class="fragment">ModelLoader::LoadModelList bowserStatueList = {
.course = gBowsersCastle,
.gfxBuffer = &amp;gBowserStatueGfx[0],
.gfxBufferSize = 162,
.gfxStart = (0x2BB8 / 8), // This is 0x2BB8 / sizeof(N64Gfx) not sizeof(Gfx)
.vtxBuffer = &amp;gBowserStatueVtx[0],
.vtxBufferSize = 717,
.vtxStart = 1942,
</pre><p> };</p>
<p>gModelLoader.Add(bowserStatueList); </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a18c419163ab2330838a5968a6749da38" name="a18c419163ab2330838a5968a6749da38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18c419163ab2330838a5968a6749da38">&#9670;&#160;</a></span>Add()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ModelLoader::Add </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a></td> <td class="paramname"><span class="paramname"><em>list</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a4be93e4e4c67207ac012298c9388c6d7" name="a4be93e4e4c67207ac012298c9388c6d7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4be93e4e4c67207ac012298c9388c6d7">&#9670;&#160;</a></span>Extract()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ModelLoader::Extract </td>
<td>(</td>
<td class="paramtype">std::shared_ptr&lt; <a class="el" href="classCourse.html">Course</a> &gt;</td> <td class="paramname"><span class="paramname"><em>course</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classModelLoader_a4be93e4e4c67207ac012298c9388c6d7_cgraph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classModelLoader_a4be93e4e4c67207ac012298c9388c6d7_icgraph.svg" width="364" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<a id="ab578b63a565352c0c270bc4ebbc07653" name="ab578b63a565352c0c270bc4ebbc07653"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab578b63a565352c0c270bc4ebbc07653">&#9670;&#160;</a></span>Load()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ModelLoader::Load </td>
<td>(</td>
<td class="paramname"><span class="paramname"><em></em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the call graph for this function:</div>
<div class="dyncontent">
<div class="center"><div class="zoom"><iframe scrolling="no" frameborder="0" src="classModelLoader_ab578b63a565352c0c270bc4ebbc07653_cgraph.svg" width="100%" height="600"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div></div>
</div>
</div>
</div>
<a id="ab2f0c139d0f7218aac0ce4344a545df8" name="ab2f0c139d0f7218aac0ce4344a545df8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab2f0c139d0f7218aac0ce4344a545df8">&#9670;&#160;</a></span>UpdateVtx()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void ModelLoader::UpdateVtx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a></td> <td class="paramname"><span class="paramname"><em>list</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<div class="dynheader">
Here is the caller graph for this function:</div>
<div class="dyncontent">
<div class="center"><iframe scrolling="no" frameborder="0" src="classModelLoader_ab2f0c139d0f7218aac0ce4344a545df8_icgraph.svg" width="595" height="36"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe></div>
</div>
</div>
</div>
<h2 class="groupheader">Field Documentation</h2>
<a id="aeaa8872de5fca9aa3dfbb41e4282e98f" name="aeaa8872de5fca9aa3dfbb41e4282e98f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeaa8872de5fca9aa3dfbb41e4282e98f">&#9670;&#160;</a></span>_deferredList</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">std::vector&lt;<a class="el" href="structModelLoader_1_1LoadModelList.html">LoadModelList</a>&gt; ModelLoader::_deferredList</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a1f7ba45f61f5452b11f168a002b4c197" name="a1f7ba45f61f5452b11f168a002b4c197"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1f7ba45f61f5452b11f168a002b4c197">&#9670;&#160;</a></span>_hasRan</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool ModelLoader::_hasRan = false</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel private">private</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>src/engine/<a class="el" href="ModelLoader_8h_source.html">ModelLoader.h</a></li>
<li>src/engine/<a class="el" href="ModelLoader_8cpp.html">ModelLoader.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="classModelLoader.html">ModelLoader</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.13.2 </li>
</ul>
</div>
</body>
</html>