C# Class LostPolygon.DynamicWaterSystem.DynamicWaterSolverAmbientSimple

Inheritance: DynamicWaterSolverSimulation
Show file Open project: caffeinatedguy/Limbs

Public Properties

Property Type Description
AmbientWaveFrequency float
AmbientWaveHeight float
AmbientWaveSpeed float
OnlyAmbient bool

Public Methods

Method Description
CreateSplashNormalized ( Vector2 center, float radius, float force ) : void

Creates a circular drop splash on the fluid surface.

GetFieldValue ( float x, float z ) : float

Returns water level at the given position in simulation grid space.

Initialize ( Vector2Int gridSize ) : void

The initialization method. Called by DynamicWater.

StepSimulation ( float speed, float damping ) : void

Executes the simulation step.

Method Details

CreateSplashNormalized() public method

Creates a circular drop splash on the fluid surface.
public CreateSplashNormalized ( Vector2 center, float radius, float force ) : void
center UnityEngine.Vector2 /// The center of the splash in simulation grid space. ///
radius float /// The radius of the splash. ///
force float /// The amount of force applied to create the splash. ///
return void

GetFieldValue() public method

Returns water level at the given position in simulation grid space.
public GetFieldValue ( float x, float z ) : float
x float /// The x coordinate. ///
z float /// The z coordinate. ///
return float

Initialize() public method

The initialization method. Called by DynamicWater.
public Initialize ( Vector2Int gridSize ) : void
gridSize Vector2Int /// The simulation grid resolution. ///
return void

StepSimulation() public method

Executes the simulation step.
public StepSimulation ( float speed, float damping ) : void
speed float /// The overall simulation speed factor. ///
damping float /// The damping value (range 0-1). ///
return void

Property Details

AmbientWaveFrequency public property

The ambient wave frequency.
public float AmbientWaveFrequency
return float

AmbientWaveHeight public property

The ambient wave height.
public float AmbientWaveHeight
return float

AmbientWaveSpeed public property

The ambient wave simulation speed factor.
public float AmbientWaveSpeed
return float

OnlyAmbient public property

Value indicating whether only ambient waves have to be simulated.
public bool OnlyAmbient
return bool