| | | 1 | | //======================================================================= |
| | | 2 | | // ScanCell.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.Collections.Generic; |
| | | 10 | | using System.Threading; |
| | | 11 | | using FixedMathSharp; |
| | | 12 | | using GridForge.Spatial; |
| | | 13 | | using SwiftCollections; |
| | | 14 | | using SwiftCollections.Utility; |
| | | 15 | | |
| | | 16 | | namespace GridForge.Grids; |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Stores one occupant registration and the generation that owns its bucket slot. |
| | | 20 | | /// </summary> |
| | | 21 | | internal readonly struct OccupantEntry |
| | | 22 | | { |
| | | 23 | | public readonly IVoxelOccupant Occupant; |
| | | 24 | | public readonly long Generation; |
| | | 25 | | |
| | | 26 | | public OccupantEntry(IVoxelOccupant occupant, long generation) |
| | | 27 | | { |
| | | 28 | | Occupant = occupant; |
| | | 29 | | Generation = generation; |
| | | 30 | | } |
| | | 31 | | } |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Represents a spatial partition within a grid, managing occupants at a finer granularity than grid voxels. |
| | | 35 | | /// Handles efficient tracking, retrieval, and removal of occupants within a designated scan cell area. |
| | | 36 | | /// </summary> |
| | | 37 | | public class ScanCell |
| | | 38 | | { |
| | | 39 | | #region Properties |
| | | 40 | | |
| | | 41 | | /// <summary> |
| | | 42 | | /// The world-local index of the grid this scan cell belongs to. |
| | | 43 | | /// </summary> |
| | | 44 | | public ushort GridIndex { get; private set; } |
| | | 45 | | |
| | | 46 | | /// <summary> |
| | | 47 | | /// The world that owns this scan cell through its parent grid. |
| | | 48 | | /// </summary> |
| | | 49 | | public GridWorld? World { get; private set; } |
| | | 50 | | |
| | | 51 | | /// <summary> |
| | | 52 | | /// A unique identifier for this scan cell in the grid. |
| | | 53 | | /// </summary> |
| | | 54 | | public int CellKey { get; private set; } |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Maps a <see cref="Voxel.WorldIndex"/> to a bucket of associated <see cref="IVoxelOccupant"/> instances. |
| | | 58 | | /// </summary> |
| | | 59 | | private SwiftDictionary<WorldVoxelIndex, SwiftBucket<OccupantEntry>>? _voxelOccupants; |
| | | 60 | | |
| | | 61 | | private object? _occupantSyncRoot; |
| | | 62 | | |
| | | 63 | | private static long s_occupantGenerationCounter; |
| | | 64 | | |
| | | 65 | | /// <summary> |
| | | 66 | | /// The total number of occupants in this scan cell. |
| | | 67 | | /// </summary> |
| | | 68 | | public int CellOccupantCount { get; private set; } |
| | | 69 | | |
| | | 70 | | /// <summary> |
| | | 71 | | /// Indicates whether this scan cell is currently allocated in the grid. |
| | | 72 | | /// </summary> |
| | | 73 | | public bool IsAllocated { get; private set; } |
| | | 74 | | |
| | | 75 | | /// <summary> |
| | | 76 | | /// Determines whether this scan cell is occupied by any occupants. |
| | | 77 | | /// A scan cell is only considered occupied if it is allocated and contains at least one occupant. |
| | | 78 | | /// </summary> |
| | 2493 | 79 | | public bool IsOccupied => IsAllocated && CellOccupantCount > 0; |
| | | 80 | | |
| | | 81 | | #endregion |
| | | 82 | | |
| | | 83 | | #region Initialization & Reset |
| | | 84 | | |
| | | 85 | | /// <summary> |
| | | 86 | | /// Initializes the scan cell with its owning grid and unique cell key. |
| | | 87 | | /// </summary> |
| | | 88 | | internal void Initialize(VoxelGrid grid, int cellKey) |
| | | 89 | | { |
| | 2123 | 90 | | World = grid.World; |
| | 2123 | 91 | | GridIndex = grid.GridIndex; |
| | 2123 | 92 | | CellKey = cellKey; |
| | 2123 | 93 | | IsAllocated = true; |
| | 2123 | 94 | | Volatile.Write(ref _occupantSyncRoot, grid.OccupantSyncRoot); |
| | 2123 | 95 | | } |
| | | 96 | | |
| | | 97 | | /// <summary> |
| | | 98 | | /// Resets the scan cell, clearing all occupants and returning memory to object pools. |
| | | 99 | | /// This effectively marks the scan cell as deallocated and removes all references. |
| | | 100 | | /// </summary> |
| | | 101 | | internal void Reset() |
| | | 102 | | { |
| | 2124 | 103 | | object? syncRoot = Interlocked.Exchange(ref _occupantSyncRoot, null); |
| | 2124 | 104 | | if (syncRoot == null) |
| | 1 | 105 | | return; |
| | | 106 | | |
| | 2123 | 107 | | lock (syncRoot) |
| | | 108 | | { |
| | 2123 | 109 | | if (_voxelOccupants != null) |
| | | 110 | | { |
| | 518 | 111 | | foreach (var kvp in _voxelOccupants) |
| | | 112 | | { |
| | 188 | 113 | | SwiftBucket<OccupantEntry> bucket = kvp.Value; |
| | 1402 | 114 | | foreach (OccupantEntry entry in bucket) |
| | 513 | 115 | | GridOccupantManager.ForgetTrackedOccupancy(World, entry.Occupant, kvp.Key); |
| | | 116 | | |
| | 188 | 117 | | Pools.VoxelOccupantBucketPool.Release(bucket); |
| | | 118 | | } |
| | | 119 | | |
| | 71 | 120 | | Pools.VoxelOccupantDictionaryPool.Release(_voxelOccupants); |
| | 71 | 121 | | _voxelOccupants = null; |
| | | 122 | | } |
| | | 123 | | |
| | 2123 | 124 | | CellOccupantCount = 0; |
| | | 125 | | |
| | 2123 | 126 | | World = null; |
| | 2123 | 127 | | GridIndex = ushort.MaxValue; |
| | 2123 | 128 | | CellKey = byte.MaxValue; |
| | | 129 | | |
| | 2123 | 130 | | IsAllocated = false; |
| | 2123 | 131 | | } |
| | 2123 | 132 | | } |
| | | 133 | | |
| | | 134 | | #endregion |
| | | 135 | | |
| | | 136 | | #region Occupant Management |
| | | 137 | | |
| | | 138 | | /// <summary> |
| | | 139 | | /// Adds an occupant to this scan cell and tracks its presence. |
| | | 140 | | /// </summary> |
| | | 141 | | /// <param name="index">The global index of the voxel where the occupant resides.</param> |
| | | 142 | | /// <param name="occupant">The occupant instance to add.</param> |
| | | 143 | | /// <returns>A generation-aware ticket for the occupant's bucket slot.</returns> |
| | | 144 | | internal OccupantTicket AddOccupant(WorldVoxelIndex index, IVoxelOccupant occupant) |
| | | 145 | | { |
| | 674 | 146 | | long generation = RuntimeIdentityAllocator.Allocate(ref s_occupantGenerationCounter); |
| | 673 | 147 | | _voxelOccupants ??= Pools.VoxelOccupantDictionaryPool.Rent(); |
| | 673 | 148 | | if (!_voxelOccupants.TryGetValue(index, out SwiftBucket<OccupantEntry> bucket)) |
| | | 149 | | { |
| | 212 | 150 | | bucket = Pools.VoxelOccupantBucketPool.Rent(); |
| | 212 | 151 | | _voxelOccupants[index] = bucket; |
| | | 152 | | } |
| | | 153 | | |
| | 673 | 154 | | int slot = bucket.Add(new OccupantEntry(occupant, generation)); |
| | 673 | 155 | | CellOccupantCount++; |
| | 673 | 156 | | return new OccupantTicket(slot, generation); |
| | | 157 | | } |
| | | 158 | | |
| | | 159 | | /// <summary> |
| | | 160 | | /// Removes an occupant from this scan cell. |
| | | 161 | | /// </summary> |
| | | 162 | | /// <param name="index">The global index of the voxel the occupant was assigned to.</param> |
| | | 163 | | /// <param name="ticket">The ticket assigned to the occupant instance from this scancell.</param> |
| | | 164 | | /// <returns>True if the occupant was successfully removed; otherwise, false.</returns> |
| | | 165 | | internal bool TryRemoveOccupant( |
| | | 166 | | WorldVoxelIndex index, |
| | | 167 | | OccupantTicket ticket) |
| | | 168 | | { |
| | 165 | 169 | | if (!IsOccupied) |
| | 1 | 170 | | return false; |
| | | 171 | | |
| | 164 | 172 | | if (!_voxelOccupants!.TryGetValue(index, out var bucket)) |
| | 1 | 173 | | return false; |
| | | 174 | | |
| | 163 | 175 | | if (!ticket.IsValid |
| | 163 | 176 | | || !bucket.TryGetValue(ticket.Slot, out OccupantEntry entry) |
| | 163 | 177 | | || entry.Generation != ticket.Generation |
| | 163 | 178 | | || !bucket.TryRemoveAt(ticket.Slot)) |
| | | 179 | | { |
| | 3 | 180 | | return false; |
| | | 181 | | } |
| | | 182 | | |
| | | 183 | | // If the occupant was the last in its bucket, remove the entire bucket |
| | 160 | 184 | | if (bucket.Count == 0) |
| | | 185 | | { |
| | 24 | 186 | | _voxelOccupants.Remove(index); |
| | 24 | 187 | | Pools.VoxelOccupantBucketPool.Release(bucket); |
| | | 188 | | } |
| | | 189 | | |
| | 160 | 190 | | CellOccupantCount--; |
| | | 191 | | |
| | 160 | 192 | | return true; |
| | | 193 | | } |
| | | 194 | | |
| | | 195 | | #endregion |
| | | 196 | | |
| | | 197 | | #region Occupant Retrieval |
| | | 198 | | |
| | | 199 | | /// <summary> |
| | | 200 | | /// Retrieves all occupants associated with this ScanCell. |
| | | 201 | | /// </summary> |
| | | 202 | | /// <returns>An enumerable of occupants within this scan cell.</returns> |
| | | 203 | | public IEnumerable<IVoxelOccupant> GetOccupants() |
| | | 204 | | { |
| | 10 | 205 | | if (_voxelOccupants == null) |
| | 2 | 206 | | yield break; |
| | | 207 | | |
| | 30 | 208 | | foreach (SwiftBucket<OccupantEntry> bucket in _voxelOccupants.Values) |
| | | 209 | | { |
| | 162 | 210 | | foreach (OccupantEntry entry in bucket) |
| | 74 | 211 | | yield return entry.Occupant; |
| | | 212 | | } |
| | 6 | 213 | | } |
| | | 214 | | |
| | | 215 | | /// <summary> |
| | | 216 | | /// Retrieves occupants whose group Ids match a given condition. |
| | | 217 | | /// </summary> |
| | | 218 | | public IEnumerable<IVoxelOccupant> GetConditionalOccupants( |
| | | 219 | | Func<IVoxelOccupant, bool>? occupantCondition = null, |
| | | 220 | | Func<byte, bool>? groupConditional = null) |
| | | 221 | | { |
| | 9 | 222 | | if (_voxelOccupants == null) |
| | 1 | 223 | | yield break; |
| | | 224 | | |
| | | 225 | | // Loop through each voxel's bucket and filter by the cluster condition |
| | 31 | 226 | | foreach (var bucket in _voxelOccupants.Values) |
| | | 227 | | { |
| | 43 | 228 | | foreach (OccupantEntry entry in bucket) |
| | | 229 | | { |
| | 14 | 230 | | IVoxelOccupant occupant = entry.Occupant; |
| | 14 | 231 | | if (occupantCondition != null && !occupantCondition(occupant)) |
| | | 232 | | continue; |
| | | 233 | | |
| | 11 | 234 | | if (groupConditional != null && !groupConditional(occupant.OccupantGroupId)) |
| | | 235 | | continue; |
| | | 236 | | |
| | 7 | 237 | | yield return occupant; |
| | | 238 | | } |
| | | 239 | | } |
| | 7 | 240 | | } |
| | | 241 | | |
| | | 242 | | /// <summary> |
| | | 243 | | /// Appends occupants within the squared radius to caller-owned storage without allocating an iterator. |
| | | 244 | | /// </summary> |
| | | 245 | | internal void AddOccupantsWithinRadiusTo( |
| | | 246 | | SwiftList<IVoxelOccupant> results, |
| | | 247 | | Vector3d position, |
| | | 248 | | Fixed64 squaredRadius, |
| | | 249 | | Func<IVoxelOccupant, bool>? occupantCondition = null, |
| | | 250 | | Func<byte, bool>? groupCondition = null) |
| | | 251 | | { |
| | 273 | 252 | | if (_voxelOccupants == null) |
| | 1 | 253 | | return; |
| | | 254 | | |
| | 33484 | 255 | | foreach (var kvp in _voxelOccupants) |
| | | 256 | | { |
| | 16470 | 257 | | SwiftBucket<OccupantEntry> bucket = kvp.Value; |
| | 65882 | 258 | | foreach (OccupantEntry entry in bucket) |
| | | 259 | | { |
| | 16471 | 260 | | IVoxelOccupant occupant = entry.Occupant; |
| | 16471 | 261 | | if (OccupantPassesFilters(occupant, occupantCondition, groupCondition) |
| | 16471 | 262 | | && IsWithinSquaredRadius(occupant, position, squaredRadius)) |
| | | 263 | | { |
| | 16461 | 264 | | results.Add(occupant); |
| | | 265 | | } |
| | | 266 | | } |
| | | 267 | | } |
| | 272 | 268 | | } |
| | | 269 | | |
| | | 270 | | /// <summary> |
| | | 271 | | /// Appends occupants within the XZ squared radius on the selected local Y voxel layer. |
| | | 272 | | /// </summary> |
| | | 273 | | internal void AddOccupantsWithinRadius2dTo( |
| | | 274 | | SwiftList<IVoxelOccupant> results, |
| | | 275 | | Vector3d position, |
| | | 276 | | int localLayerY, |
| | | 277 | | Fixed64 squaredRadius, |
| | | 278 | | Func<IVoxelOccupant, bool>? occupantCondition = null, |
| | | 279 | | Func<byte, bool>? groupCondition = null) |
| | | 280 | | { |
| | 264 | 281 | | if (_voxelOccupants == null) |
| | 1 | 282 | | return; |
| | | 283 | | |
| | 33440 | 284 | | foreach (var kvp in _voxelOccupants) |
| | | 285 | | { |
| | 16457 | 286 | | if (kvp.Key.VoxelIndex.y != localLayerY) |
| | | 287 | | continue; |
| | | 288 | | |
| | 16453 | 289 | | SwiftBucket<OccupantEntry> bucket = kvp.Value; |
| | 65816 | 290 | | foreach (OccupantEntry entry in bucket) |
| | | 291 | | { |
| | 16455 | 292 | | IVoxelOccupant occupant = entry.Occupant; |
| | 16455 | 293 | | if (OccupantPassesFilters(occupant, occupantCondition, groupCondition) |
| | 16455 | 294 | | && GridPlane2d.DistanceSquaredXZ(occupant.Position, position) <= squaredRadius) |
| | | 295 | | { |
| | 16452 | 296 | | results.Add(occupant); |
| | | 297 | | } |
| | | 298 | | } |
| | | 299 | | } |
| | 263 | 300 | | } |
| | | 301 | | |
| | | 302 | | /// <summary> |
| | | 303 | | /// Appends typed occupants within the squared radius to caller-owned storage without LINQ. |
| | | 304 | | /// </summary> |
| | | 305 | | internal void AddOccupantsWithinRadiusTo<T>( |
| | | 306 | | SwiftList<T> results, |
| | | 307 | | Vector3d position, |
| | | 308 | | Fixed64 squaredRadius, |
| | | 309 | | Func<IVoxelOccupant, bool>? occupantCondition = null, |
| | | 310 | | Func<byte, bool>? groupCondition = null) where T : IVoxelOccupant |
| | | 311 | | { |
| | 4 | 312 | | if (_voxelOccupants == null) |
| | 1 | 313 | | return; |
| | | 314 | | |
| | 12 | 315 | | foreach (var kvp in _voxelOccupants) |
| | | 316 | | { |
| | 3 | 317 | | SwiftBucket<OccupantEntry> bucket = kvp.Value; |
| | 14 | 318 | | foreach (OccupantEntry entry in bucket) |
| | | 319 | | { |
| | 4 | 320 | | IVoxelOccupant occupant = entry.Occupant; |
| | 4 | 321 | | if (!OccupantPassesFilters(occupant, occupantCondition, groupCondition)) |
| | | 322 | | continue; |
| | | 323 | | |
| | 3 | 324 | | if (TryGetTypedOccupantWithinRadius(occupant, position, squaredRadius, out T typedOccupant)) |
| | 2 | 325 | | results.Add(typedOccupant); |
| | | 326 | | } |
| | | 327 | | } |
| | 3 | 328 | | } |
| | | 329 | | |
| | | 330 | | /// <summary> |
| | | 331 | | /// Appends typed occupants within the XZ squared radius on the selected local Y voxel layer. |
| | | 332 | | /// </summary> |
| | | 333 | | internal void AddOccupantsWithinRadius2dTo<T>( |
| | | 334 | | SwiftList<T> results, |
| | | 335 | | Vector3d position, |
| | | 336 | | int localLayerY, |
| | | 337 | | Fixed64 squaredRadius, |
| | | 338 | | Func<IVoxelOccupant, bool>? occupantCondition = null, |
| | | 339 | | Func<byte, bool>? groupCondition = null) where T : IVoxelOccupant |
| | | 340 | | { |
| | 5 | 341 | | if (_voxelOccupants == null) |
| | 1 | 342 | | return; |
| | | 343 | | |
| | 20 | 344 | | foreach (var kvp in _voxelOccupants) |
| | | 345 | | { |
| | 6 | 346 | | if (kvp.Key.VoxelIndex.y != localLayerY) |
| | | 347 | | continue; |
| | | 348 | | |
| | 4 | 349 | | SwiftBucket<OccupantEntry> bucket = kvp.Value; |
| | 20 | 350 | | foreach (OccupantEntry entry in bucket) |
| | | 351 | | { |
| | 6 | 352 | | IVoxelOccupant occupant = entry.Occupant; |
| | 6 | 353 | | if (!OccupantPassesFilters(occupant, occupantCondition, groupCondition)) |
| | | 354 | | continue; |
| | | 355 | | |
| | 4 | 356 | | if (occupant is T typedOccupant |
| | 4 | 357 | | && GridPlane2d.DistanceSquaredXZ(occupant.Position, position) <= squaredRadius) |
| | | 358 | | { |
| | 2 | 359 | | results.Add(typedOccupant); |
| | | 360 | | } |
| | | 361 | | } |
| | | 362 | | } |
| | 4 | 363 | | } |
| | | 364 | | |
| | | 365 | | private static bool OccupantPassesFilters( |
| | | 366 | | IVoxelOccupant occupant, |
| | | 367 | | Func<IVoxelOccupant, bool>? occupantCondition, |
| | | 368 | | Func<byte, bool>? groupCondition) |
| | | 369 | | { |
| | 32936 | 370 | | return (occupantCondition == null || occupantCondition(occupant)) |
| | 32936 | 371 | | && (groupCondition == null || groupCondition(occupant.OccupantGroupId)); |
| | | 372 | | } |
| | | 373 | | |
| | | 374 | | private static bool IsWithinSquaredRadius( |
| | | 375 | | IVoxelOccupant occupant, |
| | | 376 | | Vector3d position, |
| | | 377 | | Fixed64 squaredRadius) |
| | | 378 | | { |
| | 16468 | 379 | | return (occupant.Position - position).MagnitudeSquared <= squaredRadius; |
| | | 380 | | } |
| | | 381 | | |
| | | 382 | | private static bool TryGetTypedOccupantWithinRadius<T>( |
| | | 383 | | IVoxelOccupant occupant, |
| | | 384 | | Vector3d position, |
| | | 385 | | Fixed64 squaredRadius, |
| | | 386 | | out T typedOccupant) where T : IVoxelOccupant |
| | | 387 | | { |
| | 3 | 388 | | typedOccupant = default!; |
| | 3 | 389 | | if (occupant is not T candidate || !IsWithinSquaredRadius(occupant, position, squaredRadius)) |
| | 1 | 390 | | return false; |
| | | 391 | | |
| | 2 | 392 | | typedOccupant = candidate; |
| | 2 | 393 | | return true; |
| | | 394 | | } |
| | | 395 | | |
| | | 396 | | /// <summary> |
| | | 397 | | /// Retrieves all occupants associated with a specific voxel spawn token within this scan cell. |
| | | 398 | | /// </summary> |
| | | 399 | | /// <param name="index">The global index of the voxel.</param> |
| | | 400 | | /// <returns>An enumerable collection of occupants assigned to the voxel.</returns> |
| | | 401 | | public IEnumerable<IVoxelOccupant> GetOccupantsFor(WorldVoxelIndex index) |
| | | 402 | | { |
| | 6 | 403 | | if (_voxelOccupants == null || !_voxelOccupants.TryGetValue(index, out SwiftBucket<OccupantEntry> voxelOccupants |
| | 2 | 404 | | yield break; |
| | | 405 | | |
| | 526 | 406 | | foreach (OccupantEntry entry in voxelOccupants) |
| | 259 | 407 | | yield return entry.Occupant; |
| | 4 | 408 | | } |
| | | 409 | | |
| | | 410 | | /// <summary> |
| | | 411 | | /// Attempts to retrieve a specific occupant in this scan cell using a voxel's spawn key and occupant ticket. |
| | | 412 | | /// </summary> |
| | | 413 | | /// <param name="index">The global index of the voxel the occupant belongs to.</param> |
| | | 414 | | /// <param name="occupantTicket">The unique ticket identifying the occupant.</param> |
| | | 415 | | /// <param name="voxelOccupant">The retrieved occupant if found.</param> |
| | | 416 | | /// <returns>True if the occupant was found, otherwise false.</returns> |
| | | 417 | | public bool TryGetOccupantAt( |
| | | 418 | | WorldVoxelIndex index, |
| | | 419 | | OccupantTicket occupantTicket, |
| | | 420 | | out IVoxelOccupant? voxelOccupant) |
| | | 421 | | { |
| | 8219 | 422 | | voxelOccupant = null; |
| | 8219 | 423 | | object? syncRoot = Volatile.Read(ref _occupantSyncRoot); |
| | 8219 | 424 | | if (syncRoot == null) |
| | 1 | 425 | | return false; |
| | | 426 | | |
| | 8218 | 427 | | lock (syncRoot) |
| | | 428 | | { |
| | 8218 | 429 | | if (!ReferenceEquals(syncRoot, Volatile.Read(ref _occupantSyncRoot)) |
| | 8218 | 430 | | || _voxelOccupants == null |
| | 8218 | 431 | | || !_voxelOccupants.TryGetValue(index, out SwiftBucket<OccupantEntry> voxelOccupants) |
| | 8218 | 432 | | || !occupantTicket.IsValid |
| | 8218 | 433 | | || !voxelOccupants.TryGetValue(occupantTicket.Slot, out OccupantEntry entry) |
| | 8218 | 434 | | || entry.Generation != occupantTicket.Generation) |
| | | 435 | | { |
| | 9 | 436 | | return false; |
| | | 437 | | } |
| | | 438 | | |
| | 8209 | 439 | | voxelOccupant = entry.Occupant; |
| | 8209 | 440 | | return true; |
| | | 441 | | } |
| | 8218 | 442 | | } |
| | | 443 | | |
| | | 444 | | #endregion |
| | | 445 | | |
| | | 446 | | /// <inheritdoc/> |
| | 2302 | 447 | | public override int GetHashCode() => SwiftHashTools.CombineHashCodes(GridIndex, CellKey); |
| | | 448 | | } |