Struct NavigationWorkBudget

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Defines finite deterministic work limits shared by a complete navigation query.

public readonly struct NavigationWorkBudget : IEquatable<NavigationWorkBudget>

Implements

IEquatable<NavigationWorkBudget>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

NavigationWorkBudget(int, int, int, int, int, int, int, int, int, int, int)

Creates a finite navigation work budget. Zero disables the corresponding category of work.

public NavigationWorkBudget(int maxLookupProbes, int maxEndpointCandidates, int maxExpandedNodes, int maxEvaluatedEdges, int maxConnectionLegs, int maxTransitionCandidates, int maxTransitionPairs, int maxStagedLegAttempts, int maxTraceIntervals, int maxCoveredVoxelIntervals, int maxSimplificationRays)

Parameters

maxLookupProbes int

maxEndpointCandidates int

maxExpandedNodes int

maxEvaluatedEdges int

maxConnectionLegs int

maxTransitionCandidates int

maxTransitionPairs int

maxStagedLegAttempts int

maxTraceIntervals int

maxCoveredVoxelIntervals int

maxSimplificationRays int

Exceptions

ArgumentOutOfRangeException

Thrown when any limit is negative.

Properties

MaxConnectionLegs

Gets the maximum number of connection witness or polyline legs evaluated.

public int MaxConnectionLegs { get; }

Property Value

int

MaxCoveredVoxelIntervals

Gets the maximum number of covered-voxel intervals visited.

public int MaxCoveredVoxelIntervals { get; }

Property Value

int

MaxEndpointCandidates

Gets the maximum number of endpoint candidates examined.

public int MaxEndpointCandidates { get; }

Property Value

int

MaxEvaluatedEdges

Gets the maximum number of graph edges evaluated.

public int MaxEvaluatedEdges { get; }

Property Value

int

MaxExpandedNodes

Gets the maximum number of graph nodes expanded.

public int MaxExpandedNodes { get; }

Property Value

int

MaxLookupProbes

Gets the maximum number of address or lookup probes.

public int MaxLookupProbes { get; }

Property Value

int

MaxSimplificationRays

Gets the maximum number of path-simplification rays evaluated.

public int MaxSimplificationRays { get; }

Property Value

int

MaxStagedLegAttempts

Gets the maximum number of staged or nested path legs attempted.

public int MaxStagedLegAttempts { get; }

Property Value

int

MaxTraceIntervals

Gets the maximum number of navigation-ray trace intervals visited.

public int MaxTraceIntervals { get; }

Property Value

int

MaxTransitionCandidates

Gets the maximum number of transition candidates examined.

public int MaxTransitionCandidates { get; }

Property Value

int

MaxTransitionPairs

Gets the maximum number of transition pairs evaluated.

public int MaxTransitionPairs { get; }

Property Value

int

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(NavigationWorkBudget)

public bool Equals(NavigationWorkBudget other)

Parameters

other NavigationWorkBudget

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(NavigationWorkBudget, NavigationWorkBudget)

Returns whether two budgets have exactly equal limits.

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

Parameters

left NavigationWorkBudget

right NavigationWorkBudget

Returns

bool

operator !=(NavigationWorkBudget, NavigationWorkBudget)

Returns whether two budgets differ.

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

Parameters

left NavigationWorkBudget

right NavigationWorkBudget

Returns

bool