luciad::MapNavigator::AboveConstraintOptions Class Reference

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

#include <luciad/maps/MapNavigator.h>

Public Member Functions
double	getMinAltitude () const
	Returns the minimum altitude the camera should stay above the terrain and/or mesh. More...
bool	isEnabled () const
void	setEnabled (bool enabled)
	Enables or disables the constraint The default is true. More...
void	setMinAltitude (double minAltitude)
	Sets the minimum altitude the camera should stay above the terrain and/or mesh. More...

Detailed Description

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

See MapNavigator::getAboveConstraint for more information.

Since

2021.1

Member Function Documentation

getMinAltitude()

double luciad::MapNavigator::AboveConstraintOptions::getMinAltitude

(

)

const

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.

isEnabled()

bool luciad::MapNavigator::AboveConstraintOptions::isEnabled

(

)

const

Returns

if the constraint is enabled

setEnabled()

void luciad::MapNavigator::AboveConstraintOptions::setEnabled

(

bool

enabled

)

Enables or disables the constraint The default is true.

Parameters

enabled

true to enable the constraint or false to disable it

setMinAltitude()

void luciad::MapNavigator::AboveConstraintOptions::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.