Skip to content

Commit

Permalink
Issue #7 - clarifying online documentation for files
Browse files Browse the repository at this point in the history
  • Loading branch information
jpaoneMines committed Sep 11, 2023
1 parent 60e9ab7 commit 90659b6
Show file tree
Hide file tree
Showing 32 changed files with 2,935 additions and 2,407 deletions.
12 changes: 12 additions & 0 deletions MD5Camera.hpp
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
/**
* @file MD5Camera.hpp
* @brief Concrete MD5 Camera implementation with Perspective Projection
* @author Dr. Jeffrey Paone
*
* @copyright MIT License Copyright (c) 2023 Dr. Jeffrey Paone
*
* These functions, classes, and constants help minimize common
* code that needs to be written.
*/

#ifndef CSCI441_MD5_CAMERA_HPP
#define CSCI441_MD5_CAMERA_HPP

Expand All @@ -10,6 +21,7 @@
namespace CSCI441 {

/**
* @class MD5Camera
* @brief A camera that implements the MD5Camera specification
* @note camera direction is controlled by file contents
*/
Expand Down
12 changes: 12 additions & 0 deletions MD5Model.hpp
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
/**
* @file MD5Model.hpp
* @brief Doom3 MD5 Model + Animation implementations
* @author Dr. Jeffrey Paone
*
* @copyright MIT License Copyright (c) 2023 Dr. Jeffrey Paone
*
* These functions, classes, and constants help minimize common
* code that needs to be written.
*/

#ifndef CSCI441_MD5_MODEL_HPP
#define CSCI441_MD5_MODEL_HPP

Expand Down Expand Up @@ -51,6 +62,7 @@
namespace CSCI441 {

/**
* @class MD5Model
* @brief stores a Doom3 MD5 Mesh + Animation
*/
class [[maybe_unused]] MD5Model {
Expand Down
4 changes: 2 additions & 2 deletions ModelLoader.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @file modelLoader.hpp
* @brief Helper functions to draw 3D OpenGL 3.0+ objects
/** @file ModelLoader.hpp
* @brief Loads OBJ+MTL, OFF, PLY, STL object files into a VAO
* @author Dr. Jeffrey Paone
*
* @copyright MIT License Copyright (c) 2017 Dr. Jeffrey Paone
Expand Down
13 changes: 10 additions & 3 deletions OpenGL3DEngine.hpp
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
//
// Created by Jeffrey Paone on 5/20/21.
//
/**
* @file OpenGL3DEngine.hpp
* @brief Abstract class engine class to setup a 3D world with an arcball camera, storage for left button state and cursor position
* @author Dr. Jeffrey Paone
*
* @copyright MIT License Copyright (c) 2021 Dr. Jeffrey Paone
*
* These functions, classes, and constants help minimize common
* code that needs to be written.
*/

#ifndef CSCI441_OPENGL3D_ENGINE_HPP
#define CSCI441_OPENGL3D_ENGINE_HPP
Expand Down
2 changes: 1 addition & 1 deletion ShaderProgram.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @file ShaderProgram.hpp
* @brief Class to work with OpenGL 3.0+ Shaders
* @brief Class to work with OpenGL 4.0+ Shaders
* @author Dr. Jeffrey Paone
*
* @copyright MIT License Copyright (c) 2017 Dr. Jeffrey Paone
Expand Down
2 changes: 1 addition & 1 deletion ShaderProgramPipeline.hpp
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/** @file ShaderProgramPipeline.hpp
* @brief Class to work with OpenGL 4.0+ Shaders
* @brief Class to work with Shader Program Pipelines
* @author Dr. Jeffrey Paone
*
* @copyright MIT License Copyright (c) 2017 Dr. Jeffrey Paone
Expand Down
2 changes: 1 addition & 1 deletion docs/_c_s_c_i441_8hpp.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
<code>#include &quot;<a class="el" href="_free_cam_8hpp_source.html">FreeCam.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="materials_8hpp_source.html">materials.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_model_loader_8hpp_source.html">ModelLoader.hpp</a>&quot;</code><br />
<code>#include &quot;OpenGL3DEngine.hpp&quot;</code><br />
<code>#include &quot;<a class="el" href="_open_g_l3_d_engine_8hpp_source.html">OpenGL3DEngine.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_open_g_l_utils_8hpp_source.html">OpenGLUtils.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="objects_8hpp_source.html">objects.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="_shader_program_8hpp_source.html">ShaderProgram.hpp</a>&quot;</code><br />
Expand Down
9 changes: 5 additions & 4 deletions docs/_c_s_c_i441_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span><span class="preprocessor">#include &quot;<a class="code" href="_free_cam_8hpp.html">FreeCam.hpp</a>&quot;</span> <span class="comment">// free cam implementation</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span><span class="preprocessor">#include &quot;<a class="code" href="materials_8hpp.html">materials.hpp</a>&quot;</span> <span class="comment">// predefined material properties</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span><span class="preprocessor">#include &quot;<a class="code" href="_model_loader_8hpp.html">ModelLoader.hpp</a>&quot;</span> <span class="comment">// to load OBJ, OFF, PLY, STL files</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#include &quot;OpenGL3DEngine.hpp&quot;</span> <span class="comment">// to create a concrete 3D Rendering engine</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span><span class="preprocessor">#include &quot;<a class="code" href="_open_g_l3_d_engine_8hpp.html">OpenGL3DEngine.hpp</a>&quot;</span> <span class="comment">// to create a concrete 3D Rendering engine</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span><span class="preprocessor">#include &quot;<a class="code" href="_open_g_l_utils_8hpp.html">OpenGLUtils.hpp</a>&quot;</span> <span class="comment">// to query OpenGL features</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span><span class="preprocessor">#include &quot;<a class="code" href="objects_8hpp.html">objects.hpp</a>&quot;</span> <span class="comment">// include 3D objects (cube, cylinder, cone, torus, sphere, disk, teapot)</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="preprocessor">#include &quot;<a class="code" href="_shader_program_8hpp.html">ShaderProgram.hpp</a>&quot;</span> <span class="comment">// helper class to compile and use shaders</span></div>
Expand All @@ -100,10 +100,11 @@
<div class="ttc" id="a_fixed_cam_8hpp_html"><div class="ttname"><a href="_fixed_cam_8hpp.html">FixedCam.hpp</a></div><div class="ttdoc">Concrete Fixed Camera implementation with Perspective Projection that can be positioned,...</div></div>
<div class="ttc" id="a_framebuffer_utils_8hpp_html"><div class="ttname"><a href="_framebuffer_utils_8hpp.html">FramebufferUtils.hpp</a></div><div class="ttdoc">Helper functions to work with OpenGL Framebuffer.</div></div>
<div class="ttc" id="a_free_cam_8hpp_html"><div class="ttname"><a href="_free_cam_8hpp.html">FreeCam.hpp</a></div><div class="ttdoc">Concrete Free Cam Implementation with Perspective Projection.</div></div>
<div class="ttc" id="a_model_loader_8hpp_html"><div class="ttname"><a href="_model_loader_8hpp.html">ModelLoader.hpp</a></div><div class="ttdoc">Helper functions to draw 3D OpenGL 3.0+ objects.</div></div>
<div class="ttc" id="a_model_loader_8hpp_html"><div class="ttname"><a href="_model_loader_8hpp.html">ModelLoader.hpp</a></div><div class="ttdoc">Loads OBJ+MTL, OFF, PLY, STL object files into a VAO.</div></div>
<div class="ttc" id="a_open_g_l3_d_engine_8hpp_html"><div class="ttname"><a href="_open_g_l3_d_engine_8hpp.html">OpenGL3DEngine.hpp</a></div><div class="ttdoc">Abstract class engine class to setup a 3D world with an arcball camera, storage for left button state...</div></div>
<div class="ttc" id="a_open_g_l_utils_8hpp_html"><div class="ttname"><a href="_open_g_l_utils_8hpp.html">OpenGLUtils.hpp</a></div><div class="ttdoc">Helper functions to work with OpenGL 3.0+.</div></div>
<div class="ttc" id="a_shader_program_8hpp_html"><div class="ttname"><a href="_shader_program_8hpp.html">ShaderProgram.hpp</a></div><div class="ttdoc">Class to work with OpenGL 3.0+ Shaders.</div></div>
<div class="ttc" id="a_shader_program_pipeline_8hpp_html"><div class="ttname"><a href="_shader_program_pipeline_8hpp.html">ShaderProgramPipeline.hpp</a></div><div class="ttdoc">Class to work with OpenGL 4.0+ Shaders.</div></div>
<div class="ttc" id="a_shader_program_8hpp_html"><div class="ttname"><a href="_shader_program_8hpp.html">ShaderProgram.hpp</a></div><div class="ttdoc">Class to work with OpenGL 4.0+ Shaders.</div></div>
<div class="ttc" id="a_shader_program_pipeline_8hpp_html"><div class="ttname"><a href="_shader_program_pipeline_8hpp.html">ShaderProgramPipeline.hpp</a></div><div class="ttdoc">Class to work with Shader Program Pipelines.</div></div>
<div class="ttc" id="a_texture_utils_8hpp_html"><div class="ttname"><a href="_texture_utils_8hpp.html">TextureUtils.hpp</a></div><div class="ttdoc">Helper functions to work with OpenGL Textures.</div></div>
<div class="ttc" id="a_uniform_buffer_object_8hpp_html"><div class="ttname"><a href="_uniform_buffer_object_8hpp.html">UniformBufferObject.hpp</a></div><div class="ttdoc">Helper functions to work with Uniform Buffer Objects.</div></div>
<div class="ttc" id="amaterials_8hpp_html"><div class="ttname"><a href="materials_8hpp.html">materials.hpp</a></div><div class="ttdoc">Predefined material properties.</div></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_compute_shader_program_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span>}</div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span> </div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="preprocessor">#endif </span><span class="comment">// CSCI441_COMPUTE_SHADER_PROGRAM_HPP</span></div>
<div class="ttc" id="a_shader_program_8hpp_html"><div class="ttname"><a href="_shader_program_8hpp.html">ShaderProgram.hpp</a></div><div class="ttdoc">Class to work with OpenGL 3.0+ Shaders.</div></div>
<div class="ttc" id="a_shader_program_8hpp_html"><div class="ttname"><a href="_shader_program_8hpp.html">ShaderProgram.hpp</a></div><div class="ttdoc">Class to work with OpenGL 4.0+ Shaders.</div></div>
<div class="ttc" id="aclass_c_s_c_i441_1_1_compute_shader_program_html"><div class="ttname"><a href="class_c_s_c_i441_1_1_compute_shader_program.html">CSCI441::ComputeShaderProgram</a></div><div class="ttdoc">Handles registration and compilation of Compute Shaders.</div><div class="ttdef"><b>Definition:</b> ComputeShaderProgram.hpp:24</div></div>
<div class="ttc" id="aclass_c_s_c_i441_1_1_compute_shader_program_html_ad74f083dab27449ee4d55d2f9180687c"><div class="ttname"><a href="class_c_s_c_i441_1_1_compute_shader_program.html#ad74f083dab27449ee4d55d2f9180687c">CSCI441::ComputeShaderProgram::dispatchWork</a></div><div class="ttdeci">virtual void dispatchWork(GLuint numGroupsX, GLuint numGroupsY, GLuint numGroupsZ) final</div><div class="ttdoc">dispatches work to the Compute Shader on the GPU</div><div class="ttdef"><b>Definition:</b> ComputeShaderProgram.hpp:141</div></div>
<div class="ttc" id="aclass_c_s_c_i441_1_1_compute_shader_program_html_aefa91afd4f55f7201f3fc7cc2b73f17b"><div class="ttname"><a href="class_c_s_c_i441_1_1_compute_shader_program.html#aefa91afd4f55f7201f3fc7cc2b73f17b">CSCI441::ComputeShaderProgram::~ComputeShaderProgram</a></div><div class="ttdeci">~ComputeShaderProgram() final=default</div><div class="ttdoc">Clean up memory associated with the Compute Shader Program.</div></div>
Expand Down
112 changes: 112 additions & 0 deletions docs/_m_d5_camera_8hpp.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
<!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.6"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CSCI441 OpenGL Library: MD5Camera.hpp File 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="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" />
</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 id="projectrow">
<td id="projectalign">
<div id="projectname">CSCI441 OpenGL Library<span id="projectnumber">&#160;4.7.0</span>
</div>
<div id="projectbrief">CS@Mines CSCI441 Computer Graphics Course Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.6 -->
<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>
<!-- 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><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#namespaces">Namespaces</a> </div>
<div class="headertitle"><div class="title">MD5Camera.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Concrete MD5 Camera implementation with Perspective Projection.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="_camera_8hpp_source.html">Camera.hpp</a>&quot;</code><br />
<code>#include &lt;ctime&gt;</code><br />
<code>#include &lt;fstream&gt;</code><br />
<code>#include &lt;string&gt;</code><br />
</div>
<p><a href="_m_d5_camera_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_c_s_c_i441_1_1_m_d5_camera.html">CSCI441::MD5Camera</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A camera that implements the <a class="el" href="class_c_s_c_i441_1_1_m_d5_camera.html" title="A camera that implements the MD5Camera specification.">MD5Camera</a> specification. <a href="class_c_s_c_i441_1_1_m_d5_camera.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespace_c_s_c_i441"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespace_c_s_c_i441.html">CSCI441</a></td></tr>
<tr class="memdesc:namespace_c_s_c_i441"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespace_c_s_c_i441.html" title="CSCI441 Helper Functions for OpenGL.">CSCI441</a> Helper Functions for OpenGL. <br /></td></tr>
<tr class="separator:"><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>Concrete MD5 Camera implementation with Perspective Projection. </p>
<dl class="section author"><dt>Author</dt><dd>Dr. Jeffrey Paone</dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>MIT License Copyright (c) 2023 Dr. Jeffrey Paone</dd></dl>
<p>These functions, classes, and constants help minimize common code that needs to be written. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6
</small></address>
</body>
</html>
Loading

0 comments on commit 90659b6

Please sign in to comment.