Luciad.Maps.Effects.EyeDomeLightingEffect Class Reference

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

Inheritance diagram for Luciad.Maps.Effects.EyeDomeLightingEffect:

Public Member Functions
void	Dispose ()
void	Set (int window, double strength, System.Drawing.Color color)
	Sets multiple properties in one go. More...

Properties
System.Drawing.Color	Color [get, set]
	The color of the shade. More...
bool	IsEnabled [get, set]
	Whether the Eye-dome lighting effect is enabled. More...
double	Strength [get, set]
	The shading multiplication factor. More...
int	Window [get, set]
	The number of surrounding pixels taken into account by EDL model. More...

Detailed Description

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

Left: eye-dome lighting disabled, Right: eye-dome lighting enabled

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 3 properties:

• 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.
• the color property defines what color the shade will have.

Note that Eye-dome lighting is only applied in 3D views.

You cannot create an EyeDomeLightingEffect. Instead, you can retrieve it from GraphicsEffects.EyeDomeLighting.

Since

2022.1

Member Function Documentation

Dispose()

void Luciad.Maps.Effects.EyeDomeLightingEffect.Dispose ( )

inline

Set()

void Luciad.Maps.Effects.EyeDomeLightingEffect.Set ( int  window, double  strength, System.Drawing.Color  color  )

inline

Sets multiple properties in one go.

Parameters

window	number of surrounding pixels taken into account by EDL model.
strength	color of the shade.
color	shading multiplication factor.

See also

Window

Strength

Color

Property Documentation

Color

System.Drawing.Color Luciad.Maps.Effects.EyeDomeLightingEffect.Color

getset

The color of the shade.

[get]

Returns the color of the shade.

[set]

Sets the color of the shade. Note that the alpha component of the color is ignored so the color is fully opaque.

The default color is black.

IsEnabled

bool Luciad.Maps.Effects.EyeDomeLightingEffect.IsEnabled

getset

Whether the Eye-dome lighting effect is enabled.

[get]

Returns whether the Eye-dome lighting effect is enabled.

[set]

Sets whether the Eye-dome lighting effect is enabled. The default is false.

Strength

double Luciad.Maps.Effects.EyeDomeLightingEffect.Strength

getset

The shading multiplication factor.

[get]

Returns the shading multiplication factor.

[set]

Sets the shading multiplication factor. A value between 0 and 1 softens the shade, a value higher than 1 hardens the shade.

The default strength is 1.

Window

int Luciad.Maps.Effects.EyeDomeLightingEffect.Window

getset

The number of surrounding pixels taken into account by EDL model.

[get]

Returns the number of surrounding pixels taken into account by EDL model.

[set]

Sets the number of surrounding pixels taken into account by EDL model. The default window is 2.