< Summary

Information
Class: Gravitas.PhysicsSettingsSaver
Assembly: Gravitas
File(s): /home/runner/work/Gravitas/Gravitas/src/Gravitas/Settings/PhysicsSettingsSaver.cs
Line coverage
100%
Covered lines: 48
Uncovered lines: 0
Coverable lines: 48
Total lines: 178
Line coverage: 100%
Branch coverage
100%
Covered branches: 30
Total branches: 30
Branch coverage: 100%
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
BindContext(...)100%11100%
ApplyTo(...)100%11100%
CreateSettings()100%1818100%
OnEarlyApply()100%11100%
CreateCollisionMatrix()100%1212100%

File(s)

/home/runner/work/Gravitas/Gravitas/src/Gravitas/Settings/PhysicsSettingsSaver.cs

#LineLine coverage
 1//=======================================================================
 2// PhysicsSettingsSaver.cs
 3//=======================================================================
 4// MIT License, Copyright (c) 2026-present David Oravsky (mrdav30)
 5// See LICENSE file in the project root for full license information.
 6//=======================================================================
 7
 8using System;
 9using System.Text.Json.Serialization;
 10using Chronicler;
 11using FixedMathSharp;
 12using Gravitas.Support;
 13using MemoryPack;
 14
 15namespace Gravitas;
 16
 17/// <summary>
 18/// Serializes optional physics settings and applies them to an explicit world context.
 19/// </summary>
 20[Serializable]
 21[MemoryPackable]
 22public sealed partial class PhysicsSettingsSaver : DefaultSaver
 23{
 24    /// <summary>
 25    /// Optional fixed-step frame rate in simulation frames per second.
 26    /// </summary>
 27    [JsonInclude]
 28    public int? FrameRate;
 29
 30    /// <summary>
 31    /// Optional square layer-to-layer collision matrix.
 32    /// </summary>
 33    [JsonInclude]
 34    public MatrixRow[]? CollisionMatrix;
 35
 36    /// <summary>
 37    /// Optional include-mask bits for ground and support checks.
 38    /// </summary>
 39    [JsonInclude]
 40    public int? GroundCheckLayerMaskBits;
 41
 42    /// <summary>
 43    /// Optional default continuous-collision mode.
 44    /// </summary>
 45    [JsonInclude]
 46    public ContinuousCollisionMode? DefaultContinuousCollisionMode;
 47
 48    /// <summary>
 49    /// Optional maximum same-frame continuous-collision time-of-impact iterations.
 50    /// </summary>
 51    [JsonInclude]
 52    public int? ContinuousCollisionMaxToiIterations;
 53
 54    /// <summary>
 55    /// Optional discrete 3D constraint-island solver iteration count.
 56    /// </summary>
 57    [JsonInclude]
 58    public int? DiscreteSolverIterations;
 59
 60    /// <summary>
 61    /// Optional closing-speed threshold below which restitution is disabled.
 62    /// </summary>
 63    [JsonInclude]
 64    public Fixed64? RestitutionVelocityThreshold;
 65
 66    /// <summary>
 67    /// Optional number of frames an empty partition remains retained for reuse.
 68    /// </summary>
 69    [JsonInclude]
 70    public int? RetainedPartitionTimeToKillFrames;
 71
 72    /// <summary>
 73    /// Optional maximum retained partitions checked per retirement sweep.
 74    /// </summary>
 75    [JsonInclude]
 76    public int? RetainedPartitionRetirementSweepBudget;
 77
 78    /// <summary>
 79    /// Optional dimensional runtime mode.
 80    /// </summary>
 81    [JsonInclude]
 82    public PhysicsRuntimeMode? RuntimeMode;
 83
 84    /// <summary>
 85    /// Optional Y-axis half-thickness for 2D colliders embedded in mixed queries and contacts.
 86    /// </summary>
 87    [JsonInclude]
 88    public Fixed64? Mixed2DHalfThickness;
 89
 90    [NonSerialized]
 91    [MemoryPackIgnore]
 92    private GravitasWorldContext? _context;
 93
 94    /// <summary>
 95    /// Binds the context used by the inherited early-apply phase.
 96    /// </summary>
 97    public void BindContext(GravitasWorldContext context)
 98    {
 199        ChronicleGuard.ThrowIfNull(context, nameof(context));
 1100        _context = context;
 1101    }
 102
 103    /// <summary>
 104    /// Creates and applies these settings to the specified context.
 105    /// </summary>
 106    public void ApplyTo(GravitasWorldContext context)
 107    {
 5108        ChronicleGuard.ThrowIfNull(context, nameof(context));
 5109        context.ApplySettings(CreateSettings());
 2110    }
 111
 112    /// <summary>
 113    /// Creates validated physics settings, using defaults for omitted values.
 114    /// </summary>
 115    public PhysicsSettings CreateSettings()
 116    {
 11117        var settings = new PhysicsSettings(
 11118            FrameRate,
 11119            CreateCollisionMatrix(),
 11120            GroundCheckLayerMaskBits.HasValue
 11121                ? new PhysicsLayerMask(GroundCheckLayerMaskBits.Value)
 11122                : null);
 123
 8124        if (DefaultContinuousCollisionMode.HasValue)
 4125            settings.DefaultContinuousCollisionMode = DefaultContinuousCollisionMode.Value;
 6126        if (ContinuousCollisionMaxToiIterations.HasValue)
 2127            settings.ContinuousCollisionMaxToiIterations = ContinuousCollisionMaxToiIterations.Value;
 6128        if (DiscreteSolverIterations.HasValue)
 2129            settings.DiscreteSolverIterations = DiscreteSolverIterations.Value;
 6130        if (RestitutionVelocityThreshold.HasValue)
 3131            settings.RestitutionVelocityThreshold = RestitutionVelocityThreshold.Value;
 6132        if (RetainedPartitionTimeToKillFrames.HasValue)
 2133            settings.RetainedPartitionTimeToKillFrames = RetainedPartitionTimeToKillFrames.Value;
 6134        if (RetainedPartitionRetirementSweepBudget.HasValue)
 2135            settings.RetainedPartitionRetirementSweepBudget = RetainedPartitionRetirementSweepBudget.Value;
 6136        if (RuntimeMode.HasValue)
 3137            settings.RuntimeMode = RuntimeMode.Value;
 6138        if (Mixed2DHalfThickness.HasValue)
 3139            settings.Mixed2DHalfThickness = Mixed2DHalfThickness.Value;
 140
 6141        return settings;
 142    }
 143
 144    /// <summary>
 145    /// Applies these settings to the context bound by <see cref="BindContext"/>.
 146    /// </summary>
 147    protected override void OnEarlyApply()
 148    {
 2149        ChronicleGuard.ThrowIfTrue(
 2150            _context == null,
 2151            nameof(PhysicsSettingsSaver),
 2152            "PhysicsSettingsSaver requires an explicit GravitasWorldContext. Call BindContext or ApplyTo before applying
 153
 1154        ApplyTo(_context!);
 1155    }
 156
 157    private bool[,]? CreateCollisionMatrix()
 158    {
 11159        int numberOfLayers = CollisionMatrix?.Length ?? 0;
 11160        if (CollisionMatrix == null || numberOfLayers == 0)
 6161            return null;
 162
 5163        bool[,] matrix = new bool[numberOfLayers, numberOfLayers];
 22164        for (int i = 0; i < numberOfLayers; ++i)
 165        {
 9166            bool[] row = CollisionMatrix[i].row;
 9167            ChronicleGuard.ThrowIfTrue(
 9168                row == null || row.Length != numberOfLayers,
 9169                nameof(CollisionMatrix),
 9170                "Physics settings collision matrix rows must be square.");
 171
 36172            for (int j = 0; j < numberOfLayers; ++j)
 12173                matrix[i, j] = row[j];
 174        }
 175
 2176        return matrix;
 177    }
 178}