< Summary

Information
Class: GridForge.Grids.Topology.GridBoundaryContactCursor
Assembly: GridForge
File(s): /home/runner/work/GridForge/GridForge/src/GridForge/Grids/Topology/GridBoundaryContactCursor.cs
Line coverage
100%
Covered lines: 84
Uncovered lines: 0
Coverable lines: 84
Total lines: 185
Line coverage: 100%
Branch coverage
100%
Covered branches: 2
Total branches: 2
Branch coverage: 100%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
get_Status()100%11100%
get_RunStamp()100%22100%
Begin(...)100%11100%
BeginFiltered(...)100%11100%
MarkStale()100%11100%
ClearPairProgress()100%11100%
ClearParticipantBinding()100%11100%
ClearFilterBinding()100%11100%

File(s)

/home/runner/work/GridForge/GridForge/src/GridForge/Grids/Topology/GridBoundaryContactCursor.cs

#LineLine coverage
 1//=======================================================================
 2// GridBoundaryContactCursor.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
 8using GridForge.Configuration;
 9using GridForge.Spatial;
 10
 11namespace GridForge.Grids.Topology;
 12
 13
 14
 15/// <summary>
 16/// Stores caller-owned scalar progress for a bounded exact boundary-contact query.
 17/// </summary>
 18/// <remarks>
 19/// Create and reuse one instance, begin it through <see cref="GridWorld.BeginBoundaryContacts"/>,
 20/// and advance it through a <c>GridWorld.AdvanceBoundaryContacts(...)</c> overload. The cursor retains no
 21/// live grid or voxel reference. If it becomes <see cref="GridBoundaryContactCursorStatus.Stale"/>,
 22/// discard every contact returned since the last begin and restart the cursor.
 23/// </remarks>
 24public sealed partial class GridBoundaryContactCursor
 25{
 26
 27
 28    internal long WorldSpawnToken;
 29    internal uint WorldVersion;
 30    internal ulong WorldChangeSequence;
 31    internal int PairSourceSummaryWordIndex;
 32    internal ulong PairSourceSummaryWord;
 33    internal int PairSourceWordIndex;
 34    internal ulong PairSourceWord;
 35    internal ushort PairSourceGridIndex;
 36    internal int PairTargetOrdinal;
 37    internal ushort SourceGridIndex;
 38    internal ushort TargetGridIndex;
 39    internal long SourceGridSpawnToken;
 40    internal long TargetGridSpawnToken;
 41    internal ulong SourceGridLastChangeSequence;
 42    internal ulong TargetGridLastChangeSequence;
 43    internal GridConfigurationKey SourceConfigurationKey;
 44    internal GridConfigurationKey TargetConfigurationKey;
 45    internal GridCellPrism SourcePrism;
 46    internal VoxelIndex SourceMinimum;
 47    internal VoxelIndex SourceMaximum;
 48    internal VoxelIndex SourceAddress;
 49    internal VoxelIndex TargetMinimum;
 50    internal VoxelIndex TargetMaximum;
 51    internal VoxelIndex TargetAddress;
 52    internal VoxelContactManifold PendingContact;
 53    internal ushort FilterGridIndex;
 54    internal long FilterGridSpawnToken;
 55    internal ulong FilterGridLastChangeSequence;
 56    internal int FilteredPairPhase;
 57    internal int FilteredPairRowCount;
 58    internal int FilteredPairRowOrdinal;
 59    internal ushort PendingFilteredGridIndex;
 60    internal bool HasPairSource;
 61    internal bool HasSourceRange;
 62    internal bool HasPendingContact;
 63    internal bool IsFiltered;
 64    internal bool HasFilteredPairRow;
 65    internal bool HasPendingFilteredPair;
 66    internal TraversalStage Stage;
 67    internal GridBoundaryContactCursorStatus CurrentStatus;
 68
 69    /// <summary>The current query state.</summary>
 270    public GridBoundaryContactCursorStatus Status => CurrentStatus;
 71
 72    /// <summary>The cumulative number of canonical pair, source-address, and target probes.</summary>
 73    public ulong CandidateOrdinal { get; internal set; }
 74
 75    /// <summary>The exact committed world revision bound by this cursor.</summary>
 76    public GridBoundaryContactRunStamp RunStamp =>
 2277        CurrentStatus == GridBoundaryContactCursorStatus.Stale
 2278            ? default
 2279            : new GridBoundaryContactRunStamp(
 2280                WorldSpawnToken,
 2281                WorldVersion,
 2282                WorldChangeSequence);
 83
 84    internal void Begin(long worldSpawnToken, uint worldVersion, ulong worldChangeSequence)
 85    {
 3986        WorldSpawnToken = worldSpawnToken;
 3987        WorldVersion = worldVersion;
 3988        WorldChangeSequence = worldChangeSequence;
 3989        PairSourceSummaryWordIndex = 0;
 3990        PairSourceSummaryWord = 0;
 3991        PairSourceWordIndex = 0;
 3992        PairSourceWord = 0;
 3993        PairTargetOrdinal = 0;
 3994        CandidateOrdinal = 0;
 3995        HasPairSource = false;
 3996        HasSourceRange = false;
 3997        HasPendingContact = false;
 3998        Stage = TraversalStage.Pair;
 3999        CurrentStatus = GridBoundaryContactCursorStatus.More;
 39100        ClearFilterBinding();
 39101        ClearParticipantBinding();
 39102    }
 103
 104    internal void BeginFiltered(
 105        long worldSpawnToken,
 106        uint worldVersion,
 107        ulong worldChangeSequence,
 108        ushort gridIndex,
 109        long gridSpawnToken,
 110        ulong gridLastChangeSequence)
 111    {
 13112        Begin(worldSpawnToken, worldVersion, worldChangeSequence);
 13113        FilterGridIndex = gridIndex;
 13114        FilterGridSpawnToken = gridSpawnToken;
 13115        FilterGridLastChangeSequence = gridLastChangeSequence;
 13116        IsFiltered = true;
 13117    }
 118
 119    internal GridBoundaryContactCursorStatus MarkStale()
 120    {
 11121        WorldSpawnToken = 0;
 11122        WorldVersion = 0;
 11123        WorldChangeSequence = 0;
 11124        PairSourceSummaryWordIndex = 0;
 11125        PairSourceSummaryWord = 0;
 11126        PairSourceWordIndex = 0;
 11127        PairSourceWord = 0;
 11128        PairTargetOrdinal = 0;
 11129        CandidateOrdinal = 0;
 11130        HasPairSource = false;
 11131        HasSourceRange = false;
 11132        HasPendingContact = false;
 11133        Stage = TraversalStage.Pair;
 11134        CurrentStatus = GridBoundaryContactCursorStatus.Stale;
 11135        ClearFilterBinding();
 11136        ClearParticipantBinding();
 11137        return CurrentStatus;
 138    }
 139
 140    internal void ClearPairProgress()
 141    {
 22142        HasSourceRange = false;
 22143        HasPendingContact = false;
 22144        Stage = TraversalStage.Pair;
 22145        SourcePrism = default;
 22146        TargetMinimum = default;
 22147        TargetMaximum = default;
 22148        TargetAddress = default;
 22149        PendingContact = default;
 22150    }
 151
 152    private void ClearParticipantBinding()
 153    {
 50154        SourceGridIndex = 0;
 50155        TargetGridIndex = 0;
 50156        SourceGridSpawnToken = 0;
 50157        TargetGridSpawnToken = 0;
 50158        SourceGridLastChangeSequence = 0;
 50159        TargetGridLastChangeSequence = 0;
 50160        SourceConfigurationKey = default;
 50161        TargetConfigurationKey = default;
 50162        SourcePrism = default;
 50163        SourceMinimum = default;
 50164        SourceMaximum = default;
 50165        SourceAddress = default;
 50166        TargetMinimum = default;
 50167        TargetMaximum = default;
 50168        TargetAddress = default;
 50169        PendingContact = default;
 50170    }
 171
 172    private void ClearFilterBinding()
 173    {
 50174        FilterGridIndex = 0;
 50175        FilterGridSpawnToken = 0;
 50176        FilterGridLastChangeSequence = 0;
 50177        FilteredPairPhase = 0;
 50178        FilteredPairRowCount = 0;
 50179        FilteredPairRowOrdinal = 0;
 50180        PendingFilteredGridIndex = 0;
 50181        IsFiltered = false;
 50182        HasFilteredPairRow = false;
 50183        HasPendingFilteredPair = false;
 50184    }
 185}