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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
|
#import <Foundation/Foundation.h>
#import "MGLTypes.h"
#import "MGLGeometry.h"
#import "MGLMapCamera.h"
NS_ASSUME_NONNULL_BEGIN
MGL_EXPORT
/**
The options to use when creating images with the `MGLMapsnapshotter`.
*/
@interface MGLMapSnapshotOptions : NSObject
/**
Creates a set of options with the minimum required information.
@param styleURL URL of the map style to snapshot. The URL may be a full HTTP or HTTPS URL,
a Mapbox URL indicating the style’s map ID (mapbox://styles/{user}/{style}), or a path
to a local file relative to the application’s resource path. Specify nil for the default style.
@param size The image size.
*/
- (instancetype)initWithStyleURL:(nullable NSURL*)styleURL camera:(MGLMapCamera*)camera size:(CGSize)size;
#pragma mark - Configuring the Map
/**
URL of the map style to snapshot. The URL may be a full HTTP or HTTPS URL,
a Mapbox URL indicating the style’s map ID (mapbox://styles/{user}/{style}), or a path
to a local file relative to the application’s resource path. Specify nil for the default style.
*/
@property (nonatomic, readonly) NSURL *styleURL;
/**
The default zoom level is 0. Overrides the altitude in the mapCamera options if set.
*/
@property (nonatomic) double zoomLevel;
/**
A camera representing the viewport visible in the snapshot.
*/
@property (nonatomic) MGLMapCamera *camera;
/**
The cooordinate rectangle that encompasses the bounds to capture. Overrides the center coordinate
in the mapCamera options if set.
*/
@property (nonatomic) MGLCoordinateBounds coordinateBounds;
#pragma mark - Configuring the Image
/**
The size of the output image.
The image may be no less than 64 pixels wide and no less than 64 pixels tall.
*/
@property (nonatomic, readonly) CGSize size;
/**
The scale of the output image. Defaults to the main screen scale.
Minimum is 1.
*/
@property (nonatomic) CGFloat scale;
@end
#if TARGET_OS_IPHONE
/**
A block to processes the result or error of a snapshot request.
@param snapshot The `UIImage` that was generated or `nil` if an error occurred.
@param error The error that occured or `nil` when succesful.
*/
typedef void (^MGLMapSnapshotCompletionHandler)(UIImage* _Nullable snapshot, NSError* _Nullable error);
#else
/**
A block to processes the result or error of a snapshot request.
@param snapshot The `NSImage` that was generated or `nil` if an error occurred.
@param error The eror that occured or `nil` when succesful.
*/
typedef void (^MGLMapSnapshotCompletionHandler)(NSImage* _Nullable snapshot, NSError* _Nullable error);
#endif
/**
An immutable utility object for capturing map-based images.
*/
MGL_EXPORT
@interface MGLMapSnapshotter : NSObject
- (instancetype)initWithOptions:(MGLMapSnapshotOptions*)options;
/**
Starts the snapshot creation and executes the specified block with the result.
@param completionHandler The block to handle the result in.
*/
- (void)startWithCompletionHandler:(MGLMapSnapshotCompletionHandler)completionHandler;
/**
Starts the snapshot creation and executes the specified block with the result on the specified queue.
@param queue The queue to handle the result on.
@param completionHandler The block to handle the result in.
*/
- (void)startWithQueue:(dispatch_queue_t)queue completionHandler:(MGLMapSnapshotCompletionHandler)completionHandler;
/**
Cancels the snapshot creation request, if any.
Once you call this method, you cannot resume the snapshot. In order to obtain the
snapshot, create a new `MGLMapSnapshotter` object.
*/
- (void)cancel;
/**
Indicates whether as snapshot is currently being generated.
*/
@property (nonatomic, readonly, getter=isLoading) BOOL loading;
@end
NS_ASSUME_NONNULL_END
|
