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

java.lang.Object
- com.bonzaiengine.effects.skyx.VolClouds

public final class VolClouds
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class VolClouds.CameraData
Camera data struct

static class VolClouds.GeometrySettings
Geometry settings

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`VolClouds.CameraData` Camera data struct
`static class`	`VolClouds.GeometrySettings` Geometry settings

Constructor Summary

Constructors
Modifier Constructor and Description

protected VolClouds(SkyX s)
Simple constructor

Constructors
Modifier	Constructor and Description
`protected`	`VolClouds(SkyX s)` Simple constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Array<VolClouds.CameraData>`	`_getCamerasData()` Get cameras data
`protected void`	`create(Vec2 height, float radius)` Create
`protected void`	`create(VolClouds.GeometrySettings gs)` Create
`protected void`	`createIfNeeded(IGLApi glApi)` Create
`protected void`	`destroy(IGLApi glApi)`
`Vec3`	`getAmbientColor(Vec3 dst)` Get Ambient color
`Vec4`	`getAmbientFactors(Vec4 dst)` Get ambient factors
`protected View`	`getCamera()`
`float`	`getCloudFieldScale()` Get cloud field scale
`protected com.bonzaiengine.effects.skyx.DataManager`	`getDataManager()` Get data manager
`void`	`getDistanceFallingParams(Vec2 dst)` Get distance falling params
`protected com.bonzaiengine.effects.skyx.GeometryManager`	`getGeometryManager()` Get geometry manager
`VolClouds.GeometrySettings`	`getGeometrySettings()` Get geometry settings
`float`	`getGlobalOpacity()` Get global opacity
`LightningManager`	`getLightningManager()` Get lightning manager
`Vec4`	`getLightResponse(Vec4 dst)` Get light response
`float`	`getNoiseScale()` Get noise scale
`protected SkyX`	`getSkyX()`
`void`	`getSunColor(Vec3 dst)` Get sun color
`void`	`getSunDirection(Vec3 dst)` Get sun direction
`Vec2`	`getWeather(Vec2 dst)` Get weather
`float`	`getWindDirection()` Get wind direction
`void`	`getWindDirectionV2(Vec2 dst)` Get wind direction as a Vector2
`float`	`getWindSpeed()` Get wind speed
`boolean`	`isCreated()` Has been create() already called?
`boolean`	`isVisible()` Is VolClouds visible?
`protected void`	`notifyCameraRender(IGLApi glApi, View c, float timeSinceLastCameraFrame)` Notify camera render, to be invoked per-camera and per-frame
`void`	`registerCamera(View c)` Register camera
`protected void`	`render(Renderer pipeline)`
`void`	`setAmbientColor(Vec3 ambientColor)` Set ambient color
`void`	`setAmbientFactors(Vec4 ambientFactors)` Set ambient factors
`void`	`setCloudFieldScale(float cloudFieldScale)` Set cloud field scale
`void`	`setDistanceFallingParams(Vec2 distanceFallingParams)` Set distance falling params
`void`	`setGeometrySettings(VolClouds.GeometrySettings geometrySettings)` Set geometry settings
`void`	`setGlobalOpacity(float globalOpacity)` Set global opacity
`void`	`setLightResponse(Vec4 lightResponse)` Set light response
`void`	`setNoiseScale(float noiseScale)` Set noise scale
`void`	`setSunColor(Vec3 sunColor)` Set sun color
`void`	`setSunDirection(Vec3 sunDirection)` Set sun direction
`void`	`setVisible(boolean visible)` Set visible
`void`	`setWeather(float humidity, float averageCloudsSize, boolean delayedResponse)` Set weather parameters Use this function to update the cloud field parameters, you'll get a smart and smooth transition from your old setting to your new ones.
`void`	`setWindDirection(float windDirection)` Set wind direction
`void`	`setWindSpeed(float windSpeed)` Set wind speed
`void`	`unregisterCamera(View c)` Unregister camera
`protected void`	`update(IGLApi glApi, float timeSinceLastFrame)` Update, to be invoked per frame

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

- Constructor Detail
  - VolClouds
```
protected VolClouds(SkyX s)
```
    Simple constructor
    
    Parameters:
    
    s - Scene manager
- Method Detail
  - destroy
```
protected void destroy(IGLApi glApi)
```
  - createIfNeeded
```
protected void createIfNeeded(IGLApi glApi)
```
    Create
  - create
```
protected void create(VolClouds.GeometrySettings gs)
```
    Create
    
    Parameters:
    
    gs - Geometry settings
  - create
```
protected void create(Vec2 height,
                      float radius)
```
    Create
    
    Parameters:
    
    height - x = Cloud field y-coord start, y: Field height (both in world coordinates)
    
    radius - Radius
  - update
```
protected void update(IGLApi glApi,
                      float timeSinceLastFrame)
```
    Update, to be invoked per frame
    
    Parameters:
    
    timeSinceLastFrame - Time since last frame
  - notifyCameraRender
```
protected void notifyCameraRender(IGLApi glApi,
                                  View c,
                                  float timeSinceLastCameraFrame)
```
    Notify camera render, to be invoked per-camera and per-frame
    
    Parameters:
    
    c - Rendering camera
    
    timeSinceLastCameraFrame - Time since last CAMERA frame
  - render
```
protected void render(Renderer pipeline)
```
  - registerCamera
```
public void registerCamera(View c)
```
    Register camera
    
    Parameters:
    
    c - Camera
  - unregisterCamera
```
public void unregisterCamera(View c)
```
    Unregister camera
    
    Parameters:
    
    c - Camera
  - isCreated
```
public boolean isCreated()
```
    Has been create() already called?
    
    Returns:
    
    true if created() have been already called, false if not
  - setGeometrySettings
```
public void setGeometrySettings(VolClouds.GeometrySettings geometrySettings)
```
    Set geometry settings
    
    Parameters:
    
    geometrySettings - Geometry settings
  - getGeometrySettings
```
public VolClouds.GeometrySettings getGeometrySettings()
```
    Get geometry settings
    
    Returns:
    
    Geometry settings
  - setDistanceFallingParams
```
public void setDistanceFallingParams(Vec2 distanceFallingParams)
```
    Set distance falling params
    
    Parameters:
    
    distanceFallingParams - DistanceFallingParams.x = Distance falling factor (How much the cloud field geometry falls with the distance) Remember that the geometry falling is relative to the distance(height) between the camera and the cloud field. Typical range is [0, ~2] 0 = no falling DistanceFallingParams.y = Max falling (in world coords), useful when , i.e., you've water and you want to go in. That param will allow you to avoid the cloud field geometry falls into the ocean. -1 means not max falling. (default)
  - getDistanceFallingParams
```
public void getDistanceFallingParams(Vec2 dst)
```
    Get distance falling params
  - setWindDirection
```
public void setWindDirection(float windDirection)
```
    Set wind direction
    
    Parameters:
    
    windDirection - Wind direction
  - getWindDirection
```
public float getWindDirection()
```
    Get wind direction
    
    Returns:
    
    Wind direction
  - getWindDirectionV2
```
public void getWindDirectionV2(Vec2 dst)
```
    Get wind direction as a Vector2
  - setWindSpeed
```
public void setWindSpeed(float windSpeed)
```
    Set wind speed
    
    Parameters:
    
    windSpeed - Wind speed
  - getWindSpeed
```
public float getWindSpeed()
```
    Get wind speed
    
    Returns:
    
    Wind speed
  - setSunDirection
```
public void setSunDirection(Vec3 sunDirection)
```
    Set sun direction
    
    Parameters:
    
    sunDirection - Sun direction
  - getSunDirection
```
public void getSunDirection(Vec3 dst)
```
    Get sun direction
  - setSunColor
```
public void setSunColor(Vec3 sunColor)
```
    Set sun color
    
    Parameters:
    
    sunColor - Sun color
  - getSunColor
```
public void getSunColor(Vec3 dst)
```
    Get sun color
  - setAmbientColor
```
public void setAmbientColor(Vec3 ambientColor)
```
    Set ambient color
    
    Parameters:
    
    ambientColor - Ambient color
  - getAmbientColor
```
public Vec3 getAmbientColor(Vec3 dst)
```
    Get Ambient color
    
    Returns:
    
    Ambient color
  - setLightResponse
```
public void setLightResponse(Vec4 lightResponse)
```
    Set light response
    
    Parameters:
    
    lightResponse - x - Sun light power y - Sun beta multiplier z - Ambient color multiplier w - Distance attenuation
  - getLightResponse
```
public Vec4 getLightResponse(Vec4 dst)
```
    Get light response
    
    Returns:
    
    Light response
  - setAmbientFactors
```
public void setAmbientFactors(Vec4 ambientFactors)
```
    Set ambient factors
    
    Parameters:
    
    ambientFactors - x - constant, y - linear, z - quadratic, w - cubic
  - getAmbientFactors
```
public Vec4 getAmbientFactors(Vec4 dst)
```
    Get ambient factors
    
    Returns:
    
    Ambient factors
  - setGlobalOpacity
```
public void setGlobalOpacity(float globalOpacity)
```
    Set global opacity
    
    Parameters:
    
    globalOpacity - Global opacity: [0,1] range 0.Transparent cloud field
  - getGlobalOpacity
```
public float getGlobalOpacity()
```
    Get global opacity
    
    Returns:
    
    Global opacity
  - setCloudFieldScale
```
public void setCloudFieldScale(float cloudFieldScale)
```
    Set cloud field scale
    
    Parameters:
    
    cloudFieldScale - Cloud field scale
  - getCloudFieldScale
```
public float getCloudFieldScale()
```
    Get cloud field scale
    
    Returns:
    
    Cloud field scale
  - setNoiseScale
```
public void setNoiseScale(float noiseScale)
```
    Set noise scale
    
    Parameters:
    
    noiseScale - Noise scale
  - getNoiseScale
```
public float getNoiseScale()
```
    Get noise scale
    
    Returns:
    
    Noise scale
  - setWeather
```
public void setWeather(float humidity,
                       float averageCloudsSize,
                       boolean delayedResponse)
```
    Set weather parameters Use this function to update the cloud field parameters, you'll get a smart and smooth transition from your old setting to your new ones.
    
    Parameters:
    
    humidity - Humidity, in other words: the percentage of clouds in [0,1] range.
    
    averageCloudsSize - Average clouds size, for example: if previous weather clouds size parameter was very different from new one(i.e: more little) only the old biggest clouds are going to be keept and the little ones are going to be replaced
    
    delayedResponse - false to change weather conditions over several updates, true to change it at the moment
  - getWeather
```
public Vec2 getWeather(Vec2 dst)
```
    Get weather
    
    Returns:
    
    Weather parameters: x = Humidity, y = Average clouds size, both in [0,1] range
  - setVisible
```
public void setVisible(boolean visible)
```
    Set visible
    
    Parameters:
    
    visible - true to set VolClouds visible, false to hide it
  - isVisible
```
public boolean isVisible()
```
    Is VolClouds visible?
    
    Returns:
    
    true if VolClouds is visible, false otherwise
  - getSkyX
```
protected SkyX getSkyX()
```
  - getDataManager
```
protected com.bonzaiengine.effects.skyx.DataManager getDataManager()
```
    Get data manager
    
    Returns:
    
    Data manager
  - getGeometryManager
```
protected com.bonzaiengine.effects.skyx.GeometryManager getGeometryManager()
```
    Get geometry manager
    
    Returns:
    
    Geometry manager
  - getLightningManager
```
public LightningManager getLightningManager()
```
    Get lightning manager
    
    Returns:
    
    Lightning manager
  - getCamera
```
protected View getCamera()
```
  - _getCamerasData
```
protected Array<VolClouds.CameraData> _getCamerasData()
```
    Get cameras data
    
    Returns:
    
    Cameras data

Class VolClouds

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VolClouds

Method Detail

destroy

createIfNeeded

create

create

update

notifyCameraRender

render

registerCamera

unregisterCamera

isCreated

setGeometrySettings

getGeometrySettings

setDistanceFallingParams

getDistanceFallingParams

setWindDirection

getWindDirection

getWindDirectionV2

setWindSpeed

getWindSpeed

setSunDirection

getSunDirection

setSunColor

getSunColor

setAmbientColor

getAmbientColor

setLightResponse

getLightResponse

setAmbientFactors

getAmbientFactors

setGlobalOpacity

getGlobalOpacity

setCloudFieldScale

getCloudFieldScale

setNoiseScale

getNoiseScale

setWeather

getWeather

setVisible

isVisible

getSkyX

getDataManager

getGeometryManager

getLightningManager

getCamera

_getCamerasData