Package com.luciad.geodesy

Class GeoLocation.Builder

java.lang.Object

com.luciad.geodesy.GeoLocation.Builder

All Implemented Interfaces:

AutoCloseable

Enclosing class:

GeoLocation

public static final class GeoLocation.Builder
extends Object
implements AutoCloseable

Builder class for GeoLocation.

Since:

2026.1

Method Summary

Modifier and Type	Method	Description
GeoLocation.Builder	azimuth(Azimuth azimuth)	The azimuth of the local Y-axis after transformation.
GeoLocation	build()	Creates the new GeoLocation.
void	close()
protected void	finalize()
GeoLocation.Builder	localOrigin(Coordinate localOrigin)	The point in the local reference that, once transformed, will correspond to the target location.
GeoLocation.Builder	targetLocation(Point targetLocation)	The target location that the local origin will map to after transformation.
GeoLocation.Builder	targetReference(CoordinateReference targetReference)	The target reference which points will be transformed to.

Methods inherited from class java.lang.Object

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

Method Details

finalize

protected void finalize()

Overrides:

finalize in class Object

close

public void close()

Specified by:

close in interface AutoCloseable

localOrigin

@NotNull
public GeoLocation.Builder localOrigin(@NotNull
 Coordinate localOrigin)

The point in the local reference that, once transformed, will correspond to the target location.

By default, this is (0, 0, 0).

Parameters:

localOrigin - the local origin.

Returns:

this builder.

targetLocation

@NotNull
public GeoLocation.Builder targetLocation(@NotNull
 Point targetLocation)
                                   throws NullPointerException,
IllegalArgumentException

The target location that the local origin will map to after transformation.

Calling this method is mandatory.

Note: for convenience, this Point does not necessarily need to have the same reference as the target reference. For example, it is possible that the GeoLocation's target reference is geocentric, but the target location is expressed in longitude/latitude/height.

Parameters:

targetLocation - the target location.

Returns:

this builder.

Throws:

NullPointerException - if the target location is null.

IllegalArgumentException - if the target location's reference is Cartesian.

targetReference

@NotNull
public GeoLocation.Builder targetReference(@NotNull
 CoordinateReference targetReference)
                                    throws NullPointerException,
IllegalArgumentException

The target reference which points will be transformed to.

By default, this is a geocentric reference (EPSG:4978).

Note: for convenience, this reference does not necessarily have to be the same as the target location's reference. For example, it is possible that the GeoLocation's target reference is geocentric, and the target location is expressed in longitude/latitude/height.

Parameters:

targetReference - the target reference.

Returns:

this builder.

Throws:

NullPointerException - if the target reference is null.

IllegalArgumentException - if the target reference is Cartesian.

azimuth

@NotNull
public GeoLocation.Builder azimuth(@NotNull
 Azimuth azimuth)

The azimuth of the local Y-axis after transformation.

By default, this is 0 (facing north).

Parameters:

azimuth - the azimuth.

Returns:

this builder.

build

@NotNull
public GeoLocation build()
                  throws IllegalStateException,
IllegalArgumentException

Creates the new GeoLocation.

Returns:

the new GeoLocation.

Throws:

IllegalStateException - if targetLocation was not called.

IllegalArgumentException - if the target location is not a valid point in the target reference.