Package com.luciad.maps.effects

Class DirectionalLightModel.Builder

java.lang.Object

com.luciad.maps.effects.DirectionalLightModel.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

DirectionalLightModel

public static final class DirectionalLightModel.Builder
extends Object
implements AutoCloseable

Builder for a DirectionalLightModel.

Since:

2026.1

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
DirectionalLightModel.Builder	ambientColor(android.graphics.Color color)	Sets the ambient color of the light.
DirectionalLightModel	build()	Builds the directional light.
void	close()
DirectionalLightModel.Builder	diffuseColor(android.graphics.Color color)	Sets the diffuse color of the light.
DirectionalLightModel.Builder	direction(Coordinate direction)	Sets the vector pointing towards the light source.
protected void	finalize()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

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

ambientColor

@NotNull
public DirectionalLightModel.Builder ambientColor(@NotNull
 android.graphics.Color color)

Sets the ambient color of the light.

The default is a dark gray (64, 64, 64).

Parameters:

color - the ambient color of the light.

Returns:

this builder.

diffuseColor

@NotNull
public DirectionalLightModel.Builder diffuseColor(@NotNull
 android.graphics.Color color)

Sets the diffuse color of the light.

The default is white.

Parameters:

color - the diffuse color of the light.

Returns:

this builder.

direction

@NotNull
public DirectionalLightModel.Builder direction(@NotNull
 Coordinate direction)

Sets the vector pointing towards the light source.

This is mandatory. It does not need to be normalized.

Parameters:

direction - the vector pointing towards the light source.

Returns:

this builder.

build

@NotNull
public DirectionalLightModel build()
                            throws IllegalStateException

Builds the directional light.

Returns:

the built directional light.

Throws:

IllegalStateException - when the direction was not set.