| | | 1 | | //======================================================================= |
| | | 2 | | // LocomotionForces.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 Chronicler; |
| | | 9 | | using FixedMathSharp; |
| | | 10 | | |
| | | 11 | | namespace Trailblazer.Navigation.Motor; |
| | | 12 | | |
| | | 13 | | /// <summary> |
| | | 14 | | /// Holds the gravity and terminal velocity forces applied to a object, with support for per-instance overrides and glob |
| | | 15 | | /// </summary> |
| | | 16 | | public sealed class LocomotionForces : IRecordable |
| | | 17 | | { |
| | | 18 | | /// <summary> |
| | | 19 | | /// Simulation-wide gravity defaults applied to all <see cref="MoveLocomotion"/> instances |
| | | 20 | | /// that do not carry a per-instance override. |
| | | 21 | | /// </summary> |
| | | 22 | | /// <remarks> |
| | | 23 | | /// Assign fields on this instance to shift gravity for every unoverridden object at once. |
| | | 24 | | /// Call <see cref="GlobalEnvironmentForces.Reset"/> to restore the defaults. |
| | | 25 | | /// </remarks> |
| | 1 | 26 | | public static readonly GlobalEnvironmentForces GlobalForces = new(); |
| | | 27 | | |
| | | 28 | | #region Configurable Parameters |
| | | 29 | | |
| | | 30 | | /// <summary> |
| | | 31 | | /// The gravity force applied to this object. |
| | | 32 | | /// Returns the per-instance override when one is set; |
| | | 33 | | /// otherwise delegates to <see cref="GlobalEnvironmentForces"/> so a single global change takes effect for all unov |
| | | 34 | | /// Assigning this property sets the per-instance override. |
| | | 35 | | /// Call <see cref="ClearGravityForceOverride"/> to remove the override and restore global tracking. |
| | | 36 | | /// </summary> |
| | | 37 | | public Fixed64 GravityForce |
| | | 38 | | { |
| | 2236 | 39 | | get => _gravityForceOverride ?? GlobalForces.GravityForce; |
| | 4 | 40 | | set => _gravityForceOverride = value; |
| | | 41 | | } |
| | | 42 | | |
| | | 43 | | private Fixed64? _gravityForceOverride; |
| | | 44 | | |
| | | 45 | | /// <summary> |
| | | 46 | | /// Returns true when this instance carries a per-instance gravity override. |
| | | 47 | | /// When false, <see cref="GravityForce"/> follows <see cref="GlobalEnvironmentForces"/>. |
| | | 48 | | /// </summary> |
| | 7 | 49 | | public bool HasGravityForceOverride => _gravityForceOverride.HasValue; |
| | | 50 | | |
| | | 51 | | |
| | | 52 | | /// <summary> |
| | | 53 | | /// The terminal fall velocity cap for this object. |
| | | 54 | | /// Returns the per-instance override when one is set; otherwise delegates to |
| | | 55 | | /// <see cref="GlobalEnvironmentForces"/>. |
| | | 56 | | /// Assigning this property sets the per-instance override. |
| | | 57 | | /// Call <see cref="ClearTerminalVelocityOverride"/> to remove the override and restore global tracking. |
| | | 58 | | /// </summary> |
| | | 59 | | public Fixed64 TerminalVelocity |
| | | 60 | | { |
| | 1674 | 61 | | get => _terminalVelocityOverride ?? GlobalForces.TerminalVelocity; |
| | 3 | 62 | | set => _terminalVelocityOverride = value; |
| | | 63 | | } |
| | | 64 | | |
| | | 65 | | private Fixed64? _terminalVelocityOverride; |
| | | 66 | | |
| | | 67 | | /// <summary> |
| | | 68 | | /// Returns true when this instance carries a per-instance terminal velocity override. |
| | | 69 | | /// When false, <see cref="TerminalVelocity"/> follows <see cref="GlobalEnvironmentForces"/>. |
| | | 70 | | /// </summary> |
| | 5 | 71 | | public bool HasTerminalVelocityOverride => _terminalVelocityOverride.HasValue; |
| | | 72 | | |
| | | 73 | | #endregion |
| | | 74 | | |
| | | 75 | | #region Overrides |
| | | 76 | | |
| | | 77 | | /// <summary> |
| | | 78 | | /// Removes the per-instance gravity override so this object tracks |
| | | 79 | | /// <see cref="GlobalEnvironmentForces"/>. |
| | | 80 | | /// </summary> |
| | 1 | 81 | | public void ClearGravityForceOverride() => _gravityForceOverride = null; |
| | | 82 | | |
| | | 83 | | /// <summary> |
| | | 84 | | /// Removes the per-instance terminal velocity override so this object tracks |
| | | 85 | | /// <see cref="GlobalEnvironmentForces"/>. |
| | | 86 | | /// </summary> |
| | 1 | 87 | | public void ClearTerminalVelocityOverride() => _terminalVelocityOverride = null; |
| | | 88 | | |
| | | 89 | | #endregion |
| | | 90 | | |
| | | 91 | | #region Serialization |
| | | 92 | | |
| | | 93 | | /// <inheritdoc /> |
| | | 94 | | public void RecordData(IChronicler chronicler) |
| | | 95 | | { |
| | | 96 | | // Gravity and terminal velocity are stored as per-instance overrides. |
| | | 97 | | // Serialize the presence flag first so loading knows whether to restore an override or clear it. |
| | 168 | 98 | | bool hasGravityOverride = _gravityForceOverride.HasValue; |
| | 168 | 99 | | Fixed64 gravityForce = _gravityForceOverride ?? GlobalForces.GravityForce; |
| | 168 | 100 | | RecordValues.Look(chronicler, ref hasGravityOverride, "HasGravityOverride", false); |
| | 168 | 101 | | RecordValues.Look(chronicler, ref gravityForce, "GravityForce", GlobalForces.GravityForce); |
| | | 102 | | |
| | 168 | 103 | | bool hasTerminalVelocityOverride = _terminalVelocityOverride.HasValue; |
| | 168 | 104 | | Fixed64 terminalVelocity = _terminalVelocityOverride ?? GlobalForces.TerminalVelocity; |
| | 168 | 105 | | RecordValues.Look(chronicler, ref hasTerminalVelocityOverride, "HasTerminalVelocityOverride", false); |
| | 168 | 106 | | RecordValues.Look(chronicler, ref terminalVelocity, "TerminalVelocity", GlobalForces.TerminalVelocity); |
| | | 107 | | |
| | 168 | 108 | | if (chronicler.Mode == SerializationMode.Loading) |
| | | 109 | | { |
| | 79 | 110 | | _gravityForceOverride = hasGravityOverride ? gravityForce : null; |
| | 79 | 111 | | _terminalVelocityOverride = hasTerminalVelocityOverride ? terminalVelocity : null; |
| | | 112 | | } |
| | 168 | 113 | | } |
| | | 114 | | |
| | | 115 | | #endregion |
| | | 116 | | } |