<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Bounding Boxes · GeometryBasics.jl</title><meta name="title" content="Bounding Boxes · GeometryBasics.jl"/><meta property="og:title" content="Bounding Boxes · GeometryBasics.jl"/><meta property="twitter:title" content="Bounding Boxes · GeometryBasics.jl"/><meta name="description" content="Documentation for GeometryBasics.jl."/><meta property="og:description" content="Documentation for GeometryBasics.jl."/><meta property="twitter:description" content="Documentation for GeometryBasics.jl."/><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="../">GeometryBasics.jl</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="../">GeometryBasics.jl</a></li><li><a class="tocitem" href="../primitives/">Primitives</a></li><li><a class="tocitem" href="../polygons/">Polygons</a></li><li><a class="tocitem" href="../meshes/">Meshes</a></li><li><a class="tocitem" href="../decomposition/">Decomposition</a></li><li class="is-active"><a class="tocitem" href>Bounding Boxes</a><ul class="internal"><li><a class="tocitem" href="#Extending"><span>Extending</span></a></li></ul></li><li><a class="tocitem" href="../static_array_types/">Point, Vec and Mat</a></li><li><a class="tocitem" href="../api/">API 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>Bounding Boxes</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Bounding Boxes</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaGeometry/GeometryBasics.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/GeometryBasics.jl/blob/master/docs/src/boundingboxes.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="Bounding-Boxes"><a class="docs-heading-anchor" href="#Bounding-Boxes">Bounding Boxes</a><a id="Bounding-Boxes-1"></a><a class="docs-heading-anchor-permalink" href="#Bounding-Boxes" title="Permalink"></a></h1><p>You can generate an axis aligned bounding box for any <code>AbstractGeometry</code> by calling <code>Rect(geom)</code>. Depending on the object this will either rely on <code>coordinates(geom)</code> or a specialized method. You can also create a bounding box of set dimension or type by adding the related parameters.</p><pre><code class="language-julia-repl hljs" style="display:block;">julia> using GeometryBasics</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia> s = Circle(Point2f(0), 1f0)</code><code class="nohighlight hljs ansi" style="display:block;">Circle{Float32}(Float32[0.0, 0.0], 1.0f0)</code><br/><code class="language-julia-repl hljs" style="display:block;">julia> Rect(s) # specialized, exact bounding box</code><code class="nohighlight hljs ansi" style="display:block;">HyperRectangle{2, Float32}(Float32[-1.0, -1.0], Float32[2.0, 2.0])</code><br/><code class="language-julia-repl hljs" style="display:block;">julia> Rect3(s)</code><code class="nohighlight hljs ansi" style="display:block;">HyperRectangle{3, Float32}(Float32[-1.0, -1.0, 0.0], Float32[2.0, 2.0, 0.0])</code><br/><code class="language-julia-repl hljs" style="display:block;">julia> Rect3d(s)</code><code class="nohighlight hljs ansi" style="display:block;">HyperRectangle{3, Float64}([-1.0, -1.0, 0.0], [2.0, 2.0, 0.0])</code><br/><code class="language-julia-repl hljs" style="display:block;">julia> RectT{Float64}(s)</code><code class="nohighlight hljs ansi" style="display:block;">HyperRectangle{2, Float64}([-1.0, -1.0], [2.0, 2.0])</code><br/><code class="language-julia-repl hljs" style="display:block;">julia> Rect(GeometryBasics.mesh(s)) # using generated coordinates in mesh</code><code class="nohighlight hljs ansi" style="display:block;">HyperRectangle{2, Float32}(Float32[-0.99875695, -0.99968916], Float32[1.9987569, 1.9993783])</code></pre><h2 id="Extending"><a class="docs-heading-anchor" href="#Extending">Extending</a><a id="Extending-1"></a><a class="docs-heading-anchor-permalink" href="#Extending" title="Permalink"></a></h2><p>If you want to add a specialized bounding box method you should implement <code>Rect{N, T}(geom) = ...</code>. All other methods funnel into that one, defaulting to the same <code>N, T</code> that the given <code>AbstractGeometry{N, T}</code> has. GeometryBasics allows the user given dimension <code>N</code> to be smaller or equal to that of the geometry. This is checked with <code>GeometryBasics.bbox_dim_check(user_dim, geom_dim)</code> which you may reuse.</p><pre><code class="language-julia hljs">function Rect{N, T}(a::HyperSphere{N2}) where {N, N2, T}
0 commit comments