Luciad.Maps.Effects.AmbientOcclusionEffect Class Reference

This class implements the Ambient occlusion effect, which shades areas of 3D geometry based on their proximity to other 3D geometry. More...

Inheritance diagram for Luciad.Maps.Effects.AmbientOcclusionEffect:

Public Member Functions
void	Dispose ()
void	Set (double radius, double power)
	Sets the radius and power values for the ambient occlusion effect. More...

Properties
bool	IsEnabled [get, set]
	Whether the Ambient Occlusion effect is enabled. More...
double	Power [get, set]
	The power factor which determines how strongly the effect is applied to the view. More...
double	Radius [get, set]
	The radius in meters at which the effect is sampled. More...

Detailed Description

This class implements the Ambient occlusion effect, which shades areas of 3D geometry based on their proximity to other 3D geometry.

This mimics a behavior of the real world where light gets trapped in tight areas. Typical examples are the corners of a room, which are slightly darker than the rest of the room as the light is trapped in the corners.

Left: ambient occlusion disabled, Right: ambient occlusion enabled

Ambient Occlusion is recommended for cases in which 3D datasets with simple colors, such as 3D CAD & BIM models, are visualized. For these types of datasets, Ambient Occlusion can help give the dataset more depth and make it easier to understand how geometry relates to each other. On top of that, it also improves the visual quality of such datasets, and gives an overall better impression.

Note that Ambient Occlusion is only applied in 3D views.

You cannot create an AmbientOcclusionEffect. Instead, you can retrieve it from GraphicsEffects.AmbientOcclusion.

Since

2022.1

Member Function Documentation

Dispose()

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

inline

Set()

void Luciad.Maps.Effects.AmbientOcclusionEffect.Set ( double  radius, double  power  )

inline

Sets the radius and power values for the ambient occlusion effect.

Parameters

radius	radius in meters at which the effect should be sampled.
power	a factor to brighten or darken the effect.

See also

Radius

Power

Property Documentation

IsEnabled

bool Luciad.Maps.Effects.AmbientOcclusionEffect.IsEnabled

getset

Whether the Ambient Occlusion effect is enabled.

[get]

Returns whether the Ambient Occlusion effect is enabled.

[set]

Sets whether the Ambient Occlusion effect is enabled. The default is false.

Power

double Luciad.Maps.Effects.AmbientOcclusionEffect.Power

getset

The power factor which determines how strongly the effect is applied to the view.

[get]

Returns the power factor which determines how strongly the effect is applied to the view.

[set]

Sets the power factor which determines how strongly the effect is applied to the view. The power factor determines how much to brighten or darken the effect.

Values should be a positive floating point number, generally between 0 and 5. Higher values are accepted, but not recommended.

The default power value is 1.

Radius

double Luciad.Maps.Effects.AmbientOcclusionEffect.Radius

getset

The radius in meters at which the effect is sampled.

[get]

Returns the radius in meters at which the effect is sampled.

[set]

Sets the radius in meters at which the effect is sampled. A lower value produces sharper results, while higher values produce softer results.

The default radius is 30m.