Class: Fluid

physics/fluid/fluid.Fluid

Simulates a fluid using SPH (Smooth Particle Hydrodynamics).

see SPH Fluid Sim in Processing

see Processing Code

see Particle-based Viscoelastic Fluid Sim

Constructors

constructor

• new Fluid(opts)

Creates an Fluid with the given options.

Parameters

Name	Type	Description
opts	FluidOptions	The options to setup the fluid with

Defined in

src/physics/fluid/fluid.ts:77

Properties

collisionGroup

• collisionGroup: number

Defined in

src/physics/fluid/fluid.ts:51

---

color

• color: Color

Defined in

src/physics/fluid/fluid.ts:55

---

debug

• debug: boolean

Defined in

src/physics/fluid/fluid.ts:63

---

debugShapes

• debugShapes: Map<Particle, Circle>

Defined in

src/physics/fluid/fluid.ts:65

---

debugTex

• debugTex: Texture

Defined in

src/physics/fluid/fluid.ts:64

---

kdTree

• kdTree: kdTree

Defined in

src/physics/fluid/fluid.ts:53

---

maxParticles

• maxParticles: number

Defined in

src/physics/fluid/fluid.ts:50

---

particleRadius

• particleRadius: number

Defined in

src/physics/fluid/fluid.ts:49

---

particles

• particles: Particle[] = []

Defined in

src/physics/fluid/fluid.ts:41

---

physics

• physics: Physics

The physics world the fluid sim was added to.

Defined in

src/physics/fluid/fluid.ts:70

---

renderThreshold

• renderThreshold: number

Defined in

src/physics/fluid/fluid.ts:56

---

restDensity

• restDensity: number

Defined in

src/physics/fluid/fluid.ts:43

---

smoothingRadius

• smoothingRadius: number

Defined in

src/physics/fluid/fluid.ts:44

---

smoothingRadiusSqr

• smoothingRadiusSqr: number

Defined in

src/physics/fluid/fluid.ts:45

---

stiffness

• stiffness: number

Defined in

src/physics/fluid/fluid.ts:46

---

stiffnessNear

• stiffnessNear: number

Defined in

src/physics/fluid/fluid.ts:47

---

translate

• Private translate: vec2

Defined in

src/physics/fluid/fluid.ts:158

---

zIndex

• zIndex: number

The z layer of the fluid.

Defined in

src/physics/fluid/fluid.ts:61

Methods

addParticle

▸ addParticle(pos): boolean

Adds a particle to the fluid at the given position.

Parameters

Name	Type	Description
pos	vec2	The position to create the particle at in world space.

Returns

boolean

Wether or not the particle was added

Defined in

src/physics/fluid/fluid.ts:104

---

debugRender

▸ debugRender(): void

Renders the particles of the fluid as individual circles.

Returns

void

Defined in

src/physics/fluid/fluid.ts:189

---

integrate

▸ integrate(delta, gravity): void

Integrate any forces on the particle, including gravity, and integrate velocity.

Also resets the particle's density from the last update.

Parameters

Name	Type	Description
delta	number	The time since the last update
gravity	vec2	-

Returns

void

Defined in

src/physics/fluid/fluid.ts:167

---

render

▸ render(): void

Queues the fluid to be renderer using the fluid renderer.

Returns

void

Defined in

src/physics/fluid/fluid.ts:182

---

update

▸ update(delta): void

Steps the fluid simulation forward in time.

Parameters

Name	Type	Description
delta	number	The time since the last update

Returns

void

Defined in

src/physics/fluid/fluid.ts:125