AWFAmpTileSourceProvider
@interface AWFAmpTileSourceProvider : NSObject
An AWFAmpTileSourceProvider
instance is responsible for managing all raster and text layers and layer options for the Aeris Maps Platform (AMP).
-
The current timestamp to use for image requests.
Declaration
Objective-C
@property (readwrite, strong, nonatomic) NSDate *_Nonnull timestamp;
Swift
var timestamp: Date { get set }
-
The tile data layer used for managing past and current imagery.
Declaration
Objective-C
@property (readonly, strong, nonatomic) AWFAmpTileSource *_Nonnull tileLayer;
Swift
var tileLayer: AWFAmpTileSource { get }
-
The tile data layer used for managing past and current text imagery.
Declaration
Objective-C
@property (readonly, strong, nonatomic) AWFAmpTileSource *_Nonnull textTileLayer;
Swift
var textTileLayer: AWFAmpTileSource { get }
-
The tile data layer used for managing future imagery.
Declaration
Objective-C
@property (readonly, strong, nonatomic) AWFAmpTileSource *_Nonnull futureTileLayer;
Swift
var futureTileLayer: AWFAmpTileSource { get }
-
The tile data layer used for managing future text imager.
Declaration
Objective-C
@property (readonly, strong, nonatomic) AWFAmpTileSource *_Nonnull futureTextTileLayer;
Swift
var futureTextTileLayer: AWFAmpTileSource { get }
-
The object that acts as the delegate of the tile source provider.
The delegate must adopt the
AWFAmpTileSourceProviderDelegate
protocol.Declaration
Objective-C
@property (assign, readwrite, nonatomic) id<AWFAmpTileSourceProviderDelegate> _Nonnull delegate;
Swift
unowned(unsafe) var delegate: AWFAmpTileSourceProviderDelegate { get set }
-
Initializes and returns a newly allocated provider with the specified weather map.
Declaration
Objective-C
- (nonnull instancetype)initWithWeatherMap:(nonnull AWFWeatherMap *)weatherMap;
Swift
init(weatherMap: AWFWeatherMap)
Parameters
weatherMap
The weather map associated with the provider.
Return Value
An allocated provider.
-
Adds a new raster map layer at the top of the layer stack.
Declaration
Objective-C
- (void)addRasterLayer:(nonnull AWFRasterMapLayer *)layer;
Swift
func addRasterLayer(_ layer: AWFRasterMapLayer)
Parameters
layer
The raster layer to add.
-
Adds a new raster map layer at the specified index.
If the specified index is greater than the total number of active layers, then the layer will be added to the top of the layer stack.
Declaration
Objective-C
- (void)addRasterLayer:(nonnull AWFRasterMapLayer *)layer atIndex:(NSInteger)index;
Swift
func addRasterLayer(_ layer: AWFRasterMapLayer, at index: Int)
Parameters
layer
The raster layer to add.
index
The index into which to insert the layer.
-
Removes a raster map layer.
Declaration
Objective-C
- (void)removeRasterLayer:(nonnull AWFRasterMapLayer *)layer;
Swift
func removeRasterLayer(_ layer: AWFRasterMapLayer)
Parameters
layer
The raster layer to remove.
-
Returns whether the provider contains the specified layer type.
Declaration
Objective-C
- (BOOL)containsLayerType:(nonnull AWFMapLayer)layerType;
Swift
func containsLayerType(_ layerType: Any!) -> Bool
Parameters
layerType
The layer type to search for.
Return Value
YES
if the provider contains the layer type, otherwiseNO
. -
Returns the raster map layer instance for the specified layer type.
If the provider does not contain the layer type, then
nil
will be returned.Declaration
Objective-C
- (nullable AWFRasterMapLayer *)rasterLayerForLayerType: (nonnull AWFMapLayer)layerType;
Swift
func rasterLayer(forLayerType layerType: Any!) -> AWFRasterMapLayer?
Parameters
layerType
The layer type to return the raster map layer for.
Return Value
The raster map layer if it exists, otherwise
nil
. -
Adds a text map layer at the top of the layer stack.
Declaration
Objective-C
- (void)addTextLayer:(nonnull AWFRasterMapLayer *)layer;
Swift
func addTextLayer(_ layer: AWFRasterMapLayer)
Parameters
layer
The text layer to add.
-
Adds a text map layer for the specified raster layer.
Note
Not all raster layers support text layers. If the provided raster layer does not contain a text layer, this method will not add a new layer to the provider.
Declaration
Objective-C
- (void)addTextLayerForRasterLayer:(nonnull AWFRasterMapLayer *)layer;
Swift
func addTextLayer(forRasterLayer layer: AWFRasterMapLayer)
Parameters
layer
The layer to add a new text layer for.
-
Removes a text map layer.
Declaration
Objective-C
- (void)removeTextLayer:(nonnull AWFRasterMapLayer *)layer;
Swift
func removeTextLayer(_ layer: AWFRasterMapLayer)
Parameters
layer
The text map layer to remove.
-
Removes the text map layer associated with the specified raster map layer, if any.
Declaration
Objective-C
- (void)removeTextLayerForRasterLayer:(nonnull AWFRasterMapLayer *)layer;
Swift
func removeTextLayer(forRasterLayer layer: AWFRasterMapLayer)
Parameters
layer
The raster map layer to remove the text layer for.
-
Returns the text map layer instance for the specified layer type.
If the provider does not contain the layer type or a text map layer for the layer type, then
nil
will be returned.Declaration
Objective-C
- (nullable AWFRasterMapLayer *)textLayerForLayerType: (nonnull AWFMapLayer)layerType;
Swift
func textLayer(forLayerType layerType: Any!) -> AWFRasterMapLayer?
Parameters
layerType
The layer type to return the text map layer for.
Return Value
The text map layer if it exists, otherwise
nil
. -
Updates the current date and time for all layers.
Declaration
Objective-C
- (void)updateLayersForDate:(nonnull NSDate *)date;
Swift
func updateLayers(for date: Date)
Parameters
date
The new date to use.