Class: GeodesicIndex
Defined in: geometry/GeodesicIndex.ts:64
Exact graph search on edge or unfolded-triangle-pair approximations to surface distance.
Constructors
Constructor
new GeodesicIndex(metric, options?): GeodesicIndex;Defined in: geometry/GeodesicIndex.ts:85
Parameters
metric
options?
GeodesicOptions = {}
Returns
GeodesicIndex
Properties
method
readonly method: "edge" | "triangle-pair";Defined in: geometry/GeodesicIndex.ts:65
byteLength
readonly byteLength: number;Defined in: geometry/GeodesicIndex.ts:66
metric
readonly metric: SurfaceMetric;Defined in: geometry/GeodesicIndex.ts:85
Methods
withinRadius()
withinRadius(seeds, radiusMm): GeodesicNeighborhood;Defined in: geometry/GeodesicIndex.ts:148
Parameters
seeds
ArrayLike<number>
radiusMm
number
Returns
distanceToRegion()
distanceToRegion(seeds): Float64Array;Defined in: geometry/GeodesicIndex.ts:152
Parameters
seeds
ArrayLike<number>
Returns
Float64Array
allows()
allows(vertex): boolean;Defined in: geometry/GeodesicIndex.ts:157
Parameters
vertex
number
Returns
boolean
querySteps()
querySteps(
seeds,
radiusMm?,
endpoint?,
penalty?,
strength?,
virtual?
): Generator<void, GeodesicNeighborhood, void>;Defined in: geometry/GeodesicIndex.ts:160
Resumable, single-owner search. Do not run concurrent queries on one index.
Parameters
seeds
ArrayLike<number>
radiusMm?
number = Infinity
endpoint?
number
penalty?
Float64Array<ArrayBufferLike>
strength?
number = 0
virtual?
initial
Float64Array
targets
Map<number, number>
point
Float64Array
Returns
Generator<void, GeodesicNeighborhood, void>
shortestPath()
shortestPath(
start,
end,
options?
): SurfacePath;Defined in: geometry/GeodesicIndex.ts:221
Parameters
start
number
end
number
options?
penalty?
ArrayLike<number>
strength?
number
Returns
shortestPathLocations()
shortestPathLocations(start, end): SurfacePath;Defined in: geometry/GeodesicIndex.ts:231
Virtual endpoints connect to their containing triangles; no nearest-vertex snapping.