Struct SwiftOctreeOptions

Namespace

SwiftCollections.Query

Assembly

SwiftCollections.dll

Controls node subdivision behavior for SwiftOctree<TKey, TVolume>.

public readonly struct SwiftOctreeOptions : IEquatable<SwiftOctreeOptions>

Implements

IEquatable<SwiftOctreeOptions>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

SwiftOctreeOptions(int, int)

Initializes a new instance of the SwiftOctreeOptions struct.

public SwiftOctreeOptions(int maxDepth, int nodeCapacity)

Parameters

maxDepth int

The maximum child depth allowed below the root node.

nodeCapacity int

The maximum number of entries a node should hold before attempting to split.

SwiftOctreeOptions(int, int, bool)

Initializes a new instance of the SwiftOctreeOptions struct.

public SwiftOctreeOptions(int maxDepth, int nodeCapacity, bool enableMergeOnRemove)

Parameters

maxDepth int

The maximum child depth allowed below the root node.

nodeCapacity int

The maximum number of entries a node should hold before attempting to split.

enableMergeOnRemove bool

Whether empty child regions should collapse back into their parent after removals.

Properties

EnableMergeOnRemove

Gets a value indicating whether nodes should merge after removals leave sparse children.

public bool EnableMergeOnRemove { get; }

Property Value

bool

MaxDepth

Gets the maximum child depth allowed below the root node.

public int MaxDepth { get; }

Property Value

int

NodeCapacity

Gets the preferred number of entries per node before subdivision is attempted.

public int NodeCapacity { get; }

Property Value

int

Methods

Equals(SwiftOctreeOptions)

public bool Equals(SwiftOctreeOptions other)

Parameters

other SwiftOctreeOptions

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(SwiftOctreeOptions, SwiftOctreeOptions)

Determines whether two SwiftOctreeOptions instances are equal.

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

Parameters

left SwiftOctreeOptions

right SwiftOctreeOptions

Returns

bool

operator !=(SwiftOctreeOptions, SwiftOctreeOptions)

Determines whether two SwiftOctreeOptions instances are not equal.

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

Parameters

left SwiftOctreeOptions

right SwiftOctreeOptions

Returns

bool