com.bonzaiengine.effects.hydrax

Class Module

java.lang.Object

com.bonzaiengine.effects.hydrax.Module

All Implemented Interfaces:

IDestroyable

Direct Known Subclasses:

ProjectedGrid

public abstract class Module
extends java.lang.Object
implements IDestroyable

Base module class, Override it for create different ways of create water noise.

Field Summary

Fields

Modifier and Type	Field and Description
protected HydraX	hydraX Hydrax
protected MeshOptions	meshOptions Module mesh options
protected Noise	noise Noise generator pointer

Constructor Summary

Constructors

Constructor and Description
Module(HydraX hydraX, java.lang.String name, Noise noise, MeshOptions meshOptions) Constructor

Method Summary

Modifier and Type	Method and Description
protected static void	_calculeNormals(VertexData vertices, int complexity) Calculate current normals
protected static GeometryData	_createGrid(int complexity)
protected static void	_smooth(VertexData vertices, int complexity) Smooth the height data
protected void	_syncStrength(float optionsStrength)
void	destroy(IGLApi glApi)
abstract float	getHeigth(float x, float z) Get the current height at a specified world-space point
protected abstract boolean	isVisible()
protected boolean	loadConfig(ConfigManager config) Load config
protected void	saveConfig(java.lang.StringBuffer data) Save config
protected abstract void	update(float timeSinceLastFrame) Call it each frame, to update time related informations
protected abstract void	updateView() Call it each frame, usually after update(float), to update view related informations
protected abstract void	updateWaitEnd() Call it each frame internally to make sure asynchronous work update has ended (if any)

Methods inherited from class java.lang.Object

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

Field Detail

hydraX

protected final HydraX hydraX

Hydrax

noise

protected Noise noise

Noise generator pointer

meshOptions

protected MeshOptions meshOptions

Module mesh options

Constructor Detail

Module

public Module(HydraX hydraX,
              java.lang.String name,
              Noise noise,
              MeshOptions meshOptions)

Constructor

Parameters:

name - Module name

noise - Noise generator pointer

meshOptions - Mesh options

normalMode - Normal generation mode

Method Detail

destroy

public void destroy(IGLApi glApi)

Specified by:

destroy in interface IDestroyable

isVisible

protected abstract boolean isVisible()

Returns:

true if the water geometry is visible on screen

update

protected abstract void update(float timeSinceLastFrame)

Call it each frame, to update time related informations

Parameters:

timeSinceLastFrame - Time since last frame(delta)

updateView

protected abstract void updateView()

Call it each frame, usually after update(float), to update view related informations

updateWaitEnd

protected abstract void updateWaitEnd()

Call it each frame internally to make sure asynchronous work update has ended (if any)

getHeigth

public abstract float getHeigth(float x,
                                float z)

Get the current height at a specified world-space point

Parameters:

x,z - X/Z World position

Returns:

Height at the given position in y-World coordinates, if it's outside of the water return -1

saveConfig

protected void saveConfig(java.lang.StringBuffer data)

Save config

Parameters:

data - String reference

loadConfig

protected boolean loadConfig(ConfigManager config)

Load config

Parameters:

config - ConfigManager reference

Returns:

True if is the correct module config

_createGrid

protected static final GeometryData _createGrid(int complexity)

_syncStrength

protected final void _syncStrength(float optionsStrength)

_smooth

protected static final void _smooth(VertexData vertices,
                                    int complexity)

Smooth the height data

_calculeNormals

protected static final void _calculeNormals(VertexData vertices,
                                            int complexity)

Calculate current normals