Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider Class Reference

An MGRS text provider that notifies callbacks whenever the currently visible zone/square of a given Map changes. More...

Inheritance diagram for Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider:

Classes
interface	ICallback
	This callback can be used to be notified whenever the currently visible zone/square changes, by giving you its formatted location text. More...

Public Member Functions
	MgrsGridTextProvider (Luciad.Maps.Map map)
	Constructs a new MgrsGridTextProvider for the given Map. More...
void	AddCallback (Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.ICallback callback)
	Adds the given callback to the MgrsGridTextProvider. More...
void	Dispose ()
void	RemoveCallback (Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.ICallback callback)
	Removes the given callback from the MgrsGridTextProvider. More...

Detailed Description

An MGRS text provider that notifies callbacks whenever the currently visible zone/square of a given Map changes.

Typically used to update a UI element in combination with an MGRS grid on the map, although this is not mandatory. The text is formatted with a maximum precision of 100km squares. MgrsGridTextProvider must be instantiated on the UI thread, and its registered ICallbacks are only called on the UI thread. See the Working with MGRS article for more information. 2023.1

Warning

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

Constructor & Destructor Documentation

MgrsGridTextProvider()

Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.MgrsGridTextProvider ( Luciad.Maps.Map  map )

inline

Constructs a new MgrsGridTextProvider for the given Map.

MgrsGridTextProvider must be instantiated on the UI thread.

map

the Map. Cannot be nullptr.

NullArgumentException

when the Map is nullptr.

Warning

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

Member Function Documentation

AddCallback()

void Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.AddCallback ( Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.ICallback  callback )

inline

Adds the given callback to the MgrsGridTextProvider.

After calling this method, the MgrsGridTextProvider starts calling the given callback instance.

callback

a callback instance. Cannot be nullptr.

NullArgumentException

when the callback is nullptr.

Warning

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

Dispose()

void Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.Dispose ( )

inline

RemoveCallback()

void Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.RemoveCallback ( Luciad.Layers.Grids.Mgrs.MgrsGridTextProvider.ICallback  callback )

inline

Removes the given callback from the MgrsGridTextProvider.

After calling this method, the MgrsGridTextProvider stops calling the given callback instance.

callback

a callback instance. Cannot be nullptr.

NullArgumentException

when the callback is nullptr.

Warning

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