summaryrefslogtreecommitdiff
path: root/platform/darwin/src/MGLRasterSource.h
blob: 78f5af8a6ab58d529268ca8398dacd50ab2c87a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
#import "MGLSource.h"
#import "MGLTypes.h"

#import <CoreGraphics/CoreGraphics.h>

@class MGLTileSet;

NS_ASSUME_NONNULL_BEGIN

/**
 A raster tile source.
 
 @see <a href="https://www.mapbox.com/mapbox-gl-style-spec/#sources-raster">The
 style specification.</a>
 */
@interface MGLRasterSource : MGLSource

#pragma mark Initializing a Source

/**
 Returns a raster source initialized with an identifier, TileJSON configuration
 URL, and tile size.
 
 After initializing and configuring the source, add it to a map view’s style
 using the `-[MGLStyle addSource:]` method.
 
 @param identifier A string that uniquely identifies the source in the style to
    which it is added.
 @param url A URL to a TileJSON configuration file describing the source’s
    contents and other metadata.
 @param tileSize The height and width (measured in points) at which to display
    each tile in this source when the map’s zoom level is an integer.
 @return An initialized raster source.
 */
- (instancetype)initWithIdentifier:(NSString *)identifier URL:(NSURL *)url tileSize:(CGFloat)tileSize NS_DESIGNATED_INITIALIZER;

/**
 Returns a raster source initialized with the given identifier, tile size, and
 tile set.
 
 After initializing and configuring the source, add it to a map view’s style
 using the `-[MGLStyle addSource:]` method.

 @param identifier A string that uniquely identifies the source in the style to
    which it is added.
 @param tileSet A tile set describing the source’s contents and other metadata.
 @param tileSize The height and width (measured in points) at which to display
    each tile in this source when the map’s zoom level is an integer.
 @return An initialized raster source.
 */
- (instancetype)initWithIdentifier:(NSString *)identifier tileSet:(MGLTileSet *)tileSet tileSize:(CGFloat)tileSize NS_DESIGNATED_INITIALIZER;

#pragma mark Accessing a Source’s Content

/**
 A URL to a TileJSON configuration file describing the source’s contents and
 other metadata.
 
 The URL may be a full HTTP or HTTPS URL or a Mapbox URL indicating the tile
 set’s map ID (`mapbox://<mapid>`).
 
 @see <a href="https://www.mapbox.com/help/an-open-platform/#tilejson">The 
 TileJSON specification.</a>
 */
@property (nonatomic, readonly, copy) NSURL *URL;

/**
 The height and width (measured in points) at which to display each tile in this
 source when the map’s zoom level is an integer.
 
 A tile may be scaled up or down when the zoom level is between two integers.
 
 The default value of this property is 512 points.
 */
@property (nonatomic, readonly, assign) NSUInteger tileSize;

/**
 The tile set used to locate and download tiles. 
 
 A tile set holds the raster tile URL template strings and associated
 configuration for those strings. It can be passed in place of the URL
 to TileJSON in order to create a source configured to download tiles
 from ordinary web URLs.
 */
@property (nonatomic, readonly, nullable) MGLTileSet *tileSet;

@end

NS_ASSUME_NONNULL_END