Struct SwiftSpatialHashOptions

Namespace

SwiftCollections.Query

Assembly

SwiftCollections.dll

Controls neighborhood query behavior for SwiftSpatialHash<TKey, TVolume>.

public readonly struct SwiftSpatialHashOptions : IEquatable<SwiftSpatialHashOptions>

Implements

IEquatable<SwiftSpatialHashOptions>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

SwiftSpatialHashOptions(int)

Initializes a new instance of the SwiftSpatialHashOptions struct.

public SwiftSpatialHashOptions(int neighborhoodPadding)

Parameters

neighborhoodPadding int

The number of additional cells to include around neighborhood queries.

Properties

Default

The default options value.

public static SwiftSpatialHashOptions Default { get; }

Property Value

SwiftSpatialHashOptions

NeighborhoodPadding

Gets the number of extra cells queried beyond the mapped volume range when using neighborhood queries.

public int NeighborhoodPadding { get; }

Property Value

int

Methods

Equals(SwiftSpatialHashOptions)

public bool Equals(SwiftSpatialHashOptions other)

Parameters

other SwiftSpatialHashOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(SwiftSpatialHashOptions, SwiftSpatialHashOptions)

Determines whether two SwiftSpatialHashOptions instances are equal.

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

Parameters

left SwiftSpatialHashOptions

right SwiftSpatialHashOptions

Returns

bool

operator !=(SwiftSpatialHashOptions, SwiftSpatialHashOptions)

Determines whether two SwiftSpatialHashOptions instances are not equal.

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

Parameters

left SwiftSpatialHashOptions

right SwiftSpatialHashOptions

Returns

bool