HydraX (Bonzai Engine bonzaiengine.com Copyright © 2007-2019 Jérôme Jouvie)

java.lang.Object
- com.bonzaiengine.effects.hydrax.HydraX

```
public class HydraX
extends java.lang.Object
```
Main HydraX class. HydraX is a plugin whose aim is rendering realistic water scenes Do not use two instances of the HydraX class.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

class HydraX.HydraXPreparePlugin

class HydraX.HydraXRenderPlugin

Nested Classes
Modifier and Type	Class and Description
`class`	`HydraX.HydraXPreparePlugin`
`class`	`HydraX.HydraXRenderPlugin`

Field Summary

Fields
Modifier and Type	Field and Description
`static float`	`EARTH_GRAVITY` Earth gravity (m/s2)
`static int`	`HYDRAX_VERSION_MAJOR`
`static int`	`HYDRAX_VERSION_MINOR`
`static int`	`HYDRAX_VERSION_PATCH`
`static int`	`SEAWATER_DENSITY` Seawater density (kg/m3)
`static java.lang.String`	`SURFACE_UNDERWATER_DEPTH`
`static int`	`UNIT_SCALE` 1m = UNIT_SCALE unit Default value: UNIT_SCALE = 1 = 1m

Constructor Summary

Constructors
Constructor and Description

HydraX(AssetManager assets, View c)
Constructor

Constructors
Constructor and Description
`HydraX(AssetManager assets, View c)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`_isCurrentFrameUnderwater()` Is current frame underwater?
`protected void`	`_setStrength(float strength)` Set water strength GPU param
`void`	`addDepthSurface(Material material)`
`void`	`create()` Create all resources according with current HydraX components and add HydraX to the scene.
`void`	`destroy(IGLApi glApi)`
`float`	`getCausticsEnd()` Get caustics end
`float`	`getCausticsPower()` Get caustics power
`float`	`getCausticsScale()` Get caustics scale
`float`	`getDepthLimit()` Get depth limit
`float`	`getDistLimit()` Get distance limit (viewable underwater)
`float`	`getFoamMaxDistance()` Get foam max distance
`float`	`getFoamScale()` Get foam scale
`float`	`getFoamStart()` Get foam start
`float`	`getFoamTransparency()` Get foam transparency
`float`	`getFullReflectionDistance()` Get full reflection distance
`float`	`getGlobalTransparency()` Get global transparency
`Vec3`	`getGodRaysExposure(Vec3 dst)` Get God rays exposure factors
`float`	`getGodRaysIntensity()` Get God rays intensity
`Module`	`getModule()` Get our Module::Module
`float`	`getNormalDistortion()` Get normal distortion
`HydraX.HydraXPreparePlugin`	`getPipelinePreparePlugin()`
`HydraX.HydraXRenderPlugin`	`getPipelineRenderPlugin()`
`float`	`getPlanesError()` Get current clip planes error
`float`	`getSmoothPower()` Get smooth power
`float`	`getSunArea()` Get sun area
`Vec3`	`getSunColor(Vec3 dst)` Get sun color
`Vec3`	`getSunPosition(Vec3 dst)` Get sun position
`float`	`getSunStrength()` Get water strength
`float`	`getUnderwaterCameraSwitchDelta()` Get the y-displacement under the water needed to change between underwater and overwater mode
`Vec3`	`getWaterColor(Vec3 dst)` Get water color
`boolean`	`isComponent(HydraXComponent component)` Returns if the specified component is active
`boolean`	`isCreated()` Has create() already called?
`boolean`	`isVisible()` Is hydrax water visible?
`boolean`	`loadConfig(Stream stream)` Load config from file
`void`	`render(IGLApi glApi, ISurfaceRenderable scene)` Render with scene composition (reflection, ...)
`boolean`	`saveConfig(Stream stream)` Save hydrax config to file
`void`	`setCausticsEnd(float causticsEnd)` Set caustics end
`void`	`setCausticsPower(float causticsPower)` Set caustics power
`void`	`setCausticsScale(float causticsScale)` Set caustics scale
`void`	`setComponents(Array<HydraXComponent> _components_)` Set HydraX components
`void`	`setDepthLimit(float depthLimit)` Set depth limit
`void`	`setDistLimit(float distLimit)` Set distance limit underwater (occlusion)
`void`	`setFoamMaxDistance(float foamMaxDistance)` Set foam max distance
`void`	`setFoamScale(float foamScale)` Set foam scale
`void`	`setFoamStart(float foamStart)` Set foam start
`void`	`setFoamTransparency(float foamTransparency)` Set foam transparency
`void`	`setFullReflectionDistance(float fullReflectionDistance)` Set full reflection distance
`void`	`setGlobalTransparency(float globalTransparency)` Set global transparency
`void`	`setGodRaysExposure(Vec3 godRaysExposure)` Set god rays exposure
`void`	`setGodRaysIntensity(float godRaysIntensity)` Set god rays intensity
`void`	`setModule(Module _module)` Set HydraX module
`void`	`setNormalDistortion(float normalDistortion)` Set normal distortion
`void`	`setPlanesError(float planesError)` Set clip planes error
`void`	`setSmoothPower(float smoothPower)` Set smooth power
`void`	`setSunArea(float sunArea)` Set sun area
`void`	`setSunColor(Vec3 sunColor)` Set sun color
`void`	`setSunPosition(Vec3 sunPosition)` Set sun position
`void`	`setSunStrength(float sunStrength)` Set sun strength
`void`	`setUnderwaterCameraSwitchDelta(float underwaterCameraSwitchDelta)`
`void`	`setVisible(boolean visible)` Show/Hide hydrax water
`void`	`setWaterColor(Vec3 waterColor)` Set water color
`void`	`update(float timeSinceLastFrame)` Call every frame
`void`	`updateView()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - HYDRAX_VERSION_MAJOR
```
public static final int HYDRAX_VERSION_MAJOR
```
    See Also:
    
    Constant Field Values
  - HYDRAX_VERSION_MINOR
```
public static final int HYDRAX_VERSION_MINOR
```
    See Also:
    
    Constant Field Values
  - HYDRAX_VERSION_PATCH
```
public static final int HYDRAX_VERSION_PATCH
```
    See Also:
    
    Constant Field Values
  - SURFACE_UNDERWATER_DEPTH
```
public static final java.lang.String SURFACE_UNDERWATER_DEPTH
```
    See Also:
    
    Constant Field Values
  - UNIT_SCALE
```
public static int UNIT_SCALE
```
    1m = UNIT_SCALE unit
    Default value: UNIT_SCALE = 1 = 1m
  - EARTH_GRAVITY
```
public static final float EARTH_GRAVITY
```
    Earth gravity (m/s2)
    
    See Also:
    
    Constant Field Values
  - SEAWATER_DENSITY
```
public static final int SEAWATER_DENSITY
```
    Seawater density (kg/m3)
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HydraX
```
public HydraX(AssetManager assets,
              View c)
```
    Constructor
    
    Parameters:
    
    sm - Ogre SceneManager
    
    c - Ogre Camera
    
    v - Ogre Main window viewport
- Method Detail
  - destroy
```
public void destroy(IGLApi glApi)
```
  - create
```
public void create()
```
    Create all resources according with current HydraX components and add HydraX to the scene.
  - addDepthSurface
```
public void addDepthSurface(Material material)
```
  - update
```
public void update(float timeSinceLastFrame)
```
    Call every frame
  - updateView
```
public void updateView()
```
  - render
```
public final void render(IGLApi glApi,
                         ISurfaceRenderable scene)
```
    Render with scene composition (reflection, ...) HydraX, the specified scene with optionally the SkyX specified.
    
    Parameters:
    
    glApi -
    
    skyX - optional SkyX
    
    scene -
  - getPipelinePreparePlugin
```
public HydraX.HydraXPreparePlugin getPipelinePreparePlugin()
```
  - getPipelineRenderPlugin
```
public HydraX.HydraXRenderPlugin getPipelineRenderPlugin()
```
  - isCreated
```
public boolean isCreated()
```
    Has create() already called?
    
    Returns:
    
    true is yes, false if not
  - setVisible
```
public void setVisible(boolean visible)
```
    Show/Hide hydrax water
    
    Parameters:
    
    Visible - true to show, false to hide
  - isVisible
```
public boolean isVisible()
```
    Is hydrax water visible?
    
    Returns:
    
    true if yes, false if not
  - loadConfig
```
public boolean loadConfig(Stream stream)
```
    Load config from file
    
    Parameters:
    
    stream - File name
    
    Returns:
    
    false if an error has been ocurred(Check the log file in this case).
  - saveConfig
```
public boolean saveConfig(Stream stream)
```
    Save hydrax config to file
    
    Parameters:
    
    stream - File name
    
    Returns:
    
    false if an error has been ocurred(Check the log file in this case).
  - setModule
```
public void setModule(Module _module)
```
    Set HydraX module
    
    Parameters:
    
    _module - HydraX module
    
    See Also:
    
    ProjectedGrid
  - setComponents
```
public void setComponents(Array<HydraXComponent> _components_)
```
    Set HydraX components
    
    Parameters:
    
    Components - Components
  - isComponent
```
public boolean isComponent(HydraXComponent component)
```
    Returns if the specified component is active
    
    Parameters:
    
    component - Component that we want to check
  - setPlanesError
```
public void setPlanesError(float planesError)
```
    Set clip planes error
    
    Parameters:
    
    PlanesError - Clip planes error
  - getPlanesError
```
public float getPlanesError()
```
    Get current clip planes error
    
    Returns:
    
    Current clip planes error
  - _setStrength
```
protected void _setStrength(float strength)
```
    Set water strength GPU param
    
    Parameters:
    
    strength - Water strength GPU param
  - setFullReflectionDistance
```
public void setFullReflectionDistance(float fullReflectionDistance)
```
    Set full reflection distance
    
    Parameters:
    
    fullReflectionDistance - Full reflection distance
  - getFullReflectionDistance
```
public float getFullReflectionDistance()
```
    Get full reflection distance
    
    Returns:
    
    HydraX water full reflection distance
  - setGlobalTransparency
```
public void setGlobalTransparency(float globalTransparency)
```
    Set global transparency
    
    Parameters:
    
    globalTransparency - Global transparency distance
  - getGlobalTransparency
```
public float getGlobalTransparency()
```
    Get global transparency
    
    Returns:
    
    HydraX water global transparency
  - setWaterColor
```
public void setWaterColor(Vec3 waterColor)
```
    Set water color
    
    Parameters:
    
    DepthColor - Water color
  - getWaterColor
```
public Vec3 getWaterColor(Vec3 dst)
```
    Get water color
    
    Returns:
    
    Water color
  - setNormalDistortion
```
public void setNormalDistortion(float normalDistortion)
```
    Set normal distortion
    
    Parameters:
    
    normalDistortion - Normal distortion
  - getNormalDistortion
```
public float getNormalDistortion()
```
    Get normal distortion
    
    Returns:
    
    HydraX normal distortion
  - setSunPosition
```
public void setSunPosition(Vec3 sunPosition)
```
    Set sun position
    
    Parameters:
    
    sunPosition - Sun position
  - getSunPosition
```
public Vec3 getSunPosition(Vec3 dst)
```
    Get sun position
    
    Returns:
    
    Sun position
  - setSunStrength
```
public void setSunStrength(float sunStrength)
```
    Set sun strength
    
    Parameters:
    
    sunStrength - Sun strength
  - getSunStrength
```
public float getSunStrength()
```
    Get water strength
    
    Returns:
    
    HydraX water strength
  - setSunArea
```
public void setSunArea(float sunArea)
```
    Set sun area
    
    Parameters:
    
    sunArea - Sun area
  - getSunArea
```
public float getSunArea()
```
    Get sun area
    
    Returns:
    
    Sun area
  - setSunColor
```
public void setSunColor(Vec3 sunColor)
```
    Set sun color
    
    Parameters:
    
    sunColor - Sun color
  - getSunColor
```
public Vec3 getSunColor(Vec3 dst)
```
    Get sun color
    
    Returns:
    
    Sun color
  - setFoamMaxDistance
```
public void setFoamMaxDistance(float foamMaxDistance)
```
    Set foam max distance
    
    Parameters:
    
    foamMaxDistance - Foam max distance
  - getFoamMaxDistance
```
public float getFoamMaxDistance()
```
    Get foam max distance
    
    Returns:
    
    Foam max distance
  - setFoamScale
```
public void setFoamScale(float foamScale)
```
    Set foam scale
    
    Parameters:
    
    foamScale - Foam scale
  - getFoamScale
```
public float getFoamScale()
```
    Get foam scale
    
    Returns:
    
    Foam scale
  - setFoamStart
```
public void setFoamStart(float foamStart)
```
    Set foam start
    
    Parameters:
    
    foamStart - Foam start
  - getFoamStart
```
public float getFoamStart()
```
    Get foam start
    
    Returns:
    
    Foam start
  - setFoamTransparency
```
public void setFoamTransparency(float foamTransparency)
```
    Set foam transparency
    
    Parameters:
    
    foamTransparency - Foam transparency
  - getFoamTransparency
```
public float getFoamTransparency()
```
    Get foam transparency
    
    Returns:
    
    Foam scale
  - setDepthLimit
```
public void setDepthLimit(float depthLimit)
```
    Set depth limit
    
    Parameters:
    
    depthLimit - Depth limit
  - getDepthLimit
```
public float getDepthLimit()
```
    Get depth limit
    
    Returns:
    
    Depth limit
  - setDistLimit
```
public void setDistLimit(float distLimit)
```
    Set distance limit underwater (occlusion)
    
    Parameters:
    
    distLimit - Distance limit
  - getDistLimit
```
public float getDistLimit()
```
    Get distance limit (viewable underwater)
    
    Returns:
    
    Distance limit
  - setSmoothPower
```
public void setSmoothPower(float smoothPower)
```
    Set smooth power
    
    Parameters:
    
    smoothPower - Smooth power
  - getSmoothPower
```
public float getSmoothPower()
```
    Get smooth power
    
    Returns:
    
    Smooth power
  - setCausticsScale
```
public void setCausticsScale(float causticsScale)
```
    Set caustics scale
    
    Parameters:
    
    causticsScale - Caustics scale
  - getCausticsScale
```
public float getCausticsScale()
```
    Get caustics scale
    
    Returns:
    
    Caustics scale
  - setCausticsPower
```
public void setCausticsPower(float causticsPower)
```
    Set caustics power
    
    Parameters:
    
    causticsPower - Caustics power
  - getCausticsPower
```
public float getCausticsPower()
```
    Get caustics power
    
    Returns:
    
    Caustics power
  - setCausticsEnd
```
public void setCausticsEnd(float causticsEnd)
```
    Set caustics end
    
    Parameters:
    
    causticsEnd - Caustics end
  - getCausticsEnd
```
public float getCausticsEnd()
```
    Get caustics end
    
    Returns:
    
    Caustics end
  - setGodRaysExposure
```
public void setGodRaysExposure(Vec3 godRaysExposure)
```
    Set god rays exposure
    
    Parameters:
    
    godRaysExposure - God rays exposure
  - getGodRaysExposure
```
public Vec3 getGodRaysExposure(Vec3 dst)
```
    Get God rays exposure factors
    
    Returns:
    
    God rays exposure factors
  - setGodRaysIntensity
```
public void setGodRaysIntensity(float godRaysIntensity)
```
    Set god rays intensity
    
    Parameters:
    
    godRaysIntensity - God rays intensity
  - getGodRaysIntensity
```
public float getGodRaysIntensity()
```
    Get God rays intensity
    
    Returns:
    
    God rays intensity
  - getUnderwaterCameraSwitchDelta
```
public float getUnderwaterCameraSwitchDelta()
```
    Get the y-displacement under the water needed to change between underwater and overwater mode
    
    Returns:
    
    Underwater camera switch delta
  - setUnderwaterCameraSwitchDelta
```
public void setUnderwaterCameraSwitchDelta(float underwaterCameraSwitchDelta)
```
  - _isCurrentFrameUnderwater
```
protected boolean _isCurrentFrameUnderwater()
```
    Is current frame underwater?
    
    Returns:
    
    true If yes, false if not
  - getModule
```
public Module getModule()
```
    Get our Module::Module
    
    Returns:
    
    Module::Module pointer or NULL if Module isn't set.

Class HydraX

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

HYDRAX_VERSION_MAJOR

HYDRAX_VERSION_MINOR

HYDRAX_VERSION_PATCH

SURFACE_UNDERWATER_DEPTH

UNIT_SCALE

EARTH_GRAVITY

SEAWATER_DENSITY

Constructor Detail

HydraX

Method Detail

destroy

create

addDepthSurface

update

updateView

render

getPipelinePreparePlugin

getPipelineRenderPlugin

isCreated

setVisible

isVisible

loadConfig

saveConfig

setModule

setComponents

isComponent

setPlanesError

getPlanesError

_setStrength

setFullReflectionDistance

getFullReflectionDistance

setGlobalTransparency

getGlobalTransparency

setWaterColor

getWaterColor

setNormalDistortion

getNormalDistortion

setSunPosition

getSunPosition

setSunStrength

getSunStrength

setSunArea

getSunArea

setSunColor

getSunColor

setFoamMaxDistance

getFoamMaxDistance

setFoamScale

getFoamScale

setFoamStart

getFoamStart

setFoamTransparency

getFoamTransparency

setDepthLimit

getDepthLimit

setDistLimit

getDistLimit

setSmoothPower

getSmoothPower

setCausticsScale

getCausticsScale

setCausticsPower

getCausticsPower

setCausticsEnd

getCausticsEnd

setGodRaysExposure

getGodRaysExposure

setGodRaysIntensity

getGodRaysIntensity

getUnderwaterCameraSwitchDelta

setUnderwaterCameraSwitchDelta

_isCurrentFrameUnderwater

getModule