MAMapView.h

Go to the documentation of this file.

//
//  MAMapView.h
//  MAMapKit
//
//  Created by 翁乐 on 3/17/16.
//  Copyright © 2016 Amap. All rights reserved.
//

#import "MAConfig.h"
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import "MAOverlay.h"
#import "MAOverlayRenderer.h"
#import "MAAnnotationView.h"
#import "MACircle.h"
#import "MAUserLocation.h"
#import "MAMapStatus.h"
#import "MAIndoorInfo.h"
#import "MAUserLocationRepresentation.h"
#import "MAMapCustomStyleOptions.h"

typedef NS_ENUM(NSInteger, MAMapType)
{
    MAMapTypeStandard = 0,  
    MAMapTypeSatellite,     
    MAMapTypeStandardNight, 
    MAMapTypeNavi,          
    MAMapTypeBus            
};

typedef NS_ENUM(NSInteger, MAUserTrackingMode)
{
    MAUserTrackingModeNone              = 0,    
    MAUserTrackingModeFollow            = 1,    
    MAUserTrackingModeFollowWithHeading = 2     
};

typedef NS_ENUM(NSInteger, MATrafficStatus)
{
    MATrafficStatusSmooth = 1,                  
    MATrafficStatusSlow,                        
    MATrafficStatusJam,                         
    MATrafficStatusSeriousJam,                  
};

typedef NS_ENUM(NSInteger, MAOverlayLevel) {
    MAOverlayLevelAboveRoads = 0,   
    MAOverlayLevelAboveLabels       
};

#pragma mark - 动画相关的key
extern NSString * const kMAMapLayerCenterMapPointKey;

extern NSString * const kMAMapLayerZoomLevelKey;

extern NSString * const kMAMapLayerRotationDegreeKey;

extern NSString * const kMAMapLayerCameraDegreeKey;


@protocol MAMapViewDelegate;

@interface MAMapView : UIView

@property (nonatomic, weak) id<MAMapViewDelegate> delegate;

@property (nonatomic) MAMapType mapType;

@property (nonatomic) CLLocationCoordinate2D centerCoordinate;

@property (nonatomic) MACoordinateRegion region;

@property (nonatomic) MAMapRect visibleMapRect;

@property (nonatomic, assign) MACoordinateRegion limitRegion;

@property (nonatomic, assign) MAMapRect limitMapRect;

@property (nonatomic) CGFloat zoomLevel;

@property (nonatomic) CGFloat minZoomLevel;

@property (nonatomic) CGFloat maxZoomLevel;

@property (nonatomic) CGFloat rotationDegree;

@property (nonatomic) CGFloat cameraDegree;

@property (nonatomic, assign) BOOL zoomingInPivotsAroundAnchorPoint;

@property (nonatomic, getter = isZoomEnabled) BOOL zoomEnabled;

@property (nonatomic, getter = isScrollEnabled) BOOL scrollEnabled;

@property (nonatomic, getter = isRotateEnabled) BOOL rotateEnabled;

@property (nonatomic, getter = isRotateCameraEnabled) BOOL rotateCameraEnabled;

@property (nonatomic, getter = isSkyModelEnabled) BOOL skyModelEnable __attribute((deprecated("已废弃 since 6.0.0")));

@property (nonatomic, getter = isShowsBuildings) BOOL showsBuildings;

@property (nonatomic, assign, getter = isShowsLabels) BOOL showsLabels;

@property (nonatomic, getter = isShowTraffic) BOOL showTraffic;

@property (nonatomic, copy) NSDictionary <NSNumber *, UIColor *> *trafficStatus;

@property (nonatomic, assign) CGFloat trafficRatio __attribute((deprecated("已废弃 since 6.0.0, 不再支持修改实时交通线宽")));

@property (nonatomic, assign) BOOL touchPOIEnabled;

@property (nonatomic, assign) BOOL showsCompass;

@property (nonatomic, assign) CGPoint compassOrigin;

@property (nonatomic, readonly) CGSize compassSize;

@property (nonatomic, assign) BOOL showsScale;

@property (nonatomic, assign) CGPoint scaleOrigin;

@property (nonatomic, readonly) CGSize scaleSize;

@property (nonatomic, assign) CGPoint logoCenter;

@property (nonatomic, readonly) CGSize logoSize;

@property (nonatomic, readonly) double metersPerPointForCurrentZoom;

@property (nonatomic, readonly) BOOL isAbroad;

@property (nonatomic, assign) NSUInteger maxRenderFrame;

@property (nonatomic, assign) BOOL isAllowDecreaseFrame;

@property (nonatomic, assign) BOOL openGLESDisabled;

@property (nonatomic, assign) CGPoint screenAnchor;

@property (nonatomic, copy) NSRunLoopMode runLoopMode;

@property (nonatomic, getter=isShowsWorldMap) NSNumber *showsWorldMap;

@property (nonatomic, strong) NSNumber *mapLanguage;

- (void)setRegion:(MACoordinateRegion)region animated:(BOOL)animated;

- (MACoordinateRegion)regionThatFits:(MACoordinateRegion)region;

- (void)setVisibleMapRect:(MAMapRect)mapRect animated:(BOOL)animated;

- (MAMapRect)mapRectThatFits:(MAMapRect)mapRect;

- (MAMapRect)mapRectThatFits:(MAMapRect)mapRect edgePadding:(UIEdgeInsets)insets;

- (void)setVisibleMapRect:(MAMapRect)mapRect edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;

- (void)setCenterCoordinate:(CLLocationCoordinate2D)coordinate animated:(BOOL)animated;

- (void)setZoomLevel:(CGFloat)zoomLevel animated:(BOOL)animated;

- (void)setZoomLevel:(CGFloat)zoomLevel atPivot:(CGPoint)pivot animated:(BOOL)animated;

- (void)setRotationDegree:(CGFloat)rotationDegree animated:(BOOL)animated duration:(CFTimeInterval)duration;

- (void)setCameraDegree:(CGFloat)cameraDegree animated:(BOOL)animated duration:(CFTimeInterval)duration;

- (MAMapStatus *)getMapStatus;


- (void)setMapStatus:(MAMapStatus *)status animated:(BOOL)animated;

- (void)setMapStatus:(MAMapStatus *)status
            animated:(BOOL)animated
            duration:(CFTimeInterval)duration;

- (void)setCompassImage:(UIImage *)image;

- (UIImage *)takeSnapshotInRect:(CGRect)rect __attribute((deprecated("已废弃，请使用takeSnapshotInRect:withCompletionBlock:方法 since 6.0.0")));

- (void)takeSnapshotInRect:(CGRect)rect withCompletionBlock:(void (^)(UIImage *resultImage, NSInteger state))block;

- (double)metersPerPointForZoomLevel:(CGFloat)zoomLevel;

- (CGPoint)convertCoordinate:(CLLocationCoordinate2D)coordinate toPointToView:(UIView *)view;

- (CLLocationCoordinate2D)convertPoint:(CGPoint)point toCoordinateFromView:(UIView *)view;

- (CGRect)convertRegion:(MACoordinateRegion)region toRectToView:(UIView *)view;

- (MACoordinateRegion)convertRect:(CGRect)rect toRegionFromView:(UIView *)view;

- (void)reloadMap;

- (void)clearDisk;

- (void)reloadInternalTexture;

- (NSString *)mapContentApprovalNumber;

- (NSString *)satelliteImageApprovalNumber;

- (void)addAnimationWith:(CAKeyframeAnimation *)mapCenterAnimation
           zoomAnimation:(CAKeyframeAnimation *)zoomAnimation
         rotateAnimation:(CAKeyframeAnimation *)rotateAnimation
   cameraDegreeAnimation:(CAKeyframeAnimation *)cameraDegreeAnimation;

- (void)forceRefresh;

@end

@interface MAMapView (Annotation)

@property (nonatomic, readonly) NSArray *annotations;

@property (nonatomic, copy) NSArray *selectedAnnotations;

@property (nonatomic, readonly) CGRect annotationVisibleRect;

@property (nonatomic, assign) BOOL allowsAnnotationViewSorting __attribute((deprecated("已废弃 since 5.3.0")));

- (void)addAnnotation:(id <MAAnnotation>)annotation;

- (void)addAnnotations:(NSArray *)annotations;

- (void)removeAnnotation:(id <MAAnnotation>)annotation;

- (void)removeAnnotations:(NSArray *)annotations;

- (NSSet *)annotationsInMapRect:(MAMapRect)mapRect;

- (MAAnnotationView *)viewForAnnotation:(id <MAAnnotation>)annotation;

- (MAAnnotationView *)dequeueReusableAnnotationViewWithIdentifier:(NSString *)identifier;

- (void)selectAnnotation:(id <MAAnnotation>)annotation animated:(BOOL)animated;

- (void)deselectAnnotation:(id <MAAnnotation>)annotation animated:(BOOL)animated;

- (void)showAnnotations:(NSArray *)annotations animated:(BOOL)animated;

- (void)showAnnotations:(NSArray *)annotations edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;

@end


@interface MAMapView (UserLocation)

@property (nonatomic) BOOL showsUserLocation;

@property (nonatomic, readonly) MAUserLocation *userLocation;

@property (nonatomic) BOOL customizeUserLocationAccuracyCircleRepresentation;

@property (nonatomic, readonly) MACircle *userLocationAccuracyCircle;

@property (nonatomic) MAUserTrackingMode userTrackingMode;

@property (nonatomic, readonly, getter=isUserLocationVisible) BOOL userLocationVisible;

@property (nonatomic) CLLocationDistance distanceFilter;

@property (nonatomic) CLLocationAccuracy desiredAccuracy;

@property (nonatomic) CLLocationDegrees headingFilter;

@property (nonatomic) BOOL pausesLocationUpdatesAutomatically;

@property (nonatomic) BOOL allowsBackgroundLocationUpdates;

- (void)setUserTrackingMode:(MAUserTrackingMode)mode animated:(BOOL)animated;

- (void)updateUserLocationRepresentation:(MAUserLocationRepresentation *)representation;

@end

@interface MAMapView (Overlay)

@property (nonatomic, readonly) NSArray *overlays;

- (NSArray *)overlaysInLevel:(MAOverlayLevel)level;

- (void)addOverlay:(id <MAOverlay>)overlay;

- (void)addOverlays:(NSArray *)overlays;

- (void)addOverlay:(id <MAOverlay>)overlay level:(MAOverlayLevel)level;

- (void)addOverlays:(NSArray *)overlays level:(MAOverlayLevel)level;

- (void)removeOverlay:(id <MAOverlay>)overlay;

- (void)removeOverlays:(NSArray *)overlays;

- (void)insertOverlay:(id <MAOverlay>)overlay atIndex:(NSUInteger)index level:(MAOverlayLevel)level;

- (void)insertOverlay:(id <MAOverlay>)overlay aboveOverlay:(id <MAOverlay>)sibling;

- (void)insertOverlay:(id <MAOverlay>)overlay belowOverlay:(id <MAOverlay>)sibling;

- (void)insertOverlay:(id <MAOverlay>)overlay atIndex:(NSUInteger)index;

- (void)exchangeOverlayAtIndex:(NSUInteger)index1 withOverlayAtIndex:(NSUInteger)index2;

- (void)exchangeOverlayAtIndex:(NSUInteger)index1 withOverlayAtIndex:(NSUInteger)index2 atLevel:(MAOverlayLevel)level;

- (void)exchangeOverlay:(id <MAOverlay>)overlay1 withOverlay:(id <MAOverlay>)overlay2;

- (MAOverlayRenderer *)rendererForOverlay:(id <MAOverlay>)overlay;

- (void)showOverlays:(NSArray *)overlays animated:(BOOL)animated;

- (void)showOverlays:(NSArray *)overlays edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;

- (NSArray*)getHittedPolylinesWith:(CLLocationCoordinate2D)tappedCoord traverseAll:(BOOL)traverseAll;

@end

#if MA_INCLUDE_INDOOR
@interface MAMapView (Indoor)

@property (nonatomic, getter = isShowsIndoorMap) BOOL showsIndoorMap;

@property (nonatomic, getter = isShowsIndoorMapControl) BOOL showsIndoorMapControl;

@property (nonatomic, readonly) CGSize indoorMapControlSize;

- (void)setIndoorMapControlOrigin:(CGPoint)origin;

- (void)setCurrentIndoorMapFloorIndex:(NSInteger)floorIndex;

- (void)clearIndoorMapCache;

@end
#endif

@interface MAMapView (CustomMapStyle)

@property (nonatomic, assign) BOOL customMapStyleEnabled;

- (void)setCustomMapStyleWithWebData:(NSData *)data __attribute((deprecated("已废弃, 请使用 setCustomMapStyleOptions: since 6.6.0")));

- (void)setCustomTextureResourcePath:(NSString *)customTextureResourcePath __attribute((deprecated("已废弃, 请使用 setCustomMapStyleOptions: since 6.6.0")));

- (void)setCustomMapStyleID:(NSString *)customMapStyleID __attribute((deprecated("已废弃, 请使用 setCustomMapStyleOptions: since 6.6.0")));

- (void)setCustomMapStyleOptions:(MAMapCustomStyleOptions *)styleOptions;

@end

#pragma mark - MAMapViewDelegate
@protocol MAMapViewDelegate <NSObject>

@optional

- (void)mapViewRegionChanged:(MAMapView *)mapView;

- (void)mapView:(MAMapView *)mapView regionWillChangeAnimated:(BOOL)animated;

- (void)mapView:(MAMapView *)mapView regionDidChangeAnimated:(BOOL)animated;

- (void)mapView:(MAMapView *)mapView regionWillChangeAnimated:(BOOL)animated wasUserAction:(BOOL)wasUserAction;

- (void)mapView:(MAMapView *)mapView regionDidChangeAnimated:(BOOL)animated wasUserAction:(BOOL)wasUserAction;

- (void)mapView:(MAMapView *)mapView mapWillMoveByUser:(BOOL)wasUserAction;

- (void)mapView:(MAMapView *)mapView mapDidMoveByUser:(BOOL)wasUserAction;

- (void)mapView:(MAMapView *)mapView mapWillZoomByUser:(BOOL)wasUserAction;

- (void)mapView:(MAMapView *)mapView mapDidZoomByUser:(BOOL)wasUserAction;

- (void)mapViewWillStartLoadingMap:(MAMapView *)mapView;

- (void)mapViewDidFinishLoadingMap:(MAMapView *)mapView;

- (void)mapViewDidFailLoadingMap:(MAMapView *)mapView withError:(NSError *)error;

- (MAAnnotationView *)mapView:(MAMapView *)mapView viewForAnnotation:(id <MAAnnotation>)annotation;

- (void)mapView:(MAMapView *)mapView didAddAnnotationViews:(NSArray *)views;

- (void)mapView:(MAMapView *)mapView didSelectAnnotationView:(MAAnnotationView *)view;

- (void)mapView:(MAMapView *)mapView didDeselectAnnotationView:(MAAnnotationView *)view;

- (void)mapViewWillStartLocatingUser:(MAMapView *)mapView;

- (void)mapViewDidStopLocatingUser:(MAMapView *)mapView;

- (void)mapView:(MAMapView *)mapView didUpdateUserLocation:(MAUserLocation *)userLocation updatingLocation:(BOOL)updatingLocation;

- (void)mapViewRequireLocationAuth:(CLLocationManager *)locationManager;

- (void)mapView:(MAMapView *)mapView didFailToLocateUserWithError:(NSError *)error;

- (void)mapView:(MAMapView *)mapView annotationView:(MAAnnotationView *)view didChangeDragState:(MAAnnotationViewDragState)newState
   fromOldState:(MAAnnotationViewDragState)oldState;

- (MAOverlayRenderer *)mapView:(MAMapView *)mapView rendererForOverlay:(id <MAOverlay>)overlay;

- (void)mapView:(MAMapView *)mapView didAddOverlayRenderers:(NSArray *)overlayRenderers;

- (void)mapView:(MAMapView *)mapView annotationView:(MAAnnotationView *)view calloutAccessoryControlTapped:(UIControl *)control;

- (void)mapView:(MAMapView *)mapView didAnnotationViewCalloutTapped:(MAAnnotationView *)view;

- (void)mapView:(MAMapView *)mapView didAnnotationViewTapped:(MAAnnotationView *)view;

- (void)mapView:(MAMapView *)mapView didChangeUserTrackingMode:(MAUserTrackingMode)mode animated:(BOOL)animated;

- (void)mapView:(MAMapView *)mapView didChangeOpenGLESDisabled:(BOOL)openGLESDisabled;

- (void)mapView:(MAMapView *)mapView didTouchPois:(NSArray *)pois;

- (void)mapView:(MAMapView *)mapView didSingleTappedAtCoordinate:(CLLocationCoordinate2D)coordinate;

- (void)mapView:(MAMapView *)mapView didLongPressedAtCoordinate:(CLLocationCoordinate2D)coordinate;

- (void)mapInitComplete:(MAMapView *)mapView;

#if MA_INCLUDE_INDOOR

- (void)mapView:(MAMapView *)mapView didIndoorMapShowed:(MAIndoorInfo *)indoorInfo;

- (void)mapView:(MAMapView *)mapView didIndoorMapFloorIndexChanged:(MAIndoorInfo *)indoorInfo;

- (void)mapView:(MAMapView *)mapView didIndoorMapHidden:(MAIndoorInfo *)indoorInfo;
#endif //end of MA_INCLUDE_INDOOR

- (void)offlineDataWillReload:(MAMapView *)mapView;

- (void)offlineDataDidReload:(MAMapView *)mapView;

@end