| | | 1 | | using System; |
| | | 2 | | |
| | | 3 | | namespace Trailblazer.Pathing; |
| | | 4 | | |
| | | 5 | | /// <summary> |
| | | 6 | | /// Represents one authored traversal cell inside a dense <see cref="NavigationChart"/>. |
| | | 7 | | /// </summary> |
| | | 8 | | [Serializable] |
| | | 9 | | public readonly struct NavigationChartCell |
| | | 10 | | { |
| | | 11 | | #region Static Presets |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// A reusable empty authored cell with no traversal data. |
| | | 15 | | /// </summary> |
| | 1 | 16 | | public static readonly NavigationChartCell Empty = new(TraversalMedia.None); |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// A reusable solid traversal cell with no additional authored metadata. |
| | | 20 | | /// </summary> |
| | 1 | 21 | | public static readonly NavigationChartCell Solid = new(TraversalMedia.Solid); |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// A reusable gas traversal cell with no additional authored metadata. |
| | | 25 | | /// </summary> |
| | 1 | 26 | | public static readonly NavigationChartCell Gas = new(TraversalMedia.Gas); |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// A reusable solid-plus-gas traversal cell with no additional authored metadata. |
| | | 30 | | /// </summary> |
| | 1 | 31 | | public static readonly NavigationChartCell SolidGas = new(TraversalMedia.Solid | TraversalMedia.Gas); |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// A reusable liquid traversal cell with no additional authored metadata. |
| | | 35 | | /// </summary> |
| | 1 | 36 | | public static readonly NavigationChartCell Liquid = new(TraversalMedia.Liquid); |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// A reusable solid-plus-liquid traversal cell with no additional authored metadata. |
| | | 40 | | /// </summary> |
| | 1 | 41 | | public static readonly NavigationChartCell SolidLiquid = new(TraversalMedia.Solid | TraversalMedia.Liquid); |
| | | 42 | | |
| | | 43 | | #endregion |
| | | 44 | | |
| | | 45 | | #region Properties |
| | | 46 | | |
| | | 47 | | /// <summary> |
| | | 48 | | /// Describes which authored traversal media this cell contributes to. |
| | | 49 | | /// </summary> |
| | | 50 | | public TraversalMedia TraversalKinds { get; } |
| | | 51 | | |
| | | 52 | | /// <summary> |
| | | 53 | | /// Returns true when this cell contributes any authored traversal data. |
| | | 54 | | /// </summary> |
| | 18857 | 55 | | public bool HasTraversalData => TraversalKinds != TraversalMedia.None; |
| | | 56 | | |
| | | 57 | | /// <summary> |
| | | 58 | | /// Returns true when this cell contributes chart-backed solid traversal. |
| | | 59 | | /// </summary> |
| | 36328 | 60 | | public bool HasSolid => (TraversalKinds & TraversalMedia.Solid) != 0; |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Returns true when this cell contributes any authored raw-volume traversal data. |
| | | 64 | | /// </summary> |
| | 9129 | 65 | | public bool HasVolume => (TraversalKinds & TraversalMedia.AnyVolume) != 0; |
| | | 66 | | |
| | | 67 | | /// <summary> |
| | | 68 | | /// An authored path cost adjustment applied when this cell initializes a live partition. |
| | | 69 | | /// </summary> |
| | | 70 | | public int PathCostModifier { get; } |
| | | 71 | | |
| | | 72 | | /// <summary> |
| | | 73 | | /// Optional authored hints currently applied to surface partitions. |
| | | 74 | | /// </summary> |
| | | 75 | | public NavigationChartCellFlags Flags { get; } |
| | | 76 | | |
| | | 77 | | /// <summary> |
| | | 78 | | /// Indicates which authored media on this cell participate in generated transition pairing. |
| | | 79 | | /// </summary> |
| | | 80 | | public TraversalMedia GeneratedTransitionMedia { get; } |
| | | 81 | | |
| | | 82 | | /// <summary> |
| | | 83 | | /// Returns true when this cell may participate in generated transition pairing. |
| | | 84 | | /// </summary> |
| | 18839 | 85 | | public bool CanGenerateTransition => GeneratedTransitionMedia != TraversalMedia.None; |
| | | 86 | | |
| | | 87 | | #endregion |
| | | 88 | | |
| | | 89 | | #region Constructors |
| | | 90 | | |
| | | 91 | | /// <summary> |
| | | 92 | | /// Creates a new chart cell payload. |
| | | 93 | | /// </summary> |
| | | 94 | | public NavigationChartCell( |
| | | 95 | | TraversalMedia traversalKinds, |
| | | 96 | | int pathCostModifier = 0, |
| | | 97 | | NavigationChartCellFlags flags = NavigationChartCellFlags.None, |
| | | 98 | | TraversalMedia generatedTransitionMedia = TraversalMedia.None) |
| | | 99 | | { |
| | 606 | 100 | | bool hasGas = (traversalKinds & TraversalMedia.Gas) != 0; |
| | 606 | 101 | | bool hasLiquid = (traversalKinds & TraversalMedia.Liquid) != 0; |
| | 606 | 102 | | bool hasSolid = (traversalKinds & TraversalMedia.Solid) != 0; |
| | 606 | 103 | | if (hasGas && hasLiquid) |
| | | 104 | | { |
| | 2 | 105 | | throw new ArgumentException( |
| | 2 | 106 | | hasSolid |
| | 2 | 107 | | ? "A single authored cell cannot currently declare solid, gas, and liquid traversal together." |
| | 2 | 108 | | : "A single authored cell cannot currently declare both gas and liquid traversal.", |
| | 2 | 109 | | nameof(traversalKinds)); |
| | | 110 | | } |
| | | 111 | | |
| | 604 | 112 | | if ((generatedTransitionMedia & ~traversalKinds) != 0) |
| | | 113 | | { |
| | 1 | 114 | | throw new ArgumentException( |
| | 1 | 115 | | "Generated transition media must be a subset of the authored traversal media.", |
| | 1 | 116 | | nameof(generatedTransitionMedia)); |
| | | 117 | | } |
| | | 118 | | |
| | 603 | 119 | | TraversalKinds = traversalKinds; |
| | 603 | 120 | | PathCostModifier = pathCostModifier; |
| | 603 | 121 | | Flags = flags; |
| | 603 | 122 | | GeneratedTransitionMedia = generatedTransitionMedia; |
| | 603 | 123 | | } |
| | | 124 | | |
| | | 125 | | #endregion |
| | | 126 | | |
| | | 127 | | /// <summary> |
| | | 128 | | /// Returns true when this cell contributes the requested traversal medium. |
| | | 129 | | /// </summary> |
| | | 130 | | public bool SupportsMedium(TraversalMedium medium) |
| | | 131 | | { |
| | 19497 | 132 | | return medium switch |
| | 19497 | 133 | | { |
| | 8 | 134 | | TraversalMedium.Solid => (TraversalKinds & TraversalMedia.Solid) != 0, |
| | 9738 | 135 | | TraversalMedium.Gas => (TraversalKinds & TraversalMedia.Gas) != 0, |
| | 9750 | 136 | | TraversalMedium.Liquid => (TraversalKinds & TraversalMedia.Liquid) != 0, |
| | 1 | 137 | | _ => false |
| | 19497 | 138 | | }; |
| | | 139 | | } |
| | | 140 | | } |