Package com.luciad.layers.styles

Class ProjectedImageryStyle.Builder

java.lang.Object

com.luciad.layers.styles.ProjectedImageryStyle.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

ProjectedImageryStyle

public static final class ProjectedImageryStyle.Builder
extends Object
implements AutoCloseable

Builder for ProjectedImageryStyle.

The default style has an opacity of 1, a sky opacity of 1, a base opacity of 0, a projection target of ProjectedImageryTarget#AllSurfaces, no orientation offset, and a projection range left at its target-dependent default.

Since:

2026.1

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ProjectedImageryStyle.Builder	baseOpacity(double baseOpacity)	Sets the opacity of the base layer used when projecting on the closest surface.
ProjectedImageryStyle	build()	Returns a new projected imagery style, based on the properties set on this builder.
void	close()
protected void	finalize()
ProjectedImageryStyle.Builder	maxRange(double maxRange)	Sets the maximum projection distance, in meters.
ProjectedImageryStyle.Builder	opacity(double opacity)	Sets the opacity of the projected imagery.
ProjectedImageryStyle.Builder	orientationOffset(double yaw, double pitch, double roll)	Sets an additional orientation offset, in degrees, applied on top of each projection's own orientation.
ProjectedImageryStyle.Builder	projectionTarget(ProjectedImageryTarget projectionTarget)	Sets the ProjectedImageryTarget that determines onto which surfaces the imagery is projected.
ProjectedImageryStyle.Builder	skyOpacity(double skyOpacity)	Sets the opacity of the sky, the part of the projection that does not hit any surface.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(@NotNull
 ProjectedImageryStyle.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

build

@NotNull
public ProjectedImageryStyle build()

Returns a new projected imagery style, based on the properties set on this builder.

Returns:

a new projected imagery style.

opacity

@NotNull
public ProjectedImageryStyle.Builder opacity(double opacity)
                                      throws IllegalArgumentException

Sets the opacity of the projected imagery.

This parameter is optional. If not set, the default is 1.

Parameters:

opacity - the alpha value. Must be in the range [0, 1] (0 is fully transparent, 1 is fully opaque).

Returns:

this builder.

Throws:

IllegalArgumentException - when opacity < 0 or opacity > 1.

skyOpacity

@NotNull
public ProjectedImageryStyle.Builder skyOpacity(double skyOpacity)
                                         throws IllegalArgumentException

Sets the opacity of the sky, the part of the projection that does not hit any surface.

This parameter is optional. If not set, the default is 1.

Parameters:

skyOpacity - the sky alpha value. Must be in the range [0, 1].

Returns:

this builder.

Throws:

IllegalArgumentException - when skyOpacity < 0 or skyOpacity > 1.

projectionTarget

@NotNull
public ProjectedImageryStyle.Builder projectionTarget(@NotNull
 ProjectedImageryTarget projectionTarget)

Sets the ProjectedImageryTarget that determines onto which surfaces the imagery is projected.

This parameter is optional. If not set, the default is ProjectedImageryTarget#AllSurfaces.

Parameters:

projectionTarget - the projection target.

Returns:

this builder.

baseOpacity

@NotNull
public ProjectedImageryStyle.Builder baseOpacity(double baseOpacity)
                                          throws IllegalArgumentException

Sets the opacity of the base layer used when projecting on the closest surface.

When the ProjectedImageryTarget is ProjectedImageryTarget#ClosestSurface, the color of the closest projection in the line of sight (assumed to have the best view of that location) is drawn as a base layer, weighted by this opacity, and the selected projections in the line of sight are painted on top of it. This fills surfaces that the closest projection sees but that are occluded from the others. A value of 0 (the default) disables the base layer.

This parameter is optional. It has no effect when the projection target is ProjectedImageryTarget#AllSurfaces.

Parameters:

baseOpacity - the base layer alpha value. Must be in the range [0, 1].

Returns:

this builder.

Throws:

IllegalArgumentException - when baseOpacity < 0 or baseOpacity > 1.

See Also:

• ProjectedImageryTarget

orientationOffset

@NotNull
public ProjectedImageryStyle.Builder orientationOffset(double yaw,
 double pitch,
 double roll)

Sets an additional orientation offset, in degrees, applied on top of each projection's own orientation.

This parameter is optional. The default is no offset (0, 0, 0).

Parameters:

yaw - the yaw offset, in degrees.

pitch - the pitch offset, in degrees.

roll - the roll offset, in degrees.

Returns:

this builder.

maxRange

@NotNull
public ProjectedImageryStyle.Builder maxRange(double maxRange)
                                       throws IllegalArgumentException

Sets the maximum projection distance, in meters.

This parameter is optional. The default is 0, which applies a target-dependent default range: 100 km when the projection target is ProjectedImageryTarget#AllSurfaces and 1 km when it is ProjectedImageryTarget#ClosestSurface.

Parameters:

maxRange - the maximum projection distance, in meters. Must be greater than or equal to 0.

Returns:

this builder.

Throws:

IllegalArgumentException - when maxRange < 0.