< Summary

Information
Class: Gravitas.Diagnostics.GravitasGroundProbeDiagnosticView
Assembly: Gravitas
File(s): /home/runner/work/Gravitas/Gravitas/src/Gravitas/Diagnostics/Events/Queries/GravitasGroundProbeDiagnosticView.cs
Line coverage
100%
Covered lines: 21
Uncovered lines: 0
Coverable lines: 21
Total lines: 82
Line coverage: 100%
Branch coverage
N/A
Covered branches: 0
Total branches: 0
Branch coverage: N/A
Method coverage

Feature is only available for sponsors

Upgrade to PRO version

Metrics

MethodBranch coverage Crap Score Cyclomatic complexity Line coverage
.ctor(...)100%11100%
get_Frame()100%11100%
get_Sequence()100%11100%
get_BodyId()100%11100%
get_ColliderId()100%11100%
get_HitColliderId()100%11100%
get_ColliderDimension()100%11100%
get_HitColliderDimension()100%11100%
get_ColliderType()100%11100%
get_HitColliderType()100%11100%
get_Collider2DType()100%11100%
get_HitCollider2DType()100%11100%
get_Start()100%11100%
get_End()100%11100%
get_HitPoint()100%11100%
get_Normal()100%11100%
get_Radius()100%11100%
get_Distance()100%11100%
get_Mode()100%11100%
get_Mode2D()100%11100%
get_Hit()100%11100%

File(s)

/home/runner/work/Gravitas/Gravitas/src/Gravitas/Diagnostics/Events/Queries/GravitasGroundProbeDiagnosticView.cs

#LineLine coverage
 1//=======================================================================
 2// GravitasGroundProbeDiagnosticView.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 FixedMathSharp;
 9using Gravitas.Colliders;
 10
 11namespace Gravitas.Diagnostics;
 12
 13/// <summary>
 14/// Typed read-only view over a ground-probe diagnostic event.
 15/// </summary>
 16public readonly struct GravitasGroundProbeDiagnosticView
 17{
 418    internal GravitasGroundProbeDiagnosticView(GravitasDiagnosticEvent diagnosticEvent) => Event = diagnosticEvent;
 19
 20    /// <summary>Gets the underlying diagnostic event.</summary>
 21    public GravitasDiagnosticEvent Event { get; }
 22
 23    /// <summary>Gets the simulation frame in which the probe was captured.</summary>
 124    public long Frame => Event.Frame;
 25
 26    /// <summary>Gets the event's sequence within its capture buffer.</summary>
 127    public int Sequence => Event.Sequence;
 28
 29    /// <summary>Gets the context-local body identifier.</summary>
 130    public int BodyId => Event.BodyId;
 31
 32    /// <summary>Gets the probing body's context-local collider identifier.</summary>
 133    public int ColliderId => Event.ColliderAId;
 34
 35    /// <summary>Gets the hit collider identifier, or <c>-1</c> when no collider was hit.</summary>
 136    public int HitColliderId => Event.ColliderBId;
 37
 38    /// <summary>Gets the probing collider's dimension.</summary>
 139    public GravitasColliderDimension ColliderDimension => Event.ColliderADimension;
 40
 41    /// <summary>Gets the hit collider's dimension.</summary>
 142    public GravitasColliderDimension HitColliderDimension => Event.ColliderBDimension;
 43
 44    /// <summary>Gets the probing collider's 3D type.</summary>
 145    public ColliderType ColliderType => Event.ColliderAType;
 46
 47    /// <summary>Gets the hit collider's 3D type.</summary>
 148    public ColliderType HitColliderType => Event.ColliderBType;
 49
 50    /// <summary>Gets the probing collider's 2D type.</summary>
 151    public ColliderType2D Collider2DType => Event.ColliderA2DType;
 52
 53    /// <summary>Gets the hit collider's 2D type.</summary>
 154    public ColliderType2D HitCollider2DType => Event.ColliderB2DType;
 55
 56    /// <summary>Gets the probe start point.</summary>
 157    public Vector3d Start => Event.Start;
 58
 59    /// <summary>Gets the probe endpoint.</summary>
 160    public Vector3d End => Event.End;
 61
 62    /// <summary>Gets the materialized hit point, or zero when unavailable.</summary>
 163    public Vector3d HitPoint => Event.PointA;
 64
 65    /// <summary>Gets the hit normal.</summary>
 166    public Vector3d Normal => Event.Vector;
 67
 68    /// <summary>Gets the probe radius.</summary>
 169    public Fixed64 Radius => Event.ScalarA;
 70
 71    /// <summary>Gets the distance to the hit.</summary>
 172    public Fixed64 Distance => Event.ScalarB;
 73
 74    /// <summary>Gets the probe mode for a 3D event.</summary>
 175    public GroundProbeMode Mode => (GroundProbeMode)Event.DataA;
 76
 77    /// <summary>Gets the probe mode for a 2D event.</summary>
 178    public GroundProbeMode2D Mode2D => (GroundProbeMode2D)Event.DataA;
 79
 80    /// <summary>Gets whether the probe hit a collider.</summary>
 181    public bool Hit => Event.Hit;
 82}