diff options
| author | FWoltermann@gmail.com <FWoltermann@gmail.com@076cb2c4-205e-83fd-5cf3-1be9aa105544> | 2012-05-31 14:46:27 +0000 |
|---|---|---|
| committer | FWoltermann@gmail.com <FWoltermann@gmail.com@076cb2c4-205e-83fd-5cf3-1be9aa105544> | 2012-05-31 14:46:27 +0000 |
| commit | 8898ad9b25fca6afe2374d293a981db02a83d7e9 (patch) | |
| tree | 8041e6eb069b6da70b83e82efdb998662140e716 /Doc/doxygen/html/_scene_8h_source.html | |
| parent | 985b945e4b49b5d5a1394e93fc3a95289c05e449 (diff) | |
| download | starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.zip starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.tar.gz starshatter-8898ad9b25fca6afe2374d293a981db02a83d7e9.tar.bz2 | |
Committing the documentation to svn to have it accessible online
Diffstat (limited to 'Doc/doxygen/html/_scene_8h_source.html')
| -rw-r--r-- | Doc/doxygen/html/_scene_8h_source.html | 193 |
1 files changed, 193 insertions, 0 deletions
diff --git a/Doc/doxygen/html/_scene_8h_source.html b/Doc/doxygen/html/_scene_8h_source.html new file mode 100644 index 0000000..1cc1840 --- /dev/null +++ b/Doc/doxygen/html/_scene_8h_source.html @@ -0,0 +1,193 @@ +<!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"/> +<title>Starshatter_Open: D:/SRC/StarshatterSVN/nGenEx/Scene.h Source File</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="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +<link href="doxygen.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 style="padding-left: 0.5em;"> + <div id="projectname">Starshatter_Open + </div> + <div id="projectbrief">Open source Starshatter engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.1 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="annotated.html"><span>Classes</span></a></li> + <li class="current"><a href="files.html"><span>Files</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="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.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> + <div id="navrow2" class="tabs2"> + <ul class="tablist"> + <li><a href="files.html"><span>File List</span></a></li> + <li><a href="globals.html"><span>File Members</span></a></li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('_scene_8h.html','');}); +</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)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="headertitle"> +<div class="title">Scene.h</div> </div> +</div><!--header--> +<div class="contents"> +<a href="_scene_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* Project nGenEx</span></div> +<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> Destroyer Studios LLC</span></div> +<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> Copyright © 1997-2004. All Rights Reserved.</span></div> +<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"></span></div> +<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> SUBSYSTEM: nGenEx.lib</span></div> +<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> FILE: Scene.h</span></div> +<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> AUTHOR: John DiCamillo</span></div> +<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"></span></div> +<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"></span></div> +<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> OVERVIEW</span></div> +<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> ========</span></div> +<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> A 3D Scene, basically a collection of 3D graphic objects</span></div> +<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">*/</span></div> +<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> </div> +<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="preprocessor">#ifndef Scene_h</span></div> +<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="preprocessor"></span><span class="preprocessor">#define Scene_h</span></div> +<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="preprocessor"></span></div> +<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="preprocessor">#include "<a class="code" href="_types_8h.html">Types.h</a>"</span></div> +<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#include "<a class="code" href="_color_8h.html">Color.h</a>"</span></div> +<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#include "<a class="code" href="_geometry_8h.html">Geometry.h</a>"</span></div> +<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="preprocessor">#include "<a class="code" href="_list_8h.html">List.h</a>"</span></div> +<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div> +<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> </div> +<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="keyword">class </span><a class="code" href="class_graphic.html">Graphic</a>;</div> +<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">class </span><a class="code" href="class_light.html">Light</a>;</div> +<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> </div> +<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> </div> +<div class="line"><a name="l00030"></a><span class="lineno"><a class="code" href="class_scene.html"> 30</a></span> <span class="keyword">class </span><a class="code" href="class_scene.html">Scene</a></div> +<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> {</div> +<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">public</span>:</div> +<div class="line"><a name="l00033"></a><span class="lineno"><a class="code" href="class_scene.html#a3ebf4f7e0fe96ceea20d51f6e0a13d7f"> 33</a></span>  <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* <a class="code" href="class_scene.html#a3ebf4f7e0fe96ceea20d51f6e0a13d7f">TYPENAME</a>() { <span class="keywordflow">return</span> <span class="stringliteral">"Scene"</span>; }</div> +<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div> +<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  <a class="code" href="class_scene.html#ad10176d75a9cc0da56626f682d083507">Scene</a>();</div> +<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="keyword">virtual</span> <a class="code" href="class_scene.html#a3b8cec2e32546713915f8c6303c951f1">~Scene</a>();</div> +<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div> +<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#ab1f0941af20130da21fc1bde4a8f8b58">AddBackground</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a695ea2570d85d14da05137d807af340e">DelBackground</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#ab3bdb63948e2399c2d0236414686b702">AddForeground</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a8aff5d5b00e0fd2cc6b88198a27ca757">DelForeground</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a2ef1e98afaf344348e0d58b1a26a3729">AddGraphic</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a34357a38e17276d4eba0dcc241a74438">DelGraphic</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#ab5aa4589de54dba7f78ae3b65622a897">AddSprite</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a3e6a2f0ddb268ab02f37326dc9156f6a">DelSprite</a>(<a class="code" href="class_graphic.html">Graphic</a>* g);</div> +<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div> +<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a725b75b685299003792ef673a7456f6f">AddLight</a>(<a class="code" href="class_light.html">Light</a>* l);</div> +<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#ad21e02f913321d3678641ad1571436c6">DelLight</a>(<a class="code" href="class_light.html">Light</a>* l);</div> +<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div> +<div class="line"><a name="l00050"></a><span class="lineno"><a class="code" href="class_scene.html#ae96871d6ec657938486ec9a07531c323"> 50</a></span>  <a class="code" href="class_list.html">List<Graphic></a>& <a class="code" href="class_scene.html#ae96871d6ec657938486ec9a07531c323">Background</a>() { <span class="keywordflow">return</span> <a class="code" href="class_scene.html#a16be1b0cc0e3604e9fab71928b45e930">background</a>; }</div> +<div class="line"><a name="l00051"></a><span class="lineno"><a class="code" href="class_scene.html#a4f42b24277a2d46dc1de96fbade49350"> 51</a></span>  <a class="code" href="class_list.html">List<Graphic></a>& <a class="code" href="class_scene.html#a4f42b24277a2d46dc1de96fbade49350">Foreground</a>() { <span class="keywordflow">return</span> <a class="code" href="class_scene.html#a927fab95e1a6408d73e37c4ae8b45491">foreground</a>; }</div> +<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="class_scene.html#a0f7d9a374ca3c72604979d35f055e98d"> 52</a></span>  <a class="code" href="class_list.html">List<Graphic></a>& <a class="code" href="class_scene.html#a0f7d9a374ca3c72604979d35f055e98d">Graphics</a>() { <span class="keywordflow">return</span> <a class="code" href="class_scene.html#af4aa26d85995ded580c550b2d89dfb5e">graphics</a>; }</div> +<div class="line"><a name="l00053"></a><span class="lineno"><a class="code" href="class_scene.html#a85b7cb242ddabfb90582f91050892dbc"> 53</a></span>  <a class="code" href="class_list.html">List<Graphic></a>& <a class="code" href="class_scene.html#a85b7cb242ddabfb90582f91050892dbc">Sprites</a>() { <span class="keywordflow">return</span> <a class="code" href="class_scene.html#a05ae86c7c42dc0a62b9148d4d0acf771">sprites</a>; }</div> +<div class="line"><a name="l00054"></a><span class="lineno"><a class="code" href="class_scene.html#a3ad8b17aed8bc3d675e0452e7a626152"> 54</a></span>  <a class="code" href="class_list.html">List<Light></a>& <a class="code" href="class_scene.html#a3ad8b17aed8bc3d675e0452e7a626152">Lights</a>() { <span class="keywordflow">return</span> <a class="code" href="class_scene.html#ac0f8f51fcfd9c53aab327417ea202e9c">lights</a>; }</div> +<div class="line"><a name="l00055"></a><span class="lineno"><a class="code" href="class_scene.html#ae07a7c30fa3db8add389570ffd76703a"> 55</a></span>  <a class="code" href="class_color.html">Color</a> <a class="code" href="class_scene.html#ae07a7c30fa3db8add389570ffd76703a">Ambient</a>() { <span class="keywordflow">return</span> <a class="code" href="class_scene.html#a63af5e81fff178281120f38ce7e5db4d">ambient</a>; }</div> +<div class="line"><a name="l00056"></a><span class="lineno"><a class="code" href="class_scene.html#a81cabf5c9c33bee53154ad383491123d"> 56</a></span>  <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a81cabf5c9c33bee53154ad383491123d">SetAmbient</a>(<a class="code" href="class_color.html">Color</a> a) { <a class="code" href="class_scene.html#a63af5e81fff178281120f38ce7e5db4d">ambient</a> = a; }</div> +<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> </div> +<div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="class_scene.html#a1d0657d65ec570815527feaff8550ea9">Collect</a>();</div> +<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div> +<div class="line"><a name="l00060"></a><span class="lineno"> 60</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="class_scene.html#ae0e73b0cb00d77f9bfd8e3b90ba736a8">IsLightObscured</a>(<span class="keyword">const</span> <a class="code" href="struct_point.html">Point</a>& obj_pos,</div> +<div class="line"><a name="l00061"></a><span class="lineno"> 61</span>  <span class="keyword">const</span> <a class="code" href="struct_point.html">Point</a>& light_pos,</div> +<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keywordtype">double</span> obj_radius,</div> +<div class="line"><a name="l00063"></a><span class="lineno"> 63</span>  <a class="code" href="struct_point.html">Point</a>* imp_point=0) <span class="keyword">const</span>;</div> +<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> </div> +<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="keyword">protected</span>:</div> +<div class="line"><a name="l00066"></a><span class="lineno"><a class="code" href="class_scene.html#a16be1b0cc0e3604e9fab71928b45e930"> 66</a></span>  <a class="code" href="class_list.html">List<Graphic></a> <a class="code" href="class_scene.html#a16be1b0cc0e3604e9fab71928b45e930">background</a>;</div> +<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="class_scene.html#a927fab95e1a6408d73e37c4ae8b45491"> 67</a></span>  <a class="code" href="class_list.html">List<Graphic></a> <a class="code" href="class_scene.html#a927fab95e1a6408d73e37c4ae8b45491">foreground</a>;</div> +<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="class_scene.html#af4aa26d85995ded580c550b2d89dfb5e"> 68</a></span>  <a class="code" href="class_list.html">List<Graphic></a> <a class="code" href="class_scene.html#af4aa26d85995ded580c550b2d89dfb5e">graphics</a>;</div> +<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="class_scene.html#a05ae86c7c42dc0a62b9148d4d0acf771"> 69</a></span>  <a class="code" href="class_list.html">List<Graphic></a> <a class="code" href="class_scene.html#a05ae86c7c42dc0a62b9148d4d0acf771">sprites</a>;</div> +<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="class_scene.html#ac0f8f51fcfd9c53aab327417ea202e9c"> 70</a></span>  <a class="code" href="class_list.html">List<Light></a> <a class="code" href="class_scene.html#ac0f8f51fcfd9c53aab327417ea202e9c">lights</a>;</div> +<div class="line"><a name="l00071"></a><span class="lineno"><a class="code" href="class_scene.html#a63af5e81fff178281120f38ce7e5db4d"> 71</a></span>  <a class="code" href="class_color.html">Color</a> <a class="code" href="class_scene.html#a63af5e81fff178281120f38ce7e5db4d">ambient</a>;</div> +<div class="line"><a name="l00072"></a><span class="lineno"> 72</span> };</div> +<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div> +<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment">// +--------------------------------------------------------------------+</span></div> +<div class="line"><a name="l00075"></a><span class="lineno"> 75</span> </div> +<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="preprocessor">#endif Scene_h</span></div> +</div><!-- fragment --></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_d6625d0f3efd9eb70ff961583505095b.html">nGenEx</a></li><li class="navelem"><a class="el" href="_scene_8h.html">Scene.h</a></li> + <li class="footer">Generated on Thu May 31 2012 16:30:58 for Starshatter_Open by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.1 </li> + </ul> +</div> +</body> +</html> |