Struct PlatformSnapshot

Namespace

Trailblazer.Navigation.Motor

Assembly

Trailblazer.dll

Represents a host-provided snapshot of a contacted surface's stable identity and transform for the current frame.

public struct PlatformSnapshot : IEquatable<PlatformSnapshot>, IRecordable

Implements

IEquatable<PlatformSnapshot>

IRecordable

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

PlatformSnapshot(int, Fixed4x4, bool)

Initializes a new instance of the PlatformSnapshot class with the specified identifier, transform, and inert state.

[JsonConstructor]
public PlatformSnapshot(int id, Fixed4x4 transform, bool inert = false)

Parameters

id int

The unique identifier for the platform snapshot.

transform Fixed4x4

The transformation matrix representing the platform's position and orientation.

inert bool

true if the platform is inert and does not interact with other objects; otherwise, false.

Fields

Inert

Indicates that the sampled surface should not act as a kinematic carrier for platform locomotion.

public bool Inert

Field Value

bool

Transform

World-space transform sampled from the host for this frame.

public Fixed4x4 Transform

Field Value

Fixed4x4

Properties

Active

Whether this snapshot represents an active platform sample.

public readonly bool Active { get; }

Property Value

bool

Id

Stable identifier used to determine whether two surface snapshots refer to the same platform.

public readonly int Id { get; }

Property Value

int

SupportsKinematicMotion

Whether this sampled surface should participate in moving-platform attachment and motion transfer logic.

public readonly bool SupportsKinematicMotion { get; }

Property Value

bool

Methods

Equals(object?)

public override readonly bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(PlatformSnapshot)

Two snapshots are considered the same platform when they share the same stable id.

public readonly bool Equals(PlatformSnapshot other)

Parameters

other PlatformSnapshot

Returns

bool

GetHashCode()

public override readonly int GetHashCode()

Returns

int

RecordData(IChronicler)

Records the current instance state to the provided chronicler.

public void RecordData(IChronicler chronicler)

Parameters

chronicler IChronicler

The active chronicler pass.

Operators

operator ==(PlatformSnapshot, PlatformSnapshot)

Determines whether two PlatformSnapshot instances are equal.

public static bool operator ==(PlatformSnapshot left, PlatformSnapshot right)

Parameters

left PlatformSnapshot

right PlatformSnapshot

Returns

bool

operator !=(PlatformSnapshot, PlatformSnapshot)

Determines whether two PlatformSnapshot instances are not equal.

public static bool operator !=(PlatformSnapshot left, PlatformSnapshot right)

Parameters

left PlatformSnapshot

right PlatformSnapshot

Returns

bool