RMTileSource Protocol Reference
| Conforms to | NSObject |
| Declared in | RMTileSource.h |
Overview
The RMTileSource protocol describes the general interface for map tile sources. Whether retrieved from network sources or provided locally, tile sources must provide some specific minimum properties.
Tasks
Configuring the Supported Zoom Levels
-
minZoomproperty required method -
maxZoomproperty required method -
cacheableproperty required method -
opaqueproperty required method
Querying the Bounds
-
latitudeLongitudeBoundingBoxproperty required method
Configuring Caching
-
uniqueTilecacheKeyproperty required method
Configuring Tile Size
-
tileSideLengthproperty required method
Configuring Descriptive Properties
-
shortNameproperty required method -
longDescriptionproperty required method -
shortAttributionproperty required method -
longAttributionproperty required method
Supplying Tile Images
-
– imageForTile:inCache:required method -
– tileSourceHasTile:required method
Properties
cacheable
A Boolean value indicating whether the tiles from this source should be cached.
@property (nonatomic, assign, getter=isCacheable) BOOL cacheableDiscussion
A Boolean value indicating whether the tiles from this source should be cached.
Declared In
RMTileSource.hlatitudeLongitudeBoundingBox
The bounding box that the tile source provides coverage for.
@property (nonatomic, readonly) RMSphericalTrapezium latitudeLongitudeBoundingBoxDiscussion
The bounding box that the tile source provides coverage for.
Declared In
RMTileSource.hlongAttribution
An extended version of the tile source’s attribution string.
@property (nonatomic, readonly) NSString *longAttributionDiscussion
An extended version of the tile source’s attribution string.
Declared In
RMTileSource.hlongDescription
An extended version of the tile source’s description.
@property (nonatomic, readonly) NSString *longDescriptionDiscussion
An extended version of the tile source’s description.
Declared In
RMTileSource.hmaxZoom
The maximum zoom level supported by the tile source.
@property (nonatomic, assign) float maxZoomDiscussion
The maximum zoom level supported by the tile source.
Declared In
RMTileSource.hminZoom
The minimum zoom level supported by the tile source.
@property (nonatomic, assign) float minZoomDiscussion
The minimum zoom level supported by the tile source.
Declared In
RMTileSource.hopaque
A Boolean value indicating whether the tiles from this source are opaque. Setting this correctly is important when using RMCompositeSource so that alpha transparency can be preserved when compositing tile images.
@property (nonatomic, assign, getter=isOpaque) BOOL opaqueDiscussion
A Boolean value indicating whether the tiles from this source are opaque. Setting this correctly is important when using RMCompositeSource so that alpha transparency can be preserved when compositing tile images.
Declared In
RMTileSource.hshortAttribution
A short version of the tile source’s attribution string.
@property (nonatomic, readonly) NSString *shortAttributionDiscussion
A short version of the tile source’s attribution string.
Declared In
RMTileSource.hshortName
A short version of the tile source’s name.
@property (nonatomic, readonly) NSString *shortNameDiscussion
A short version of the tile source’s name.
Declared In
RMTileSource.htileSideLength
The number of pixels along the side of a tile image for this source.
@property (nonatomic, readonly) NSUInteger tileSideLengthDiscussion
The number of pixels along the side of a tile image for this source.
Declared In
RMTileSource.huniqueTilecacheKey
A unique string representing the tile source in the cache in order to distinguish it from other tile sources.
@property (nonatomic, readonly) NSString *uniqueTilecacheKeyDiscussion
A unique string representing the tile source in the cache in order to distinguish it from other tile sources.
Declared In
RMTileSource.hInstance Methods
imageForTile:inCache:
Provide an image for a given tile location using a given cache.
- (UIImage *)imageForTile:(RMTile)tile inCache:(RMTileCache *)tileCacheParameters
- tile
The map tile in question.
- tileCache
A tile cache to check first when providing the image.
Return Value
An image to display.
Discussion
Provide an image for a given tile location using a given cache.
Declared In
RMTileSource.htileSourceHasTile:
Check if the tile source can provide the requested tile.
- (BOOL)tileSourceHasTile:(RMTile)tileParameters
- tile
The map tile in question.
Return Value
A Boolean value indicating whether the tile source can provide the requested tile.
Discussion
Check if the tile source can provide the requested tile.
Declared In
RMTileSource.h