Remove CKAnnotation protocol.

Fix selection.

Author: maxep

ClusterKit/Core/Algorithm/CKClusterAlgorithm.m

@@ -38,7 +38,7 @@ - (instancetype)init {
     NSArray *annotations = [tree annotationsInRect:rect];
     NSMutableArray *clusters = [NSMutableArray arrayWithCapacity:annotations.count];
 
-    for (id<CKAnnotation> annotation in annotations) {
+    for (id<MKAnnotation> annotation in annotations) {
         CKCluster *cluster = [self clusterWithCoordinate:annotation.coordinate];
         [cluster addAnnotation:annotation];
         [clusters addObject:cluster];

ClusterKit/Core/Algorithm/CKGridBasedAlgorithm.m

@@ -42,7 +42,7 @@ - (instancetype)init {
         // Divide the whole map into a numCells x numCells grid and assign annotations to them.
         long numCells = (long)ceil(256 * pow(2, zoom) / self.cellSize);
 
-        for (id<CKAnnotation> annotation in annotations) {
+        for (id<MKAnnotation> annotation in annotations) {
 
             MKMapPoint point = MKMapPointForCoordinate(annotation.coordinate);
             NSUInteger col = numCells * point.x / MKMapSizeWorld.width;

ClusterKit/Core/Algorithm/CKNonHierarchicalDistanceBasedAlgorithm.m

@@ -46,13 +46,13 @@ - (instancetype)init {
 
     NSMutableArray<CKCluster *> *clusters = [[NSMutableArray alloc] init];
 
-    NSMapTable<id<CKAnnotation>, CKCandidate *> *visited = [NSMapTable strongToStrongObjectsMapTable];
+    NSMapTable<id<MKAnnotation>, CKCandidate *> *visited = [NSMapTable strongToStrongObjectsMapTable];
 
     @synchronized(tree) {
 
         NSArray *annotations = [tree annotationsInRect:rect];
 
-        for (id<CKAnnotation> annotation in annotations) {
+        for (id<MKAnnotation> annotation in annotations) {
 
             if ([visited objectForKey:annotation]) {
                 continue;
@@ -64,7 +64,7 @@ - (instancetype)init {
             MKMapRect clusterRect = CKCreateRectFromSpan(annotation.coordinate, zoomSpecificSpan);
             NSArray *neighbors  = [tree annotationsInRect:clusterRect];
 
-            for (id<CKAnnotation> neighbor in neighbors) {
+            for (id<MKAnnotation> neighbor in neighbors) {
 
                 CKCandidate *candidate = [visited objectForKey:neighbor];
 

ClusterKit/Core/CKCluster.h

@@ -38,21 +38,6 @@ MK_EXTERN MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point);
 
 @class CKCluster;
 
-#pragma - CKAnnotation protocol
-
-/**
- The CKAnnotation protocol is used to provide clusterized place information to a map. To use this protocol, you adopt it in any custom objects that store or represent a place data. Annotation objects do not provide the visual representation of the place but typically coordinate and parent cluster.
- @discussion An object that adopts this protocol must implement the coordinate and cluster properties. The other methods of this protocol are optional.
- */
-@protocol CKAnnotation <MKAnnotation>
-
-/**
- The cluster that the annotation is related to.
- */
-@property (nonatomic, weak, nullable) CKCluster *cluster;
-
-@end
-
 #pragma - Cluster definitions
 
 /**
@@ -83,7 +68,7 @@ MK_EXTERN MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point);
 /**
  Cluster annotation array.
  */
-@property (nonatomic, readonly, copy) NSArray<id<CKAnnotation>> *annotations;
+@property (nonatomic, readonly, copy) NSArray<id<MKAnnotation>> *annotations;
 
 /**
  The number of annotations in the cluster.
@@ -94,13 +79,13 @@ MK_EXTERN MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point);
  The first annotation in the cluster.
  If the cluster is empty, returns nil.
  */
-@property (nonatomic, readonly, nullable) id<CKAnnotation> firstAnnotation;
+@property (nonatomic, readonly, nullable) id<MKAnnotation> firstAnnotation;
 
 /**
  The last annotation in the cluster.
  If the cluster is empty, returns nil.
  */
-@property (nonatomic, readonly, nullable) id<CKAnnotation> lastAnnotation;
+@property (nonatomic, readonly, nullable) id<MKAnnotation> lastAnnotation;
 
 /**
  Represents a rectangular bounding box on the Earth's projection.
@@ -112,14 +97,14 @@ MK_EXTERN MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point);
  
  @param annotation The annotation to add.
  */
-- (void)addAnnotation:(id<CKAnnotation>)annotation;
+- (void)addAnnotation:(id<MKAnnotation>)annotation;
 
 /**
  Removes a given annotation from the cluster.
  
  @param annotation The annotation to remove.
  */
-- (void)removeAnnotation:(id<CKAnnotation>)annotation;
+- (void)removeAnnotation:(id<MKAnnotation>)annotation;
 
 /**
  Returns the annotation at the given index.
@@ -128,7 +113,7 @@ MK_EXTERN MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point);
  @param index An annotation index within the bounds of the array.
  @return The annotation located at index.
  */
-- (id<CKAnnotation>)annotationAtIndex:(NSUInteger)index;
+- (id<MKAnnotation>)annotationAtIndex:(NSUInteger)index;
 
 /**
  Returns a Boolean value that indicates whether a given annotation is present in the cluster.
@@ -137,20 +122,20 @@ MK_EXTERN MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point);
  @param annotation An annotation.
  @return YES if the gievn annotation is present in the cluster, otherwise NO.
  */
-- (BOOL)containsAnnotation:(id<CKAnnotation>)annotation;
+- (BOOL)containsAnnotation:(id<MKAnnotation>)annotation;
 
 /**
  Returns the annotation at the specified index.
  This method has the same behavior as the annotationAtIndex: method.
  If index is beyond the end of the cluster (that is, if index is greater than or equal to the value returned by count), an NSRangeException is raised.
  You shouldn’t need to call this method directly. Instead, this method is called when accessing an annotation by index using subscripting.
  
- `id<CKAnnotation> value = cluster[3]; // equivalent to [cluster annotationAtIndex:3]`
+ `id<MKAnnotation> value = cluster[3]; // equivalent to [cluster annotationAtIndex:3]`
  
  @param index An index within the bounds of the cluster.
  @return The annotation located at index.
  */
-- (id<CKAnnotation>)objectAtIndexedSubscript:(NSUInteger)index;
+- (id<MKAnnotation>)objectAtIndexedSubscript:(NSUInteger)index;
 
 /**
  Returns a Boolean value that indicates whether the receiver and a given cluster are equal.

ClusterKit/Core/CKCluster.m

@@ -39,7 +39,7 @@ MKMapRect MKMapRectByAddingPoint(MKMapRect rect, MKMapPoint point) {
 
 @implementation CKCluster {
 @protected
-    NSMutableOrderedSet<id<CKAnnotation>> *_annotations;
+    NSMutableOrderedSet<id<MKAnnotation>> *_annotations;
 
     MKMapRect _bounds;
     BOOL _invalidate_bounds;
@@ -58,14 +58,14 @@ - (instancetype)init{
     return self;
 }
 
-- (NSArray<id<CKAnnotation>> *)annotations {
+- (NSArray<id<MKAnnotation>> *)annotations {
     return _annotations.array;
 }
 
 - (MKMapRect)bounds {
     if (_invalidate_bounds) {
         _bounds = MKMapRectNull;
-        for (id<CKAnnotation> annotation in _annotations) {
+        for (id<MKAnnotation> annotation in _annotations) {
             _bounds = MKMapRectByAddingPoint(_bounds, MKMapPointForCoordinate(annotation.coordinate));
         }
 
@@ -78,39 +78,35 @@ - (NSUInteger)count {
     return _annotations.count;
 }
 
-- (id<CKAnnotation>)firstAnnotation {
+- (id<MKAnnotation>)firstAnnotation {
     return _annotations.firstObject;
 }
 
-- (id<CKAnnotation>)lastAnnotation {
+- (id<MKAnnotation>)lastAnnotation {
     return _annotations.firstObject;
 }
 
-- (id<CKAnnotation>)annotationAtIndex:(NSUInteger)index {
+- (id<MKAnnotation>)annotationAtIndex:(NSUInteger)index {
     return _annotations[index];
 }
 
-- (id<CKAnnotation>)objectAtIndexedSubscript:(NSUInteger)index {
+- (id<MKAnnotation>)objectAtIndexedSubscript:(NSUInteger)index {
     return _annotations[index];
 }
 
-- (void)addAnnotation:(id<CKAnnotation>)annotation {
+- (void)addAnnotation:(id<MKAnnotation>)annotation {
     [_annotations addObject:annotation];
-    annotation.cluster = self;
-    
     _bounds = MKMapRectByAddingPoint(_bounds, MKMapPointForCoordinate(annotation.coordinate));
 }
 
-- (void)removeAnnotation:(id<CKAnnotation>)annotation {
-    if (annotation.cluster == self) {
+- (void)removeAnnotation:(id<MKAnnotation>)annotation {
+    if ([_annotations containsObject:self]) {
         [_annotations removeObject:annotation];
-        annotation.cluster = nil;
-        
         _invalidate_bounds = YES;
     }
 }
 
-- (BOOL)containsAnnotation:(id<CKAnnotation>)annotation {
+- (BOOL)containsAnnotation:(id<MKAnnotation>)annotation {
     return [_annotations containsObject:annotation];
 }
 
@@ -174,20 +170,20 @@ - (NSUInteger)countByEnumeratingWithState:(NSFastEnumerationState *)state object
 
 @implementation CKCentroidCluster
 
-- (void)addAnnotation:(id<CKAnnotation>)annotation {
+- (void)addAnnotation:(id<MKAnnotation>)annotation {
     [super addAnnotation:annotation];
     self.coordinate = [self coordinateByAddingAnnotation:annotation];
 }
 
-- (void)removeAnnotation:(id<CKAnnotation>)annotation {
-    if (annotation.cluster == self) {
-        [super removeAnnotation:annotation];
-        
+- (void)removeAnnotation:(id<MKAnnotation>)annotation {
+    if ([_annotations containsObject:self]) {
+        [_annotations removeObject:annotation];
+        _invalidate_bounds = YES;
         self.coordinate = [self coordinateByRemovingAnnotation:annotation];
     }
 }
 
-- (CLLocationCoordinate2D)coordinateByAddingAnnotation:(id<CKAnnotation>)annotation {
+- (CLLocationCoordinate2D)coordinateByAddingAnnotation:(id<MKAnnotation>)annotation {
     if (self.count < 2) {
         return annotation.coordinate;
     }
@@ -200,7 +196,7 @@ - (CLLocationCoordinate2D)coordinateByAddingAnnotation:(id<CKAnnotation>)annotat
     return CLLocationCoordinate2DMake(latitude / self.count, longitude / self.count);
 }
 
-- (CLLocationCoordinate2D)coordinateByRemovingAnnotation:(id<CKAnnotation>)annotation {
+- (CLLocationCoordinate2D)coordinateByRemovingAnnotation:(id<MKAnnotation>)annotation {
     if (self.count < 1) {
         return kCLLocationCoordinate2DInvalid;
     }
@@ -220,10 +216,9 @@ @implementation CKNearestCentroidCluster {
     CLLocationCoordinate2D _center;
 }
 
-- (void)addAnnotation:(id<CKAnnotation>)annotation {
-    if (annotation.cluster != self) {
+- (void)addAnnotation:(id<MKAnnotation>)annotation {
+    if (![_annotations containsObject:self]) {
         [_annotations addObject:annotation];
-        annotation.cluster = self;
 
         _center = [self coordinateByAddingAnnotation:annotation];
         self.coordinate = [self coordinateByDistanceSort];
@@ -232,10 +227,9 @@ - (void)addAnnotation:(id<CKAnnotation>)annotation {
     }
 }
 
-- (void)removeAnnotation:(id<CKAnnotation>)annotation {
-    if (annotation.cluster == self) {
+- (void)removeAnnotation:(id<MKAnnotation>)annotation {
+    if ([_annotations containsObject:self]) {
         [_annotations removeObject:annotation];
-        annotation.cluster = nil;
 
         _center = [self coordinateByRemovingAnnotation:annotation];
         self.coordinate = [self coordinateByDistanceSort];
@@ -245,7 +239,7 @@ - (void)removeAnnotation:(id<CKAnnotation>)annotation {
 }
 
 - (CLLocationCoordinate2D)coordinateByDistanceSort {
-    [_annotations sortUsingComparator:^NSComparisonResult(id<CKAnnotation> _Nonnull obj1, id<CKAnnotation> _Nonnull obj2) {
+    [_annotations sortUsingComparator:^NSComparisonResult(id<MKAnnotation> _Nonnull obj1, id<MKAnnotation> _Nonnull obj2) {
         double d1 = CKDistance(self->_center, obj1.coordinate);
         double d2 = CKDistance(self->_center, obj2.coordinate);
         if (d1 > d2) return NSOrderedDescending;
@@ -260,30 +254,28 @@ - (CLLocationCoordinate2D)coordinateByDistanceSort {
 
 @implementation CKBottomCluster
 
-- (void)addAnnotation:(id<CKAnnotation>)annotation {
-    if (annotation.cluster != self) {
+- (void)addAnnotation:(id<MKAnnotation>)annotation {
+    if (![_annotations containsObject:self]) {
         NSUInteger index = [_annotations indexOfObject:annotation
                                          inSortedRange:NSMakeRange(0, _annotations.count)
                                                options:NSBinarySearchingInsertionIndex
-                                       usingComparator:^NSComparisonResult(id<CKAnnotation> _Nonnull obj1, id<CKAnnotation> _Nonnull obj2) {
+                                       usingComparator:^NSComparisonResult(id<MKAnnotation> _Nonnull obj1, id<MKAnnotation> _Nonnull obj2) {
                                            if (obj1.coordinate.latitude > obj2.coordinate.latitude) return NSOrderedDescending;
                                            if (obj1.coordinate.latitude < obj2.coordinate.latitude) return NSOrderedAscending;
                                            return NSOrderedSame;
                                        }];
 
         [_annotations insertObject:annotation atIndex:index];
-        annotation.cluster = self;
 
         self.coordinate = _annotations.firstObject.coordinate;
 
         _bounds = MKMapRectByAddingPoint(_bounds, MKMapPointForCoordinate(annotation.coordinate));
     }
 }
 
-- (void)removeAnnotation:(id<CKAnnotation>)annotation {
-    if (annotation.cluster == self) {
+- (void)removeAnnotation:(id<MKAnnotation>)annotation {
+    if ([_annotations containsObject:self]) {
         [_annotations removeObject:annotation];
-        annotation.cluster = nil;
 
         self.coordinate = _annotations.firstObject.coordinate;
 

ClusterKit/Core/CKClusterManager.h

@@ -47,7 +47,7 @@ FOUNDATION_EXTERN const double kCKMarginFactorWorld;
  
  @return Yes to permit clusterization of the given annotation.
  */
-- (BOOL)clusterManager:(CKClusterManager *)clusterManager shouldClusterAnnotation:(id<CKAnnotation>)annotation;
+- (BOOL)clusterManager:(CKClusterManager *)clusterManager shouldClusterAnnotation:(id<MKAnnotation>)annotation;
 
 /**
  Tells the delegate to perform an animation.
@@ -90,7 +90,7 @@ FOUNDATION_EXTERN const double kCKMarginFactorWorld;
 /**
  The currently selected annotation.
  */
-@property (nonatomic,readonly) id<CKAnnotation> selectedAnnotation;
+@property (nonatomic,readonly) id<MKAnnotation> selectedAnnotation;
 
 /**
  The current cluster array.
@@ -110,49 +110,49 @@ FOUNDATION_EXTERN const double kCKMarginFactorWorld;
 /**
  The annotations to clusterize.
  */
-@property (nonatomic,copy) NSArray<id<CKAnnotation>> *annotations;
+@property (nonatomic,copy) NSArray<id<MKAnnotation>> *annotations;
 
 /**
  Adds an annotation.
  
  @param annotation The annotation to add.
  */
-- (void)addAnnotation:(id<CKAnnotation>)annotation;
+- (void)addAnnotation:(id<MKAnnotation>)annotation;
 
 /**
  Adds annotations.
  
  @param annotations Annotations to add.
  */
-- (void)addAnnotations:(NSArray<id<CKAnnotation>> *)annotations;
+- (void)addAnnotations:(NSArray<id<MKAnnotation>> *)annotations;
 
 /**
  Removes an annotation.
  
  @param annotation The annotation to remove.
  */
-- (void)removeAnnotation:(id<CKAnnotation>)annotation;
+- (void)removeAnnotation:(id<MKAnnotation>)annotation;
 
 /**
  Removes annotations.
  
  @param annotations Annotations to remove.
  */
-- (void)removeAnnotations:(NSArray<id<CKAnnotation>> *)annotations;
+- (void)removeAnnotations:(NSArray<id<MKAnnotation>> *)annotations;
 
 /**
  Selects an annotation. Look for the annotation in clusters and extract it if necessary.
  
  @param annotation   The annotation to be selected.
  */
-- (void)selectAnnotation:(id<CKAnnotation>)annotation animated:(BOOL)animated;
+- (void)selectAnnotation:(id<MKAnnotation>)annotation animated:(BOOL)animated;
 
 /**
  Deselects an annotation.
  
  @param annotation   The annotation to be deselected.
  */
-- (void)deselectAnnotation:(nullable id<CKAnnotation>)annotation animated:(BOOL)animated;
+- (void)deselectAnnotation:(nullable id<MKAnnotation>)annotation animated:(BOOL)animated;
 
 /**
  Updates displayed clusters.