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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
/*
* MaplyCluster.h
* WhirlyGlobe-MaplyComponent
*
* Created by Steve Gifford on 9/29/15.
* Copyright 2011-2022 mousebird consulting
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
*/
#import <UIKit/UIKit.h>
#import <WhirlyGlobe/MaplyCoordinate.h>
#import <WhirlyGlobe/MaplyScreenMarker.h>
#import <WhirlyGlobe/MaplyShader.h>
@class MaplyBaseViewController;
/**
Information about the group of objects to cluster.
This object is passed in when the developer needs to make an image for a group of objects.
*/
@interface MaplyClusterInfo : NSObject
/// Number of objects being clustered
@property (nonatomic,assign) int numObjects;
/// All the unique IDs from the
@property (nonatomic,retain) NSArray<NSString *> * __nullable uniqueIDs;
@end
/**
Visual representation for a group of markers.
Fill this in when you're implementing a MaplyClusterGenerator.
*/
@interface MaplyClusterGroup : NSObject
/// The image to use for the group
@property (nonatomic,strong) id __nonnull image;
/// Screen size to use for the resulting marker
@property (nonatomic,assign) CGSize size;
/// Size used for layout. If it's not set, we use the regular size.
@property (nonatomic,assign) CGSize layoutSize;
@end
/**
Fill in this protocol to provide images when individual markers/labels are clustered.
This is the protocol for marker/label clustering. You must fill this in and register the cluster
*/
@protocol MaplyClusterGenerator <NSObject>
/**
Called at the start of clustering.
Called right before we start generating clusters. Do you setup here if need be.
*/
- (void) startClusterGroup;
/**
Generate a cluster group for a given collection of markers.
Generate an image and size to represent the number of marker/labels we're consolidating.
@note Will not be called if @c -showMarkerWithHighestImportance returns @c true.
*/
- (MaplyClusterGroup *__nonnull) makeClusterGroup:(MaplyClusterInfo *__nonnull)clusterInfo;
/**
Called at the end of clustering.
If you were doing optimization (for image reuse, say) clean it up here.
*/
- (void) endClusterGroup;
/// Return the cluster number we're covering
- (int) clusterNumber;
/// The size of the cluster that will be created.
/// This is the biggest cluster you're likely to create. We use it to figure overlaps between clusters.
- (CGSize) clusterLayoutSize;
/// Use appearance and coordinate of cluster group marker with highest importance. If not set then an average of coordinates will be used
- (bool) showMarkerWithHighestImportance;
/// Set this if you want cluster to be user selectable. On by default.
- (bool) selectable;
/// How long to animate markers the join and leave a cluster
- (double) markerAnimationTime;
/// The shader to use for moving objects around
/// If you're doing animation from point to cluster you need to provide a suitable shader.
- (MaplyShader *__nullable) motionShader;
@end
/**
The basic cluster generator installed by default.
This cluster generator will make images for grouped clusters of markers/labels.
*/
@interface MaplyBasicClusterGenerator : NSObject <MaplyClusterGenerator>
/**
Initialize with a list of colors.
Initialize with a list of colors. Each order of magnitude will use another color. Must provide at least 1.
*/
- (nonnull instancetype)initWithColors:(NSArray *__nonnull)colors clusterNumber:(int)clusterNumber size:(CGSize)markerSize viewC:(NSObject<MaplyRenderControllerProtocol> *__nonnull)viewC;
/// The ID number corresponding to the cluster. Every marker/label with this cluster ID will be grouped together.
@property (nonatomic,assign) int clusterNumber;
/// The size of the cluster that will be created.
/// This is the biggest cluster you're likely to create. We use it to figure overlaps between clusters.
@property (nonatomic) CGSize clusterLayoutSize;
/// Set to use appearance and coordinate of cluster group marker with highest importance. Off by default.
@property (nonatomic) bool showMarkerWithHighestImportance;
/// Set this if you want cluster to be user selectable. On by default.
@property (nonatomic) bool selectable;
/// How long to animate markers the join and leave a cluster
@property (nonatomic) double markerAnimationTime;
/// The shader to use when moving objects around
/// When warping objects to their new locations we use a motion shader. Set this if you want to override the default.
@property (nonatomic,strong) MaplyShader * __nullable motionShader;
@end
|
