NDEVR
API Documentation
MercatorImageManagerabstract
User Interface » Software Services

Place where service can be registered to provide aerial image support. More...

Inheritance diagram for MercatorImageManager:
[legend]
Collaboration diagram for MercatorImageManager:
[legend]

Public Member Functions

 MercatorImageManager ()
 Constructor.
virtual DynamicPointer< WebMercatorTileService > defaultService (AerialImageMode mode) const =0
 Returns the default tile service for the given aerial image mode.
virtual bool postRequest (const AerialImageRequest &request)
 Posts a high-level aerial image request for asynchronous processing.
virtual bool postRequest (const MercatorImageRequest &request, std::function< void(const MercatorImage &)> finished_callback)=0
 Posts a Mercator tile image request for asynchronous processing.
virtual void setDevicePixelRatio (fltp08)
 Sets the device pixel ratio used for DPI calculations.

Static Public Member Functions

static MercatorImageManager * PrimaryManager ()
 Returns the singleton primary MercatorImageManager instance.

Static Protected Member Functions

static void SetPrimaryManager (MercatorImageManager *manager)
 Sets the singleton primary manager instance.

Static Protected Attributes

static MercatorImageManager * s_manager
 Singleton pointer to the primary manager.

Detailed Description

Place where service can be registered to provide aerial image support.

Definition at line 269 of file MercatorImageManager.h.

Constructor & Destructor Documentation

◆ MercatorImageManager()

MercatorImageManager::MercatorImageManager ( )

Constructor.

Registers this manager instance.

Referenced by PrimaryManager(), and SetPrimaryManager().

Member Function Documentation

◆ defaultService()

virtual DynamicPointer< WebMercatorTileService > MercatorImageManager::defaultService ( AerialImageMode mode) const
nodiscardpure virtual

Returns the default tile service for the given aerial image mode.

Parameters
[in]modeThe aerial image mode to look up.
Returns
A DynamicPointer to the default WebMercatorTileService for the mode.

Implemented in MercatorWebImageManager.

◆ postRequest() [1/2]

virtual bool MercatorImageManager::postRequest ( const AerialImageRequest & request)
virtual

Posts a high-level aerial image request for asynchronous processing.

Parameters
[in]requestThe aerial image request descriptor.
Returns
True if the request was successfully queued.

Reimplemented in MercatorWebImageManager.

◆ postRequest() [2/2]

virtual bool MercatorImageManager::postRequest ( const MercatorImageRequest & request,
std::function< void(const MercatorImage &)> finished_callback )
pure virtual

Posts a Mercator tile image request for asynchronous processing.

Parameters
[in]requestThe Mercator image request descriptor.
[in]finished_callbackCallback invoked with the resulting MercatorImage.
Returns
True if the request was successfully queued.

Implemented in MercatorWebImageManager.

◆ PrimaryManager()

MercatorImageManager * MercatorImageManager::PrimaryManager ( )
inlinestaticnodiscard

Returns the singleton primary MercatorImageManager instance.

Returns
Pointer to the primary manager, or nullptr if none is registered.

Definition at line 293 of file MercatorImageManager.h.

References MercatorImageManager(), and s_manager.

◆ setDevicePixelRatio()

virtual void MercatorImageManager::setDevicePixelRatio ( fltp08 )
inlinevirtual

Sets the device pixel ratio used for DPI calculations.

Parameters
[in]ratioThe device pixel ratio (e.g. 2.0 for Retina displays).
Note
Default implementation is a no-op.

Reimplemented in MercatorWebImageManager.

Definition at line 289 of file MercatorImageManager.h.

◆ SetPrimaryManager()

void MercatorImageManager::SetPrimaryManager ( MercatorImageManager * manager)
staticprotected

Sets the singleton primary manager instance.

Parameters
[in]managerThe manager to register as the primary instance.

References MercatorImageManager().

The documentation for this class was generated from the following file: