| | | 1 | | //======================================================================= |
| | | 2 | | // GlobalEnvironmentForces.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 FixedMathSharp; |
| | | 9 | | |
| | | 10 | | namespace Trailblazer.Navigation.Motor; |
| | | 11 | | |
| | | 12 | | /// <summary> |
| | | 13 | | /// Holds simulation-wide gravity defaults read by all <see cref="MoveLocomotion"/> instances |
| | | 14 | | /// that do not carry a per-instance override. |
| | | 15 | | /// </summary> |
| | | 16 | | /// <remarks> |
| | | 17 | | /// Access the shared instance through <see cref="LocomotionForces.GlobalForces"/>. |
| | | 18 | | /// Assigning fields on that instance changes the effective gravity for every unoverridden object |
| | | 19 | | /// on the next simulation frame without touching individual locomotion instances. |
| | | 20 | | /// </remarks> |
| | | 21 | | public sealed class GlobalEnvironmentForces |
| | | 22 | | { |
| | | 23 | | /// <summary> |
| | | 24 | | /// The default fixed-point acceleration force for gravity. |
| | | 25 | | /// </summary> |
| | | 26 | | /// <remarks> |
| | | 27 | | /// Default acceleration due to gravity is approximately 9.8 m/s². |
| | | 28 | | /// </remarks> |
| | 1 | 29 | | public readonly static Fixed64 DefaultGravityForce = Fixed64.FromRaw(0x9CCCCCCCDL); |
| | | 30 | | |
| | | 31 | | /// <summary> |
| | | 32 | | /// The default maximum downward fixed-point velocity a scout can reach due to gravity. |
| | | 33 | | /// </summary> |
| | | 34 | | /// <remarks> |
| | | 35 | | /// Default terminal velocity is roughly 53 m/s (190 km/h or ~120 mph). |
| | | 36 | | /// </remarks> |
| | 1 | 37 | | public readonly static Fixed64 DefaultTerminalVelocity = (Fixed64)53f; |
| | | 38 | | |
| | | 39 | | /// <summary> |
| | | 40 | | /// The gravity force applied to all navigators without a per-instance override. |
| | | 41 | | /// </summary> |
| | | 42 | | public Fixed64 GravityForce; |
| | | 43 | | |
| | | 44 | | /// <summary> |
| | | 45 | | /// The terminal fall velocity cap applied to all navigators without a per-instance override. |
| | | 46 | | /// </summary> |
| | | 47 | | public Fixed64 TerminalVelocity; |
| | | 48 | | |
| | 1 | 49 | | internal GlobalEnvironmentForces() |
| | | 50 | | { |
| | 1 | 51 | | GravityForce = DefaultGravityForce; |
| | 1 | 52 | | TerminalVelocity = DefaultTerminalVelocity; |
| | 1 | 53 | | } |
| | | 54 | | |
| | | 55 | | /// <summary> |
| | | 56 | | /// Restores both global forces to the <see cref="MoveLocomotion"/> defaults. |
| | | 57 | | /// </summary> |
| | | 58 | | public void Reset() |
| | | 59 | | { |
| | 5 | 60 | | GravityForce = DefaultGravityForce; |
| | 5 | 61 | | TerminalVelocity = DefaultTerminalVelocity; |
| | 5 | 62 | | } |
| | | 63 | | } |