Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Vitor Greati committed Apr 9, 2019
1 parent 372fd0e commit dad9475
Show file tree
Hide file tree
Showing 208 changed files with 5,258 additions and 507 deletions.
2 changes: 1 addition & 1 deletion docs/Doxyconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ PROJECT_NAME = omg
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER = 0.0.1
PROJECT_NUMBER = 0.9.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
Expand Down
Binary file removed docs/html/FreeSans.ttf
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/html/_background_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_buffer_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
32 changes: 18 additions & 14 deletions docs/html/_camera_8h_source.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/_col_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_configs_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_grad_bilinear_background_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_image_background_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_logger_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
5 changes: 3 additions & 2 deletions docs/html/_mat_8h_source.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/_netpbm_printer_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_object_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
9 changes: 5 additions & 4 deletions docs/html/_ortho_camera_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down Expand Up @@ -71,14 +71,15 @@
<div class="title">OrthoCamera.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __ORTHOCAMERA__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __ORTHOCAMERA__</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;Camera.h&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceomg.html">omg</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classomg_1_1_ortho_camera.html"> 12</a></span>&#160;<span class="keyword">class </span><a class="code" href="classomg_1_1_ortho_camera.html">OrthoCamera</a> : <span class="keyword">public</span> <a class="code" href="classomg_1_1_camera.html">Camera</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="classomg_1_1_ortho_camera.html">OrthoCamera</a>(<span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height, <span class="keyword">const</span> <a class="code" href="structomg_1_1_camera_1_1_vp_dims.html">VpDims</a>&amp; vpdims, <span class="keyword">const</span> <a class="code" href="classtao_1_1_col.html">Point3</a>&amp; position, <span class="keyword">const</span> <a class="code" href="classtao_1_1_col.html">Vec3</a>&amp; target, <span class="keyword">const</span> <a class="code" href="classtao_1_1_col.html">Vec3</a>&amp; up)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; : <a class="code" href="classomg_1_1_camera.html">Camera</a> {width, height, vpdims, position, target, up}</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; {<span class="comment">/*empty*/</span>}</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classomg_1_1_ortho_camera.html#af5dba96ad9cdf91121093d0c9d72e57f"> 21</a></span>&#160; <a class="code" href="classomg_1_1_ray.html">Ray</a> <a class="code" href="classomg_1_1_ortho_camera.html#af5dba96ad9cdf91121093d0c9d72e57f">generate_ray</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y)<span class="keyword"> override </span>{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="classtao_1_1_col.html">Vec3</a> direction = -1.0f * this-&gt;_w;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">auto</span> [u, v] = this-&gt;<a class="code" href="classomg_1_1_camera.html#a7978815c7f03689ea47eaf70065b4266">compute_u_v</a>(x, y);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classtao_1_1_col.html">Point3</a> origin = _position + (u * <a class="code" href="classomg_1_1_camera.html#a9cc9befcbf8720cc2b602d0e70173f4b">_u</a>) + (v * _v);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classomg_1_1_ray.html">Ray</a> {origin, direction};</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; }</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;};</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;};</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceomg_html"><div class="ttname"><a href="namespaceomg.html">omg</a></div><div class="ttdoc">Interface for backgrounds.</div><div class="ttdef"><b>Definition:</b> Background.h:11</div></div>
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#ifndef __ORTHOCAMERA__</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="preprocessor">#define __ORTHOCAMERA__</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;</div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="preprocessor">#include &quot;Camera.h&quot;</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;</div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="keyword">namespace </span><a class="code" href="namespaceomg.html">omg</a> {</div><div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="classomg_1_1_ortho_camera.html"> 12</a></span>&#160;<span class="keyword">class </span><a class="code" href="classomg_1_1_ortho_camera.html">OrthoCamera</a> : <span class="keyword">public</span> <a class="code" href="classomg_1_1_camera.html">Camera</a> {</div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;</div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; <span class="keyword">public</span>:</div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;</div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; <a class="code" href="classomg_1_1_ortho_camera.html">OrthoCamera</a>(<span class="keywordtype">int</span> width, <span class="keywordtype">int</span> height, <span class="keyword">const</span> <a class="code" href="classtao_1_1_col.html">Point3</a>&amp; position, <span class="keyword">const</span> <a class="code" href="classtao_1_1_col.html">Vec3</a>&amp; target, <span class="keyword">const</span> <a class="code" href="classtao_1_1_col.html">Vec3</a>&amp; up, <span class="keyword">const</span> <a class="code" href="structomg_1_1_camera_1_1_vp_dims.html">VpDims</a>&amp; vpdims)</div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; : <a class="code" href="classomg_1_1_camera.html">Camera</a> {width, height, position, target, up, vpdims}</div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; {<span class="comment">/*empty*/</span>}</div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;</div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;</div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="classomg_1_1_ortho_camera.html#af5dba96ad9cdf91121093d0c9d72e57f"> 21</a></span>&#160; <a class="code" href="classomg_1_1_ray.html">Ray</a> <a class="code" href="classomg_1_1_ortho_camera.html#af5dba96ad9cdf91121093d0c9d72e57f">generate_ray</a>(<span class="keywordtype">float</span> x, <span class="keywordtype">float</span> y)<span class="keyword"> override </span>{</div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; <a class="code" href="classtao_1_1_col.html">Vec3</a> direction = this-&gt;<a class="code" href="classomg_1_1_camera.html#aabfc8456e81fa75da2267df6c0b447a5">_plane_normal</a>;</div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; <span class="keyword">auto</span> [u, v] = this-&gt;<a class="code" href="classomg_1_1_camera.html#a7978815c7f03689ea47eaf70065b4266">compute_u_v</a>(x, y);</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160; <a class="code" href="classtao_1_1_col.html">Point3</a> origin = _position + (u * <a class="code" href="classomg_1_1_camera.html#a9cc9befcbf8720cc2b602d0e70173f4b">_u</a>) + (v * _v);</div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">return</span> <a class="code" href="classomg_1_1_ray.html">Ray</a> {origin, direction};</div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160; }</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;};</div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;};</div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="namespaceomg_html"><div class="ttname"><a href="namespaceomg.html">omg</a></div><div class="ttdoc">Interface for backgrounds.</div><div class="ttdef"><b>Definition:</b> Background.h:11</div></div>
<div class="ttc" id="classomg_1_1_camera_html_aabfc8456e81fa75da2267df6c0b447a5"><div class="ttname"><a href="classomg_1_1_camera.html#aabfc8456e81fa75da2267df6c0b447a5">omg::Camera::_plane_normal</a></div><div class="ttdeci">Vec3 _plane_normal</div><div class="ttdoc">Orthonormal basis.</div><div class="ttdef"><b>Definition:</b> Camera.h:46</div></div>
<div class="ttc" id="classtao_1_1_col_html"><div class="ttname"><a href="classtao_1_1_col.html">tao::Col</a></div><div class="ttdef"><b>Definition:</b> Col.h:10</div></div>
<div class="ttc" id="classomg_1_1_ray_html"><div class="ttname"><a href="classomg_1_1_ray.html">omg::Ray</a></div><div class="ttdoc">Represents a ray in the raytracer technique.</div><div class="ttdef"><b>Definition:</b> Ray.h:13</div></div>
<div class="ttc" id="classomg_1_1_camera_html_a9cc9befcbf8720cc2b602d0e70173f4b"><div class="ttname"><a href="classomg_1_1_camera.html#a9cc9befcbf8720cc2b602d0e70173f4b">omg::Camera::_u</a></div><div class="ttdeci">Vec3 _u</div><div class="ttdoc">Camera height.</div><div class="ttdef"><b>Definition:</b> Camera.h:45</div></div>
<div class="ttc" id="classomg_1_1_ortho_camera_html_af5dba96ad9cdf91121093d0c9d72e57f"><div class="ttname"><a href="classomg_1_1_ortho_camera.html#af5dba96ad9cdf91121093d0c9d72e57f">omg::OrthoCamera::generate_ray</a></div><div class="ttdeci">Ray generate_ray(float x, float y) override</div><div class="ttdoc">Produces a ray given an x and y in [0,1].</div><div class="ttdef"><b>Definition:</b> OrthoCamera.h:21</div></div>
<div class="ttc" id="classomg_1_1_camera_html_a7978815c7f03689ea47eaf70065b4266"><div class="ttname"><a href="classomg_1_1_camera.html#a7978815c7f03689ea47eaf70065b4266">omg::Camera::compute_u_v</a></div><div class="ttdeci">std::pair&lt; float, float &gt; compute_u_v(float i, float j) const</div><div class="ttdoc">Compute the (u,v) from (i,j), i, j in [0,1].</div><div class="ttdef"><b>Definition:</b> Camera.h:119</div></div>
<div class="ttc" id="classomg_1_1_camera_html_a7978815c7f03689ea47eaf70065b4266"><div class="ttname"><a href="classomg_1_1_camera.html#a7978815c7f03689ea47eaf70065b4266">omg::Camera::compute_u_v</a></div><div class="ttdeci">std::pair&lt; float, float &gt; compute_u_v(float i, float j) const</div><div class="ttdoc">Compute the (u,v) from (i,j), i, j in [0,1].</div><div class="ttdef"><b>Definition:</b> Camera.h:136</div></div>
<div class="ttc" id="classomg_1_1_camera_html"><div class="ttname"><a href="classomg_1_1_camera.html">omg::Camera</a></div><div class="ttdoc">Represents a generic camera.</div><div class="ttdef"><b>Definition:</b> Camera.h:13</div></div>
<div class="ttc" id="structomg_1_1_camera_1_1_vp_dims_html"><div class="ttname"><a href="structomg_1_1_camera_1_1_vp_dims.html">omg::Camera::VpDims</a></div><div class="ttdoc">View plane dimensions.</div><div class="ttdef"><b>Definition:</b> Camera.h:28</div></div>
<div class="ttc" id="structomg_1_1_camera_1_1_vp_dims_html"><div class="ttname"><a href="structomg_1_1_camera_1_1_vp_dims.html">omg::Camera::VpDims</a></div><div class="ttdoc">View plane dimensions.</div><div class="ttdef"><b>Definition:</b> Camera.h:27</div></div>
<div class="ttc" id="classomg_1_1_ortho_camera_html"><div class="ttname"><a href="classomg_1_1_ortho_camera.html">omg::OrthoCamera</a></div><div class="ttdoc">Represents an orthogonal camera.</div><div class="ttdef"><b>Definition:</b> OrthoCamera.h:12</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
Expand Down
2 changes: 1 addition & 1 deletion docs/html/_parser_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">omg
&#160;<span id="projectnumber">0.0.1</span>
&#160;<span id="projectnumber">0.9.0</span>
</div>
<div id="projectbrief">Open Machinery for Graphics</div>
</td>
Expand Down
Loading

0 comments on commit dad9475

Please sign in to comment.