com.bonzaiengine.effects.hydrax

Class Real

java.lang.Object

com.bonzaiengine.effects.hydrax.Noise

com.bonzaiengine.effects.hydrax.Real

public final class Real
extends Noise

This class is a sea elevation module that combines several effects: \n Waves, defined by direction, amplitude, period and optionally, phase. Perlin noise, used to randomize the sea surface. Pressure points, used to create punctual waves.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Real.PressurePoint A PressurePoint defined by the origin, pressure pulse, Maximum time of perturbation and wave longitude.
static class	Real.Wave A wave defined by the direction, amplitude, period, and optionally phase.

Constructor Summary

Constructors

Constructor and Description
Real()

Method Summary

Modifier and Type	Method and Description
int	addPressurePoint(Vec2 origin, float pressure, float maxTime, float waveLength) Adds a pressure point to the system
int	addWave(Vec2 dir, float amplitude, float periode, float phase) Adds a wave to the system.
protected void	destroy() Remove
int	getNumWaves()
protected float	getStrength()
float	getValue(float x, float y) Get the specified x/y noise value
Real.Wave	getWave(int id) Returns a wave to the system.
protected boolean	isUpdateThreadSafe()
protected boolean	loadConfig(ConfigManager config) Load config
boolean	modifyWave(int id, Vec2 dir, float A, float T, float p) Modify a wave from the system.
boolean	removeWave(int id) Removes a wave from the system.
protected void	saveConfig(java.lang.StringBuffer data) Save config
protected boolean	update(float timeSinceLastFrame) Call it each frame

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Real

public Real()

Method Detail

destroy

protected void destroy()

Remove

Specified by:

destroy in class Noise

getNumWaves

public int getNumWaves()

Returns:

the number of waves

addWave

public int addWave(Vec2 dir,
                   float amplitude,
                   float periode,
                   float phase)

Adds a wave to the system.

Parameters:

dir - Direction of the wave.

amplitude - Amplitude of the wave (m).

periode - Period of the wave (s).

phase - Phase of the wave (rad).

Returns:

Id of the wave.

getWave

public Real.Wave getWave(int id)

Returns a wave to the system.

Parameters:

id - Identifier of the wave.

Returns:

Selected wave.

removeWave

public boolean removeWave(int id)

Removes a wave from the system.

Parameters:

id - Identifier of the wave.

Returns:

true if all gone right, or false if errors happen.

modifyWave

public boolean modifyWave(int id,
                          Vec2 dir,
                          float A,
                          float T,
                          float p)

Modify a wave from the system.

Parameters:

id - Identifier of the wave.

A - Amplitude of the wave (m).

T - Period of the wave (s).

p - Phase of the wave (rad).

Returns:

true if all gone right, or false if errors happen.

addPressurePoint

public int addPressurePoint(Vec2 origin,
                            float pressure,
                            float maxTime,
                            float waveLength)

Adds a pressure point to the system

Parameters:

origin - Origin of perturbation.

pressure - Pressure pulse (N.m). \n The maximum half-amplitude of the wave will result from divide this value with g*rho. So, a pressure of 10000 N·m produces 2 m waves.

maxTime - Maximum time of perturbation (s). \n The effect of the perturbation will decay. When T time will be elapsed, any effects will remain.

waveLength - wave length. \n To objects falling, similar values to amplitude can be OK. For ships Kelvin wakes probably length of the ship is a better choice.

Returns:

Id of the pressure point.

saveConfig

protected void saveConfig(java.lang.StringBuffer data)

Save config

Overrides:

saveConfig in class Noise

Parameters:

data - String reference

loadConfig

protected boolean loadConfig(ConfigManager config)

Load config

Overrides:

loadConfig in class Noise

Parameters:

config - ConfigManager

Returns:

True if is the correct noise config

update

protected boolean update(float timeSinceLastFrame)

Call it each frame

Specified by:

update in class Noise

Parameters:

timeSinceLastFrame - Time since last frame(delta)

isUpdateThreadSafe

protected boolean isUpdateThreadSafe()

Specified by:

isUpdateThreadSafe in class Noise

getValue

public float getValue(float x,
                      float y)

Get the specified x/y noise value

Specified by:

getValue in class Noise

Parameters:

x - X Coordinate

y - Y Coordinate

Returns:

Noise value

getStrength

protected float getStrength()

Overrides:

getStrength in class Noise