ISpatialDistanceTrait

Description

[StaticTemplate]
interface Tinman.Terrain.Util.ISpatialDistanceTrait
→ <TEntity ⁱⁿ ^val>
→ <TCoords ⁱⁿ ^val>

Extended by: NoSpatialDistanceTrait ^struct
SpatialOctree_Lines_Distance ^struct
SpatialOctree_Points_Distance ^struct
SpatialOctree_Triangles_Distance ^struct
SpatialQuadtree_Lines_Distance ^struct
SpatialQuadtree_Points_Distance ^struct
SpatialQuadtree_Triangles_Distance ^struct

Type trait for omnidirectional distance queries.

_2 overloads

[Pure]
public method ComputeDistance¹ → (3)

Computes the nearest distance from the given point to the spatial entity.

[Pure]
public method ComputeDistance² → (5)

coords ⁱⁿ : TCoords: Coordinates of point.
distance ⁱⁿ : float64: The current nearest distance.
entity ⁱⁿ : TEntity: The spatial entity.
vertices ^out : Vec3I: Vertex indices that describe the location of the nearest spatial entity feature. If the spatial entity does not have any vertices, Vec3I.Zero is returned. Vertex index values with a weight of zero are ignored, but their value is retained.
weights ^out : Vec3D: Location of the nearest spatial entity feature, given as relative weights (i.e. the weight sum is 1) of vertices ^out. The weights are sorted in descending order, i.e. Vec3D.X always holds the greatest weight and Vec3D.Z always holds the smallest weight. The sum of all weights is 1. If the spatial entity does not have any vertices, Vec3D.Zero is returned.
returns → float64: The nearest distance.

Computes the nearest distance from the given point to the spatial entity.

A default implementation should forward to ComputeDistance¹ and set vertices ^out to Vec3I.Zero and weights ^out to Vec3D.Zero.