Rocket-Game-Engine.github.io/LoadRscene_8cpp.html at master · Rocket-Game-Engine/Rocket-Game-Engine.github.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
<!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>Rocket Game Engine: gen-files/include/RScene/LoadRscene.cpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript">var page_layout=1;</script>
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  $(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="side-nav" class="ui-resizable side-nav-resizable"><!-- do not remove this div, it is closed by doxygen! -->
<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">Rocket Game Engine
   </div>
  </td>
 </tr>
   <tr><td colspan="2">        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
          <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)"
               onblur="searchBox.OnSearchFieldFocus(false)"
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
          </span>
        </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>
</div><!-- top -->
  <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('LoadRscene_8cpp.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="#define-members">Macros</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">LoadRscene.cpp File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Implementation for <a class="el" href="LoadRscene_8hpp.html">LoadRscene.hpp</a>.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="LoadRscene_8hpp_source.html">LoadRscene.hpp</a>&quot;</code><br />
<code>#include &lt;fstream&gt;</code><br />
<code>#include &lt;sstream&gt;</code><br />
<code>#include &quot;stb_c_lexer.h&quot;</code><br />
<code>#include &quot;RocLogger/RocLogger.hpp&quot;</code><br />
<code>#include &quot;<a class="el" href="Keyboard_8hpp_source.html">Base/Keyboard.hpp</a>&quot;</code><br />
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a3a0e935d53bcbcb5a717d673e37bd9b9" id="r_a3a0e935d53bcbcb5a717d673e37bd9b9"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="LoadRscene_8cpp.html#a3a0e935d53bcbcb5a717d673e37bd9b9">GetNextString</a> (stb_lexer &amp;lex)</td></tr>
<tr class="separator:a3a0e935d53bcbcb5a717d673e37bd9b9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac191f322eb2f231537c3ad0835f98642" id="r_ac191f322eb2f231537c3ad0835f98642"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="LoadRscene_8cpp.html#ac191f322eb2f231537c3ad0835f98642">GetNextID</a> (stb_lexer &amp;lex)</td></tr>
<tr class="separator:ac191f322eb2f231537c3ad0835f98642"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1c5c70438301ce70eb028e5bba115125" id="r_a1c5c70438301ce70eb028e5bba115125"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="LoadRscene_8cpp.html#a1c5c70438301ce70eb028e5bba115125">LoadScene</a> (const std::string &amp;filepath)</td></tr>
<tr class="separator:a1c5c70438301ce70eb028e5bba115125"><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>Implementation for <a class="el" href="LoadRscene_8hpp.html">LoadRscene.hpp</a>. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="ac191f322eb2f231537c3ad0835f98642" name="ac191f322eb2f231537c3ad0835f98642"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac191f322eb2f231537c3ad0835f98642">&#9670;&#160;</a></span>GetNextID()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char * GetNextID </td>
          <td>(</td>
          <td class="paramtype">stb_lexer &amp;&#160;</td>
          <td class="paramname"><em>lex</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Helper function to get the next identifier from the lexer. Can throw asserts, as it checks that the next string MUST be an identifier, and not just some string.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">lex</td><td>A reference to the stb_c_lexer object to obtain the string from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A char* to the identifier read in by the lexer. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char * GetNextString </td>
          <td>(</td>
          <td class="paramtype">stb_lexer &amp;&#160;</td>
          <td class="paramname"><em>lex</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Helper function to get the next string value from the lexer. Can throw asserts, as it checks that the next string MUST be a string, and not some identifier.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">lex</td><td>A reference to the stb_c_lexer object to obtain the string from.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A char* to the string read in by the lexer. </dd></dl>

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

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void LoadScene </td>
          <td>(</td>
          <td class="paramtype">const std::string &amp;&#160;</td>
          <td class="paramname"><em>filepath</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Call this function to load a scene into the game engine. Ensure that the format of the scene file is correct, or there will be errors.</p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000011">Todo:</a></b></dt><dd>Add more thorough error checking for syntax</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">filepath</td><td>The relative path to the scene file to load </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</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="dir_2b5be651b6c0a66b392f466b8aa97e51.html">gen-files</a></li><li class="navelem"><a class="el" href="dir_7921784d17ff334b07681a73ba3a02df.html">include</a></li><li class="navelem"><a class="el" href="dir_a997f9ca84f63de9eec384f9787d8601.html">RScene</a></li><li class="navelem"><a class="el" href="LoadRscene_8cpp.html">LoadRscene.cpp</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.9.8 </li>
  </ul>
</div>
</body>
</html>