com.luciad.view.lightspeed.style

LuciadLightspeedClass TLspEyeDomeLightingSettings.Builder

java.lang.Object

com.luciad.view.lightspeed.style.TLspEyeDomeLightingSettings.Builder

Enclosing class:

TLspEyeDomeLightingSettings

public static final class TLspEyeDomeLightingSettings.Builder
extends Object

Builder used to create eye-dome lighting settings.

Default values:

• enabled(boolean): true
• window(int): 1
• strength(double): 1.0
• color(Color): black

Since:

2019.1

Method Summary

Modifier and Type	Method and Description
TLspEyeDomeLightingSettings	build() Construct a new settings object with the properties that are set on this builder.
TLspEyeDomeLightingSettings.Builder	color(Color aEdlColor) Sets the value for the color property that is used for shading the EDL.
TLspEyeDomeLightingSettings.Builder	enabled(boolean aEnabled) Sets the value for the enabled property that defines whether the EDL model has to be applied.
TLspEyeDomeLightingSettings.Builder	strength(double aEdlStrength) Sets the value for the strength property that is multiplied with the shading that is applied to the image.
TLspEyeDomeLightingSettings.Builder	window(int aEdlWindow) Sets the value for the window property that defines how many surrounding pixels must be taken into account for the EDL model.

Methods inherited from class java.lang.Object

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

Method Detail

enabled

public TLspEyeDomeLightingSettings.Builder enabled(boolean aEnabled)

Sets the value for the enabled property that defines whether the EDL model has to be applied.

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

Default value: true.

Parameters:

aEnabled - a value for the EDL enabled property

Returns:

this

window

public TLspEyeDomeLightingSettings.Builder window(int aEdlWindow)

Sets the value for the window property that defines how many surrounding pixels must be taken into account for the EDL model.

• a value of 1 to 10 will take into account a square area around a given pixel with a width and height of 2 * aEdlWindow + 1 for calculating the shade of that pixel;
• any other value will result in an IllegalArgumentException to be thrown.

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

Picture 1: EDL window 1

Picture 2: EDL window 5

Default value: 1.

Parameters:

aEdlWindow - a value for the EDL window, between 1 and 10 (inclusive)

Returns:

this

strength

public TLspEyeDomeLightingSettings.Builder strength(double aEdlStrength)

Sets the value for the strength property that is multiplied with the shading that is applied to the image.

• a value between 0.0 and 1.0 will soften the shade;
• a value between 1.0 and 4.0 will harden the shade;
• any other value will result in an IllegalArgumentException to be thrown

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

Picture 1: EDL strength 1.0

Picture 2: EDL strength 3.0

Default value: 1.0.

Parameters:

aEdlStrength - a value for the EDL strength, between 0.0 and 4.0 (inclusive)

Returns:

this

color

public TLspEyeDomeLightingSettings.Builder color(Color aEdlColor)

Sets the value for the color property that is used for shading the EDL.

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

Picture 1: EDL color black

Picture 2: EDL color dark red

Default value: black.

Parameters:

aEdlColor - a value for the EDL color

Returns:

this

build

public TLspEyeDomeLightingSettings build()

Construct a new settings object with the properties that are set on this builder.

Returns:

a new settings object