Package net.risingworld.api.objects.visuals

Class Fog

java.lang.Object

net.risingworld.api.objects.visuals.Fog

public final class Fog
extends Object

Post-processing effect: Global fog. Used in conjunction with a PostProcessing object.


Dense green fog

Constructor Summary

Constructors

Constructor	Description
Fog()

Method Summary

Modifier and Type	Method	Description
boolean	isOverridden()	Determines if the effect is set.
void	reset()	Resets the effect, so it is no longer active (and no longer overrides any game effects).
void	set(float attenuation, float r, float g, float b)	Sets the global fog.
void	set(float attenuation, float r, float g, float b, float maximumHeight, float baseHeight)	Sets the global fog.

Methods inherited from class java.lang.Object

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

Constructor Details

Fog

public Fog()

Method Details

set

public void set(float attenuation,
 float r,
 float g,
 float b)

Sets the global fog.

Parameters:

attenuation - fog attenuation (mean free path).

r - fog red color component (0-1, but HDR colors are also supported).

g - fog green color component (0-1, but HDR colors are also supported).

b - fog blue color component (0-1, but HDR colors are also supported).

set

public void set(float attenuation,
 float r,
 float g,
 float b,
 float maximumHeight,
 float baseHeight)

Sets the global fog.

Parameters:

attenuation - fog attenuation (mean free path).

r - fog red color component (0-1, but HDR colors are also supported).

g - fog green color component (0-1, but HDR colors are also supported).

b - fog blue color component (0-1, but HDR colors are also supported).

maximumHeight - max height for the fog (upper limit). Default value is 1000.

baseHeight - base height for the fog (lower limit). Default value is 0.

reset

public void reset()

Resets the effect, so it is no longer active (and no longer overrides any game effects).

isOverridden

public boolean isOverridden()

Determines if the effect is set.

Returns:

true if this effect was set, false if not (or if it was reset).