<!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::Scene 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&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&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&dn=expat.txt MIT */ $(document).ready(function(){initNavTree('classfpr_1_1_scene.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> | <a href="#pub-static-attribs">Static Public Attributes</a> | <a href="#pri-attribs">Private Attributes</a> | <a href="classfpr_1_1_scene-members.html">List of all members</a> </div> <div class="headertitle"><div class="title">fpr::Scene Class Reference</div></div> </div><!--header--> <div class="contents"> <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:a7b4fb701bdb34aaf200856c1ca648889"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#a7b4fb701bdb34aaf200856c1ca648889">Scene</a> (const char *file_name)</td></tr> <tr class="separator:a7b4fb701bdb34aaf200856c1ca648889"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a796c35c23b60bcbff1ad3bae1de42ca1"><td class="memItemLeft" align="right" valign="top">const std::vector< std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#a796c35c23b60bcbff1ad3bae1de42ca1">GetModels</a> () const FPR_NOEXCEPT</td></tr> <tr class="separator:a796c35c23b60bcbff1ad3bae1de42ca1"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad58a469e1294b01f50b3dae7e7c9bc39"><td class="memItemLeft" align="right" valign="top">const std::vector< <a class="el" href="classfpr_1_1_point_light.html">PointLight</a> > & </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#ad58a469e1294b01f50b3dae7e7c9bc39">GetLights</a> () const FPR_NOEXCEPT</td></tr> <tr class="separator:ad58a469e1294b01f50b3dae7e7c9bc39"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a73f641a6bdb899f5d721b251cfaaf277"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#a73f641a6bdb899f5d721b251cfaaf277">AddModel</a> (std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > &new_model)</td></tr> <tr class="separator:a73f641a6bdb899f5d721b251cfaaf277"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ad55641f76d0e6ecb655a642d7717708a"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#ad55641f76d0e6ecb655a642d7717708a">AddModels</a> (std::vector< std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > > &new_models)</td></tr> <tr class="separator:ad55641f76d0e6ecb655a642d7717708a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ace29f66f6c0fcd423045828e62f68320"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#ace29f66f6c0fcd423045828e62f68320">AddLight</a> (<a class="el" href="classfpr_1_1_point_light.html">PointLight</a> new_light)</td></tr> <tr class="separator:ace29f66f6c0fcd423045828e62f68320"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aed60a15180442b102fc24f05e7dbc7fa"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#aed60a15180442b102fc24f05e7dbc7fa">AddLights</a> (std::vector< <a class="el" href="classfpr_1_1_point_light.html">PointLight</a> > &new_lights)</td></tr> <tr class="separator:aed60a15180442b102fc24f05e7dbc7fa"><td class="memSeparator" colspan="2"> </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:a0d56c3cd728db57e649c52662b449014"><td class="memItemLeft" align="right" valign="top">static constexpr const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#a0d56c3cd728db57e649c52662b449014">SCENE_FILE_EXT</a> = ".scene"</td></tr> <tr class="separator:a0d56c3cd728db57e649c52662b449014"><td class="memSeparator" colspan="2"> </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:a8092be5262eb433a4904e446f49c454e"><td class="memItemLeft" align="right" valign="top">std::vector< std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#a8092be5262eb433a4904e446f49c454e">m_models</a></td></tr> <tr class="separator:a8092be5262eb433a4904e446f49c454e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a2fc7c569ae27b9c87784049d0fa06342"><td class="memItemLeft" align="right" valign="top">std::vector< <a class="el" href="classfpr_1_1_point_light.html">PointLight</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfpr_1_1_scene.html#a2fc7c569ae27b9c87784049d0fa06342">m_lights</a></td></tr> <tr class="separator:a2fc7c569ae27b9c87784049d0fa06342"><td class="memSeparator" colspan="2"> </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="_scene_8h_source.html#l00009">9</a> of file <a class="el" href="_scene_8h_source.html">Scene.h</a>.</p> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a7b4fb701bdb34aaf200856c1ca648889" name="a7b4fb701bdb34aaf200856c1ca648889"></a> <h2 class="memtitle"><span class="permalink"><a href="#a7b4fb701bdb34aaf200856c1ca648889">◆ </a></span>Scene()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">fpr::Scene::Scene </td> <td>(</td> <td class="paramtype">const char * </td> <td class="paramname"><em>file_name</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00007">7</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="ace29f66f6c0fcd423045828e62f68320" name="ace29f66f6c0fcd423045828e62f68320"></a> <h2 class="memtitle"><span class="permalink"><a href="#ace29f66f6c0fcd423045828e62f68320">◆ </a></span>AddLight()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fpr::Scene::AddLight </td> <td>(</td> <td class="paramtype"><a class="el" href="classfpr_1_1_point_light.html">PointLight</a> </td> <td class="paramname"><em>new_light</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00059">59</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <a id="aed60a15180442b102fc24f05e7dbc7fa" name="aed60a15180442b102fc24f05e7dbc7fa"></a> <h2 class="memtitle"><span class="permalink"><a href="#aed60a15180442b102fc24f05e7dbc7fa">◆ </a></span>AddLights()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fpr::Scene::AddLights </td> <td>(</td> <td class="paramtype">std::vector< <a class="el" href="classfpr_1_1_point_light.html">PointLight</a> > & </td> <td class="paramname"><em>new_lights</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00064">64</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <a id="a73f641a6bdb899f5d721b251cfaaf277" name="a73f641a6bdb899f5d721b251cfaaf277"></a> <h2 class="memtitle"><span class="permalink"><a href="#a73f641a6bdb899f5d721b251cfaaf277">◆ </a></span>AddModel()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fpr::Scene::AddModel </td> <td>(</td> <td class="paramtype">std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > & </td> <td class="paramname"><em>new_model</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00049">49</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <a id="ad55641f76d0e6ecb655a642d7717708a" name="ad55641f76d0e6ecb655a642d7717708a"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad55641f76d0e6ecb655a642d7717708a">◆ </a></span>AddModels()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void fpr::Scene::AddModels </td> <td>(</td> <td class="paramtype">std::vector< std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > > & </td> <td class="paramname"><em>new_models</em></td><td>)</td> <td></td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00054">54</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <a id="ad58a469e1294b01f50b3dae7e7c9bc39" name="ad58a469e1294b01f50b3dae7e7c9bc39"></a> <h2 class="memtitle"><span class="permalink"><a href="#ad58a469e1294b01f50b3dae7e7c9bc39">◆ </a></span>GetLights()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::vector< <a class="el" href="classfpr_1_1_point_light.html">PointLight</a> > & fpr::Scene::GetLights </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00075">75</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <a id="a796c35c23b60bcbff1ad3bae1de42ca1" name="a796c35c23b60bcbff1ad3bae1de42ca1"></a> <h2 class="memtitle"><span class="permalink"><a href="#a796c35c23b60bcbff1ad3bae1de42ca1">◆ </a></span>GetModels()</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const std::vector< std::shared_ptr< <a class="el" href="classfpr_1_1_model.html">Model</a> > > & fpr::Scene::GetModels </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8cpp_source.html#l00070">70</a> of file <a class="el" href="_scene_8cpp_source.html">Scene.cpp</a>.</p> </div> </div> <h2 class="groupheader">Member Data Documentation</h2> <a id="a2fc7c569ae27b9c87784049d0fa06342" name="a2fc7c569ae27b9c87784049d0fa06342"></a> <h2 class="memtitle"><span class="permalink"><a href="#a2fc7c569ae27b9c87784049d0fa06342">◆ </a></span>m_lights</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::vector<<a class="el" href="classfpr_1_1_point_light.html">PointLight</a>> fpr::Scene::m_lights</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="_scene_8h_source.html#l00012">12</a> of file <a class="el" href="_scene_8h_source.html">Scene.h</a>.</p> </div> </div> <a id="a8092be5262eb433a4904e446f49c454e" name="a8092be5262eb433a4904e446f49c454e"></a> <h2 class="memtitle"><span class="permalink"><a href="#a8092be5262eb433a4904e446f49c454e">◆ </a></span>m_models</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">std::vector<std::shared_ptr<<a class="el" href="classfpr_1_1_model.html">Model</a>> > fpr::Scene::m_models</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="_scene_8h_source.html#l00011">11</a> of file <a class="el" href="_scene_8h_source.html">Scene.h</a>.</p> </div> </div> <a id="a0d56c3cd728db57e649c52662b449014" name="a0d56c3cd728db57e649c52662b449014"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0d56c3cd728db57e649c52662b449014">◆ </a></span>SCENE_FILE_EXT</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">constexpr const char* fpr::Scene::SCENE_FILE_EXT = ".scene"</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">static</span><span class="mlabel">constexpr</span></span> </td> </tr> </table> </div><div class="memdoc"> <p class="definition">Definition at line <a class="el" href="_scene_8h_source.html#l00014">14</a> of file <a class="el" href="_scene_8h_source.html">Scene.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="_scene_8h_source.html">Scene.h</a></li> <li>D:/Users/mbuzelis/source/repos/ForwardPlusRenderer/include/<a class="el" href="_scene_8cpp_source.html">Scene.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_scene.html">Scene</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>