Newer
Older
ForwardPlusRenderer / Docs / html / classfpr_1_1_model.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"/>
		<meta http-equiv="X-UA-Compatible" content="IE=9"/>
		<meta name="generator" content="Doxygen 1.9.5"/>
		<meta name="viewport" content="width=device-width, initial-scale=1"/>
		<title>Final Year Project: fpr::Model 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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.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="custom_dark_theme.css" rel="stylesheet" type="text/css"/>
<link href="custom.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="projectalign" style="padding-left: 0.5em;">
							<div id="projectname">Final Year Project
							</div>
						</td>
					</tr>
				</tbody>
			</table>
		</div>
		<!-- end header part --><!-- Generated by Doxygen 1.9.5 -->
<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>
</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 */
$(document).ready(function(){initNavTree('classfpr_1_1_model.html',''); initResizable(); });
/* @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="#pri-attribs">Private Attributes</a> &#124;
<a href="classfpr_1_1_model-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">fpr::Model Class Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="dynheader">
Collaboration diagram for fpr::Model:</div>
<div class="dyncontent">
<div class="center"><img src="classfpr_1_1_model__coll__graph.png" border="0" usemap="#afpr_1_1_model_coll__map" alt="Collaboration graph"/></div>
<map name="afpr_1_1_model_coll__map" id="afpr_1_1_model_coll__map">
<area shape="rect" title=" " alt="" coords="99,108,177,133"/>
<area shape="rect" href="structfpr_1_1_model_primitives.html" title=" " alt="" coords="5,5,140,31"/>
<area shape="rect" href="classfpr_1_1_buffer.html" title="Holds some essential information for data transfer between the CPU and GPU. Data transfer between GPU..." alt="" coords="165,5,242,31"/>
</map>
<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="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:acb8a494c34aa1df5613bffeab5c92fe9"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#acb8a494c34aa1df5613bffeab5c92fe9">Model</a> (const char *file_name, glm::mat4 model_matrix=glm::mat4(1.0f))</td></tr>
<tr class="separator:acb8a494c34aa1df5613bffeab5c92fe9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67101ffb37fd97e22f0f1d269afef638"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="classfpr_1_1_mesh.html">Mesh</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#a67101ffb37fd97e22f0f1d269afef638">GetMeshes</a> () FPR_NOEXCEPT</td></tr>
<tr class="separator:a67101ffb37fd97e22f0f1d269afef638"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02cad3acba0c62398809af9c6b1a575a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfpr_1_1_buffer.html">fpr::Buffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#a02cad3acba0c62398809af9c6b1a575a">GetVertexBuffer</a> ()</td></tr>
<tr class="separator:a02cad3acba0c62398809af9c6b1a575a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:addcb1159d7210670741b6cc55ac2886a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfpr_1_1_buffer.html">fpr::Buffer</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#addcb1159d7210670741b6cc55ac2886a">GetIndexBuffer</a> ()</td></tr>
<tr class="separator:addcb1159d7210670741b6cc55ac2886a"><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:a6331c97b554416c5dbea37ddcd8ea37c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfpr_1_1_model_primitives.html">ModelPrimitives</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#a6331c97b554416c5dbea37ddcd8ea37c">m_primitives</a></td></tr>
<tr class="separator:a6331c97b554416c5dbea37ddcd8ea37c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6539f1cb3edca1d11172bd33f7f5fd9f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfpr_1_1_buffer.html">fpr::Buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#a6539f1cb3edca1d11172bd33f7f5fd9f">m_index_buffer</a></td></tr>
<tr class="separator:a6539f1cb3edca1d11172bd33f7f5fd9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a21c2bfbbb6842b1daae8e27f3092cd63"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfpr_1_1_buffer.html">fpr::Buffer</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#a21c2bfbbb6842b1daae8e27f3092cd63">m_vertex_buffer</a></td></tr>
<tr class="separator:a21c2bfbbb6842b1daae8e27f3092cd63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c67233f4957501e97729768b15032c5"><td class="memItemLeft" align="right" valign="top">glm::mat4&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_model.html#a9c67233f4957501e97729768b15032c5">m_model_matrix</a></td></tr>
<tr class="separator:a9c67233f4957501e97729768b15032c5"><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 class="definition">Definition at line <a class="el" href="_model_8h_source.html#l00014">14</a> of file <a class="el" href="_model_8h_source.html">Model.h</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="acb8a494c34aa1df5613bffeab5c92fe9" name="acb8a494c34aa1df5613bffeab5c92fe9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb8a494c34aa1df5613bffeab5c92fe9">&#9670;&#160;</a></span>Model()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">fpr::Model::Model </td>
          <td>(</td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>file_name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">glm::mat4&#160;</td>
          <td class="paramname"><em>model_matrix</em> = <code>glm::mat4(1.0f)</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8cpp_source.html#l00012">12</a> of file <a class="el" href="_model_8cpp_source.html">Model.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="addcb1159d7210670741b6cc55ac2886a" name="addcb1159d7210670741b6cc55ac2886a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#addcb1159d7210670741b6cc55ac2886a">&#9670;&#160;</a></span>GetIndexBuffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfpr_1_1_buffer.html">fpr::Buffer</a> &amp; fpr::Model::GetIndexBuffer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8cpp_source.html#l00044">44</a> of file <a class="el" href="_model_8cpp_source.html">Model.cpp</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const std::vector&lt; <a class="el" href="classfpr_1_1_mesh.html">Mesh</a> &gt; &amp; fpr::Model::GetMeshes </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8cpp_source.html#l00034">34</a> of file <a class="el" href="_model_8cpp_source.html">Model.cpp</a>.</p>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classfpr_1_1_buffer.html">fpr::Buffer</a> &amp; fpr::Model::GetVertexBuffer </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8cpp_source.html#l00039">39</a> of file <a class="el" href="_model_8cpp_source.html">Model.cpp</a>.</p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6539f1cb3edca1d11172bd33f7f5fd9f" name="a6539f1cb3edca1d11172bd33f7f5fd9f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6539f1cb3edca1d11172bd33f7f5fd9f">&#9670;&#160;</a></span>m_index_buffer</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="classfpr_1_1_buffer.html">fpr::Buffer</a> fpr::Model::m_index_buffer</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8h_source.html#l00017">17</a> of file <a class="el" href="_model_8h_source.html">Model.h</a>.</p>

</div>
</div>
<a id="a9c67233f4957501e97729768b15032c5" name="a9c67233f4957501e97729768b15032c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9c67233f4957501e97729768b15032c5">&#9670;&#160;</a></span>m_model_matrix</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">glm::mat4 fpr::Model::m_model_matrix</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8h_source.html#l00019">19</a> of file <a class="el" href="_model_8h_source.html">Model.h</a>.</p>

</div>
</div>
<a id="a6331c97b554416c5dbea37ddcd8ea37c" name="a6331c97b554416c5dbea37ddcd8ea37c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6331c97b554416c5dbea37ddcd8ea37c">&#9670;&#160;</a></span>m_primitives</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="structfpr_1_1_model_primitives.html">ModelPrimitives</a> fpr::Model::m_primitives</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8h_source.html#l00016">16</a> of file <a class="el" href="_model_8h_source.html">Model.h</a>.</p>

</div>
</div>
<a id="a21c2bfbbb6842b1daae8e27f3092cd63" name="a21c2bfbbb6842b1daae8e27f3092cd63"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a21c2bfbbb6842b1daae8e27f3092cd63">&#9670;&#160;</a></span>m_vertex_buffer</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="classfpr_1_1_buffer.html">fpr::Buffer</a> fpr::Model::m_vertex_buffer</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">private</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="_model_8h_source.html#l00018">18</a> of file <a class="el" href="_model_8h_source.html">Model.h</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/include/<a class="el" href="_model_8h_source.html">Model.h</a></li>
<li>D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/src/<a class="el" href="_model_8cpp_source.html">Model.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"><b>fpr</b></li><li class="navelem"><a class="el" href="classfpr_1_1_model.html">Model</a></li>
				<li class="footer">
					Generated on Mon Oct 3 2022 13:44:05 for Final Year Project by <a href="http://www.doxygen.org/index.html">
					<img class="footer" src="doxygen.png" alt="doxygen"
                     onerror="this.onerror=null;this.src='doxygen.svg';"/></a> 1.9.5.
					Dark theme by <a href="http://majerle.eu" target="_new">Tilen Majerle</a>. All rights reserved.
				</li>
			</ul>
		</div>
		<script src="custom.js"></script>
	</body>
</html>