< Summary

Information
Class: Gravitas.PhysicsPartition
Assembly: Gravitas
File(s): /home/runner/work/Gravitas/Gravitas/src/Gravitas/Partitions/3D/PhysicsPartition.cs
Line coverage
100%
Covered lines: 166
Uncovered lines: 0
Coverable lines: 166
Total lines: 384
Line coverage: 100%
Branch coverage
100%
Covered branches: 118
Total branches: 118
Branch coverage: 100%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor()100%11100%
get_IsAllocated()100%11100%
get_DynamicObjectCount()100%22100%
get_KinematicObjectCount()100%22100%
get_StaticObjectCount()100%22100%
get_IsEmpty()100%44100%
get_EmptySinceFrame()100%11100%
get_RetainedIndex()100%11100%
get_AwakeDynamicObjectCount()100%22100%
get_Owner()100%11100%
OnAddToVoxel(...)100%11100%
Distribute(...)100%1818100%
CopyAllColliderIds(...)100%11100%
CopyStaticStyleColliderIds(...)100%11100%
CopyIds(...)100%44100%
ProcessPair(...)100%44100%
AddDynamicObject(...)100%66100%
AddStaticObject(...)100%44100%
AddKinematicObject(...)100%44100%
RemoveDynamicObject(...)100%1010100%
RemoveStaticObject(...)100%66100%
RemoveKinematicObject(...)100%66100%
ContainsAwakeDynamicObject(...)100%22100%
SetDynamicObjectAwake(...)100%1010100%
IsDynamicObjectAwake(...)100%44100%
OnRemoveFromVoxel(...)100%11100%
SetOwner(...)100%22100%
IsOwnedBy(...)100%11100%
SetRetainedIndex(...)100%11100%
ClearRetainedIndex()100%11100%
ResetRetainedMembership()100%1010100%
ResetForPool()100%1010100%
MarkOccupied()100%22100%
MarkEmptyIfUnoccupied()100%22100%
MarkEmpty(...)100%22100%
SetParentIndex(...)100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_RetainedIndex()100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_EmptyIndex()100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.set_EmptyIndex(...)100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_IsEmpty()100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_EmptySinceFrame()100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.IsOwnedBy(...)100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.SetRetainedIndex(...)100%11100%
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.ClearRetainedIndex()100%11100%

File(s)

/home/runner/work/Gravitas/Gravitas/src/Gravitas/Partitions/3D/PhysicsPartition.cs

#LineLine coverage
 1//=======================================================================
 2// PhysicsPartition.cs
 3//=======================================================================
 4// MIT License, Copyright (c) 2026-present David Oravsky (mrdav30)
 5// See LICENSE file in the project root for full license information.
 6//=======================================================================
 7
 8using System.Runtime.CompilerServices;
 9using Gravitas.CollisionHandling;
 10using GridForge.Grids;
 11using GridForge.Spatial;
 12using SwiftCollections;
 13
 14namespace Gravitas;
 15
 16/// <summary>
 17/// Stores the 3D collider IDs assigned to one GridForge voxel.
 18/// </summary>
 19public class PhysicsPartition : IVoxelPartition, IRetainedPhysicsPartition<GravitasCollisionService>
 20{
 21    private GravitasCollisionService? _owner;
 109888822    private long _emptySinceFrame = -1;
 109888823    private int _retainedIndex = -1;
 24
 25    /// <summary>Gets or sets the world voxel occupied by this partition.</summary>
 26    public WorldVoxelIndex WorldIndex { get; set; }
 27
 28    /// <summary>Gets or sets whether this partition is attached to a voxel.</summary>
 29    public bool IsPartitioned { get; set; }
 30
 31    /// <summary>
 32    /// Stores context-local dynamic body IDs.
 33    /// </summary>
 34    internal SwiftHashSet<int>? ContainedDynamicObjects;
 35
 36    /// <summary>
 37    /// Stores the subset of dynamic collider IDs whose bodies can currently drive collision work.
 38    /// </summary>
 39    internal SwiftHashSet<int>? ContainedAwakeDynamicObjects;
 40
 41    /// <summary>Stores context-local kinematic collider IDs.</summary>
 42    internal SwiftHashSet<int>? ContainedKinematicObjects;
 43
 44    /// <summary>Stores context-local static collider IDs.</summary>
 45    internal SwiftHashSet<int>? ContainedStaticObjects;
 46
 47    /// <summary>Gets the active-partition slot, or <c>-1</c> when inactive.</summary>
 48    public int ActivationId { get; private set; }
 49
 50    /// <summary>Gets whether this partition has an active-partition slot.</summary>
 160069051    public bool IsAllocated => ActivationId != -1;
 52
 53    /// <summary>Gets the number of dynamic collider IDs, including sleeping bodies.</summary>
 737149454    public int DynamicObjectCount => ContainedDynamicObjects?.Count ?? 0;
 55
 56    /// <summary>Gets the number of kinematic collider IDs.</summary>
 602737757    public int KinematicObjectCount => ContainedKinematicObjects?.Count ?? 0;
 58
 59    /// <summary>Gets the number of static collider IDs.</summary>
 575517060    public int StaticObjectCount => ContainedStaticObjects?.Count ?? 0;
 61
 737149362    internal bool IsEmpty => DynamicObjectCount == 0 && KinematicObjectCount == 0 && StaticObjectCount == 0;
 63
 32907164    internal long EmptySinceFrame => _emptySinceFrame;
 65
 534945166    internal int RetainedIndex => _retainedIndex;
 67
 68    internal int EmptyIndex { get; set; } = -1;
 69
 70    /// <summary>
 71    /// Gets the number of awake dynamic IDs currently in this partition.
 72    /// </summary>
 24273    public int AwakeDynamicObjectCount => ContainedAwakeDynamicObjects?.Count ?? 0;
 74
 75    /// <summary>Gets the collision service that owns this partition.</summary>
 76    public GravitasCollisionService Owner
 77    {
 78        get
 79        {
 714719480            ChronicleGuard.ThrowIfTrue(
 714719481                _owner == null,
 714719482                nameof(PhysicsPartition),
 714719483                "PhysicsPartition is missing its owner collision service.");
 714719184            return _owner!;
 85        }
 86    }
 87
 88    /// <summary>Creates an inactive 3D physics partition.</summary>
 109888889    public PhysicsPartition()
 90    {
 109888891        ActivationId = -1;
 109888892    }
 93
 94    /// <summary>Attaches this partition to a voxel.</summary>
 95    public void OnAddToVoxel(Voxel voxel)
 96    {
 115917397        ChronicleGuard.ThrowIfTrue(_owner == null, nameof(PhysicsPartition), "PhysicsPartition is missing its owner coll
 115917398        WorldIndex = voxel.WorldIndex;
 115917399        IsPartitioned = true;
 1159173100    }
 101
 102    internal void Distribute(
 103        SwiftList<int> dynamicIds,
 104        SwiftList<int> staticIds)
 105    {
 2011531106        int dynamicCount = ContainedDynamicObjects?.Count ?? 0;
 2011531107        int awakeDynamicCount = ContainedAwakeDynamicObjects?.Count ?? 0;
 2011531108        if (ContainedDynamicObjects == null || dynamicCount == 0 || ContainedAwakeDynamicObjects == null || awakeDynamic
 78326109            return;
 110
 1933205111        dynamicIds.FastClear();
 1933205112        CopyIds(ContainedDynamicObjects, dynamicIds);
 1933205113        dynamicIds.SortInPlace();
 1933205114        CopyStaticStyleColliderIds(staticIds);
 115
 116        // Sleeping bodies stay query-visible in dynamic membership, while awake membership gates partition work.
 117        // Once an active partition is selected, all local dynamic links are emitted so the discrete
 118        // island builder can wake and solve connected bodies in a stable graph instead of a flat pair pass.
 8111316119        for (int j = 0; j < dynamicIds.Count; j++)
 120        {
 2122453121            int id1 = dynamicIds[j];
 4790934122            for (int k = j + 1; k < dynamicIds.Count; k++)
 273014123                ProcessPair(id1, dynamicIds[k]);
 124
 8585270125            for (int k = 0; k < staticIds.Count; k++)
 126            {
 2170182127                int id2 = staticIds[k];
 2170182128                ProcessPair(id1, id2);
 129            }
 130        }
 1933205131    }
 132
 133    /// <summary>Clears and fills caller-owned storage with all collider IDs in ascending order.</summary>
 134    public void CopyAllColliderIds(SwiftList<int> destination)
 135    {
 179117136        ChronicleGuard.ThrowIfNull(destination, nameof(destination));
 179116137        destination.FastClear();
 179116138        CopyIds(ContainedDynamicObjects, destination);
 179116139        CopyIds(ContainedKinematicObjects, destination);
 179116140        CopyIds(ContainedStaticObjects, destination);
 179116141        destination.SortInPlace();
 179116142    }
 143
 144    internal void CopyStaticStyleColliderIds(SwiftList<int> destination)
 145    {
 1933207146        destination.FastClear();
 1933207147        CopyIds(ContainedKinematicObjects, destination);
 1933207148        CopyIds(ContainedStaticObjects, destination);
 1933207149        destination.SortInPlace();
 1933207150    }
 151
 152    private static void CopyIds(SwiftHashSet<int>? source, SwiftList<int> destination)
 153    {
 6336967154        if (source == null)
 3011941155            return;
 156
 15528150157        foreach (int id in source)
 4439049158            destination.Add(id);
 3325026159    }
 160
 161    private void ProcessPair(int id1, int id2)
 162    {
 2443196163        GravitasCollisionService owner = Owner;
 2443196164        CollisionPair? pair = owner.Context.Physics.GetCollisionPair(id1, id2);
 165
 166        //Ensures collision pairs are not run twice
 2443196167        if (pair == null || pair.PartitionVersion == owner.Version)
 2350492168            return;
 169
 92704170        pair.PartitionVersion = owner.Version;
 92704171        pair.UpdateCollisionDeferred();
 92704172    }
 173
 174    /// <summary>Adds a dynamic collider ID to this partition.</summary>
 175    public void AddDynamicObject(int item)
 176    {
 4345422177        ChronicleGuard.ThrowIfNegative(item, nameof(item));
 4345421178        ContainedDynamicObjects ??= new();
 4345421179        if (!ContainedDynamicObjects.Add(item))
 3789273180            return;
 181
 556148182        MarkOccupied();
 556148183        SetDynamicObjectAwake(item, IsDynamicObjectAwake(item));
 184
 556148185        if (ContainedDynamicObjects.Count == 1)
 537548186            ActivationId = Owner.ActivatePartition(this);
 556148187    }
 188
 189    /// <summary>Adds a static collider ID to this partition.</summary>
 190    public void AddStaticObject(int item)
 191    {
 790270192        ChronicleGuard.ThrowIfNegative(item, nameof(item));
 790269193        ContainedStaticObjects ??= new();
 790269194        if (ContainedStaticObjects.Add(item))
 779284195            MarkOccupied();
 790269196    }
 197
 198    /// <summary>Adds a kinematic collider ID to this partition.</summary>
 199    public void AddKinematicObject(int item)
 200    {
 380815201        ChronicleGuard.ThrowIfNegative(item, nameof(item));
 380814202        ContainedKinematicObjects ??= new();
 380814203        if (ContainedKinematicObjects.Add(item))
 259540204            MarkOccupied();
 380814205    }
 206
 207    /// <summary>Removes a dynamic collider ID from this partition.</summary>
 208    public void RemoveDynamicObject(int item)
 209    {
 95204210        if (ContainedDynamicObjects?.Remove(item) != true)
 211        {
 4212            GravitasLogger.DebugChannel.Info($"Dynamic item not removed - {item}");
 4213            return;
 214        }
 215
 95200216        ContainedAwakeDynamicObjects?.Remove(item);
 217
 95200218        if (ContainedDynamicObjects.Count > 0)
 4476219            return;
 220
 221        // If there are no more dynamic objects, we can deactivate the partition to save on future checks until it's nee
 90724222        Owner.DeactivatePartition(ActivationId);
 90724223        ActivationId = -1;
 90724224        MarkEmptyIfUnoccupied();
 90724225    }
 226
 227    /// <summary>Removes a static collider ID from this partition.</summary>
 228    public void RemoveStaticObject(int item)
 229    {
 44987230        if (ContainedStaticObjects?.Remove(item) != true)
 231        {
 5232            GravitasLogger.DebugChannel.Info($"Static item not removed - {item}");
 5233            return;
 234        }
 235
 44982236        MarkEmptyIfUnoccupied();
 44982237    }
 238
 239    /// <summary>Removes a kinematic collider ID from this partition.</summary>
 240    public void RemoveKinematicObject(int item)
 241    {
 232289242        if (ContainedKinematicObjects?.Remove(item) != true)
 243        {
 5244            GravitasLogger.DebugChannel.Info($"Kinematic item not removed - {item}");
 5245            return;
 246        }
 247
 232284248        MarkEmptyIfUnoccupied();
 232284249    }
 250
 251    /// <summary>
 252    /// Returns true when the supplied dynamic collider ID is marked awake in this partition.
 253    /// </summary>
 15254    public bool ContainsAwakeDynamicObject(int item) => ContainedAwakeDynamicObjects?.Contains(item) == true;
 255
 256    /// <summary>
 257    /// Updates the awake dynamic subset for a collider already present in dynamic membership.
 258    /// </summary>
 259    public void SetDynamicObjectAwake(int item, bool awake)
 260    {
 5104948261        if (ContainedDynamicObjects?.Contains(item) != true)
 2262            return;
 263
 5104946264        if (awake)
 265        {
 5082012266            ContainedAwakeDynamicObjects ??= new();
 5082012267            ContainedAwakeDynamicObjects.Add(item);
 5082012268            return;
 269        }
 270
 22934271        ContainedAwakeDynamicObjects?.Remove(item);
 22181272    }
 273
 274    private bool IsDynamicObjectAwake(int item)
 275    {
 556148276        if (!Owner.Context.Physics.TryGetColliderById(item, out Gravitas.Colliders.LSCollider? collider))
 14277            return true;
 278
 556134279        SolidBody? body = collider!.Body;
 556134280        return body == null || body.IsAwakeForCollision;
 281    }
 282
 283    /// <summary>Releases this partition when it is removed from a voxel.</summary>
 284    public void OnRemoveFromVoxel(Voxel voxel)
 285    {
 1159174286        Owner.ReleasePartition(this);
 1159173287    }
 288
 289    internal void SetOwner(GravitasCollisionService owner)
 290    {
 1159194291        ChronicleGuard.ThrowIfNull(owner, nameof(owner));
 1159194292        ChronicleGuard.ThrowIfArgument(
 1159194293            _owner != null && !ReferenceEquals(_owner, owner),
 1159194294            nameof(owner),
 1159194295            "PhysicsPartition is already owned by a different collision service.");
 296
 1159193297        _owner = owner;
 1159193298    }
 299
 7020941300    internal bool IsOwnedBy(GravitasCollisionService owner) => ReferenceEquals(_owner, owner);
 301
 302    [MethodImpl(MethodImplOptions.AggressiveInlining)]
 303    internal void SetRetainedIndex(int index)
 304    {
 1934709305        ChronicleGuard.ThrowIfNegative(index, nameof(index));
 1934709306        _retainedIndex = index;
 1934709307    }
 308
 309    [MethodImpl(MethodImplOptions.AggressiveInlining)]
 1159179310    internal void ClearRetainedIndex() => _retainedIndex = -1;
 311
 312    internal void ResetRetainedMembership()
 313    {
 6314        ContainedDynamicObjects?.Clear();
 6315        ContainedAwakeDynamicObjects?.Clear();
 6316        ContainedKinematicObjects?.Clear();
 6317        ContainedStaticObjects?.Clear();
 6318        ActivationId = -1;
 6319        MarkEmpty(_owner?.Context.FrameCount ?? 0);
 6320    }
 321
 322    internal void ResetForPool()
 323    {
 1159182324        ContainedDynamicObjects?.Clear();
 1159182325        ContainedAwakeDynamicObjects?.Clear();
 1159182326        ContainedKinematicObjects?.Clear();
 1159182327        ContainedStaticObjects?.Clear();
 328
 1159182329        if (ActivationId != -1)
 446820330            Owner.DeactivatePartition(ActivationId);
 331
 1159182332        _owner = null;
 1159182333        ActivationId = -1;
 1159182334        IsPartitioned = false;
 1159182335        _emptySinceFrame = -1;
 1159182336        _retainedIndex = -1;
 1159182337        EmptyIndex = -1;
 1159182338    }
 339
 340    [MethodImpl(MethodImplOptions.AggressiveInlining)]
 341    private void MarkOccupied()
 342    {
 1594972343        _emptySinceFrame = -1;
 1594972344        _owner?.RefreshRetainedPartitionEligibility(this);
 1594969345    }
 346
 347    [MethodImpl(MethodImplOptions.AggressiveInlining)]
 348    private void MarkEmptyIfUnoccupied()
 349    {
 367990350        if (IsEmpty)
 216852351            MarkEmpty(Owner.Context.FrameCount);
 367990352    }
 353
 354    [MethodImpl(MethodImplOptions.AggressiveInlining)]
 355    private void MarkEmpty(long frame)
 356    {
 216858357        _emptySinceFrame = frame;
 216858358        _owner?.RefreshRetainedPartitionEligibility(this);
 216855359    }
 360
 361    /// <summary>
 362    /// Sets the parent index for the current voxel in the world.
 363    /// </summary>
 364    /// <param name="parentIndex">The index to assign as the parent of the current voxel.</param>
 1159173365    public void SetParentIndex(WorldVoxelIndex parentIndex) => WorldIndex = parentIndex;
 366
 5349450367    int IRetainedPhysicsPartition<GravitasCollisionService>.RetainedIndex => RetainedIndex;
 368
 369    int IRetainedPhysicsPartition<GravitasCollisionService>.EmptyIndex
 370    {
 4130185371        get => EmptyIndex;
 4274832372        set => EmptyIndex = value;
 373    }
 374
 7003493375    bool IRetainedPhysicsPartition<GravitasCollisionService>.IsEmpty => IsEmpty;
 376
 329062377    long IRetainedPhysicsPartition<GravitasCollisionService>.EmptySinceFrame => EmptySinceFrame;
 378
 7020941379    bool IRetainedPhysicsPartition<GravitasCollisionService>.IsOwnedBy(GravitasCollisionService owner) => IsOwnedBy(owne
 380
 1934709381    void IRetainedPhysicsPartition<GravitasCollisionService>.SetRetainedIndex(int index) => SetRetainedIndex(index);
 382
 1159179383    void IRetainedPhysicsPartition<GravitasCollisionService>.ClearRetainedIndex() => ClearRetainedIndex();
 384}

Methods/Properties

.ctor()
get_IsAllocated()
get_DynamicObjectCount()
get_KinematicObjectCount()
get_StaticObjectCount()
get_IsEmpty()
get_EmptySinceFrame()
get_RetainedIndex()
get_AwakeDynamicObjectCount()
get_Owner()
OnAddToVoxel(GridForge.Grids.Voxel)
Distribute(SwiftCollections.SwiftList`1<System.Int32>,SwiftCollections.SwiftList`1<System.Int32>)
CopyAllColliderIds(SwiftCollections.SwiftList`1<System.Int32>)
CopyStaticStyleColliderIds(SwiftCollections.SwiftList`1<System.Int32>)
CopyIds(SwiftCollections.SwiftHashSet`1<System.Int32>,SwiftCollections.SwiftList`1<System.Int32>)
ProcessPair(System.Int32,System.Int32)
AddDynamicObject(System.Int32)
AddStaticObject(System.Int32)
AddKinematicObject(System.Int32)
RemoveDynamicObject(System.Int32)
RemoveStaticObject(System.Int32)
RemoveKinematicObject(System.Int32)
ContainsAwakeDynamicObject(System.Int32)
SetDynamicObjectAwake(System.Int32,System.Boolean)
IsDynamicObjectAwake(System.Int32)
OnRemoveFromVoxel(GridForge.Grids.Voxel)
SetOwner(Gravitas.GravitasCollisionService)
IsOwnedBy(Gravitas.GravitasCollisionService)
SetRetainedIndex(System.Int32)
ClearRetainedIndex()
ResetRetainedMembership()
ResetForPool()
MarkOccupied()
MarkEmptyIfUnoccupied()
MarkEmpty(System.Int64)
SetParentIndex(GridForge.Spatial.WorldVoxelIndex)
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_RetainedIndex()
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_EmptyIndex()
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.set_EmptyIndex(System.Int32)
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_IsEmpty()
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.get_EmptySinceFrame()
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.IsOwnedBy(Gravitas.GravitasCollisionService)
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.SetRetainedIndex(System.Int32)
Gravitas.IRetainedPhysicsPartition<Gravitas.GravitasCollisionService>.ClearRetainedIndex()