Luciad.Maps.Effects.AtmosphereEffect Class Reference

Graphics effect which adds a sky/atmosphere background to a 3D view. More...

Inheritance diagram for Luciad.Maps.Effects.AtmosphereEffect:

Public Member Functions
void	Dispose ()

Properties
System.Drawing.Color	HorizonColor [get, set]
	The horizon color. More...
bool	IsEnabled [get, set]
	Whether the atmosphere effect is enabled. More...
System.Drawing.Color	SkyColor [get, set]
	The sky color. More...

Detailed Description

Graphics effect which adds a sky/atmosphere background to a 3D view.

This effect is only applied in 3D views.

If the view has a geocentric reference, an atmospheric glow effect is drawn around the globe. The colors of this glow can be configured using setHorizonColor() and setSkyColor().

You cannot create an AtmosphereEffect. Instead, you can retrieve it from GraphicsEffects.Atmosphere.

Since

2023.1

Member Function Documentation

Dispose()

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

inline

Property Documentation

HorizonColor

System.Drawing.Color Luciad.Maps.Effects.AtmosphereEffect.HorizonColor

getset

The horizon color.

[get]

Returns the horizon color. Only used in geocentric views, where a gradient going from getHorizonColor() to getSkyColor() will be visible on the horizon.

[set]

Sets the horizon color.

IsEnabled

bool Luciad.Maps.Effects.AtmosphereEffect.IsEnabled

getset

Whether the atmosphere effect is enabled.

[get]

Returns whether the atmosphere effect is enabled.

[set]

Sets whether the atmosphere effect is enabled. The default is true.

SkyColor

System.Drawing.Color Luciad.Maps.Effects.AtmosphereEffect.SkyColor

getset

The sky color.

[get]

Returns the sky color. Only used in geocentric views, where a gradient going from getHorizonColor() to getSkyColor() will be visible on the horizon.

[set]

Sets the sky color.