| | | 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 | | |
| | | 8 | | using GridForge.Configuration; |
| | | 9 | | using GridForge.Spatial; |
| | | 10 | | |
| | | 11 | | namespace 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> |
| | | 24 | | public 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> |
| | 2 | 70 | | 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 => |
| | 22 | 77 | | CurrentStatus == GridBoundaryContactCursorStatus.Stale |
| | 22 | 78 | | ? default |
| | 22 | 79 | | : new GridBoundaryContactRunStamp( |
| | 22 | 80 | | WorldSpawnToken, |
| | 22 | 81 | | WorldVersion, |
| | 22 | 82 | | WorldChangeSequence); |
| | | 83 | | |
| | | 84 | | internal void Begin(long worldSpawnToken, uint worldVersion, ulong worldChangeSequence) |
| | | 85 | | { |
| | 39 | 86 | | WorldSpawnToken = worldSpawnToken; |
| | 39 | 87 | | WorldVersion = worldVersion; |
| | 39 | 88 | | WorldChangeSequence = worldChangeSequence; |
| | 39 | 89 | | PairSourceSummaryWordIndex = 0; |
| | 39 | 90 | | PairSourceSummaryWord = 0; |
| | 39 | 91 | | PairSourceWordIndex = 0; |
| | 39 | 92 | | PairSourceWord = 0; |
| | 39 | 93 | | PairTargetOrdinal = 0; |
| | 39 | 94 | | CandidateOrdinal = 0; |
| | 39 | 95 | | HasPairSource = false; |
| | 39 | 96 | | HasSourceRange = false; |
| | 39 | 97 | | HasPendingContact = false; |
| | 39 | 98 | | Stage = TraversalStage.Pair; |
| | 39 | 99 | | CurrentStatus = GridBoundaryContactCursorStatus.More; |
| | 39 | 100 | | ClearFilterBinding(); |
| | 39 | 101 | | ClearParticipantBinding(); |
| | 39 | 102 | | } |
| | | 103 | | |
| | | 104 | | internal void BeginFiltered( |
| | | 105 | | long worldSpawnToken, |
| | | 106 | | uint worldVersion, |
| | | 107 | | ulong worldChangeSequence, |
| | | 108 | | ushort gridIndex, |
| | | 109 | | long gridSpawnToken, |
| | | 110 | | ulong gridLastChangeSequence) |
| | | 111 | | { |
| | 13 | 112 | | Begin(worldSpawnToken, worldVersion, worldChangeSequence); |
| | 13 | 113 | | FilterGridIndex = gridIndex; |
| | 13 | 114 | | FilterGridSpawnToken = gridSpawnToken; |
| | 13 | 115 | | FilterGridLastChangeSequence = gridLastChangeSequence; |
| | 13 | 116 | | IsFiltered = true; |
| | 13 | 117 | | } |
| | | 118 | | |
| | | 119 | | internal GridBoundaryContactCursorStatus MarkStale() |
| | | 120 | | { |
| | 11 | 121 | | WorldSpawnToken = 0; |
| | 11 | 122 | | WorldVersion = 0; |
| | 11 | 123 | | WorldChangeSequence = 0; |
| | 11 | 124 | | PairSourceSummaryWordIndex = 0; |
| | 11 | 125 | | PairSourceSummaryWord = 0; |
| | 11 | 126 | | PairSourceWordIndex = 0; |
| | 11 | 127 | | PairSourceWord = 0; |
| | 11 | 128 | | PairTargetOrdinal = 0; |
| | 11 | 129 | | CandidateOrdinal = 0; |
| | 11 | 130 | | HasPairSource = false; |
| | 11 | 131 | | HasSourceRange = false; |
| | 11 | 132 | | HasPendingContact = false; |
| | 11 | 133 | | Stage = TraversalStage.Pair; |
| | 11 | 134 | | CurrentStatus = GridBoundaryContactCursorStatus.Stale; |
| | 11 | 135 | | ClearFilterBinding(); |
| | 11 | 136 | | ClearParticipantBinding(); |
| | 11 | 137 | | return CurrentStatus; |
| | | 138 | | } |
| | | 139 | | |
| | | 140 | | internal void ClearPairProgress() |
| | | 141 | | { |
| | 22 | 142 | | HasSourceRange = false; |
| | 22 | 143 | | HasPendingContact = false; |
| | 22 | 144 | | Stage = TraversalStage.Pair; |
| | 22 | 145 | | SourcePrism = default; |
| | 22 | 146 | | TargetMinimum = default; |
| | 22 | 147 | | TargetMaximum = default; |
| | 22 | 148 | | TargetAddress = default; |
| | 22 | 149 | | PendingContact = default; |
| | 22 | 150 | | } |
| | | 151 | | |
| | | 152 | | private void ClearParticipantBinding() |
| | | 153 | | { |
| | 50 | 154 | | SourceGridIndex = 0; |
| | 50 | 155 | | TargetGridIndex = 0; |
| | 50 | 156 | | SourceGridSpawnToken = 0; |
| | 50 | 157 | | TargetGridSpawnToken = 0; |
| | 50 | 158 | | SourceGridLastChangeSequence = 0; |
| | 50 | 159 | | TargetGridLastChangeSequence = 0; |
| | 50 | 160 | | SourceConfigurationKey = default; |
| | 50 | 161 | | TargetConfigurationKey = default; |
| | 50 | 162 | | SourcePrism = default; |
| | 50 | 163 | | SourceMinimum = default; |
| | 50 | 164 | | SourceMaximum = default; |
| | 50 | 165 | | SourceAddress = default; |
| | 50 | 166 | | TargetMinimum = default; |
| | 50 | 167 | | TargetMaximum = default; |
| | 50 | 168 | | TargetAddress = default; |
| | 50 | 169 | | PendingContact = default; |
| | 50 | 170 | | } |
| | | 171 | | |
| | | 172 | | private void ClearFilterBinding() |
| | | 173 | | { |
| | 50 | 174 | | FilterGridIndex = 0; |
| | 50 | 175 | | FilterGridSpawnToken = 0; |
| | 50 | 176 | | FilterGridLastChangeSequence = 0; |
| | 50 | 177 | | FilteredPairPhase = 0; |
| | 50 | 178 | | FilteredPairRowCount = 0; |
| | 50 | 179 | | FilteredPairRowOrdinal = 0; |
| | 50 | 180 | | PendingFilteredGridIndex = 0; |
| | 50 | 181 | | IsFiltered = false; |
| | 50 | 182 | | HasFilteredPairRow = false; |
| | 50 | 183 | | HasPendingFilteredPair = false; |
| | 50 | 184 | | } |
| | | 185 | | } |