com.bonzaiengine.effects.hydrax

Class ProjectedGrid

java.lang.Object

com.bonzaiengine.effects.hydrax.Module

com.bonzaiengine.effects.hydrax.ProjectedGrid

All Implemented Interfaces:

IDestroyable

public class ProjectedGrid
extends Module

HydraX projected grid module

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProjectedGrid.Options Struct which contains HydraX projected grid module options

Field Summary

Fields

Modifier and Type	Field and Description
static float	MAX_FAR_CLIP_DISTANCE
static float	MIN_NEAR_CLIP_DISTANCE
static boolean	USE_THREADING

Fields inherited from class com.bonzaiengine.effects.hydrax.Module

hydraX, meshOptions, noise

Constructor Summary

Constructors

Constructor and Description
ProjectedGrid(HydraX h, Noise n, Plane _basePlane) Constructor
ProjectedGrid(HydraX h, Noise n, Plane basePlane, ProjectedGrid.Options options) Constructor

Method Summary

Modifier and Type	Method and Description
void	destroy(IGLApi glApi)
float	getHeigth(float x, float z) Get the current height at a specified world-space point
ProjectedGrid.Options	getOptions() Get current options
protected boolean	loadConfig(ConfigManager config) Load config
protected void	saveConfig(java.lang.StringBuffer data) Save config
void	setOptions(ProjectedGrid.Options _options) Set options
protected void	update(float timeSinceLastFrame) Call it each frame, to update time related informations
protected void	updateView() Call it each frame, to update view related informations
protected void	updateWaitEnd() Call it each frame internally to make sure asynchronous work update has ended (if any)

Methods inherited from class com.bonzaiengine.effects.hydrax.Module

_calculeNormals, _createGrid, _smooth, _syncStrength, isVisible

Methods inherited from class java.lang.Object

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

Field Detail

MIN_NEAR_CLIP_DISTANCE

public static float MIN_NEAR_CLIP_DISTANCE

MAX_FAR_CLIP_DISTANCE

public static float MAX_FAR_CLIP_DISTANCE

USE_THREADING

public static boolean USE_THREADING

Constructor Detail

ProjectedGrid

public ProjectedGrid(HydraX h,
                     Noise n,
                     Plane _basePlane)

Constructor

Parameters:

h - HydraX manager pointer

n - HydraX noise module

_basePlane - Noise base plane

ProjectedGrid

public ProjectedGrid(HydraX h,
                     Noise n,
                     Plane basePlane,
                     ProjectedGrid.Options options)

Constructor

Parameters:

h - HydraX manager pointer

n - HydraX noise module

basePlane - Noise base plane

options - Perlin options

Method Detail

destroy

public void destroy(IGLApi glApi)

Specified by:

destroy in interface IDestroyable

Overrides:

destroy in class Module

setOptions

public void setOptions(ProjectedGrid.Options _options)

Set options

Parameters:

_options - Options

getOptions

public ProjectedGrid.Options getOptions()

Get current options

Returns:

Current options

saveConfig

protected void saveConfig(java.lang.StringBuffer data)

Save config

Overrides:

saveConfig in class Module

Parameters:

data - String reference

loadConfig

protected boolean loadConfig(ConfigManager config)

Load config

Overrides:

loadConfig in class Module

Parameters:

config - ConfigManager reference

Returns:

True if is the correct module config

update

protected void update(float timeSinceLastFrame)

Call it each frame, to update time related informations

Specified by:

update in class Module

Parameters:

timeSinceLastFrame - Time since last frame(delta)

updateView

protected void updateView()

Call it each frame, to update view related informations

Specified by:

updateView in class Module

updateWaitEnd

protected void updateWaitEnd()

Description copied from class: Module

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

Specified by:

updateWaitEnd in class Module

getHeigth

public float getHeigth(float x,
                       float z)

Get the current height at a specified world-space point

Specified by:

getHeigth in class Module

Parameters:

x - X World position

z - Z World position

Returns:

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