Package com.luciad.maps

Class MapNavigator.AboveConstraintOptions

java.lang.Object

com.luciad.maps.MapNavigator.AboveConstraintOptions

All Implemented Interfaces:

AutoCloseable

Enclosing class:

MapNavigator

public static final class MapNavigator.AboveConstraintOptions
extends Object
implements AutoCloseable

Option to configure the navigation constraint to keep the camera above the terrain.

See MapNavigator#getAboveConstraint for more information.

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	finalize()
double	getMinAltitude()	Returns the minimum altitude the camera should stay above the terrain and/or mesh.
boolean	isEnabled()	Returns whether the constraint is enabled.
void	setEnabled(boolean enabled)	Sets whether the constraint is enabled.
void	setMinAltitude(double minAltitude)	Sets the minimum altitude the camera should stay above the terrain and/or mesh.

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

isEnabled

public boolean isEnabled()

Returns whether the constraint is enabled.

Returns:

whether the constraint is enabled.

setEnabled

public void setEnabled(boolean enabled)

Sets whether the constraint is enabled.

The default is true.

Parameters:

enabled - true to enable the constraint or false to disable it

getMinAltitude

public double getMinAltitude()

Returns the minimum altitude the camera should stay above the terrain and/or mesh.

Returns:

the minimum altitude the camera should stay above the terrain and/or mesh.

setMinAltitude

public void setMinAltitude(double minAltitude)

Sets the minimum altitude the camera should stay above the terrain and/or mesh.

The minimum altitude defined in the unit of the map reference, typically meters.

The default value is 20.

Only positive values are allowed. If a negative value is passed, an exception is thrown.

Parameters:

minAltitude - the minimum altitude.