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"
#import <AMapFoundationKit/AMapServices.h>
#import "MABaseEngineOverlay.h"
#import "MAPoiFilter.h"
 
typedef NS_ENUM(NSInteger, MAMapType)
{
    MAMapTypeStandard = 0,  
    MAMapTypeSatellite,     
    MAMapTypeStandardNight, 
    MAMapTypeNavi,          
    MAMapTypeBus,           
    MAMapTypeNaviNight      
};
 
typedef NS_ENUM(NSInteger, MAUserTrackingMode)
{
    MAUserTrackingModeNone              = 0,    
    MAUserTrackingModeFollow            = 1,    
    MAUserTrackingModeFollowWithHeading = 2     
};
 
typedef NS_ENUM(NSInteger, MATrafficStatus)
{
    MATrafficStatusSmooth = 1,                  
    MATrafficStatusSlow,                        
    MATrafficStatusJam,                         
    MATrafficStatusSeriousJam,                  
    MATrafficStatusExtremelySmooth,             
};
 
typedef NS_ENUM(NSInteger, MAOverlayLevel) {
    MAOverlayLevelAboveRoads = 0,                   
    MAOverlayLevelAboveLabels = 1,                  
    MAOverlayLevelBeforeBuildings = 2,              
    MAOverlayLevelAboveBuildings = 3                
};
 
typedef NS_ENUM(NSUInteger, MALogoLanguage) {
    MALogoLanguageEnglish,
    MALogoLanguageChinese,
};
 
typedef NS_ENUM(NSInteger, MAScaleControlsUnit){
    MAScaleControlsUnitMETRIC, 
    MAScaleControlsUnitIMPERIAL 
};
 
typedef NS_OPTIONS(uint64_t, MAALCLogLevel) {
    MAALCLogLevelDebug = 1ULL << 3,
    MAALCLogLevelInfo = 1ULL << 4,
    MAALCLogLevelWarning = 1ULL << 5,
    MAALCLogLevelError = 1ULL << 6,
    MAALCLogLevelFatal = 1ULL << 7,
    MAALCLogLevelPerformance = 1ULL << 8,
    MAALCLogLevelTracing = 1ULL << 9,
    MAALCLogLevelPrismTracing = 1ULL << 10,
    MAALCLogLevelHeader = 1ULL << 11,
    MAALCLogLevelAll = MAALCLogLevelDebug
        | MAALCLogLevelInfo
        | MAALCLogLevelWarning
        | MAALCLogLevelError
        | MAALCLogLevelFatal
        | MAALCLogLevelPerformance
        | MAALCLogLevelTracing
        | MAALCLogLevelPrismTracing
        | MAALCLogLevelHeader,
};
 
#pragma mark - 动画相关的key Animation-related key
extern NSString * const kMAMapLayerCenterMapPointKey;
 
extern NSString * const kMAMapLayerZoomLevelKey;
 
extern NSString * const kMAMapLayerRotationDegreeKey;
 
extern NSString * const kMAMapLayerCameraDegreeKey;
 
 
@protocol MAMapViewDelegate;
 
@interface MAMapView : UIView
 
@property (nonatomic, assign, class) BOOL metalEnabled;
 
@property (nonatomic, assign, class) BOOL terrainEnabled;
 
@property (nonatomic, assign, readonly) BOOL terrainAuth;
 
@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 = isShowsBuildings) BOOL showsBuildings;
 
@property (nonatomic, assign, getter = isShowsLabels) BOOL showsLabels;
 
@property (nonatomic, assign, getter = isShowsLocalLanguage) BOOL showsLocalLanguage;
 
@property (nonatomic, getter = isShowTraffic) BOOL showTraffic;
 
@property (nonatomic, copy) NSDictionary <NSNumber *, UIColor *> *trafficStatus __attribute((deprecated("Deprecated since 7.8.0")));
 
@property (nonatomic, assign) BOOL touchPOIEnabled;
 
@property (nonatomic, assign) BOOL showsCompass;
 
@property (nonatomic, assign) CGPoint compassOrigin;
 
@property (nonatomic, readonly) CGSize compassSize;
 
@property (nonatomic, assign) MAScaleControlsUnit scaleControlsUnit;
 
@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, assign) CGFloat logoSizeScale;
 
@property (nonatomic, assign) BOOL logoEnable;
 
@property (nonatomic, assign) MALogoLanguage logoLanguage;
 
@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 __attribute((deprecated("Deprecated, since 7.9.0, please use the renderringDisabled property")));
 
@property (nonatomic, assign) BOOL renderringDisabled;
 
//disable map drawing, default NO
@property (nonatomic, assign) BOOL drawingDisabled;
 
@property (nonatomic, assign) CGPoint screenAnchor;
 
typedef void (^MATileLoadCallback)(BOOL success, int64_t durationMs, NSString *tileIdentifier);
 
@property (nonatomic, copy) MATileLoadCallback tileLoadCallback;
 
@property (nonatomic, copy) NSRunLoopMode runLoopMode;
 
#if MA_INCLUDE_WORLD_EN_MAP
@property (nonatomic, strong) NSNumber *mapLanguage;
#endif
 
// 注意：在使用地图功能前，请通过 [AMapServices sharedServices].regionLanguageType 来设置语言类型 (since 11.2.000)
// @property (nonatomic, assign, class) AMapRegionLanguageType regionLanguageType;
 
@property (nonatomic, assign, class) BOOL loadWorldVectorMap;
 
- (instancetype)initWithFrame:(CGRect)frame isNavi:(BOOL)isNavi;
 
- (instancetype)initWithFrame:(CGRect)frame scaleFactor:(CGFloat)scaleFactor;
 
 
- (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)setVisibleMapRect:(MAMapRect)mapRect edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated duration:(CFTimeInterval)duration;
 
- (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("Deprecated, please use the takeSnapshotInRect:withCompletionBlock: method since 6.0.0")));
 
- (void)takeSnapshotInRect:(CGRect)rect withCompletionBlock:(void (^)(UIImage *resultImage, NSInteger state))block;
 
- (void)takeSnapshotInRect:(CGRect)rect timeoutInterval:(NSTimeInterval)timeout completionBlock:(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;
 
- (NSString *)terrainApprovalNumber;
 
- (void)addAnimationWith:(CAKeyframeAnimation *)mapCenterAnimation
           zoomAnimation:(CAKeyframeAnimation *)zoomAnimation
         rotateAnimation:(CAKeyframeAnimation *)rotateAnimation
   cameraDegreeAnimation:(CAKeyframeAnimation *)cameraDegreeAnimation;
 
- (void)forceRefresh;
 
- (void)setConstructingRoadEnable:(BOOL)enabled;
 
- (void)setMapOptRecordState:(BOOL)state;
 
#pragma mark - ALC Log
+ (void)setAlcLogConfig:(MAALCLogLevel)loglevelMask recordStorage:(BOOL)recordStorage;
 
#pragma mark - Privacy 隐私合规 Privacy compliance
+ (void)updatePrivacyShow:(AMapPrivacyShowStatus)showStatus privacyInfo:(AMapPrivacyInfoStatus)containStatus;
+ (void)updatePrivacyAgree:(AMapPrivacyAgreeStatus)agreeStatus;
 
@end
 
@interface MAMapView (Annotation)
 
@property (nonatomic, readonly) NSArray *annotations;
 
@property (nonatomic, copy) NSArray *selectedAnnotations;
 
@property (nonatomic, readonly) CGRect annotationVisibleRect;
 
- (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;
 
- (void)setCurrentLocation:(CLLocationCoordinate2D)location;
@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)setCustomMapStyleOptions:(MAMapCustomStyleOptions *)styleOptions;
 
@end
 
@interface MAMapView (Buildings)
 
- (NSInteger)hideBuildingsWithPolygon:(CLLocationCoordinate2D *)polygon polygonSize:(NSUInteger)polygonSize;
 
- (void)showHiddenBuildingsWithOperationId:(NSInteger)operationId;
@end
 
@interface MAMapView (EngineOverlay)
 
- (void)addEngineOverlay:(MABaseEngineOverlay *)overlay;
@end
 
@interface MAMapView (PoiFilter)
- (void)addPoiFilter:(MAPoiFilter *)poiFilter;
- (void)removePoiFilter:(NSString *)keyName;
- (void)clearPoiFilter;
@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;
 
- (void)mapView:(MAMapView *)mapView didFailLoadTerrainWithError:(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 __attribute((deprecated("Deprecated, since 7.9.0")));
 
- (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;
 
- (void)customMapStyleAuthFailedWithErrorCode:(int)errorCode message:(NSString *)msg;
 
@end