Package com.luciad.maps.effects

Class AmbientOcclusionModel.Builder

java.lang.Object

com.luciad.maps.effects.AmbientOcclusionModel.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

AmbientOcclusionModel

public static final class AmbientOcclusionModel.Builder
extends Object
implements AutoCloseable

Builder for an AmbientOcclusionModel.

Since:

2026.1

Constructor Summary

Constructors

Constructor	Description
Builder(AmbientOcclusionModel.Builder other)	Copy constructor.

Method Summary

Modifier and Type	Method	Description
AmbientOcclusionModel	build()	Builds the ambient-occlusion model.
void	close()
protected void	finalize()
AmbientOcclusionModel.Builder	performanceHint(PerformanceHint performanceHint)	Sets the performance hint that indicates if Ambient Occlusion should prioritize the quality or the rendering performance of the effect.
AmbientOcclusionModel.Builder	power(double power)	Sets the power factor which determines how strongly the effect is applied to the view.
AmbientOcclusionModel.Builder	radius(double radius)	Sets the radius in meters at which the effect is sampled.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 AmbientOcclusionModel.Builder other)

Copy constructor.

Parameters:

other - the builder to copy.

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

radius

@NotNull
public AmbientOcclusionModel.Builder radius(double radius)
                                     throws IllegalArgumentException

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 is 30.

Parameters:

radius - radius in meters at which the effect should be sampled. Must be non-negative.

Returns:

this builder.

Throws:

IllegalArgumentException - when the radius is negative.

power

@NotNull
public AmbientOcclusionModel.Builder power(double power)
                                    throws IllegalArgumentException

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 is 1.

Parameters:

power - factor to brighten or darken the effect. Must be non-negative.

Returns:

this builder.

Throws:

IllegalArgumentException - when the power is negative.

performanceHint

@NotNull
public AmbientOcclusionModel.Builder performanceHint(@NotNull
 PerformanceHint performanceHint)

Sets the performance hint that indicates if Ambient Occlusion should prioritize the quality or the rendering performance of the effect.

The default is PerformanceHint#PreferPerformance.

Parameters:

performanceHint - indicates if Ambient Occlusion should prioritize quality or performance.

Returns:

this builder.

build

@NotNull
public AmbientOcclusionModel build()

Builds the ambient-occlusion model.

Returns:

the built ambient-occlusion model.