Skip to content

Commit

Permalink
Update the C++ docs
Browse files Browse the repository at this point in the history
  • Loading branch information
abey79 committed Oct 14, 2024
1 parent ca3f9e5 commit 4a04b3a
Show file tree
Hide file tree
Showing 51 changed files with 257 additions and 256 deletions.
8 changes: 4 additions & 4 deletions docs/cpp/main/annotated.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@
<tr id="row_1_1_1_3_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1AutoSpaceViews.html" target="_self">AutoSpaceViews</a></td><td class="desc"><b>Component</b>: Whether or not space views should be created automatically </td></tr>
<tr id="row_1_1_1_4_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1ColumnShare.html" target="_self">ColumnShare</a></td><td class="desc"><b>Component</b>: The layout share of a column in the container </td></tr>
<tr id="row_1_1_1_5_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1ComponentColumnSelector.html" target="_self">ComponentColumnSelector</a></td><td class="desc"><b>Component</b>: Describe a component column to be selected in the dataframe view </td></tr>
<tr id="row_1_1_1_6_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterByEvent.html" target="_self">FilterByEvent</a></td><td class="desc"><b>Component</b>: Configuration for the filter-by-event feature of the dataframe view </td></tr>
<tr id="row_1_1_1_7_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterByRange.html" target="_self">FilterByRange</a></td><td class="desc"><b>Component</b>: Configuration for a filter-by-range feature of the dataframe view </td></tr>
<tr id="row_1_1_1_6_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterByRange.html" target="_self">FilterByRange</a></td><td class="desc"><b>Component</b>: Configuration for a filter-by-range feature of the dataframe view </td></tr>
<tr id="row_1_1_1_7_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterIsNotNull.html" target="_self">FilterIsNotNull</a></td><td class="desc"><b>Component</b>: Configuration for the filter is not null feature of the dataframe view </td></tr>
<tr id="row_1_1_1_8_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1GridColumns.html" target="_self">GridColumns</a></td><td class="desc"><b>Component</b>: How many columns a grid container should have </td></tr>
<tr id="row_1_1_1_9_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1IncludedContent.html" target="_self">IncludedContent</a></td><td class="desc"><b>Component</b>: All the contents in the container </td></tr>
<tr id="row_1_1_1_10_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1IncludedSpaceView.html" target="_self">IncludedSpaceView</a></td><td class="desc"><b>Component</b>: The unique id of a space view, used to refer to views in containers </td></tr>
Expand All @@ -224,8 +224,8 @@
<tr id="row_1_1_1_26_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1components_1_1VisualizerOverrides.html" target="_self">VisualizerOverrides</a></td><td class="desc"><b>Component</b>: Override the visualizers for an entity </td></tr>
<tr id="row_1_1_2_" class="odd" style="display:none;"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><span id="arr_1_1_2_" class="arrow" onclick="toggleFolder('1_1_2_')">&#9658;</span><span class="icona"><span class="icon">N</span></span><b>datatypes</b></td><td class="desc"></td></tr>
<tr id="row_1_1_2_0_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1ComponentColumnSelector.html" target="_self">ComponentColumnSelector</a></td><td class="desc"><b>Datatype</b>: Describe a component column to be selected in the dataframe view </td></tr>
<tr id="row_1_1_2_1_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterByEvent.html" target="_self">FilterByEvent</a></td><td class="desc"><b>Datatype</b>: Configuration for the filter by event feature of the dataframe view </td></tr>
<tr id="row_1_1_2_2_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterByRange.html" target="_self">FilterByRange</a></td><td class="desc"><b>Datatype</b>: Configuration for the filter-by-range feature of the dataframe view </td></tr>
<tr id="row_1_1_2_1_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterByRange.html" target="_self">FilterByRange</a></td><td class="desc"><b>Datatype</b>: Configuration for the filter-by-range feature of the dataframe view </td></tr>
<tr id="row_1_1_2_2_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterIsNotNull.html" target="_self">FilterIsNotNull</a></td><td class="desc"><b>Datatype</b>: Configuration for the filter is not null feature of the dataframe view </td></tr>
<tr id="row_1_1_2_3_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1SelectedColumns.html" target="_self">SelectedColumns</a></td><td class="desc"><b>Datatype</b>: List of selected columns in a dataframe </td></tr>
<tr id="row_1_1_2_4_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1TensorDimensionIndexSlider.html" target="_self">TensorDimensionIndexSlider</a></td><td class="desc"><b>Datatype</b>: Defines a slider for the index of some dimension </td></tr>
<tr id="row_1_1_2_5_" class="odd" style="display:none;"><td class="entry"><span style="width:64px;display:inline-block;">&#160;</span><span class="icona"><span class="icon">C</span></span><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1Utf8List.html" target="_self">Utf8List</a></td><td class="desc"><b>Datatype</b>: A list of strings of text, encoded as UTF-8 </td></tr>
Expand Down
4 changes: 2 additions & 2 deletions docs/cpp/main/annotated_dup.js
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,8 @@ var annotated_dup =
[ "AutoSpaceViews", "structrerun_1_1blueprint_1_1components_1_1AutoSpaceViews.html", "structrerun_1_1blueprint_1_1components_1_1AutoSpaceViews" ],
[ "ColumnShare", "structrerun_1_1blueprint_1_1components_1_1ColumnShare.html", "structrerun_1_1blueprint_1_1components_1_1ColumnShare" ],
[ "ComponentColumnSelector", "structrerun_1_1blueprint_1_1components_1_1ComponentColumnSelector.html", "structrerun_1_1blueprint_1_1components_1_1ComponentColumnSelector" ],
[ "FilterByEvent", "structrerun_1_1blueprint_1_1components_1_1FilterByEvent.html", "structrerun_1_1blueprint_1_1components_1_1FilterByEvent" ],
[ "FilterByRange", "structrerun_1_1blueprint_1_1components_1_1FilterByRange.html", "structrerun_1_1blueprint_1_1components_1_1FilterByRange" ],
[ "FilterIsNotNull", "structrerun_1_1blueprint_1_1components_1_1FilterIsNotNull.html", "structrerun_1_1blueprint_1_1components_1_1FilterIsNotNull" ],
[ "GridColumns", "structrerun_1_1blueprint_1_1components_1_1GridColumns.html", "structrerun_1_1blueprint_1_1components_1_1GridColumns" ],
[ "IncludedContent", "structrerun_1_1blueprint_1_1components_1_1IncludedContent.html", "structrerun_1_1blueprint_1_1components_1_1IncludedContent" ],
[ "IncludedSpaceView", "structrerun_1_1blueprint_1_1components_1_1IncludedSpaceView.html", "structrerun_1_1blueprint_1_1components_1_1IncludedSpaceView" ],
Expand All @@ -126,8 +126,8 @@ var annotated_dup =
] ],
[ "datatypes", null, [
[ "ComponentColumnSelector", "structrerun_1_1blueprint_1_1datatypes_1_1ComponentColumnSelector.html", "structrerun_1_1blueprint_1_1datatypes_1_1ComponentColumnSelector" ],
[ "FilterByEvent", "structrerun_1_1blueprint_1_1datatypes_1_1FilterByEvent.html", "structrerun_1_1blueprint_1_1datatypes_1_1FilterByEvent" ],
[ "FilterByRange", "structrerun_1_1blueprint_1_1datatypes_1_1FilterByRange.html", "structrerun_1_1blueprint_1_1datatypes_1_1FilterByRange" ],
[ "FilterIsNotNull", "structrerun_1_1blueprint_1_1datatypes_1_1FilterIsNotNull.html", "structrerun_1_1blueprint_1_1datatypes_1_1FilterIsNotNull" ],
[ "SelectedColumns", "structrerun_1_1blueprint_1_1datatypes_1_1SelectedColumns.html", "structrerun_1_1blueprint_1_1datatypes_1_1SelectedColumns" ],
[ "TensorDimensionIndexSlider", "structrerun_1_1blueprint_1_1datatypes_1_1TensorDimensionIndexSlider.html", "structrerun_1_1blueprint_1_1datatypes_1_1TensorDimensionIndexSlider" ],
[ "Utf8List", "structrerun_1_1blueprint_1_1datatypes_1_1Utf8List.html", null ]
Expand Down
4 changes: 2 additions & 2 deletions docs/cpp/main/blueprint_2components_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -116,8 +116,8 @@
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &quot;blueprint/components/component_column_selector.hpp&quot;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &quot;blueprint/components/container_kind.hpp&quot;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="preprocessor">#include &quot;blueprint/components/corner2d.hpp&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;blueprint/components/filter_by_event.hpp&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;blueprint/components/filter_by_range.hpp&quot;</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include &quot;blueprint/components/filter_by_range.hpp&quot;</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include &quot;blueprint/components/filter_is_not_null.hpp&quot;</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#include &quot;blueprint/components/grid_columns.hpp&quot;</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="preprocessor">#include &quot;blueprint/components/included_content.hpp&quot;</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#include &quot;blueprint/components/included_space_view.hpp&quot;</span></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/cpp/main/blueprint_2datatypes_8hpp_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,8 @@
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span> </div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="preprocessor">#include &quot;blueprint/datatypes/component_column_selector.hpp&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;blueprint/datatypes/filter_by_event.hpp&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;blueprint/datatypes/filter_by_range.hpp&quot;</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="preprocessor">#include &quot;blueprint/datatypes/filter_by_range.hpp&quot;</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#include &quot;blueprint/datatypes/filter_is_not_null.hpp&quot;</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include &quot;blueprint/datatypes/selected_columns.hpp&quot;</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include &quot;blueprint/datatypes/tensor_dimension_index_slider.hpp&quot;</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include &quot;blueprint/datatypes/utf8list.hpp&quot;</span></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/cpp/main/classes.html
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
<dd><a class="el" href="structrerun_1_1archetypes_1_1Ellipsoids3D.html">Ellipsoids3D</a> (<a class="el" href="namespacererun_1_1archetypes.html">rerun::archetypes</a>)</dd><dd><a class="el" href="structrerun_1_1archetypes_1_1EncodedImage.html">EncodedImage</a> (<a class="el" href="namespacererun_1_1archetypes.html">rerun::archetypes</a>)</dd><dd><a class="el" href="structrerun_1_1components_1_1EntityPath.html">EntityPath</a> (<a class="el" href="namespacererun_1_1components.html">rerun::components</a>)</dd><dd><a class="el" href="structrerun_1_1datatypes_1_1EntityPath.html">EntityPath</a> (<a class="el" href="namespacererun_1_1datatypes.html">rerun::datatypes</a>)</dd><dd><a class="el" href="classrerun_1_1Error.html">Error</a> (<a class="el" href="namespacererun.html">rerun</a>)</dd><dd><a class="el" href="classcxxopts_1_1exceptions_1_1exception.html">exception</a> (cxxopts::exceptions)</dd></dl>
<dl class="classindex odd">
<dt class="alphachar"><a id="letter_F" name="letter_F">F</a></dt>
<dd><a class="el" href="structrerun_1_1components_1_1FillRatio.html">FillRatio</a> (<a class="el" href="namespacererun_1_1components.html">rerun::components</a>)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterByEvent.html">FilterByEvent</a> (rerun::blueprint::components)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterByEvent.html">FilterByEvent</a> (rerun::blueprint::datatypes)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterByRange.html">FilterByRange</a> (rerun::blueprint::components)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterByRange.html">FilterByRange</a> (rerun::blueprint::datatypes)</dd><dd><a class="el" href="structrerun_1_1datatypes_1_1Float32.html">Float32</a> (<a class="el" href="namespacererun_1_1datatypes.html">rerun::datatypes</a>)</dd><dd><a class="el" href="structrerun_1_1datatypes_1_1Float64.html">Float64</a> (<a class="el" href="namespacererun_1_1datatypes.html">rerun::datatypes</a>)</dd></dl>
<dd><a class="el" href="structrerun_1_1components_1_1FillRatio.html">FillRatio</a> (<a class="el" href="namespacererun_1_1components.html">rerun::components</a>)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterByRange.html">FilterByRange</a> (rerun::blueprint::components)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterByRange.html">FilterByRange</a> (rerun::blueprint::datatypes)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1components_1_1FilterIsNotNull.html">FilterIsNotNull</a> (rerun::blueprint::components)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1datatypes_1_1FilterIsNotNull.html">FilterIsNotNull</a> (rerun::blueprint::datatypes)</dd><dd><a class="el" href="structrerun_1_1datatypes_1_1Float32.html">Float32</a> (<a class="el" href="namespacererun_1_1datatypes.html">rerun::datatypes</a>)</dd><dd><a class="el" href="structrerun_1_1datatypes_1_1Float64.html">Float64</a> (<a class="el" href="namespacererun_1_1datatypes.html">rerun::datatypes</a>)</dd></dl>
<dl class="classindex even">
<dt class="alphachar"><a id="letter_G" name="letter_G">G</a></dt>
<dd><a class="el" href="structrerun_1_1components_1_1GammaCorrection.html">GammaCorrection</a> (<a class="el" href="namespacererun_1_1components.html">rerun::components</a>)</dd><dd><a class="el" href="classcxxopts_1_1exceptions_1_1gratuitous__argument__for__option.html">gratuitous_argument_for_option</a> (cxxopts::exceptions)</dd><dd><a class="el" href="structrerun_1_1blueprint_1_1components_1_1GridColumns.html">GridColumns</a> (rerun::blueprint::components)</dd></dl>
Expand Down
Loading

0 comments on commit 4a04b3a

Please sign in to comment.