LuciadCPillar C# 2023.1.03
Luciad.Maps.MapNavigator Class Reference

Class that offers functionality to navigate around the globe. More...

Inheritance diagram for Luciad.Maps.MapNavigator:

Classes

class  AboveConstraintOptions
 Option to configure the navigation constraint to keep the camera above the terrain. More...
 
class  BoundsConstraintOptions
 Options to configure the constraint to restrict the navigation to specific bounds. More...
 
class  FitAction
 Class that allows to build a fit action and apply it, either directly or using an animation. More...
 
class  PanAction
 Class that allows to build a pan action and apply it, either directly or using an animation. More...
 
class  PitchConstraintOptions
 Options to configure the constraint to restrict the pitch (tilt) of the camera. More...
 
class  RotateAction
 Class that allows to build a rotate action and apply it, either directly or using an animation. More...
 
class  ScaleConstraintOptions
 Options to configure the scale constraint to restrict the camera zooming. More...
 
class  ZoomAction
 Class that allows to build a zoom action and apply it, either directly or using an animation. More...
 

Public Member Functions

void Cancel ()
 Cancels all ongoing navigate actions that were started using this MapNavigator. More...
 
void Dispose ()
 
Luciad.Maps.MapNavigator.FitAction NewFitAction ()
 Creates an object that allows to configure fit parameters, and apply them, either directly or using an animation. More...
 
Luciad.Maps.MapNavigator.PanAction NewPanAction ()
 Creates an object that allows to configure pan parameters, and apply them, either directly or using an animation. More...
 
Luciad.Maps.MapNavigator.RotateAction NewRotateAction ()
 Creates an object that allows to configure rotate parameters, and apply them, either directly or using an animation. More...
 
Luciad.Maps.MapNavigator.ZoomAction NewZoomAction ()
 Creates an object that allows to configure zoom parameters, and apply them, either directly or using an animation. More...
 

Properties

Luciad.Maps.MapNavigator.AboveConstraintOptions AboveConstraint [get]
 
Luciad.Maps.MapNavigator.BoundsConstraintOptions BoundsConstraint [get]
 
Luciad.Maps.MapNavigator.PitchConstraintOptions PitchConstraint [get]
 
Luciad.Maps.MapNavigator.ScaleConstraintOptions ScaleConstraint [get]
 

Detailed Description

Class that offers functionality to navigate around the globe.

It offers high-level navigation capabilities, built on top of the more low-level camera API. See documentation of the following classes for example usages: MapNavigator::PanAction MapNavigator::ZoomAction MapNavigator::RotateAction MapNavigator::FitAction

This class animates the camera by submitting IAnimations to the map's luciad::Map::getAnimationManager, or by registering Map::IRendererCallback instance. These can be canceled using the MapNavigator::cancel method. Note that starting a new navigate action using MapNavigator will automatically cancel any ongoing navigate actions. The following navigation constraints can be used to restrict navigation:

above: keeps the camera above terrain. bounds: keeps the camera inside the defined bounds. scale: prevents the camera from zooming in or out too far. pitch: restricts the pitch (tilt) of the camera

If you use the map's underlying Camera directly, the constraints are not applied. In that case, it's the API user's responsibility to restrict the camera movement. See also the related articles on

map navigation. map navigation constraints.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MapNavigator.

Member Function Documentation

◆ Cancel()

void Luciad.Maps.MapNavigator.Cancel ( )
inline

Cancels all ongoing navigate actions that were started using this MapNavigator.

This includes stopping all animations and all input-based navigate actions. The latter will start ignoring input after this method is called. 2022.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MapNavigator::cancel.

◆ Dispose()

void Luciad.Maps.MapNavigator.Dispose ( )
inline

◆ NewFitAction()

Luciad.Maps.MapNavigator.FitAction Luciad.Maps.MapNavigator.NewFitAction ( )
inline

Creates an object that allows to configure fit parameters, and apply them, either directly or using an animation.

an object that allows to configure fit parameters, and apply them, either directly or using an animation.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MapNavigator::newFitAction.

◆ NewPanAction()

Luciad.Maps.MapNavigator.PanAction Luciad.Maps.MapNavigator.NewPanAction ( )
inline

Creates an object that allows to configure pan parameters, and apply them, either directly or using an animation.

an object that allows to configure pan parameters, and apply them, either directly or using an animation.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MapNavigator::newPanAction.

◆ NewRotateAction()

Luciad.Maps.MapNavigator.RotateAction Luciad.Maps.MapNavigator.NewRotateAction ( )
inline

Creates an object that allows to configure rotate parameters, and apply them, either directly or using an animation.

an object that allows to configure rotate parameters, and apply them, either directly or using an animation.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MapNavigator::newRotateAction.

◆ NewZoomAction()

Luciad.Maps.MapNavigator.ZoomAction Luciad.Maps.MapNavigator.NewZoomAction ( )
inline

Creates an object that allows to configure zoom parameters, and apply them, either directly or using an animation.

an object that allows to configure zoom parameters, and apply them, either directly or using an animation.

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MapNavigator::newZoomAction.

Property Documentation

◆ AboveConstraint

Luciad.Maps.MapNavigator.AboveConstraintOptions Luciad.Maps.MapNavigator.AboveConstraint
get

◆ BoundsConstraint

Luciad.Maps.MapNavigator.BoundsConstraintOptions Luciad.Maps.MapNavigator.BoundsConstraint
get

◆ PitchConstraint

Luciad.Maps.MapNavigator.PitchConstraintOptions Luciad.Maps.MapNavigator.PitchConstraint
get

◆ ScaleConstraint

Luciad.Maps.MapNavigator.ScaleConstraintOptions Luciad.Maps.MapNavigator.ScaleConstraint
get