Package net.risingworld.api.objects.visuals

Class LensDistortion

java.lang.Object

net.risingworld.api.objects.visuals.LensDistortion

public final class LensDistortion
extends Object

Post-processing effect: Screen distortion effect. Used in conjunction with a PostProcessing object.

Constructor Summary

Constructors

Constructor	Description
LensDistortion()

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 intensity, float scale)	Sets the lens distortion effect.
void	set(float intensity, float scale, float xMultiplier, float yMultiplier)	Sets the lens distortion effect.

Methods inherited from class java.lang.Object

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

Constructor Details

LensDistortion

public LensDistortion()

Method Details

set

public void set(float intensity,
 float scale)

Sets the lens distortion effect. To reset the values to the game default values, call reset()

Parameters:

intensity - distortion intensity, between -1 and +1.

scale - scale factor for the distortion (betwene 0 and 5).

set

public void set(float intensity,
 float scale,
 float xMultiplier,
 float yMultiplier)

Sets the lens distortion effect. To reset the values to the game default values, call reset()

Parameters:

intensity - distortion intensity, between -1 and +1.

scale - scale factor for the distortion (betwene 0 and 5).

xMultiplier - optional multiplier along the screen width (0-1). Default value is 1.

yMultiplier - optional multiplier along the screen height (0-1). Default value is 1.

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).