Skip to content

Commit 07afdc2

Browse files
committed
docs: generated doxygen
1 parent bcf2bfc commit 07afdc2

File tree

285 files changed

+23395
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

285 files changed

+23395
-2
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,15 @@ $ cmake -DCMAKE_BUILD_TYPE=Release .. && make -j # Build
5757
$ ./app.gui # Run the GUI
5858
```
5959

60+
# Generate the docs
61+
62+
First, install `doxygen`.
63+
64+
```sh
65+
$ doxygen doxygen
66+
$ firefox docs/html/index.html # Open it
67+
```
68+
6069
# Developer's notes
6170

6271
## Finding a method

docs/html/annotated.html

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.20"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Realtime closest point on mesh: Class List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectalign" style="padding-left: 0.5em;">
28+
<div id="projectname">Realtime closest point on mesh
29+
</div>
30+
</td>
31+
</tr>
32+
</tbody>
33+
</table>
34+
</div>
35+
<!-- end header part -->
36+
<!-- Generated by Doxygen 1.8.20 -->
37+
<script type="text/javascript">
38+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
39+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
40+
/* @license-end */
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
46+
$(function() {
47+
initMenu('',true,false,'search.php','Search');
48+
$(document).ready(function() { init_search(); });
49+
});
50+
/* @license-end */</script>
51+
<div id="main-nav"></div>
52+
</div><!-- top -->
53+
<div id="side-nav" class="ui-resizable side-nav-resizable">
54+
<div id="nav-tree">
55+
<div id="nav-tree-contents">
56+
<div id="nav-sync" class="sync"></div>
57+
</div>
58+
</div>
59+
<div id="splitbar" style="-moz-user-select:none;"
60+
class="ui-resizable-handle">
61+
</div>
62+
</div>
63+
<script type="text/javascript">
64+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
65+
$(document).ready(function(){initNavTree('annotated.html',''); initResizable(); });
66+
/* @license-end */
67+
</script>
68+
<div id="doc-content">
69+
<!-- window showing the filter options -->
70+
<div id="MSearchSelectWindow"
71+
onmouseover="return searchBox.OnSearchSelectShow()"
72+
onmouseout="return searchBox.OnSearchSelectHide()"
73+
onkeydown="return searchBox.OnSearchSelectKey(event)">
74+
</div>
75+
76+
<!-- iframe showing the search results (closed by default) -->
77+
<div id="MSearchResultsWindow">
78+
<iframe src="javascript:void(0)" frameborder="0"
79+
name="MSearchResults" id="MSearchResults">
80+
</iframe>
81+
</div>
82+
83+
<div class="header">
84+
<div class="headertitle">
85+
<div class="title">Class List</div> </div>
86+
</div><!--header-->
87+
<div class="contents">
88+
<div class="textblock">Here are the classes, structs, unions and interfaces with brief descriptions:</div><div class="directory">
89+
<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span>]</div><table class="directory">
90+
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacecore.html" target="_self">core</a></td><td class="desc"></td></tr>
91+
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcore_1_1ClosestPointQuery.html" target="_self">ClosestPointQuery</a></td><td class="desc">Fast closest point to mesh algortihm implementation </td></tr>
92+
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_0_1_" class="arrow" onclick="toggleFolder('0_1_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcore_1_1Mesh.html" target="_self">Mesh</a></td><td class="desc"><a class="el" href="classcore_1_1Mesh.html" title="Mesh object.">Mesh</a> object </td></tr>
93+
<tr id="row_0_1_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structcore_1_1Mesh_1_1Vertex.html" target="_self">Vertex</a></td><td class="desc"></td></tr>
94+
<tr id="row_0_2_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcore_1_1MeshPointCloud.html" target="_self">MeshPointCloud</a></td><td class="desc">Create a point cloud using a mesh. FIXME: To get a better representation of the mesh surface, we should generate points on the mesh. At the moment, we only use the mesh vertices </td></tr>
95+
<tr id="row_0_3_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcore_1_1RasterizedMesh.html" target="_self">RasterizedMesh</a></td><td class="desc"><a class="el" href="classcore_1_1Mesh.html" title="Mesh object.">Mesh</a> wrapper that do everything necessary to render the mesh with OpenGL </td></tr>
96+
<tr id="row_0_4_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classcore_1_1Scene.html" target="_self">Scene</a></td><td class="desc">Store multiple meshes and everything required to render them </td></tr>
97+
<tr id="row_1_"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_1_" class="arrow" onclick="toggleFolder('1_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespacegui.html" target="_self">gui</a></td><td class="desc"></td></tr>
98+
<tr id="row_1_0_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgui_1_1MainWindow.html" target="_self">MainWindow</a></td><td class="desc">Standalone application </td></tr>
99+
<tr id="row_1_1_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgui_1_1OrbitCamera.html" target="_self">OrbitCamera</a></td><td class="desc">Camera designed to rotate around a 3D model </td></tr>
100+
<tr id="row_1_2_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span id="arr_1_2_" class="arrow" onclick="toggleFolder('1_2_')">&#9660;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgui_1_1RasterizedPoints.html" target="_self">RasterizedPoints</a></td><td class="desc">OpenGL drawing implementation for a list of point. Give it a list of point+color and it will do the necessary to draw it </td></tr>
101+
<tr id="row_1_2_0_"><td class="entry"><span style="width:48px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structgui_1_1RasterizedPoints_1_1Point.html" target="_self">Point</a></td><td class="desc"></td></tr>
102+
<tr id="row_1_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="classgui_1_1Shader.html" target="_self">Shader</a></td><td class="desc">Simplify shader compilation and usage in an OpenGL pipeline </td></tr>
103+
</table>
104+
</div><!-- directory -->
105+
</div><!-- contents -->
106+
</div><!-- doc-content -->
107+
<!-- start footer part -->
108+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
109+
<ul>
110+
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
111+
</ul>
112+
</div>
113+
</body>
114+
</html>

docs/html/annotated_dup.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
var annotated_dup =
2+
[
3+
[ "core", "namespacecore.html", "namespacecore" ],
4+
[ "gui", "namespacegui.html", "namespacegui" ]
5+
];

docs/html/bc_s.png

676 Bytes
Loading

docs/html/bdwn.png

147 Bytes
Loading
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.20"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Realtime closest point on mesh: Member List</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
17+
<script type="text/javascript" src="search/searchdata.js"></script>
18+
<script type="text/javascript" src="search/search.js"></script>
19+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
20+
</head>
21+
<body>
22+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
23+
<div id="titlearea">
24+
<table cellspacing="0" cellpadding="0">
25+
<tbody>
26+
<tr style="height: 56px;">
27+
<td id="projectalign" style="padding-left: 0.5em;">
28+
<div id="projectname">Realtime closest point on mesh
29+
</div>
30+
</td>
31+
</tr>
32+
</tbody>
33+
</table>
34+
</div>
35+
<!-- end header part -->
36+
<!-- Generated by Doxygen 1.8.20 -->
37+
<script type="text/javascript">
38+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
39+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
40+
/* @license-end */
41+
</script>
42+
<script type="text/javascript" src="menudata.js"></script>
43+
<script type="text/javascript" src="menu.js"></script>
44+
<script type="text/javascript">
45+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
46+
$(function() {
47+
initMenu('',true,false,'search.php','Search');
48+
$(document).ready(function() { init_search(); });
49+
});
50+
/* @license-end */</script>
51+
<div id="main-nav"></div>
52+
</div><!-- top -->
53+
<div id="side-nav" class="ui-resizable side-nav-resizable">
54+
<div id="nav-tree">
55+
<div id="nav-tree-contents">
56+
<div id="nav-sync" class="sync"></div>
57+
</div>
58+
</div>
59+
<div id="splitbar" style="-moz-user-select:none;"
60+
class="ui-resizable-handle">
61+
</div>
62+
</div>
63+
<script type="text/javascript">
64+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
65+
$(document).ready(function(){initNavTree('classcore_1_1ClosestPointQuery.html',''); initResizable(); });
66+
/* @license-end */
67+
</script>
68+
<div id="doc-content">
69+
<!-- window showing the filter options -->
70+
<div id="MSearchSelectWindow"
71+
onmouseover="return searchBox.OnSearchSelectShow()"
72+
onmouseout="return searchBox.OnSearchSelectHide()"
73+
onkeydown="return searchBox.OnSearchSelectKey(event)">
74+
</div>
75+
76+
<!-- iframe showing the search results (closed by default) -->
77+
<div id="MSearchResultsWindow">
78+
<iframe src="javascript:void(0)" frameborder="0"
79+
name="MSearchResults" id="MSearchResults">
80+
</iframe>
81+
</div>
82+
83+
<div class="header">
84+
<div class="headertitle">
85+
<div class="title">core::ClosestPointQuery Member List</div> </div>
86+
</div><!--header-->
87+
<div class="contents">
88+
89+
<p>This is the complete list of members for <a class="el" href="classcore_1_1ClosestPointQuery.html">core::ClosestPointQuery</a>, including all inherited members.</p>
90+
<table class="directory">
91+
<tr class="even"><td class="entry"><a class="el" href="classcore_1_1ClosestPointQuery.html#a3ddfccabf0f382090bfdbaab16350d63">ClosestPointQuery</a>(const MeshPointCloud &amp;mesh_point_cloud)</td><td class="entry"><a class="el" href="classcore_1_1ClosestPointQuery.html">core::ClosestPointQuery</a></td><td class="entry"></td></tr>
92+
<tr><td class="entry"><a class="el" href="classcore_1_1ClosestPointQuery.html#a1d8eda0ae1c2cd40c3ec0a48fe42a480">get_closest_point</a>(const glm::vec3 &amp;query_point, float max_distance, glm::vec3 &amp;result) const</td><td class="entry"><a class="el" href="classcore_1_1ClosestPointQuery.html">core::ClosestPointQuery</a></td><td class="entry"></td></tr>
93+
</table></div><!-- contents -->
94+
</div><!-- doc-content -->
95+
<!-- start footer part -->
96+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
97+
<ul>
98+
<li class="footer">Generated by <a href="http://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.8.20 </li>
99+
</ul>
100+
</div>
101+
</body>
102+
</html>

0 commit comments

Comments
 (0)