eulerjs API / @eulerjs/marine / Ocean

Ocean<Waves>

Defined in: packages/marine/src/media.ts:25

Water with a wavy surface. The water itself is still; only the surface moves.

Type Parameters

Type Parameter	Default type
Waves extends WaveSurface	SpectralWaves

Implements

• FluidMedium

Constructors

Constructor

new Ocean<Waves>(options?): Ocean<Waves>;

Defined in: packages/marine/src/media.ts:29

Parameters

Parameter	Type
options?	OceanOptions<Waves>

Returns

Ocean<Waves>

Properties

Property	Modifier	Type	Description	Defined in
density	public	number	In kg/m³.	packages/marine/src/media.ts:27
waves	readonly	Waves	-	packages/marine/src/media.ts:26

Methods

createSurfaceSampler()

createSurfaceSampler(pointCount): SurfaceSampler;

Defined in: packages/marine/src/media.ts:40

A faster way to sample the surface under a fixed set of moving points, e.g. a hull's cells.

Parameters

Parameter	Type
pointCount	number

Returns

SurfaceSampler

---

surfaceHeight()

surfaceHeight(
   worldX, 
   worldZ, 
   time
): number;

Defined in: packages/marine/src/media.ts:35

Parameters

Parameter	Type
worldX	number
worldZ	number
time	number

Returns

number

---

surfaceNormal()

surfaceNormal(
   worldX, 
   worldZ, 
   time, 
   target?
): Vector3;

Defined in: packages/marine/src/media.ts:44

Parameters

Parameter	Type
worldX	number
worldZ	number
time	number
target?	Vector3

Returns

Vector3

---

velocityAt()

velocityAt(
   _point, 
   _time, 
   target
): Vector3;

Defined in: packages/marine/src/media.ts:48

Velocity of the fluid at point and time, in m/s, written into target.

Parameters

Parameter	Type
_point	Vector3
_time	number
target	Vector3

Returns

Vector3

Implementation of

FluidMedium.velocityAt