Table of Contents

Struct Physics3DHit

Namespace
Gravitas.Queries
Assembly
Gravitas.dll

Result from a 3D physics query.

public readonly struct Physics3DHit
Inherited Members

Constructors

Physics3DHit(LSCollider?, Vector3d, Vector3d, Fixed64, Vector3d)

Creates a 3D query hit from a world-space surface witness.

public Physics3DHit(LSCollider? collider, Vector3d point, Vector3d normal, Fixed64 distance, Vector3d direction)

Parameters

collider LSCollider
point Vector3d
normal Vector3d
distance Fixed64
direction Vector3d

Physics3DHit(LSCollider?, ContactAnchor, Vector3d, Fixed64, Vector3d)

Creates a query hit with a rigid-frame surface witness.

public Physics3DHit(LSCollider? collider, ContactAnchor anchor, Vector3d normal, Fixed64 distance, Vector3d direction)

Parameters

collider LSCollider
anchor ContactAnchor
normal Vector3d
distance Fixed64
direction Vector3d

Properties

Anchor

Gets the authoritative rigid-frame query witness.

public ContactAnchor Anchor { get; }

Property Value

ContactAnchor

Body

Gets the collider's body, or null for a bodyless hit.

public SolidBody? Body { get; }

Property Value

SolidBody

Collider

Gets the collider reported by the query, if any.

public LSCollider? Collider { get; }

Property Value

LSCollider

Direction

Gets the query direction associated with the hit.

public Vector3d Direction { get; }

Property Value

Vector3d

Distance

Gets the query-specific distance used to rank this hit.

public Fixed64 Distance { get; }

Property Value

Fixed64

Remarks

Rays and sweeps report query travel; cone volumes report axial distance. Projected overlaps use their overlap ranking distance, which can be zero for a contained origin. This need not equal origin-to-witness distance.

Normal

Gets the world-space surface normal.

public Vector3d Normal { get; }

Property Value

Vector3d

Point

Gets the materialized world-space query witness.

public Vector3d Point { get; }

Property Value

Vector3d

Exceptions

InvalidOperationException

The conceptual witness lies outside the representable coordinate range.

Methods

TryGetPoint(out Vector3d)

Attempts to materialize the world-space query witness without saturation.

public bool TryGetPoint(out Vector3d point)

Parameters

point Vector3d

Returns

bool