Files
Misaki.HighPerformance/docfx/_site/api/Misaki.HighPerformance.Mathematics.Geometry.AABB.html

1056 lines
37 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Struct AABB | Misaki.HighPerformance </title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Struct AABB | Misaki.HighPerformance ">
<meta name="description" content="Represents an axis-aligned bounding box (AABB) defined by minimum and maximum points in 3D space.">
<link rel="icon" href="../favicon.ico">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:rel" content="../">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;">
<meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
<meta name="loc:downloadPdf" content="Download PDF">
<script type="module" src="./../public/docfx.min.js"></script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
</head>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../logo.svg" alt="Misaki.HighPerformance">
Misaki.HighPerformance
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
<form class="search" role="search" id="search">
<i class="bi bi-search"></i>
<input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search">
</form>
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB">
<h1 id="Misaki_HighPerformance_Mathematics_Geometry_AABB" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB" class="text-break">
Struct AABB
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Misaki.html">Misaki</a>.<a class="xref" href="Misaki.HighPerformance.html">HighPerformance</a>.<a class="xref" href="Misaki.HighPerformance.Mathematics.html">Mathematics</a>.<a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.html">Geometry</a></dd></dl>
<dl><dt>Assembly</dt><dd>Misaki.HighPerformance.Mathematics.dll</dd></dl>
</div>
<div class="markdown summary"><p>Represents an axis-aligned bounding box (AABB) defined by minimum and maximum points in 3D space.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct AABB : IEquatable&lt;AABB&gt;</code></pre>
</div>
<dl class="typelist implements">
<dt>Implements</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a>&lt;<a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a>&gt;</div>
</dd>
</dl>
<dl class="typelist inheritedMembers">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
</dd></dl>
<h2 class="section" id="constructors">Constructors
</h2>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB__ctor_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.#ctor*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB__ctor_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.#ctor(Misaki.HighPerformance.Mathematics.float3,Misaki.HighPerformance.Mathematics.float3)">
AABB(float3, float3)
</h3>
<div class="markdown level1 summary"><p>Constructs the AABB with the given minimum and maximum.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public AABB(float3 min, float3 max)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>min</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Minimum point inside AABB.</p>
</dd>
<dt><code>max</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Maximum point inside AABB.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB__ctor_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>If you have a center and extents, you can call <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_">CreateFromCenterAndExtents(float3, float3)</a> or <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndHalfExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_">CreateFromCenterAndHalfExtents(float3, float3)</a>
to create the AABB.</p>
</div>
<h2 class="section" id="properties">Properties
</h2>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Center_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Center*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Center" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Center">
Center
</h3>
<div class="markdown level1 summary"><p>Computes the center of the AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly float3 Center { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd></dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Extents_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Extents*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Extents" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Extents">
Extents
</h3>
<div class="markdown level1 summary"><p>Computes the extents of the AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly float3 Extents { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Extents_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Extents is the componentwise distance between min and max.</p>
</div>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_HalfExtents_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.HalfExtents*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_HalfExtents" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.HalfExtents">
HalfExtents
</h3>
<div class="markdown level1 summary"><p>Computes the half extents of the AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly float3 HalfExtents { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_HalfExtents_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>HalfExtents is half of the componentwise distance between min and max. Subtracting HalfExtents from Center
gives Min and adding HalfExtents to Center gives Max.</p>
</div>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_IsValid_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.IsValid*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_IsValid" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.IsValid">
IsValid
</h3>
<div class="markdown level1 summary"><p>Check if the AABB is valid.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly bool IsValid { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>True if <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Min">Min</a> is componentwise less than or equal to <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Max">Max</a>.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_IsValid_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>An AABB is considered valid if <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Min">Min</a> is componentwise less than or equal to <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Max">Max</a>.</p>
</div>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Max_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Max*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Max" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Max">
Max
</h3>
<div class="markdown level1 summary"><p>The maximum point contained by the AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float3 Max { readonly get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Max_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>If any component of <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Max">Max</a> is less than <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Min">Min</a> then this AABB is invalid.</p>
</div>
<dl class="typelist seealso">
<dt>See Also</dt>
<dd>
<div><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_IsValid">IsValid</a></div>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Min_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Min*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Min" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Min">
Min
</h3>
<div class="markdown level1 summary"><p>The minimum point contained by the AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public float3 Min { readonly get; set; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd></dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Min_remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>If any component of <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Min">Min</a> is greater than <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Max">Max</a> then this AABB is invalid.</p>
</div>
<dl class="typelist seealso">
<dt>See Also</dt>
<dd>
<div><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_IsValid">IsValid</a></div>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_SurfaceArea_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.SurfaceArea*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_SurfaceArea" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.SurfaceArea">
SurfaceArea
</h3>
<div class="markdown level1 summary"><p>Computes the surface area for this axis aligned bounding box.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly float SurfaceArea { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt>
<dd></dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Zero_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Zero*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Zero" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Zero">
Zero
</h3>
<div class="markdown level1 summary"><p>Creates a new AABB with zero extents, centered at the origin.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static AABB Zero { get; }</code></pre>
</div>
<h4 class="section">Property Value</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd></dd>
</dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Contains_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Contains*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Contains_Misaki_HighPerformance_Mathematics_Geometry_AABB_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Contains(Misaki.HighPerformance.Mathematics.Geometry.AABB)">
Contains(AABB)
</h3>
<div class="markdown level1 summary"><p>Tests if the input AABB is contained entirely by this AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly bool Contains(AABB aabb)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>aabb</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd><p>AABB to test.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>True if input AABB is contained entirely by this AABB.</p>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Contains_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Contains*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Contains_Misaki_HighPerformance_Mathematics_float3_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Contains(Misaki.HighPerformance.Mathematics.float3)">
Contains(float3)
</h3>
<div class="markdown level1 summary"><p>Tests if the input point is contained by the AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly bool Contains(float3 point)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>point</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Point to test.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>True if AABB contains the input point.</p>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndExtents_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.CreateFromCenterAndExtents*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.CreateFromCenterAndExtents(Misaki.HighPerformance.Mathematics.float3,Misaki.HighPerformance.Mathematics.float3)">
CreateFromCenterAndExtents(float3, float3)
</h3>
<div class="markdown level1 summary"><p>Creates the AABB from a center and extents.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static AABB CreateFromCenterAndExtents(float3 center, float3 extents)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>center</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Center of AABB.</p>
</dd>
<dt><code>extents</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Full extents of AABB.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd><p>AABB created from inputs.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This function takes full extents. It is the distance between <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Min">Min</a> and <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Max">Max</a>.
If you have half extents, you can call <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndHalfExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_">CreateFromCenterAndHalfExtents(float3, float3)</a>.</p>
</div>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndHalfExtents_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.CreateFromCenterAndHalfExtents*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndHalfExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.CreateFromCenterAndHalfExtents(Misaki.HighPerformance.Mathematics.float3,Misaki.HighPerformance.Mathematics.float3)">
CreateFromCenterAndHalfExtents(float3, float3)
</h3>
<div class="markdown level1 summary"><p>Creates the AABB from a center and half extents.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static AABB CreateFromCenterAndHalfExtents(float3 center, float3 halfExtents)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>center</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Center of AABB.</p>
</dd>
<dt><code>halfExtents</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Half extents of AABB.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd><p>AABB created from inputs.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndHalfExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>This function takes half extents. It is half the distance between <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Min">Min</a> and <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Max">Max</a>.
If you have full extents, you can call <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_CreateFromCenterAndExtents_Misaki_HighPerformance_Mathematics_float3_Misaki_HighPerformance_Mathematics_float3_">CreateFromCenterAndExtents(float3, float3)</a>.</p>
</div>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Encapsulate_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Encapsulate*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Encapsulate_Misaki_HighPerformance_Mathematics_Geometry_AABB_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Encapsulate(Misaki.HighPerformance.Mathematics.Geometry.AABB)">
Encapsulate(AABB)
</h3>
<div class="markdown level1 summary"><p>Encapsulates the given AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Encapsulate(AABB aabb)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>aabb</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd><p>AABB to encapsulate.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Encapsulate_Misaki_HighPerformance_Mathematics_Geometry_AABB__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Modifies this AABB so that it contains the given AABB. If the given AABB is already contained by this AABB,
then this AABB doesn't change.</p>
</div>
<dl class="typelist seealso">
<dt>See Also</dt>
<dd>
<div><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Contains_Misaki_HighPerformance_Mathematics_Geometry_AABB_">Contains(AABB)</a></div>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Encapsulate_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Encapsulate*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Encapsulate_Misaki_HighPerformance_Mathematics_float3_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Encapsulate(Misaki.HighPerformance.Mathematics.float3)">
Encapsulate(float3)
</h3>
<div class="markdown level1 summary"><p>Encapsulate the given point.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Encapsulate(float3 point)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>point</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.float3.html">float3</a></dt>
<dd><p>Point to encapsulate.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Encapsulate_Misaki_HighPerformance_Mathematics_float3__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Modifies this AABB so that it contains the given point. If the given point is already contained by this AABB,
then this AABB doesn't change.</p>
</div>
<dl class="typelist seealso">
<dt>See Also</dt>
<dd>
<div><a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html#Misaki_HighPerformance_Mathematics_Geometry_AABB_Contains_Misaki_HighPerformance_Mathematics_float3_">Contains(float3)</a></div>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Equals_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Equals*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Equals_Misaki_HighPerformance_Mathematics_Geometry_AABB_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Equals(Misaki.HighPerformance.Mathematics.Geometry.AABB)">
Equals(AABB)
</h3>
<div class="markdown level1 summary"><p>Indicates whether the current object is equal to another object of the same type.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly bool Equals(AABB other)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>other</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd><p>An object to compare with this object.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the current object is equal to the <code class="paramref">other</code> parameter; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Equals_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Equals*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Equals_System_Object_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Equals(System.Object)">
Equals(object?)
</h3>
<div class="markdown level1 summary"><p>Indicates whether this instance and a specified object are equal.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool Equals(object? obj)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
<dd><p>The object to compare with the current instance.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if <code class="paramref">obj</code> and this instance are the same type and represent the same value; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Expand_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Expand*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Expand_System_Single_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Expand(System.Single)">
Expand(float)
</h3>
<div class="markdown level1 summary"><p>Expands the AABB by the given signed distance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Expand(float signedDistance)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>signedDistance</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.single">float</a></dt>
<dd><p>Signed distance to expand the AABB with.</p>
</dd>
</dl>
<h4 class="section" id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Expand_System_Single__remarks">Remarks</h4>
<div class="markdown level1 remarks"><p>Positive distance expands the AABB while negative distance shrinks the AABB.</p>
</div>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_GetHashCode_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.GetHashCode*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_GetHashCode" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.GetHashCode">
GetHashCode()
</h3>
<div class="markdown level1 summary"><p>Returns the hash code for this instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override readonly int GetHashCode()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
<dd><p>A 32-bit signed integer that is the hash code for this instance.</p>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Overlaps_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Overlaps*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_Overlaps_Misaki_HighPerformance_Mathematics_Geometry_AABB_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.Overlaps(Misaki.HighPerformance.Mathematics.Geometry.AABB)">
Overlaps(AABB)
</h3>
<div class="markdown level1 summary"><p>Tests if the input AABB overlaps this AABB.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public readonly bool Overlaps(AABB aabb)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>aabb</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd><p>AABB to test.</p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd><p>True if input AABB overlaps with this AABB.</p>
</dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_ToString_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.ToString*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_ToString" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.ToString">
ToString()
</h3>
<div class="markdown level1 summary"><p>Returns the fully qualified type name of this instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override readonly string ToString()</code></pre>
</div>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd><p>The fully qualified type name.</p>
</dd>
</dl>
<h2 class="section" id="operators">Operators
</h2>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_op_Equality_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.op_Equality*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_op_Equality_Misaki_HighPerformance_Mathematics_Geometry_AABB_Misaki_HighPerformance_Mathematics_Geometry_AABB_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.op_Equality(Misaki.HighPerformance.Mathematics.Geometry.AABB,Misaki.HighPerformance.Mathematics.Geometry.AABB)">
operator ==(AABB, AABB)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator ==(AABB left, AABB right)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>left</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd></dd>
<dt><code>right</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
<a id="Misaki_HighPerformance_Mathematics_Geometry_AABB_op_Inequality_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.op_Inequality*"></a>
<h3 id="Misaki_HighPerformance_Mathematics_Geometry_AABB_op_Inequality_Misaki_HighPerformance_Mathematics_Geometry_AABB_Misaki_HighPerformance_Mathematics_Geometry_AABB_" data-uid="Misaki.HighPerformance.Mathematics.Geometry.AABB.op_Inequality(Misaki.HighPerformance.Mathematics.Geometry.AABB,Misaki.HighPerformance.Mathematics.Geometry.AABB)">
operator !=(AABB, AABB)
</h3>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static bool operator !=(AABB left, AABB right)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>left</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd></dd>
<dt><code>right</code> <a class="xref" href="Misaki.HighPerformance.Mathematics.Geometry.AABB.html">AABB</a></dt>
<dd></dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
<dd></dd>
</dl>
</article>
<div class="contribution d-print-none">
</div>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<div class="container-xxl search-results" id="search-results"></div>
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>