Skip to content

Commit

Permalink
add comments
Browse files Browse the repository at this point in the history
  • Loading branch information
besok committed Jan 13, 2025
1 parent e47e380 commit df1a0ea
Show file tree
Hide file tree
Showing 33 changed files with 776 additions and 36 deletions.
26 changes: 25 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,28 @@
**/node_modules
.idea
*.iml
**/gen
**/gen

target

# MacOS temp file
.DS_Store

book-test
guide/book

.vscode
tests/dummy_book/book/
test_book/book/

# Ignore Jetbrains specific files.
.idea/

# Ignore Vim temporary and swap files.
*.sw?
*~

# GUI tests
node_modules
package-lock.json
package.json
4 changes: 2 additions & 2 deletions docs/book/CONTRIBUTING.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="bsptree.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a rel="prev" href="distance.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

Expand All @@ -172,7 +172,7 @@ <h1 id="contributing"><a class="header" href="#contributing">Contributing</a></h
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="bsptree.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<a rel="prev" href="distance.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
4 changes: 3 additions & 1 deletion docs/book/auxiliary.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,9 @@ <h1 class="menu-title">Tesselate. 3d scientific visualization with Rust</h1>

<div id="content" class="content">
<main>

<h1 id="auxiliary-methods-and-structures"><a class="header" href="#auxiliary-methods-and-structures">Auxiliary methods and structures</a></h1>
<p>This section contains a collection of auxiliary methods and structures that are used in the library.</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand Down
4 changes: 2 additions & 2 deletions docs/book/basic_geometries.html
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,8 @@ <h1 class="menu-title">Tesselate. 3d scientific visualization with Rust</h1>
<div id="content" class="content">
<main>
<h1 id="basic-shapes"><a class="header" href="#basic-shapes">Basic shapes</a></h1>
<p>This section covers the creation of basic geometric shapes using <code>tesselate</code>.</p>
<p><img src="bshapes.png" alt="Example" /></p>
<p>This section covers the creation of basic geometric shapes using <code>tesselate</code>.
<img src="assets/bshapes.png" alt="Example" /></p>
<p>The running example can be found
in the <a href="https://github.com/besok/tessellate/tree/main/examples/basic_shapes" target="_blank">repository</a></p>
<h2 id="shapes"><a class="header" href="#shapes">Shapes</a></h2>
Expand Down
11 changes: 8 additions & 3 deletions docs/book/bsptree.html
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,12 @@ <h1 class="menu-title">Tesselate. 3d scientific visualization with Rust</h1>

<div id="content" class="content">
<main>

<h1 id="bsptree"><a class="header" href="#bsptree">BSPTree</a></h1>
<p>A BSPTree (Binary Space Partitioning Tree) is a data structure used in computer graphics, computational geometry, and
other fields to recursively subdivide a space into convex sets by hyperplanes. This structure is useful for rendering
scenes, collision detection, and other spatial queries.</p>
<p>For details see <a href="./query.html">query</a> and `` and <code>try_bsp_tree</code> method.</p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
Expand All @@ -161,7 +166,7 @@ <h1 class="menu-title">Tesselate. 3d scientific visualization with Rust</h1>
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="CONTRIBUTING.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next prefetch" href="distance.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

Expand All @@ -175,7 +180,7 @@ <h1 class="menu-title">Tesselate. 3d scientific visualization with Rust</h1>
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="CONTRIBUTING.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<a rel="next prefetch" href="distance.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
Expand Down
233 changes: 233 additions & 0 deletions docs/book/connectivity.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,233 @@
<!DOCTYPE HTML>
<html lang="en" class="light sidebar-visible" dir="ltr">
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Connectivity - Tesselate. 3d scientific visualization with Rust</title>


<!-- Custom HTML head -->

<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">

<link rel="icon" href="favicon.svg">
<link rel="shortcut icon" href="favicon.png">
<link rel="stylesheet" href="css/variables.css">
<link rel="stylesheet" href="css/general.css">
<link rel="stylesheet" href="css/chrome.css">
<link rel="stylesheet" href="css/print.css" media="print">

<!-- Fonts -->
<link rel="stylesheet" href="FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="fonts/fonts.css">

<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="highlight.css">
<link rel="stylesheet" href="tomorrow-night.css">
<link rel="stylesheet" href="ayu-highlight.css">

<!-- Custom theme stylesheets -->


<!-- Provide site root to javascript -->
<script>
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
<!-- Start loading toc.js asap -->
<script src="toc.js"></script>
</head>
<body>
<div id="body-container">
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');

if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}

if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>

<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
const html = document.documentElement;
html.classList.remove('light')
html.classList.add(theme);
html.classList.add("js");
</script>

<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">

<!-- Hide / unhide sidebar before it is displayed -->
<script>
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
</script>

<nav id="sidebar" class="sidebar" aria-label="Table of contents">
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
</noscript>
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>

<div id="page-wrapper" class="page-wrapper">

<div class="page">
<div id="menu-bar-hover-placeholder"></div>
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>

<h1 class="menu-title">Tesselate. 3d scientific visualization with Rust</h1>

<div class="right-buttons">
<a href="print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>

</div>
</div>

<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>

<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>

<div id="content" class="content">
<main>
<h1 id="connected-regions-on-the-mesh"><a class="header" href="#connected-regions-on-the-mesh">Connected regions on the mesh</a></h1>
<p>The query on the mesh provides a row of methods to extract the connected regions of the mesh.</p>
<p>The following methods are available in the <code>tessellate</code> module:</p>
<ul>
<li><code>extract_connected_regions</code>: Extracts all connected regions from the mesh.</li>
<li><code>extract_largest_connected_region</code>: Extracts the largest connected region from the mesh.</li>
<li><code>extract_connected_regions_by_vertexes</code>: Extracts connected regions based on specified vertices.</li>
<li><code>extract_closest_connected_region</code>: Extracts the connected region closest to a specified vertex.</li>
</ul>
<p>The running example can be found
in the <a href="https://github.com/besok/tessellate/tree/main/examples/connectivity" target="_blank">repository</a></p>

</main>

<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="extract_cell_centers.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="extract_edges.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>

<div style="clear: both"></div>
</nav>
</div>
</div>

<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="extract_cell_centers.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>

<a rel="next prefetch" href="extract_edges.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>

</div>

<!-- Livereload script (if served using the cli tool) -->
<script>
const wsProtocol = location.protocol === 'https:' ? 'wss:' : 'ws:';
const wsAddress = wsProtocol + "//" + location.host + "/" + "__livereload";
const socket = new WebSocket(wsAddress);
socket.onmessage = function (event) {
if (event.data === "reload") {
socket.close();
location.reload();
}
};

window.onbeforeunload = function() {
socket.close();
}
</script>



<script>
window.playground_copyable = true;
</script>


<script src="elasticlunr.min.js"></script>
<script src="mark.min.js"></script>
<script src="searcher.js"></script>

<script src="clipboard.min.js"></script>
<script src="highlight.js"></script>
<script src="book.js"></script>

<!-- Custom JS scripts -->


</div>
</body>
</html>
2 changes: 1 addition & 1 deletion docs/book/controls.html
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ <h2 id="camera-controls-by-mouse"><a class="header" href="#camera-controls-by-mo
With middle mouse button, you can zoom in and out.</p>
<h2 id="ui-controls"><a class="header" href="#ui-controls">UI controls</a></h2>
<p>The UI controls are displayed on the left side of the screen.
<img src="controls.png" alt="Controls" /></p>
<img src="assets/controls.png" alt="Controls" /></p>
<p>with the UI controls, you can:</p>
<ul>
<li>Rotate the camera around the object</li>
Expand Down
Loading

0 comments on commit df1a0ea

Please sign in to comment.