Package com.luciad.view.lightspeed.style

Class TLspEyeDomeLightingSettings

java.lang.Object

com.luciad.view.lightspeed.style.TLspEyeDomeLightingSettings

public final class TLspEyeDomeLightingSettings
extends Object

This settings class presents a set of properties for handling eye-dome lighting.

Eye-dome lighting (EDL) is a non-photorealistic lighting model, which helps accentuate the shapes of different objects to improve depth perception, by shading their outlines.

The effect can be seen in these screenshots of a layer displaying point cloud data using a TLspPointCloudStyle:

Picture 1: EDL is disabled

Picture 2: EDL is enabled

Technically, the lighting model applies a shade to each pixel, based on the depth difference between that pixel and its surrounding pixels. The EDL technique uses 4 properties, all to be set in this settings object:

• the enabled property defines whether the EDL has to be applied.
• the window property defines how many surrounding pixels must be taken into account.
• the strength property is a factor to multiply with the shading that is applied to the image. A value between 0 and 1 will soften the shade, a value between 1 and 4 will harden the shade.
• the color property defines what color the shade will have.

Construction and configuration is done through the TLspEyeDomeLightingSettings.Builder class, of which an instance can be acquired via newBuilder(). See TLspEyeDomeLightingSettings.Builder for default values.

Example:

    TLspEyeDomeLightingSettings settings = TLspEyeDomeLightingSettings.newBuilder()
                                                                      .enabled(true)
                                                                      .window(2)
                                                                      .strength(0.85)
                                                                      .color(Color.RED)
                                                                      .build();

Since:

2019.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	TLspEyeDomeLightingSettings.Builder	Builder used to create eye-dome lighting settings.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object aO)
Color	getColor()	Returns the value for the EDL color, which defines what color the shade will have.
double	getStrength()	Returns the value for the EDL strength, which is a factor to multiply with the shading that is applied to the image.
int	getWindow()	Returns the value for the EDL window, which defines how many surrounding pixels must be taken into account.
int	hashCode()
boolean	isEnabled()	Returns whether EDL is enabled.
static TLspEyeDomeLightingSettings.Builder	newBuilder()	Creates a new builder with the default values.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public static TLspEyeDomeLightingSettings.Builder newBuilder()

Creates a new builder with the default values.

Returns:

the new builder.

See Also:

• Builder for default values

isEnabled

public boolean isEnabled()

Returns whether EDL is enabled.

Returns:

true if EDL is enabled

See Also:

• TLspEyeDomeLightingSettings.Builder.enabled(boolean)

getWindow

public int getWindow()

Returns the value for the EDL window, which defines how many surrounding pixels must be taken into account.

Returns:

the value for the EDL window

See Also:

• TLspEyeDomeLightingSettings.Builder.window(int)

getStrength

public double getStrength()

Returns the value for the EDL strength, which is a factor to multiply with the shading that is applied to the image. A value between 0 and 1 will soften the shade, a value between 1 and 4 will harden the shade.

Returns:

the value for the EDL strength

See Also:

• TLspEyeDomeLightingSettings.Builder.strength(double)

getColor

public Color getColor()

Returns the value for the EDL color, which defines what color the shade will have.

Returns:

the value for the EDL color

See Also:

• TLspEyeDomeLightingSettings.Builder.color(Color)

equals

public boolean equals(Object aO)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object