Skip to content

Commit

Permalink
build based on 506704e
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Nov 15, 2024
1 parent 755887f commit 7262305
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-15T14:33:06","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-11-15T15:20:30","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@

co = ClipperOffset()
add_path!(co, polygon, JoinTypeMiter, EndTypeClosedPolygon)
miter_offset_polygons = execute(co, 7.0)</code></pre><p><img src="assets/offset_diff_types.png" alt="Different offsetting types"/></p><p><code>JoinTypeRound</code> produces rounded corners, <code>JoinTypeSquare</code> produces squared corners. In the case of <code>JoinTypeMiter</code> it depends on the degree of the angle or in different words the maximum offsetted distance if corners. would not be squared. If the maximum distance is bigger than <code>MiterLimit * delta</code> than it is squared which would be the case in the upper right corner.</p><p>The <code>MiterLimit</code> is the first argument of <code>ClipperOffset</code> for example <code>ClipperOffset(3.0)</code> would set it to <code>3.0</code> (default is <code>2.0</code>). <code>delta</code> is simply the distance we want to offset in our case above we set it to <code>7.0</code> as the second parameter of the <code>execute</code> function.</p><p>The three different types are also explained in the <a href="http://www.angusj.com/delphi/clipper/documentation/Docs/Units/ClipperLib/Types/JoinType.htm">official documentation</a>.</p><h2 id="Boolean-operations-between-two-or-more-polygons"><a class="docs-heading-anchor" href="#Boolean-operations-between-two-or-more-polygons">Boolean operations between two or more polygons</a><a id="Boolean-operations-between-two-or-more-polygons-1"></a><a class="docs-heading-anchor-permalink" href="#Boolean-operations-between-two-or-more-polygons" title="Permalink"></a></h2><p>Needs to be written. Feel free to open a PR.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 15 November 2024 14:33">Friday 15 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
miter_offset_polygons = execute(co, 7.0)</code></pre><p><img src="assets/offset_diff_types.png" alt="Different offsetting types"/></p><p><code>JoinTypeRound</code> produces rounded corners, <code>JoinTypeSquare</code> produces squared corners. In the case of <code>JoinTypeMiter</code> it depends on the degree of the angle or in different words the maximum offsetted distance if corners. would not be squared. If the maximum distance is bigger than <code>MiterLimit * delta</code> than it is squared which would be the case in the upper right corner.</p><p>The <code>MiterLimit</code> is the first argument of <code>ClipperOffset</code> for example <code>ClipperOffset(3.0)</code> would set it to <code>3.0</code> (default is <code>2.0</code>). <code>delta</code> is simply the distance we want to offset in our case above we set it to <code>7.0</code> as the second parameter of the <code>execute</code> function.</p><p>The three different types are also explained in the <a href="http://www.angusj.com/delphi/clipper/documentation/Docs/Units/ClipperLib/Types/JoinType.htm">official documentation</a>.</p><h2 id="Boolean-operations-between-two-or-more-polygons"><a class="docs-heading-anchor" href="#Boolean-operations-between-two-or-more-polygons">Boolean operations between two or more polygons</a><a id="Boolean-operations-between-two-or-more-polygons-1"></a><a class="docs-heading-anchor-permalink" href="#Boolean-operations-between-two-or-more-polygons" title="Permalink"></a></h2><p>Needs to be written. Feel free to open a PR.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="reference/">Reference »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 15 November 2024 15:20">Friday 15 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/reference/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Reference · Clipper</title><meta name="title" content="Reference · Clipper"/><meta property="og:title" content="Reference · Clipper"/><meta property="twitter:title" content="Reference · Clipper"/><meta name="description" content="Documentation for Clipper."/><meta property="og:description" content="Documentation for Clipper."/><meta property="twitter:description" content="Documentation for Clipper."/><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../search_index.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">Clipper</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>Reference</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Reference</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaGeometry/Clipper.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaGeometry/Clipper.jl/blob/master/docs/src/reference.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Public-functions"><a class="docs-heading-anchor" href="#Public-functions">Public functions</a><a id="Public-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Public-functions" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clipper.IntPoint-Tuple{Union{Float16, Float32, Float64}, Union{Float16, Float32, Float64}, Int64, Int64}" href="#Clipper.IntPoint-Tuple{Union{Float16, Float32, Float64}, Union{Float16, Float32, Float64}, Int64, Int64}"><code>Clipper.IntPoint</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">IntPoint(x, y)</code></pre><p>Create an IntPoint from integer values.</p><pre><code class="nohighlight hljs">IntPoint(x, y, magnitude, precision)</code></pre><p>Create an IntPoint from floating point values with the given number of digits of precision. magnitude = number of digits above zero (90 =&gt; 2, 9 =&gt; 1, 0.9 =&gt; 0, 0.09 =&gt; -1) sigdigits = number of digits to preserve (94.3856 with 4 =&gt; 94.39)</p><pre><code class="language-julia hljs">a = IntPoint(5.483, 55.8739, 2, 4) # [548, 5587]
b,c = tofloat(a, 2, 4) # 5.48, 55.87</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeometry/Clipper.jl/blob/ae2fd7fea4c53dac8f5170855258de1d1abf7aa1/src/Clipper.jl#L29-L44">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clipper.tofloat-Tuple{IntPoint, Int64, Int64}" href="#Clipper.tofloat-Tuple{IntPoint, Int64, Int64}"><code>Clipper.tofloat</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tofloat(intpoint, magnitude, precision)</code></pre><p>Restore an IntPoint to floating point values using the specified magnitude and precision. magnitude = number of digits to be above zero (90 =&gt; 2, 9 =&gt; 1, 0.9 =&gt; 0, 0.09 =&gt; -1) sigdigits = number of digits that were preserved (94.3856 with 4 =&gt; 94.39)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeometry/Clipper.jl/blob/ae2fd7fea4c53dac8f5170855258de1d1abf7aa1/src/Clipper.jl#L53-L59">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 15 November 2024 14:33">Friday 15 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
b,c = tofloat(a, 2, 4) # 5.48, 55.87</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeometry/Clipper.jl/blob/506704e8464cebbf221e56239fe446641a959770/src/Clipper.jl#L29-L44">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Clipper.tofloat-Tuple{IntPoint, Int64, Int64}" href="#Clipper.tofloat-Tuple{IntPoint, Int64, Int64}"><code>Clipper.tofloat</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">tofloat(intpoint, magnitude, precision)</code></pre><p>Restore an IntPoint to floating point values using the specified magnitude and precision. magnitude = number of digits to be above zero (90 =&gt; 2, 9 =&gt; 1, 0.9 =&gt; 0, 0.09 =&gt; -1) sigdigits = number of digits that were preserved (94.3856 with 4 =&gt; 94.39)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeometry/Clipper.jl/blob/506704e8464cebbf221e56239fe446641a959770/src/Clipper.jl#L53-L59">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.8.0 on <span class="colophon-date" title="Friday 15 November 2024 15:20">Friday 15 November 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 comments on commit 7262305

Please sign in to comment.