Struct ClimbAffordanceSnapshot

Namespace

Trailblazer.Navigation.Motor

Assembly

Trailblazer.dll

Immutable frame snapshot describing a climb affordance supplied by the host.

public readonly struct ClimbAffordanceSnapshot

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

ClimbAffordanceSnapshot(ClimbAffordanceKind, Vector3d, Vector3d, Vector3d, int?, bool, bool, bool, bool, bool, bool, Vector3d?)

Initializes a new snapshot.

public ClimbAffordanceSnapshot(ClimbAffordanceKind kind, Vector3d attachmentPoint, Vector3d surfaceNormal, Vector3d upDirection, int? affordanceId = null, bool canStartClimb = true, bool canContinueClimb = true, bool allowLateralTraverse = true, bool allowDescent = true, bool allowMantle = false, bool allowDetachJump = true, Vector3d? mantleTargetPosition = null)

Parameters

kind ClimbAffordanceKind

attachmentPoint Vector3d

surfaceNormal Vector3d

upDirection Vector3d

affordanceId int?

canStartClimb bool

canContinueClimb bool

allowLateralTraverse bool

allowDescent bool

allowMantle bool

allowDetachJump bool

mantleTargetPosition Vector3d?

Properties

AffordanceId

Gets the identifier of the associated affordance, if available.

public int? AffordanceId { get; }

Property Value

int?

AllowDescent

Gets a value indicating whether descent is permitted in the current context.

public bool AllowDescent { get; }

Property Value

bool

AllowDetachJump

Gets a value indicating whether detach jump operations are permitted.

public bool AllowDetachJump { get; }

Property Value

bool

AllowLateralTraverse

Gets a value indicating whether lateral traversal is permitted.

public bool AllowLateralTraverse { get; }

Property Value

bool

AllowMantle

Gets a value indicating whether mantle actions are permitted.

public bool AllowMantle { get; }

Property Value

bool

AttachmentPoint

Gets the position in 3D space where the object is attached.

public Vector3d AttachmentPoint { get; }

Property Value

Vector3d

CanContinueClimb

Gets a value indicating whether the climb can continue based on the current state.

public bool CanContinueClimb { get; }

Property Value

bool

CanStartClimb

Gets a value indicating whether climbing can be started based on the current state.

public bool CanStartClimb { get; }

Property Value

bool

Kind

Gets the type of climb affordance represented by this instance.

public ClimbAffordanceKind Kind { get; }

Property Value

ClimbAffordanceKind

MantleTargetPosition

Gets the target position for the mantle action, if available.

public Vector3d? MantleTargetPosition { get; }

Property Value

Vector3d?

Remarks

The target position is determined when a mantle action is in progress. If no mantle is being performed, the value is null.

SurfaceNormal

Gets the normal vector of the surface at the current location.

public Vector3d SurfaceNormal { get; }

Property Value

Vector3d

UpDirection

Gets the upward direction vector for the current coordinate system.

public Vector3d UpDirection { get; }

Property Value

Vector3d