Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ethanuppal
ethanuppal committed Apr 20, 2024
1 parent 9bcd1ce commit 2b4557f
Show file tree
Hide file tree
Showing 115 changed files with 3,332 additions and 1,896 deletions.
5 changes: 2 additions & 3 deletions docs/annotated.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,8 @@
<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="dynsection.toggleFolder('0_')">&#9660;</span><span class="icona"><span class="icon">N</span></span><a class="el" href="namespaceicp.html" target="_self">icp</a></td><td class="desc"></td></tr>
<tr id="row_0_0_" class="odd"><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="classicp_1_1_i_c_p.html" target="_self">ICP</a></td><td class="desc">Interface for iterative closest points; please read the Detailed Description for usage information </td></tr>
<tr id="row_0_1_" 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="structicp_1_1_methods.html" target="_self">Methods</a></td><td class="desc"></td></tr>
<tr id="row_0_2_" class="odd"><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="structicp_1_1_point.html" target="_self">Point</a></td><td class="desc"></td></tr>
<tr id="row_0_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="structicp_1_1_transform.html" target="_self">Transform</a></td><td class="desc"></td></tr>
<tr id="row_1_" class="odd"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_lidar_view.html" target="_self">LidarView</a></td><td class="desc"></td></tr>
<tr id="row_0_2_" class="odd"><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="structicp_1_1_r_b_transform.html" target="_self">RBTransform</a></td><td class="desc">Rigid-body transformation </td></tr>
<tr id="row_1_" class="even"><td class="entry"><span style="width:16px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="class_lidar_view.html" target="_self">LidarView</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
6 changes: 3 additions & 3 deletions docs/class_lidar_view-members.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,10 @@
<table class="directory">
<tr class="even"><td class="entry"><a class="el" href="class_lidar_view.html#a8b517313dcbfb06228233d86181478ee">construct_instance</a>()</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_lidar_view.html#adc727da2f727ceaf0ee20c5d4019917f">draw</a>(SDL_Renderer *renderer, const SDL_Rect *frame, double dtime) override</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_lidar_view.html#afce9618015ba3ba744e39b63270d21a1">get_dest</a>() const</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_lidar_view.html#a8a3355c4f42d29cfb2134e2dd509ed8d">get_source</a>() const</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_lidar_view.html#a6f10765c7dcb6a347e4b3164b818207d">get_dest</a>() const</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_lidar_view.html#af1f338c2eec9bf29e87ab9d31acd75c4">get_source</a>() const</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_lidar_view.html#abfada6e9607893414f149398aa46fc13">LidarView</a>()</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_lidar_view.html#af79bff0f6b5c3443e93a7ffc208931ff">LidarView</a>(std::vector&lt; icp::Point &gt; source, std::vector&lt; icp::Point &gt; destination, const std::string method)</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_lidar_view.html#afefd516221a746567a02cc7f2a0cc4ee">LidarView</a>(std::vector&lt; icp::Vector &gt; source, std::vector&lt; icp::Vector &gt; destination, const std::string method)</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="even"><td class="entry"><a class="el" href="class_lidar_view.html#a5845bccd63d38d8cc99ec2a213bf8495">on_event</a>(const SDL_Event &amp;event) override</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
<tr class="odd"><td class="entry"><a class="el" href="class_lidar_view.html#aaaa17fc7431a01c6b934264dc4655f7f">~LidarView</a>() noexcept override</td><td class="entry"><a class="el" href="class_lidar_view.html">LidarView</a></td><td class="entry"></td></tr>
</table></div><!-- contents -->
Expand Down
42 changes: 21 additions & 21 deletions docs/class_lidar_view.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,9 +93,9 @@
<tr class="memitem:abfada6e9607893414f149398aa46fc13" id="r_abfada6e9607893414f149398aa46fc13"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#abfada6e9607893414f149398aa46fc13">LidarView</a> ()</td></tr>
<tr class="memdesc:abfada6e9607893414f149398aa46fc13"><td class="mdescLeft">&#160;</td><td class="mdescRight">Consructs a new lidar view visualizing ICP on a random instance. <br /></td></tr>
<tr class="separator:abfada6e9607893414f149398aa46fc13"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af79bff0f6b5c3443e93a7ffc208931ff" id="r_af79bff0f6b5c3443e93a7ffc208931ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af79bff0f6b5c3443e93a7ffc208931ff">LidarView</a> (std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt; source, std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt; destination, const std::string method)</td></tr>
<tr class="memdesc:af79bff0f6b5c3443e93a7ffc208931ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new lidar view visualizing ICP (by method <code>method</code>) on the given instance (<code>source</code> and <code>destination</code>). <br /></td></tr>
<tr class="separator:af79bff0f6b5c3443e93a7ffc208931ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afefd516221a746567a02cc7f2a0cc4ee" id="r_afefd516221a746567a02cc7f2a0cc4ee"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afefd516221a746567a02cc7f2a0cc4ee">LidarView</a> (std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt; source, std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt; destination, const std::string method)</td></tr>
<tr class="memdesc:afefd516221a746567a02cc7f2a0cc4ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs a new lidar view visualizing ICP (by method <code>method</code>) on the given instance (<code>source</code> and <code>destination</code>). <br /></td></tr>
<tr class="separator:afefd516221a746567a02cc7f2a0cc4ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaaa17fc7431a01c6b934264dc4655f7f" id="r_aaaa17fc7431a01c6b934264dc4655f7f"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aaaa17fc7431a01c6b934264dc4655f7f">~LidarView</a> () noexcept override</td></tr>
<tr class="separator:aaaa17fc7431a01c6b934264dc4655f7f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5845bccd63d38d8cc99ec2a213bf8495" id="r_a5845bccd63d38d8cc99ec2a213bf8495"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5845bccd63d38d8cc99ec2a213bf8495">on_event</a> (const SDL_Event &amp;event) override</td></tr>
Expand All @@ -104,10 +104,10 @@
<tr class="separator:adc727da2f727ceaf0ee20c5d4019917f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8b517313dcbfb06228233d86181478ee" id="r_a8b517313dcbfb06228233d86181478ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8b517313dcbfb06228233d86181478ee">construct_instance</a> ()</td></tr>
<tr class="separator:a8b517313dcbfb06228233d86181478ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a3355c4f42d29cfb2134e2dd509ed8d" id="r_a8a3355c4f42d29cfb2134e2dd509ed8d"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8a3355c4f42d29cfb2134e2dd509ed8d">get_source</a> () const</td></tr>
<tr class="separator:a8a3355c4f42d29cfb2134e2dd509ed8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afce9618015ba3ba744e39b63270d21a1" id="r_afce9618015ba3ba744e39b63270d21a1"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#afce9618015ba3ba744e39b63270d21a1">get_dest</a> () const</td></tr>
<tr class="separator:afce9618015ba3ba744e39b63270d21a1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1f338c2eec9bf29e87ab9d31acd75c4" id="r_af1f338c2eec9bf29e87ab9d31acd75c4"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#af1f338c2eec9bf29e87ab9d31acd75c4">get_source</a> () const</td></tr>
<tr class="separator:af1f338c2eec9bf29e87ab9d31acd75c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6f10765c7dcb6a347e4b3164b818207d" id="r_a6f10765c7dcb6a347e4b3164b818207d"><td class="memItemLeft" align="right" valign="top">const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a6f10765c7dcb6a347e4b3164b818207d">get_dest</a> () const</td></tr>
<tr class="separator:a6f10765c7dcb6a347e4b3164b818207d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock">
Expand All @@ -134,21 +134,21 @@ <h2 class="memtitle"><span class="permalink"><a href="#abfada6e9607893414f149398

</div>
</div>
<a id="af79bff0f6b5c3443e93a7ffc208931ff" name="af79bff0f6b5c3443e93a7ffc208931ff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af79bff0f6b5c3443e93a7ffc208931ff">&#9670;&#160;</a></span>LidarView() <span class="overload">[2/2]</span></h2>
<a id="afefd516221a746567a02cc7f2a0cc4ee" name="afefd516221a746567a02cc7f2a0cc4ee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afefd516221a746567a02cc7f2a0cc4ee">&#9670;&#160;</a></span>LidarView() <span class="overload">[2/2]</span></h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">LidarView::LidarView </td>
<td>(</td>
<td class="paramtype">std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt;</td> <td class="paramname"><span class="paramname"><em>source</em>, </span></td>
<td class="paramtype">std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt;</td> <td class="paramname"><span class="paramname"><em>source</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt;</td> <td class="paramname"><span class="paramname"><em>destination</em>, </span></td>
<td class="paramtype">std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt;</td> <td class="paramname"><span class="paramname"><em>destination</em>, </span></td>
</tr>
<tr>
<td class="paramkey"></td>
Expand Down Expand Up @@ -243,45 +243,45 @@ <h2 class="memtitle"><span class="permalink"><a href="#adc727da2f727ceaf0ee20c5d
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00103">103</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00107">107</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt; &amp; LidarView::get_dest </td>
<td class="memname">const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt; &amp; LidarView::get_dest </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00137">137</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00145">145</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>

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

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const std::vector&lt; <a class="el" href="structicp_1_1_point.html">icp::Point</a> &gt; &amp; LidarView::get_source </td>
<td class="memname">const std::vector&lt; <a class="el" href="namespaceicp.html#aba583ee22f8131f5494d90fb3a611bd5">icp::Vector</a> &gt; &amp; LidarView::get_source </td>
<td>(</td>
<td class="paramname"><span class="paramname"></span></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00134">134</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00142">142</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>

</div>
</div>
Expand All @@ -308,7 +308,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#a5845bccd63d38d8cc99ec2a2
</table>
</div><div class="memdoc">

<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00093">93</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>
<p class="definition">Definition at line <a class="el" href="lidar__view_8cpp_source.html#l00097">97</a> of file <a class="el" href="lidar__view_8cpp_source.html">lidar_view.cpp</a>.</p>

</div>
</div>
Expand Down
9 changes: 3 additions & 6 deletions docs/classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
<div class="headertitle"><div class="title">Class Index</div></div>
</div><!--header-->
<div class="contents">
<div class="qindex"><a class="qindex" href="#letter_I">I</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_P">P</a>&#160;|&#160;<a class="qindex" href="#letter_T">T</a></div>
<div class="qindex"><a class="qindex" href="#letter_I">I</a>&#160;|&#160;<a class="qindex" href="#letter_L">L</a>&#160;|&#160;<a class="qindex" href="#letter_M">M</a>&#160;|&#160;<a class="qindex" href="#letter_R">R</a></div>
<div class="classindex">
<dl class="classindex even">
<dt class="alphachar"><a id="letter_I" name="letter_I">I</a></dt>
Expand All @@ -88,11 +88,8 @@
<dt class="alphachar"><a id="letter_M" name="letter_M">M</a></dt>
<dd><a class="el" href="structicp_1_1_methods.html">Methods</a> (<a class="el" href="namespaceicp.html">icp</a>)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_P" name="letter_P">P</a></dt>
<dd><a class="el" href="structicp_1_1_point.html">Point</a> (<a class="el" href="namespaceicp.html">icp</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_T" name="letter_T">T</a></dt>
<dd><a class="el" href="structicp_1_1_transform.html">Transform</a> (<a class="el" href="namespaceicp.html">icp</a>)</dd></dl>
<dt class="alphachar"><a id="letter_R" name="letter_R">R</a></dt>
<dd><a class="el" href="structicp_1_1_r_b_transform.html">RBTransform</a> (<a class="el" href="namespaceicp.html">icp</a>)</dd></dl>
</div>
</div><!-- contents -->
<!-- start footer part -->
Expand Down
Loading

0 comments on commit 2b4557f

Please sign in to comment.