eulerjs API / @eulerjs/marine / SurfaceSampler

SurfaceSampler

Defined in: packages/marine/src/waves/SurfaceSampler.ts:8

Surface heights under a fixed set of points that move a little between calls, such as the cells of a floating hull. Each point remembers how far its undisplaced grid point was from it last time and starts from there, so a single iteration finds the displaced surface.

Constructors

Constructor

new SurfaceSampler(
   waves, 
   pointCount, 
   warmIterations?
): SurfaceSampler;

Defined in: packages/marine/src/waves/SurfaceSampler.ts:16

Parameters

Parameter	Type	Default value
waves	WaveSurface	undefined
pointCount	number	undefined
warmIterations?	number	1

Returns

SurfaceSampler

Properties

Property	Modifier	Type	Description	Defined in
warmIterations	readonly	number	Iterations per call once a point has a remembered offset.	packages/marine/src/waves/SurfaceSampler.ts:11
waves	readonly	WaveSurface	-	packages/marine/src/waves/SurfaceSampler.ts:9

Accessors

pointCount

Get Signature

get pointCount(): number;

Defined in: packages/marine/src/waves/SurfaceSampler.ts:23

Returns

number

Methods

heightAt()

heightAt(
   pointIndex, 
   worldX, 
   worldZ, 
   time
): number;

Defined in: packages/marine/src/waves/SurfaceSampler.ts:27

Parameters

Parameter	Type
pointIndex	number
worldX	number
worldZ	number
time	number

Returns

number

---

reset()

reset(): void;

Defined in: packages/marine/src/waves/SurfaceSampler.ts:39

Forgets every remembered offset, e.g. after teleporting the points.

Returns

void