luciad::MapNavigator::FitAction Class Reference

Class that allows to build a fit action and apply it, either directly or using an animation. More...

#include <luciad/maps/MapNavigator.h>

Public Member Functions
	~FitAction ()
FitAction &	animate (bool animated)
	Specifies if the action should use an animation. More...
FitAction &	bounds (Bounds bounds)
	Sets the bounds to fit on. More...
FitAction &	duration (std::chrono::milliseconds duration)
	Specifies the duration of the animation. More...
void	fit () const
	Applies the fit action. More...
FitAction &	fitMarginPercent (double fitMarginPercent)
	The fit margin is the margin between the bounds to fit on and the edge of the visible map. More...

Detailed Description

Class that allows to build a fit action and apply it, either directly or using an animation.

Fitting works by:

• defining bounds to fit to
• optionally defining a fit margin

Example: Execute a fit action

  map->getMapNavigator().newFitAction().bounds(bounds).fitMarginPercent(5).fit();

Constructor & Destructor Documentation

~FitAction()

luciad::MapNavigator::FitAction::~FitAction

(

)

Member Function Documentation

animate()

FitAction & luciad::MapNavigator::FitAction::animate

(

bool

animated

)

Specifies if the action should use an animation.

Parameters

animated

if this action should use an animation. The default is false.

Returns

this

bounds()

FitAction & luciad::MapNavigator::FitAction::bounds

(

Bounds

bounds

)

Sets the bounds to fit on.

These bounds can be defined in any reference

This parameter is mandatory. Not setting it will cause FitAction::fit to throw an exception.

Parameters

bounds

the bounds to fit on

Returns

this

duration()

FitAction & luciad::MapNavigator::FitAction::duration

(

std::chrono::milliseconds

duration

)

Specifies the duration of the animation.

This parameter is only used if animate(bool) is called with true as argument.

Parameters

duration

the duration of the animation in milliseconds. The default is 2000 (=2 seconds)

Returns

this

fit()

void luciad::MapNavigator::FitAction::fit

(

)

const

Applies the fit action.

Exceptions

luciad::LogicException

if the action is not built correctly, for example if mandatory parameters are missing, or if incompatible parameters are configured.

fitMarginPercent()

FitAction & luciad::MapNavigator::FitAction::fitMarginPercent

(

double

fitMarginPercent

)

The fit margin is the margin between the bounds to fit on and the edge of the visible map.

A fit margin of "5%" will add a margin of 5% of the map's screen dimensions on each side of the bounds, the center remains unchanged.

This parameter is optional. The default fit margin is 2%.

Parameters

fitMarginPercent

a fit margin, expressed as a percentage.

Returns

this

Exceptions

luciad::InvalidArgumentException

when a fit margin >= 50% is specified, or a value <= 0.