Class: GeometryWorkerClient

Defined in: geometry/GeometryWorkerClient.ts:18

Explicit worker ownership. Inputs are structured-cloned, never transferred from renderer buffers.

Constructors

Constructor

new GeometryWorkerClient(options): GeometryWorkerClient;

Defined in: geometry/GeometryWorkerClient.ts:31

Parameters

options

workerFactory

() => GeometryWorker

ownsWorker?

boolean

limits?

{ budgetBytes: number; planBudgetBytes: number; }

limits.budgetBytes

number

limits.planBudgetBytes

number

Returns

GeometryWorkerClient

Methods

request()

request<T>(command, options?): Promise<T>;

Defined in: geometry/GeometryWorkerClient.ts:68

Type Parameters

T

T = unknown

Parameters

command

GeometryWorkerCommand

options?

GeometryJobOptions = {}

Returns

Promise<T>

---

registerDomain()

registerDomain(domain, options?): Promise<string>;

Defined in: geometry/GeometryWorkerClient.ts:95

Parameters

domain

SurfaceDomain

options?

GeometryJobOptions

Returns

Promise<string>

---

registerMetric()

registerMetric(
   domain, 
   metric, 
   options?
): Promise<string>;

Defined in: geometry/GeometryWorkerClient.ts:99

Parameters

domain

string

metric

SurfaceMetric

options?

GeometryJobOptions

Returns

Promise<string>

---

buildSmoothing()

buildSmoothing(
   metric, 
   options, 
   job?
): Promise<string>;

Defined in: geometry/GeometryWorkerClient.ts:103

Parameters

metric

string

options

SurfaceSmoothingOptions

job?

GeometryJobOptions

Returns

Promise<string>

---

buildGeodesic()

buildGeodesic(
   metric, 
   options?, 
   job?
): Promise<string>;

Defined in: geometry/GeometryWorkerClient.ts:104

Parameters

metric

string

options?

GeodesicOptions = {}

job?

GeometryJobOptions

Returns

Promise<string>

---

withinRadius()

withinRadius(
   index, 
   seeds, 
   radiusMm, 
   job?
): Promise<GeodesicNeighborhood>;

Defined in: geometry/GeometryWorkerClient.ts:105

Parameters

index

string

seeds

Uint32Array

radiusMm

number

job?

GeometryJobOptions

Returns

Promise<GeodesicNeighborhood>

---

apply()

apply(
   plan, 
   values, 
   options?, 
   job?
): Promise<
  | SurfaceComputationResult
  | RibbonIntegrationResult>;

Defined in: geometry/GeometryWorkerClient.ts:106

Parameters

plan

string

values

ArrayLike<number>

options?

ApplySurfaceOptions = {}

job?

GeometryJobOptions

Returns

Promise< | SurfaceComputationResult | RibbonIntegrationResult>

---

smoothBatch()

smoothBatch(
   metric, 
   frames, 
   smoothing, 
   options?, 
   job?
): Promise<SurfaceComputationResult[]>;

Defined in: geometry/GeometryWorkerClient.ts:107

Parameters

metric

string

frames

readonly ArrayLike<number>[]

smoothing

SurfaceSmoothingOptions

options?

SurfaceSmoothingBatchOptions = {}

job?

GeometryJobOptions

Returns

Promise<SurfaceComputationResult[]>

---

prepareSmoothing()

prepareSmoothing(
   plan, 
   options?, 
   budgetBytes?, 
   job?
): Promise<string>;

Defined in: geometry/GeometryWorkerClient.ts:111

Parameters

plan

string

options?

ApplySurfaceOptions = {}

budgetBytes?

number

job?

GeometryJobOptions

Returns

Promise<string>

---

applyBatch()

applyBatch(
   prepared, 
   frames, 
   job?
): Promise<SurfaceComputationResult[]>;

Defined in: geometry/GeometryWorkerClient.ts:112

Parameters

prepared

string

frames

readonly ArrayLike<number>[]

job?

GeometryJobOptions

Returns

Promise<SurfaceComputationResult[]>

---

release()

release(handle): Promise<void>;

Defined in: geometry/GeometryWorkerClient.ts:116

Parameters

handle

string

Returns

Promise<void>

---

dispose()

dispose(): void;

Defined in: geometry/GeometryWorkerClient.ts:125

Returns

void