luciad::GraphicsEffects Class Reference

This class contains the graphics effects that can be applied to a map. More...

#include <luciad/maps/effects/GraphicsEffects.h>

Public Member Functions
AmbientOcclusionEffect &	getAmbientOcclusion ()
	Returns the ambient occlusion effect that is used.
const AmbientOcclusionEffect &	getAmbientOcclusion () const
	Returns the ambient occlusion effect that is used.
AtmosphereEffect &	getAtmosphere ()
	Returns the atmosphere effect that is used.
const AtmosphereEffect &	getAtmosphere () const
	Returns the atmosphere effect that is used.
BloomEffect &	getBloom ()
	Returns the bloom effect that is used.
const BloomEffect &	getBloom () const
	Returns the bloom effect that is used.
DepthOfFieldEffect &	getDepthOfField ()
	Returns the depth-of-field effect that is used.
const DepthOfFieldEffect &	getDepthOfField () const
	Returns the depth-of-field effect that is used.
EnvironmentMapEffect &	getEnvironmentMap ()
	Returns the environment map effect that is used.
const EnvironmentMapEffect &	getEnvironmentMap () const
	Returns the environment map effect that is used.
EyeDomeLightingEffect &	getEyeDomeLighting ()
	Returns the eye-dome lighting effect that is used.
const EyeDomeLightingEffect &	getEyeDomeLighting () const
	Returns the eye-dome lighting effect that is used.
FogEffect &	getFog ()
	Returns the fog effect that is used.
const FogEffect &	getFog () const
	Returns the fog effect that is used.
LightEffect &	getLight ()
	Returns the light effect that is used.
const LightEffect &	getLight () const
	Returns the light effect that is used.

Detailed Description

This class contains the graphics effects that can be applied to a map.

You cannot create a GraphicsEffects. Instead, you can retrieve it from luciad::Map::getEffects and assign properties.

Available effects are:

• luciad::EyeDomeLightingEffect
• luciad::AmbientOcclusionEffect
• luciad::AtmosphereEffect
• luciad::EnvironmentMapEffect
• luciad::FogEffect
• luciad::DepthOfFieldEffect
• luciad::LightEffect

Since

2022.1

Member Function Documentation

getAmbientOcclusion() [1/2]

AmbientOcclusionEffect & luciad::GraphicsEffects::getAmbientOcclusion

(

)

Returns the ambient occlusion effect that is used.

Note that ambient occlusion is only applied in 3D views.

Returns

the ambient occlusion effect that is used.

getAmbientOcclusion() [2/2]

const AmbientOcclusionEffect & luciad::GraphicsEffects::getAmbientOcclusion

(

)

const

Returns the ambient occlusion effect that is used.

Note that ambient occlusion is only applied in 3D views.

Returns

the ambient occlusion effect that is used.

getAtmosphere() [1/2]

AtmosphereEffect & luciad::GraphicsEffects::getAtmosphere

(

)

Returns the atmosphere effect that is used.

Note that the atmosphere is only applied in 3D views.

Returns

the atmosphere effect that is used.

Since

2023.1

getAtmosphere() [2/2]

const AtmosphereEffect & luciad::GraphicsEffects::getAtmosphere

(

)

const

Returns the atmosphere effect that is used.

Note that the atmosphere is only applied in 3D views.

Returns

the atmosphere effect that is used.

Since

2023.1

getBloom() [1/2]

BloomEffect & luciad::GraphicsEffects::getBloom

(

)

Returns the bloom effect that is used.

Returns

the bloom effect that is used.

Since

2026.1

getBloom() [2/2]

const BloomEffect & luciad::GraphicsEffects::getBloom

(

)

const

Returns the bloom effect that is used.

Returns

the bloom effect that is used.

Since

2026.1

getDepthOfField() [1/2]

DepthOfFieldEffect & luciad::GraphicsEffects::getDepthOfField

(

)

Returns the depth-of-field effect that is used.

Note that depth of field is only applied in 3D views.

Returns

the depth-of-field effect that is used.

Since

2026.1

getDepthOfField() [2/2]

const DepthOfFieldEffect & luciad::GraphicsEffects::getDepthOfField

(

)

const

Returns the depth-of-field effect that is used.

Note that depth of field is only applied in 3D views.

Returns

the depth-of-field effect that is used.

Since

2026.1

getEnvironmentMap() [1/2]

EnvironmentMapEffect & luciad::GraphicsEffects::getEnvironmentMap

(

)

Returns the environment map effect that is used.

Note that the environment map is only applied in 3D views.

Returns

the environment map effect that is used.

Since

2026.1

getEnvironmentMap() [2/2]

const EnvironmentMapEffect & luciad::GraphicsEffects::getEnvironmentMap

(

)

const

Returns the environment map effect that is used.

Note that the environment map is only applied in 3D views.

Returns

the environment map effect that is used.

Since

2026.1

getEyeDomeLighting() [1/2]

EyeDomeLightingEffect & luciad::GraphicsEffects::getEyeDomeLighting

(

)

Returns the eye-dome lighting effect that is used.

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

Returns

the eye-dome lighting effect that is used.

getEyeDomeLighting() [2/2]

const EyeDomeLightingEffect & luciad::GraphicsEffects::getEyeDomeLighting

(

)

const

Returns the eye-dome lighting effect that is used.

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

Returns

the eye-dome lighting effect that is used.

getFog() [1/2]

FogEffect & luciad::GraphicsEffects::getFog

(

)

Returns the fog effect that is used.

Note that fog is only applied in 3D views.

Returns

the fog effect that is used.

Since

2026.1

getFog() [2/2]

const FogEffect & luciad::GraphicsEffects::getFog

(

)

const

Returns the fog effect that is used.

Note that fog is only applied in 3D views.

Returns

the fog effect that is used.

Since

2026.1

getLight() [1/2]

LightEffect & luciad::GraphicsEffects::getLight

(

)

Returns the light effect that is used.

By default, a map is lit with a headlight, meaning 3D content is shaded even when no light is configured. Use the returned LightEffect to change the light or to disable it with LightEffect::setEnabled.

Returns

the light effect that is used.

Since

2026.1

getLight() [2/2]

const LightEffect & luciad::GraphicsEffects::getLight

(

)

const

Returns the light effect that is used.

By default, a map is lit with a headlight, meaning 3D content is shaded even when no light is configured. Use the returned LightEffect to change the light or to disable it with LightEffect::setEnabled.

Returns

the light effect that is used.

Since

2026.1