| | | 1 | | //======================================================================= |
| | | 2 | | // BoundVolume.cs |
| | | 3 | | //======================================================================= |
| | | 4 | | // MIT License, Copyright (c) 2024–present David Oravsky (mrdav30) |
| | | 5 | | // See LICENSE file in the project root for full license information. |
| | | 6 | | //======================================================================= |
| | | 7 | | |
| | | 8 | | using System; |
| | | 9 | | using System.Numerics; |
| | | 10 | | using System.Runtime.CompilerServices; |
| | | 11 | | |
| | | 12 | | namespace SwiftCollections.Query; |
| | | 13 | | |
| | | 14 | | /// <summary> |
| | | 15 | | /// Represents an axis-aligned bounding box (AABB) in 3D space. |
| | | 16 | | /// </summary> |
| | | 17 | | public struct BoundVolume : IBoundVolume<BoundVolume>, IEquatable<BoundVolume> |
| | | 18 | | { |
| | | 19 | | /// <summary> |
| | | 20 | | /// The minimum point of the bounding volume. |
| | | 21 | | /// </summary> |
| | | 22 | | private Vector3 _min; |
| | | 23 | | |
| | | 24 | | /// <summary> |
| | | 25 | | /// The maximum point of the bounding volume. |
| | | 26 | | /// </summary> |
| | | 27 | | private Vector3 _max; |
| | | 28 | | |
| | | 29 | | /// <summary> |
| | | 30 | | /// The center of the bounding volume as the midpoint of the minimum and maximum points. |
| | | 31 | | /// </summary> |
| | | 32 | | private Vector3 _center; |
| | | 33 | | |
| | | 34 | | /// <summary> |
| | | 35 | | /// The size of the bounding volume as the difference between the maximum and minimum points. |
| | | 36 | | /// </summary> |
| | | 37 | | private Vector3 _size; |
| | | 38 | | |
| | | 39 | | /// <summary> |
| | | 40 | | /// The volume of the bounding box, calculated as the product of its dimensions. |
| | | 41 | | /// </summary> |
| | | 42 | | private double _volume; |
| | | 43 | | |
| | | 44 | | /// <summary> |
| | | 45 | | /// Marks the bounding volume as dirty, indicating its properties need recalculation. |
| | | 46 | | /// </summary> |
| | | 47 | | private bool _isDirty; |
| | | 48 | | |
| | | 49 | | /// <summary> |
| | | 50 | | /// Initializes a new instance of the <see cref="BoundVolume"/> struct with the specified minimum and maximum points |
| | | 51 | | /// </summary> |
| | | 52 | | /// <param name="min">The minimum point of the bounding volume.</param> |
| | | 53 | | /// <param name="max">The maximum point of the bounding volume.</param> |
| | | 54 | | public BoundVolume(Vector3 min, Vector3 max) |
| | | 55 | | { |
| | 417645 | 56 | | _min = min; |
| | 417645 | 57 | | _max = max; |
| | | 58 | | |
| | 417645 | 59 | | _isDirty = true; |
| | 417645 | 60 | | _center = default; |
| | 417645 | 61 | | _size = default; |
| | 417645 | 62 | | _volume = default; |
| | 417645 | 63 | | } |
| | | 64 | | |
| | | 65 | | /// <inheritdoc cref="_min"/> |
| | 2803817 | 66 | | public readonly Vector3 Min => _min; |
| | | 67 | | |
| | | 68 | | /// <inheritdoc cref="_max"/> |
| | 2803757 | 69 | | public readonly Vector3 Max => _max; |
| | | 70 | | |
| | | 71 | | /// <inheritdoc cref="_center"/> |
| | | 72 | | public Vector3 Center |
| | | 73 | | { |
| | | 74 | | get |
| | | 75 | | { |
| | 6 | 76 | | if (_isDirty) |
| | 3 | 77 | | RecalculateMeta(); |
| | 6 | 78 | | return _center; |
| | | 79 | | } |
| | | 80 | | } |
| | | 81 | | |
| | | 82 | | /// <inheritdoc cref="_size"/> |
| | | 83 | | public Vector3 Size |
| | | 84 | | { |
| | | 85 | | get |
| | | 86 | | { |
| | 9 | 87 | | if (_isDirty) |
| | 8 | 88 | | RecalculateMeta(); |
| | 9 | 89 | | return _size; |
| | | 90 | | } |
| | | 91 | | } |
| | | 92 | | |
| | | 93 | | /// <inheritdoc cref="_volume"/> |
| | | 94 | | public double Volume |
| | | 95 | | { |
| | | 96 | | get |
| | | 97 | | { |
| | 251948 | 98 | | if (_isDirty) |
| | 251947 | 99 | | RecalculateMeta(); |
| | 251948 | 100 | | return _volume; |
| | | 101 | | } |
| | | 102 | | } |
| | | 103 | | |
| | | 104 | | /// <summary> |
| | | 105 | | /// Forces recalculation of the bounding volume's metadata, such as center, size, and volume. |
| | | 106 | | /// </summary> |
| | | 107 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 108 | | private void RecalculateMeta() |
| | | 109 | | { |
| | 251958 | 110 | | _center = (_min + _max) / 2; |
| | 251958 | 111 | | _size = _max - _min; |
| | 251958 | 112 | | _volume = _size.X * _size.Y * _size.Z; |
| | 251958 | 113 | | _isDirty = false; |
| | 251958 | 114 | | } |
| | | 115 | | |
| | | 116 | | /// <inheritdoc /> |
| | | 117 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 118 | | public readonly BoundVolume Union(BoundVolume other) |
| | | 119 | | { |
| | 404258 | 120 | | return new BoundVolume( |
| | 404258 | 121 | | new Vector3(Math.Min(Min.X, other.Min.X), Math.Min(Min.Y, other.Min.Y), Math.Min(Min.Z, other.Min.Z)), |
| | 404258 | 122 | | new Vector3(Math.Max(Max.X, other.Max.X), Math.Max(Max.Y, other.Max.Y), Math.Max(Max.Z, other.Max.Z)) |
| | 404258 | 123 | | ); |
| | | 124 | | } |
| | | 125 | | |
| | | 126 | | /// <inheritdoc /> |
| | | 127 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 128 | | public readonly bool Intersects(BoundVolume other) |
| | | 129 | | { |
| | 21145 | 130 | | return !(Min.X > other.Max.X || Max.X < other.Min.X || |
| | 21145 | 131 | | Min.Y > other.Max.Y || Max.Y < other.Min.Y || |
| | 21145 | 132 | | Min.Z > other.Max.Z || Max.Z < other.Min.Z); |
| | | 133 | | } |
| | | 134 | | |
| | | 135 | | /// <inheritdoc /> |
| | | 136 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 137 | | public readonly long GetCost(BoundVolume other) |
| | | 138 | | { |
| | 251947 | 139 | | BoundVolume union = Union(other); |
| | 251947 | 140 | | Vector3 size = Max - Min; |
| | 251947 | 141 | | double volume = size.X * size.Y * size.Z; |
| | 251947 | 142 | | double delta = union.Volume - volume; |
| | 251947 | 143 | | return delta >= (double)long.MaxValue ? long.MaxValue : (long)delta; |
| | | 144 | | } |
| | | 145 | | |
| | | 146 | | /// <inheritdoc /> |
| | | 147 | | [MethodImpl(MethodImplOptions.AggressiveInlining)] |
| | | 148 | | public readonly bool BoundsEquals(BoundVolume other) |
| | | 149 | | { |
| | 19 | 150 | | return Min.Equals(other.Min) && Max.Equals(other.Max); |
| | | 151 | | } |
| | | 152 | | |
| | | 153 | | /// <inheritdoc /> |
| | 5 | 154 | | public readonly bool Equals(BoundVolume other) => BoundsEquals(other); |
| | | 155 | | |
| | | 156 | | /// <inheritdoc /> |
| | 4 | 157 | | public override readonly bool Equals(object? obj) => obj is BoundVolume other && BoundsEquals(other); |
| | | 158 | | |
| | | 159 | | /// <summary> |
| | | 160 | | /// Determines whether two BoundVolume instances are equal. |
| | | 161 | | /// </summary> |
| | 4 | 162 | | public static bool operator ==(BoundVolume left, BoundVolume right) => left.Equals(right); |
| | | 163 | | |
| | | 164 | | /// <summary> |
| | | 165 | | /// Determines whether two BoundVolume instances are not equal. |
| | | 166 | | /// </summary> |
| | 2 | 167 | | public static bool operator !=(BoundVolume left, BoundVolume right) => !(left == right); |
| | | 168 | | |
| | | 169 | | /// <inheritdoc /> |
| | 2 | 170 | | public override readonly int GetHashCode() => HashCode.Combine(Min, Max); |
| | | 171 | | |
| | | 172 | | /// <summary> |
| | | 173 | | /// Returns a string that represents the current object, including the minimum and maximum values. |
| | | 174 | | /// </summary> |
| | | 175 | | /// <returns>A string in the format "Min: {Min}, Max: {Max}" that displays the minimum and maximum values of the obj |
| | 1 | 176 | | public override readonly string ToString() => $"Min: {Min}, Max: {Max}"; |
| | | 177 | | } |