Class

OpenStreetMapProvider

Initializes a new instance of the OpenStreetMapProvider class with default tile downloader and memory cache provider.

Declaration

public OpenStreetMapProvider()

Declaration

protected Dictionary<string, List<TileInfo>> cacheLoadReference

Field Value

Declaration

protected object lockObj

Field Value

Gets or sets the cache provider used for storing and retrieving downloaded map tiles to improve performance and reduce network requests.

Declaration

public IMapCacheProvider CacheProvider { get; set; }

Property Value

Implements IMapTileProvider.CacheProvider

Gets or sets a value indicating whether tile caching is enabled for this provider to store downloaded tiles locally.

Declaration

public bool EnableCaching { get; set; }

Property Value

Implements IMapTileProvider.EnableCaching

Gets the unique identifier for this map provider instance.

Declaration

public string Id { get; }

Property Value

Implements IMapProvider.Id

Gets or sets the URL template used for downloading OpenStreetMap tiles, supporting placeholder tokens for coordinates and zoom level.

Declaration

public string ImageUrl { get; set; }

Property Value

Gets or sets a value indicating whether this OpenStreetMapProvider has completed its initialization process.

Declaration

public bool Initialized { get; protected set; }

Property Value

Gets or sets the maximum zoom level supported by this OpenStreetMap provider.

Declaration

public int MaxZoomLevel { get; set; }

Property Value

Implements IMapProvider.MaxZoomLevel

Gets or sets the minimum zoom level supported by this OpenStreetMap provider.

Declaration

public int MinZoomLevel { get; set; }

Property Value

Implements IMapProvider.MinZoomLevel

Gets the settings that control tile rendering behavior.

Declaration

public MapTileProviderSettings Settings { get; }

Property Value

Implements IMapTileProvider.Settings

Gets or sets the tile downloader responsible for asynchronously downloading map tiles from OpenStreetMap servers.

Declaration

public IMapTileDownloader TileDownloader { get; set; }

Property Value

Implements IMapTileProvider.TileDownloader

Gets the size of map tiles used by this provider, typically 256x256 pixels for OpenStreetMap.

Declaration

public Size TileSize { get; }

Property Value

Implements IMapTileProvider.TileSize

Creates a deep copy of this OpenStreetMapProvider instance with identical configuration settings.

Declaration

public virtual object Clone()

Returns

Implements ICloneable.Clone()

Generates a unique cache key string for storing and retrieving tile images based on tile coordinates and zoom level.

Declaration

protected virtual string GetCacheKey(int tileX, int tileY, int zoomLevel)

Parameters

Returns

Retrieves the visual elements representing map tiles for the current viewport, converting cached tile data to renderable map elements.

Declaration

public IEnumerable<MapVisualElement> GetContent(IMapViewport viewport)

Parameters

Returns

Implements IMapProvider.GetContent(IMapViewport)

Gets the list of supported map views for this provider, returning null as OpenStreetMap uses a standard view.

Declaration

public List<MapViewInfo> GetSupportedViews()

Returns

Implements IMapProvider.GetSupportedViews()

Constructs the complete URL for retrieving a specific map tile from OpenStreetMap servers based on tile coordinates and zoom level.

Declaration

public Uri GetTile(int tileMatrixX, int tileMatrixY, int zoomLevel)

Parameters

Returns

Synchronously retrieves a map tile image for the specified coordinates and zoom level, utilizing cache when available.

Declaration

public Image GetTileImage(int tileMatrixX, int tileMatrixY, int zoomLevel)

Parameters

Returns

Implements IMapTileProvider.GetTileImage(int, int, int)

Initiates the asynchronous loading of tile image data, either from cache or by downloading from OpenStreetMap servers.

Declaration

protected virtual void GetTileInfoImage(TileInfo tileInfo)

Parameters

Initializes the provider, marking it as ready for tile requests and raising the initialization complete event.

Declaration

public void Initialize()

Implements IMapProvider.Initialize()

Handles the completion of asynchronous file loading operations from the cache provider, updating tile content or initiating download if cache miss occurs.

Declaration

protected virtual void OnFileLoadAsyncComplete(string fileName, byte[] content)

Parameters

Raises the InitializationComplete event when provider initialization is successfully completed.

Declaration

protected virtual void OnInitializationComplete(EventArgs e)

Parameters

Raises the InitializationError event when an error occurs during provider initialization.

Declaration

protected virtual void OnInitializationError(InitializationErrorEventArgs e)

Parameters

Raises the ProviderUpdated event when provider content changes, such as when new tiles are available.

Declaration

protected virtual void OnProviderUpdated(EventArgs e)

Parameters

Handles the completion of tile download operations, updating cache storage and synchronizing tile content across wraparound instances.

Declaration

protected virtual void OnTileDownloadComplete(object sender, TileInfoEventArgs e)

Parameters

Sets the active map view for this provider, currently not implemented for OpenStreetMap.

Declaration

public void SetView(MapViewInfo view)

Parameters

Implements IMapProvider.SetView(MapViewInfo)

Responds to viewport changes by calculating and managing the visible tiles required for the current view, handling tile loading and caching operations.

Declaration

public void ViewportChanged(IMapViewport viewport, ViewportChangeAction action)

Parameters

Implements IMapProvider.ViewportChanged(IMapViewport, ViewportChangeAction)

Occurs when the provider initialization process is completed successfully.

Declaration

public event EventHandler InitializationComplete

Event Value

Implements IMapProvider.InitializationComplete

Occurs when an error is encountered during the provider initialization process.

Declaration

public event InitializationErrorEventHandler InitializationError

Event Value

Implements IMapProvider.InitializationError

Occurs when the provider content is updated, typically after new tiles are loaded or downloaded.

Declaration

public event EventHandler ProviderUpdated

Event Value

Implements IMapProvider.ProviderUpdated