From 3cc2a83d4fd9b4ab0460650bbcfead992a89069a Mon Sep 17 00:00:00 2001 From: Fr0sT-Brutal Date: Fri, 28 Oct 2022 16:55:21 +0300 Subject: [PATCH] Docs update --- docs/autolink-excl | 4 +- docs/docs/AllFunctions.html | 41 ++++++------ docs/docs/AllIdentifiers.html | 63 ++++++++++++------- docs/docs/AllTypes.html | 7 ++- docs/docs/AllVariables.html | 14 ++++- docs/docs/OSM.MapControl.TMapControl.html | 2 +- docs/docs/OSM.TileStorage.TTileStorage.html | 6 +- ...sProvider.Google.TGoogleTilesProvider.html | 16 ++++- ...TilesProvider.HERE.THERETilesProvider.html | 52 ++++----------- ...M.TilesProvider.OSM.TOSMTilesProvider.html | 38 ++++------- ...OSM.TilesProvider.TDummyTilesProvider.html | 16 ++++- .../OSM.TilesProvider.TTilesProvider.html | 30 ++++++++- docs/docs/OSM.TilesProvider.html | 51 ++++++++++++++- 13 files changed, 214 insertions(+), 126 deletions(-) diff --git a/docs/autolink-excl b/docs/autolink-excl index ee62101..23a4eae 100644 --- a/docs/autolink-excl +++ b/docs/autolink-excl @@ -13,4 +13,6 @@ zoom proxy url data -layer \ No newline at end of file +layer +properties +name \ No newline at end of file diff --git a/docs/docs/AllFunctions.html b/docs/docs/AllFunctions.html index 6501d9b..4203562 100644 --- a/docs/docs/AllFunctions.html +++ b/docs/docs/AllFunctions.html @@ -50,12 +50,12 @@

All Functions and Procedures

InMap OSM.SlippyMapUtils -

Checks if rect Rc is inside a map at zoom level Zoom

+

Checks if point Pt is inside a map at zoom level Zoom

InMap OSM.SlippyMapUtils -

Checks if point Pt is inside a map at zoom level Zoom

+

Checks if rect Rc is inside a map at zoom level Zoom

LatitudeToMapCoord @@ -85,12 +85,12 @@

All Functions and Procedures

MapToGeoCoords OSM.SlippyMapUtils -

Converts map point in pixels to geo point in degrees

+

Converts map rect in pixels to geo rect in degrees

MapToGeoCoords OSM.SlippyMapUtils -

Converts map rect in pixels to geo rect in degrees

+

Converts map point in pixels to geo point in degrees

MapWidth @@ -118,39 +118,39 @@

All Functions and Procedures

Construct TRect from two TPoint-s

+RegisterTilesProvider +OSM.TilesProvider +

Add class of tiles provider to global TilesProviders array.

+ + TileCount OSM.SlippyMapUtils

Returns count of tiles on Zoom level (= 2ˆZoom)

- + TilesEqual OSM.SlippyMapUtils

Compares tiles

- + TileToStr OSM.SlippyMapUtils

Returns standartized string representation of Tile

- + TileValid OSM.SlippyMapUtils

Checks Tile fields for validity

- -ToInnerCoords -OSM.MapControl -

Convert absolute map rect to a rect inside a viewport having given top-left point

- ToInnerCoords OSM.MapControl

Convert absolute map coords to a point inside a viewport having given top-left point

-ToOuterCoords +ToInnerCoords OSM.MapControl -

Convert a rect inside a viewport having given top-left point to absolute map rect

+

Convert absolute map rect to a rect inside a viewport having given top-left point

ToOuterCoords @@ -158,26 +158,31 @@

All Functions and Procedures

Convert a point inside a viewport having given top-left point to absolute map coords

+ToOuterCoords +OSM.MapControl +

Convert a rect inside a viewport having given top-left point to absolute map rect

+ + ToTileBoundary OSM.SlippyMapUtils

Align absolute map rect to tile boundaries

- + ToTileHeightGreater OSM.SlippyMapUtils

Ceil vertical map coord to tile size

- + ToTileHeightLesser OSM.SlippyMapUtils

Floor vertical map coord to tile size

- + ToTileWidthGreater OSM.SlippyMapUtils

Ceil horizontal map coord to tile size

- + ToTileWidthLesser OSM.SlippyMapUtils

Floor horizontal map coord to tile size

diff --git a/docs/docs/AllIdentifiers.html b/docs/docs/AllIdentifiers.html index f41be7b..aaf8ac8 100644 --- a/docs/docs/AllIdentifiers.html +++ b/docs/docs/AllIdentifiers.html @@ -70,12 +70,12 @@

All Identifiers

EnsureInMap OSM.SlippyMapUtils -

Ensures rect Rc is inside a map at zoom level Zoom, corrects values if necessary

+

Ensures point Pt is inside a map at zoom level Zoom, corrects values if necessary

EnsureInMap OSM.SlippyMapUtils -

Ensures point Pt is inside a map at zoom level Zoom, corrects values if necessary

+

Ensures rect Rc is inside a map at zoom level Zoom, corrects values if necessary

GDI_HANDLES_LIMIT @@ -95,12 +95,12 @@

All Identifiers

GeoCoordsToMap OSM.SlippyMapUtils -

Converts geo point in degrees to map point in pixels

+

Converts geo rect in degrees to map rect in pixels

GeoCoordsToMap OSM.SlippyMapUtils -

Converts geo rect in degrees to map rect in pixels

+

Converts geo point in degrees to map point in pixels

GetScaleBarParams @@ -160,12 +160,12 @@

All Identifiers

MapToGeoCoords OSM.SlippyMapUtils -

Converts map rect in pixels to geo rect in degrees

+

Converts map point in pixels to geo point in degrees

MapToGeoCoords OSM.SlippyMapUtils -

Converts map point in pixels to geo point in degrees

+

Converts map rect in pixels to geo rect in degrees

MapWidth @@ -208,90 +208,100 @@

All Identifiers

Construct TRect from two TPoint-s

+RegisterTilesProvider +OSM.TilesProvider +

Add class of tiles provider to global TilesProviders array.

+ + ReqTimeout OSM.NetworkRequest

Timeout for connect and request

- + SampleHeaders OSM.NetworkRequest

Headers that you could add to TNetworkRequestQueue.

- + SystemProxy OSM.NetworkRequest

Internal constant to designate OS-wide proxy

- + S_Lbl_Loading OSM.MapControl

 

- + TBlockingNetworkRequestFunc OSM.NetworkRequest

Generic type of blocking network request function.

- + TCacheLimits OSM.TileStorage

Limits of tile cache in memory

- + TDummyTilesProvider OSM.TilesProvider

Dummy tile provider class, used as a stub in map control if no real provider is assigned.

- + TGeoPoint OSM.SlippyMapUtils

Point on a map defined by longitude and latitude.

- + TGeoRect OSM.SlippyMapUtils

Region on a map defined by two pairs of longitude and latitude.

- + TGoogleTilesProvider OSM.TilesProvider.Google

Google tile image provider

- + TGotTileCallbackBgThr OSM.NetworkRequest

Generic type of method to call when request is completed
! Called from the context of a background thread !

- + THERETilesProvider OSM.TilesProvider.HERE

HERE tile image provider

- + THttpRequestCapabilities OSM.NetworkRequest

Capabilities that a network engine has

- + THttpRequestProps OSM.NetworkRequest

Generic properties of request.

- + TileCount OSM.SlippyMapUtils

Returns count of tiles on Zoom level (= 2ˆZoom)

- + TileMetersPerPixelOnEquator OSM.SlippyMapUtils

See https://wiki.openstreetmap.org/wiki/Zoom_levels Level Degree Area m / pixel ˜Scale # Tiles 0 360 whole world 156,412 1:500 million 1 1 180 78,206 1:250 million 4 2 90 39,103 1:150 million 16 3 45 19,551 1:70 million 64 4 22.5 9,776 1:35 million 256 5 11.25 4,888 1:15 million 1,024 6 5.625 2,444 1:10 million 4,096 7 2.813 1,222 1:4 million 16,384 8 1.406 610.984 1:2 million 65,536 9 0.703 wide area 305.492 1:1 million 262,144 10 0.352 152.746 1:500,000 1,048,576 11 0.176 area 76.373 1:250,000 4,194,304 12 0.088 38.187 1:150,000 16,777,216 13 0.044 village/town 19.093 1:70,000 67,108,864 14 0.022 9.547 1:35,000 268,435,456 15 0.011 4.773 1:15,000 1,073,741,824 16 0.005 small road 2.387 1:8,000 4,294,967,296 17 0.003 1.193 1:4,000 17,179,869,184 18 0.001 0.596 1:2,000 68,719,476,736 19 0.0005 0.298 1:1,000 274,877,906,944 20 0.00025 mid-sized bldng 0.149 1:5,00 1,099,511,627,776

- + TilesEqual OSM.SlippyMapUtils

Compares tiles

+ +TilesProviders +OSM.TilesProvider +

Global list of registered tiles providers.

+ TileToStr OSM.SlippyMapUtils @@ -483,16 +493,21 @@

All Identifiers

Abstract base class for tile image provider.

+TTilesProviderClass +OSM.TilesProvider +

 

+ + TTileStorage OSM.TileStorage

Class that encapsulates memory and file cache of tile images.

- + TTileStorageOption OSM.TileStorage

Flags for TTileStorage

- + TTileStorageOptions OSM.TileStorage

 

diff --git a/docs/docs/AllTypes.html b/docs/docs/AllTypes.html index a822124..a4d5910 100644 --- a/docs/docs/AllTypes.html +++ b/docs/docs/AllTypes.html @@ -118,11 +118,16 @@

All Types

Callback to react on selection by mouse

+TTilesProviderClass +OSM.TilesProvider +

 

+ + TTileStorageOption OSM.TileStorage

Flags for TTileStorage

- + TTileStorageOptions OSM.TileStorage

 

diff --git a/docs/docs/AllVariables.html b/docs/docs/AllVariables.html index fda5aab..80cb476 100644 --- a/docs/docs/AllVariables.html +++ b/docs/docs/AllVariables.html @@ -11,8 +11,18 @@

OSM Map control

All Variables

-

-The units do not contain any variables.

+ + + + + + + + + + + +
NameUnitDescription
TilesProvidersOSM.TilesProvider

Global list of registered tiles providers.

Generated by PasDoc 0.16.0.
diff --git a/docs/docs/OSM.MapControl.TMapControl.html b/docs/docs/OSM.MapControl.TMapControl.html index 3b5d106..5686b80 100644 --- a/docs/docs/OSM.MapControl.TMapControl.html +++ b/docs/docs/OSM.MapControl.TMapControl.html @@ -489,7 +489,7 @@

Properties

-Tiles provider object. Assigning this property could change some map properties (zoom range, for example). Map control takes ownership on assigned object and destroys it when needed. Assign Nil to use an instance of TDummyTilesProvider.

+Tiles provider object. Assigning this property could change some map properties (zoom range, for example, and hence current zoom) so cache will be cleared and the map will be redrawn with new conditions.
Map control takes ownership on assigned object and destroys it when needed.
Assign Nil to use an instance of TDummyTilesProvider.

diff --git a/docs/docs/OSM.TileStorage.TTileStorage.html b/docs/docs/OSM.TileStorage.TTileStorage.html index b88a816..882b562 100644 --- a/docs/docs/OSM.TileStorage.TTileStorage.html +++ b/docs/docs/OSM.TileStorage.TTileStorage.html @@ -69,7 +69,7 @@

Description

- +
Publicproperty FileCacheBaseDir: string read FFileCacheBaseDir write FFileCacheBaseDir;property FileCacheBaseDir: string read FFileCacheBaseDir write SetFileCacheBaseDir;

Description

@@ -173,11 +173,11 @@

Properties

- +
Publicproperty FileCacheBaseDir: string read FFileCacheBaseDir write FFileCacheBaseDir;property FileCacheBaseDir: string read FFileCacheBaseDir write SetFileCacheBaseDir;

-Base directory of file cache

+Base directory of file cache. All cached images are released on path change

Generated by PasDoc 0.16.0. diff --git a/docs/docs/OSM.TilesProvider.Google.TGoogleTilesProvider.html b/docs/docs/OSM.TilesProvider.Google.TGoogleTilesProvider.html index af7ecb4..0729be0 100644 --- a/docs/docs/OSM.TilesProvider.Google.TGoogleTilesProvider.html +++ b/docs/docs/OSM.TilesProvider.Google.TGoogleTilesProvider.html @@ -49,10 +49,14 @@

Description

- + + + + +
Publicconstructor Create;constructor Create; override;
Publicclass function Name: string; override;
Public function GetTileURL(const Tile: TTile): string; override;
@@ -102,7 +106,15 @@

Methods

- + + + +
Publicconstructor Create;constructor Create; override;
+ 
+ + + + diff --git a/docs/docs/OSM.TilesProvider.HERE.THERETilesProvider.html b/docs/docs/OSM.TilesProvider.HERE.THERETilesProvider.html index c4192b3..1478ed4 100644 --- a/docs/docs/OSM.TilesProvider.HERE.THERETilesProvider.html +++ b/docs/docs/OSM.TilesProvider.HERE.THERETilesProvider.html @@ -30,18 +30,6 @@

Description

Publicclass function Name: string; override;
 
- - - - - - - - - - - -
Publicnested const DefTilesCopyright = '(c) HERE';
Publicnested const DefTileURLPatt = 'https://%d.base.maps.ls.hereapi.com/maptile/2.1/maptile/newest/normal.day/%d/%d/%d/256/png8?apiKey=%s';
Publicnested const MaxSubdomainNum = 4;
Public TileURLPatt: string;
@@ -49,60 +37,42 @@

Description

- + - + -
Publicconstructor Create;constructor Create; override;
Publicfunction GetTileURL(const Tile: TTile): string; override;class function Name: string; override;
-

Description

-

Fields

- - - - -
Publicnested const DefTilesCopyright = '(c) HERE';
-

-Default copyright text

-
- - - - + -
Publicnested const DefTileURLPatt = 'https://%d.base.maps.ls.hereapi.com/maptile/2.1/maptile/newest/normal.day/%d/%d/%d/256/png8?apiKey=%s';function GetTileURL(const Tile: TTile): string; override;
-

-Default pattern of tile URL. Placeholders are for: Random subdomain (1..MaxSubdomainNum), Zoom, X, Y, ApiKEY

-
+

Description

+

Fields

- +
Publicnested const MaxSubdomainNum = 4;TileURLPatt: string;

-Maximal subdomain number

+Pattern of tile URL. Placeholders are for: Random subdomain (1..MaxSubdomainNum), Zoom, X, Y, ApiKEY

+

Methods

- + + 
PublicTileURLPatt: string;constructor Create; override;
-

-Pattern of tile URL. Placeholders are for: Random subdomain (1..MaxSubdomainNum), Zoom, X, Y, ApiKEY

-
-

Methods

- + diff --git a/docs/docs/OSM.TilesProvider.OSM.TOSMTilesProvider.html b/docs/docs/OSM.TilesProvider.OSM.TOSMTilesProvider.html index db1f2d4..1b5e663 100644 --- a/docs/docs/OSM.TilesProvider.OSM.TOSMTilesProvider.html +++ b/docs/docs/OSM.TilesProvider.OSM.TOSMTilesProvider.html @@ -30,14 +30,6 @@

Description

Publicconstructor Create;class function Name: string; override;
 
- - - - - - - -
Publicnested const DefTilesCopyright = '(c) OpenStreetMap contributors';
Publicnested const DefTileURLPatt = 'http://tile.openstreetmap.org/%d/%d/%d.png';
Public TileURLPatt: string;
@@ -45,50 +37,42 @@

Description

- + - + -
Publicconstructor Create;constructor Create; override;
Publicfunction GetTileURL(const Tile: TTile): string; override;class function Name: string; override;
-

Description

-

Fields

- - + -
Publicnested const DefTilesCopyright = '(c) OpenStreetMap contributors';function GetTileURL(const Tile: TTile): string; override;
-

-Default copyright text

-
+

Description

+

Fields

- +
Publicnested const DefTileURLPatt = 'http://tile.openstreetmap.org/%d/%d/%d.png';TileURLPatt: string;

-Default pattern of tile URL. Placeholders are for: Zoom, X, Y

+Pattern of tile URL. Placeholders are for: Zoom, X, Y

+

Methods

- + + 
PublicTileURLPatt: string;constructor Create; override;
-

-Pattern of tile URL. Placeholders are for: Zoom, X, Y

-
-

Methods

- + diff --git a/docs/docs/OSM.TilesProvider.TDummyTilesProvider.html b/docs/docs/OSM.TilesProvider.TDummyTilesProvider.html index 833cffb..4337c37 100644 --- a/docs/docs/OSM.TilesProvider.TDummyTilesProvider.html +++ b/docs/docs/OSM.TilesProvider.TDummyTilesProvider.html @@ -30,10 +30,14 @@

Description

Publicconstructor Create;class function Name: string; override;
 
- + + + + +
Publicconstructor Create;constructor Create; override;
Publicclass function Name: string; override;
Public function GetTileURL(const Tile: TTile): string; override;
@@ -42,7 +46,15 @@

Methods

- + + + +
Publicconstructor Create;constructor Create; override;
+ 
+ + + + diff --git a/docs/docs/OSM.TilesProvider.TTilesProvider.html b/docs/docs/OSM.TilesProvider.TTilesProvider.html index d09df1f..0aeb502 100644 --- a/docs/docs/OSM.TilesProvider.TTilesProvider.html +++ b/docs/docs/OSM.TilesProvider.TTilesProvider.html @@ -21,7 +21,7 @@

Declaration

type TTilesProvider = class(TObject)

Description

-Abstract base class for tile image provider. Real implementations must inherit from it, assign properties and override methods.

+Abstract base class for tile image provider. Real implementations must inherit from it, assign properties and override methods.
Note to implementors: take any of the existing implementations as base. Try to store all constants within the class declaration leaving no magic values in implementation. This way all values won't be scattered between methods and will be easy to modify.

Hierarchy

Overview

@@ -48,6 +48,14 @@

Description

Publicclass function Name: string; override;
 
+ + + + + + + +
Publicconstructor Create; virtual; abstract;
Publicclass function Name: string; virtual; abstract;
Public function GetTileURL(const Tile: TTile): string; virtual; abstract;
@@ -104,6 +112,24 @@

Methods

+ + + +
Publicconstructor Create; virtual; abstract;
+ 
+ + + + + + +
Publicclass function Name: string; virtual; abstract;
+

+Function to return displayable provider name. Name could be used for selection in UI, file paths etc. There's no special limitations on the format of this string so when using it for something other than simple display, the value must be validated/preprocessed. The only recommendation is to keep the name short.

+
+ + +
Public function GetTileURL(const Tile: TTile): string; virtual; abstract;
@@ -119,7 +145,7 @@

Properties

-Generic storage for provider-specific properties. Raises exception in base class, should be implemented in descendants

+Generic storage for provider-specific properties. Raises exception in base class, should be implemented in descendants

Generated by PasDoc 0.16.0. diff --git a/docs/docs/OSM.TilesProvider.html b/docs/docs/OSM.TilesProvider.html index af03285..4a91718 100644 --- a/docs/docs/OSM.TilesProvider.html +++ b/docs/docs/OSM.TilesProvider.html @@ -12,10 +12,10 @@

OSM Map control

Unit OSM.TilesProvider

-
Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables
+
Description
Uses
Classes, Interfaces, Objects and Records
Functions and Procedures
Types
Constants
Variables

Description

-Generic (no real implementation) base class for tile image provider. Stores properties that could be specific to a real providers. +Generic (no real implementation) base class for tile image provider. Stores properties that could be specific to real providers.

(c) Fr0sT-Brutal https://github.com/Fr0sT-Brutal/Delphi_OSMMap @@ -36,6 +36,53 @@

Unit OSM.TilesProvider

Dummy tile provider class, used as a stub in map control if no real provider is assigned. +

Functions and Procedures

+ + + + +
procedure RegisterTilesProvider(TilesProviderClass: TTilesProviderClass);
+

Types

+ + + + +
TTilesProviderClass = class of TTilesProvider;
+

Variables

+ + + + +
TilesProviders: TArray<TTilesProviderClass>;
+

Description

+

Functions and Procedures

+ + + + + +
procedure RegisterTilesProvider(TilesProviderClass: TTilesProviderClass);
+

+Add class of tiles provider to global TilesProviders array. Handles multiple calls with the same class (by ignoring duplicates).

+
+

Types

+ + + + + +
TTilesProviderClass = class of TTilesProvider;
+ 
+

Variables

+ + + + + +
TilesProviders: TArray<TTilesProviderClass>;
+

+Global list of registered tiles providers. Use it if you want to support multiple providers within the same app.

+

Authors

  • Fr0sT-Brutal (https://github.com/Fr0sT-Brutal)