BMKMapView.h

浏览该文件的文档.

/*
 *  BMKMapView.h
 *  BMapKit
 *
 *  Copyright 2011 Baidu Inc. All rights reserved.
 *
 */
 
#import "BMKAnnotation.h"
#import "BMKAnnotationView.h"
#import "BMKOverlayView.h"
#import "BMKMapStatus.h"
#import "BMKLocationViewDisplayParam.h"
#import "BMKHeatMap.h"
#import "BMKHexagonHeatMap.h"
#import "BMKBaseIndoorMapInfo.h"
#import "BMKCustomMapStyleOption.h"
#import "BMKMapGestureDelegate.h"
#import "BMKParticleEffectOption.h"
#import "BMKMapTouch.h"
 
NS_ASSUME_NONNULL_BEGIN
@class BMMapControl;
@class CompassOverlay;
@class BMKUserLocation;
@protocol BMKMapViewDelegate;
 
typedef enum {
    BMKTrafficUGCTypeNoUGC = 0,    
    BMKTrafficUGCTypeConstruction, 
    BMKTrafficUGCTypeJam,          
    BMKTrafficUGCTypeBlocking,     
    BMKTrafficUGCTypeEmergency     
} BMKTrafficUGCType;
@interface BMKMapPoi : NSObject
 
@property (nonatomic, copy, nullable) NSString *text;
 
@property (nonatomic, assign) CLLocationCoordinate2D pt;
 
@property (nonatomic, copy, nullable) NSString *uid;
 
@property (nonatomic, assign) BMKTrafficUGCType trafficUGCType;
@end
 
typedef enum {
    BMKUserTrackingModeNone = 0,             
    BMKUserTrackingModeHeading,              
    BMKUserTrackingModeFollow,               
    BMKUserTrackingModeFollowWithHeading,    
} BMKUserTrackingMode;
 
typedef enum {
    BMKLogoPositionLeftBottom = 0,          
    BMKLogoPositionLeftTop,                 
    BMKLogoPositionCenterBottom,            
    BMKLogoPositionCenterTop,               
    BMKLogoPositionRightBottom,             
    BMKLogoPositionRightTop,                
} BMKLogoPosition;
 
typedef enum {
    BMKSwitchIndoorFloorSuccess = 0,     
    BMKSwitchIndoorFloorFailed,          
    BMKSwitchIndoorFloorNotFocused,      
    BMKSwitchIndoorFloorNotExist,        
} BMKSwitchIndoorFloorError;
 
typedef enum {
    BMKRegionChangeReasonGesture = 0,     
    BMKRegionChangeReasonEvent,           
    BMKRegionChangeReasonAPIs,            
} BMKRegionChangeReason;
 
typedef enum {
    kBMKMapLanguageTypeChinese = 0,         
    kBMKMapLanguageTypeEnglish,             
    kBMKMapLanguageTypeTraditionalChinese,  
    kBMKMapLanguageTypeFrench,              
    kBMKMapLanguageTypeGerman,            
    kBMKMapLanguageTypeIndonesian,        
    kBMKMapLanguageTypeItalian,          
    kBMKMapLanguageTypeJapanese,            
    kBMKMapLanguageTypeKorean,            
    kBMKMapLanguageTypeMalayalam,           
    kBMKMapLanguageTypePortuguese,        
    kBMKMapLanguageTypeRussian,          
    kBMKMapLanguageTypeSpanish,           
    kBMKMapLanguageTypeThai,              
    kBMKMapLanguageTypeTurkish,          
    kBMKMapLanguageTypeVietnamese,        
} BMKMapLanguageType;
 
typedef enum : NSInteger {
    BMKMapParticleEffectUnknow = -1, // 未知，关闭粒子效果时传入该值将关闭所有粒子效果
    BMKMapParticleEffectSnow = 0,        // 雪
    BMKMapParticleEffectRainStorm = 4,   // 雨
    BMKMapParticleEffectSmog = 5,        // 雾霾
    BMKMapParticleEffectSandStorm = 7,   // 沙尘暴
    BMKMapParticleEffectFireworks = 8,   // 烟花
    BMKMapParticleEffectFlower = 14      // 花瓣
} BMKMapParticleEffect;
 
 
typedef enum {
    kBMKPoiTagTypeAll,        
    kBMKPoiTagTypeEpidemic,   
    kBMKPoiTagTypeTravel,     
    kBMKPoiTagTypeShop        
}BMKPoiTagType;
 
typedef enum {
    kBMKLayerSDKOverlay,    
    kBMKLayerSDKHeatMap,    
    kBMKLayerSDKHexagonHeatMap,    
    kBMKLayerNewSDKDefaultOverlay   
} BMKLayerType;
 
 
@interface BMKMapView : UIView
 
@property (nonatomic, weak, nullable) id<BMKMapViewDelegate> delegate;
 
@property (nonatomic, weak, nullable) id<BMKMapGestureDelegate> gestureDelegate;
 
@property (nonatomic, assign) BMKMapType mapType;
 
@property (nonatomic, assign) BMKMapLanguageType languageType;
@property (nonatomic, assign) BOOL showSingleLanguage;
 
@property (nonatomic, strong) UIColor *backgroundColor;
 
@property (nonatomic, strong) UIImage *backgroundImage;
 
@property (nonatomic, assign) BMKCoordinateRegion region;
 
@property (nonatomic, assign) BMKCoordinateRegion limitMapRegion;
 
@property (nonatomic, assign) CGPoint compassPosition;
 
@property (nonatomic, readonly) CGSize compassSize;
 
@property (nonatomic, assign) CLLocationCoordinate2D centerCoordinate;
 
@property (nonatomic, assign) NSInteger fontSizeLevel;
 
@property (nonatomic, assign) float zoomLevel;
 
@property (nonatomic, assign) float minZoomLevel;
 
@property (nonatomic, assign) float maxZoomLevel;
 
@property (nonatomic, assign) int rotation;
 
@property (nonatomic, assign) int overlooking;
 
@property (nonatomic, assign) int minOverlooking;
 
@property(nonatomic, getter = isBuildingsEnabled) BOOL buildingsEnabled;
 
@property(nonatomic, getter = isModel3DEnabled) BOOL model3DEnabled;
 
@property(nonatomic, assign) BOOL showMapPoi;
 
@property(nonatomic, getter = isTrafficEnabled) BOOL trafficEnabled;
@property(nonatomic, getter = isCustomTrafficColorEnabled) BOOL customTrafficColorEnabled;
 
@property(nonatomic, getter = isBaiduHeatMapEnabled) BOOL baiduHeatMapEnabled;
 
@property(nonatomic) BOOL gesturesEnabled;
 
@property(nonatomic) BOOL doubleTapHoldPanEnabled;
 
@property(nonatomic, getter = isZoomEnabled) BOOL zoomEnabled;
 
@property(nonatomic, getter = isZoomEnabledWithTap) BOOL zoomEnabledWithTap;
 
@property(nonatomic, getter = isScrollEnabled) BOOL scrollEnabled;
 
@property(nonatomic, getter = isOverlookEnabled) BOOL overlookEnabled;
 
@property(nonatomic, getter = isRotateEnabled) BOOL rotateEnabled;
 
@property(nonatomic, assign) BOOL forceTouchEnabled;
 
@property(nonatomic, assign) BOOL gestureZoomAnimationEnabled;
 
@property (nonatomic, assign) BOOL showMapScaleBar;
 
@property (nonatomic, assign) CGPoint mapScaleBarPosition;
 
@property (nonatomic, readonly) CGSize mapScaleBarSize;
 
@property (nonatomic, strong) UIColor *mapScaleBarColor;
 
@property (nonatomic, strong) UIColor *mapScaleBarTextColor;
 
@property (nonatomic, assign) BMKLogoPosition logoPosition;
 
@property (nonatomic, assign) BMKMapRect visibleMapRect;
 
@property (nonatomic, assign) UIEdgeInsets mapPadding;
 
@property (nonatomic, assign) BOOL updateTargetScreenPtWhenMapPaddingChanged;
 
@property(nonatomic, getter = isChangeWithTouchPointCenterEnabled) BOOL ChangeWithTouchPointCenterEnabled;
 
@property(nonatomic, getter = isChangeCenterWithDoubleTouchPointEnabled) BOOL ChangeCenterWithDoubleTouchPointEnabled;
 
@property(nonatomic, assign) BOOL supportBackgroundDraw;
 
+ (void)customMapStyle:(NSString *)customMapStyleJsonFilePath __deprecated_msg("Please use - (void)setCustomMapStyleEnable:(BOOL)enable");
 
+ (void)enableCustomMapStyle:(BOOL)enable __deprecated_msg("Please use - (void)setCustomMapStylePath:(NSString *)customMapStyleFilePath");
 
+ (void)willBackGround __deprecated_msg("废弃方法（空实现）,逻辑由地图SDK控制");
 
+ (void)didForeGround __deprecated_msg("废弃方法（空实现）,逻辑由地图SDK控制");
 
+ (BOOL)setBaiduMapSDKMetalEnable:(BOOL)metalEnable;
 
+ (BOOL)getBaiduMapSDKMetalEnable;
 
+ (BOOL)setBaiduMapSDKOverlayNewVersionEnable:(BOOL)newVersionEnable;
 
+ (BOOL)getBaiduMapSDKOverlayNewVersionEnable;
 
- (BOOL)setCustomTrafficColorForSmooth:(UIColor *)smooth
                                  slow:(UIColor *)slow
                            congestion:(UIColor *)congestion
                      severeCongestion:(UIColor *)severeCongestion;
 
- (void)viewWillAppear;
 
- (void)viewWillDisappear;
 
- (void)cleanCacheWithMapType:(BMKMapType)type;
 
- (void)mapForceRefresh;
 
- (BOOL)zoomIn;
 
- (BOOL)zoomOut;
 
- (BMKCoordinateRegion)regionThatFits:(BMKCoordinateRegion)region __deprecated_msg("此方法已废弃");
 
- (void)setRegion:(BMKCoordinateRegion)region animated:(BOOL)animated;
 
- (void)setCenterCoordinate:(CLLocationCoordinate2D)coordinate animated:(BOOL)animated;
 
- (nullable UIImage *)takeSnapshot;
 
- (nullable UIImage *)takeSnapshot:(CGRect)rect;
 
- (void)setCompassImage:(UIImage *)image;
 
- (void)setVisibleMapRect:(BMKMapRect)mapRect animated:(BOOL)animate;
 
- (BMKMapRect)mapRectThatFits:(BMKMapRect)mapRect __deprecated_msg("此方法已废弃");
 
- (void)setVisibleMapRect:(BMKMapRect)mapRect edgePadding:(UIEdgeInsets)insets animated:(BOOL)animate;
 
- (void)fitVisibleMapRect:(BMKMapRect)mapRect edgePadding:(UIEdgeInsets)insets withAnimated:(BOOL)animate;
 
- (BMKMapRect)mapRectThatFits:(BMKMapRect)mapRect edgePadding:(UIEdgeInsets)insets;
 
- (CGPoint)convertCoordinate:(CLLocationCoordinate2D)coordinate toPointToView:(UIView *)view;
 
- (CLLocationCoordinate2D)convertPoint:(CGPoint)point toCoordinateFromView:(UIView *)view;
 
- (CGRect)convertRegion:(BMKCoordinateRegion)region toRectToView:(UIView *)view;
 
- (BMKCoordinateRegion)convertRect:(CGRect)rect toRegionFromView:(UIView *)view;
 
- (CGRect)convertMapRect:(BMKMapRect)mapRect toRectToView:(UIView *)view;
 
- (BMKMapRect)convertRect:(CGRect)rect toMapRectFromView:(UIView *)view;
 
- (CGPoint)screenPointFromMapPoint3:(BMKMapPoint3)mapPoint3;
 
- (CGPoint)glPointForMapPoint:(BMKMapPoint)mapPoint;
 
- (CGPoint *)glPointsForMapPoints:(BMKMapPoint *)mapPoints count:(NSUInteger)count;
 
 
- (void)setMapCenterToScreenPt:(CGPoint)ptInScreen;
 
- (BMKMapStatus *)getMapStatusFromCoordinateRegion:(BMKCoordinateRegion)region edgePadding:(UIEdgeInsets)insets;
 
- (BMKMapStatus *)getMapStatus;
 
- (void)setMapStatus:(BMKMapStatus *)mapStatus;
 
- (void)setMapStatus:(BMKMapStatus *)mapStatus withAnimation:(BOOL)bAnimation;
 
- (void)setMapStatus:(BMKMapStatus *)mapStatus withAnimation:(BOOL)bAnimation withAnimationTime:(int)ulDuration;
 
- (BOOL)isSurpportBaiduHeatMap;
 
- (float *)getProjectionMatrix;
 
- (float *)getViewMatrix;
 
- (void)touchesBegan:(NSSet<BMKMapTouch *> *)touches;
- (void)touchesMoved:(NSSet<BMKMapTouch *> *)touches;
- (void)touchesEnded:(NSSet<BMKMapTouch *> *)touches;
- (void)touchesCancelled:(NSSet<BMKMapTouch *> *)touches;
@end
 
@interface BMKMapView (CustomMapAPI)
 
- (BOOL)setCustomMapStylePath:(NSString *)customMapStyleFilePath;
 
- (BOOL)setCustomMapStylePath:(NSString *)customMapStyleFilePath mode:(int)mode;
 
- (BOOL)setCustomMapStyleEnable:(BOOL)enable;
 
- (BOOL)setCustomMapStyleWithOption:(BMKCustomMapStyleOption *)option
                            preLoad:(void (^ _Nullable)(NSString * _Nullable path))preLoad
                            success:(void (^ _Nullable)(NSString * path))success
                            failure:(void (^ _Nullable)(NSError * error, NSString * _Nullable path))failure;
 
 
@end
 
@interface BMKMapView (IndoorMapAPI)
 
@property (nonatomic, assign) BOOL baseIndoorMapEnabled;
 
@property (nonatomic, assign) BOOL showIndoorMapPoi;
 
@property (nonatomic, assign) BOOL showDotPoi;
 
- (BMKSwitchIndoorFloorError)switchBaseIndoorMapFloor:(NSString *)strFloor withID:(NSString *)strID;
 
- (nullable BMKBaseIndoorMapInfo *)getFocusedBaseIndoorMapInfo;
 
@end
 
@interface BMKMapView (LocationViewAPI)
 
@property (nonatomic, assign) BOOL showsUserLocation;
 
@property (nonatomic, assign) BMKUserTrackingMode userTrackingMode;
 
@property (nonatomic, readonly, getter = isUserLocationVisible) BOOL userLocationVisible;
 
- (void)updateLocationViewWithParam:(BMKLocationViewDisplayParam *)locationViewDisplayParam;
 
- (void)updateLocationData:(BMKUserLocation *)userLocation;
@end
 
@interface BMKMapView (AnnotationAPI)
 
@property (nonatomic, copy, readonly, nullable) NSArray<id <BMKAnnotation>> *annotations;
 
@property (nonatomic, assign) BOOL isSelectedAnnotationViewFront;
 
- (void)addAnnotation:(id <BMKAnnotation>)annotation;
 
- (void)addAnnotations:(NSArray<id <BMKAnnotation>> *)annotations;
 
- (void)removeAnnotation:(id <BMKAnnotation>)annotation;
 
- (void)removeAnnotations:(NSArray<id <BMKAnnotation> > *)annotations;
 
- (nullable BMKAnnotationView *)viewForAnnotation:(id <BMKAnnotation>)annotation;
 
- (nullable BMKAnnotationView *)dequeueReusableAnnotationViewWithIdentifier:(NSString *)identifier;
 
- (void)selectAnnotation:(id <BMKAnnotation>)annotation animated:(BOOL)animated;
 
- (void)deselectAnnotation:(id <BMKAnnotation>)annotation animated:(BOOL)animated;
 
- (void)showAnnotations:(NSArray<id <BMKAnnotation>> *)annotations animated:(BOOL)animated;
 
- (void)showAnnotations:(NSArray<id <BMKAnnotation>> *)annotations padding:(UIEdgeInsets)padding animated:(BOOL)animated;
 
- (nullable NSArray<id <BMKAnnotation>> *)annotationsInCoordinateBounds:(BMKCoordinateBounds)bounds;
 
@end
 
@interface BMKMapView (OverlaysAPI)
 
- (void)addOverlay:(id <BMKOverlay>)overlay;
 
- (void)addOverlays:(NSArray<id <BMKOverlay>> *)overlays;
 
- (void)removeOverlay:(id <BMKOverlay>)overlay;
 
- (void)removeOverlays:(NSArray<id <BMKOverlay>> *)overlays;
 
- (void)insertOverlay:(id <BMKOverlay>)overlay atIndex:(NSUInteger)index;
 
- (void)exchangeOverlayAtIndex:(NSUInteger)index1 withOverlayAtIndex:(NSUInteger)index2;
 
- (void)insertOverlay:(id <BMKOverlay>)overlay aboveOverlay:(id <BMKOverlay>)sibling;
 
- (void)insertOverlay:(id <BMKOverlay>)overlay belowOverlay:(id <BMKOverlay>)sibling;
 
@property (nonatomic, copy, readonly, nullable) NSArray<id <BMKOverlay>> *overlays;
 
- (nullable BMKOverlayView *)viewForOverlay:(id <BMKOverlay>)overlay;
 
@end
 
@interface BMKMapView (HeatMapAPI)
 
- (void)addHeatMap:(BMKHeatMap *)heatMap;
 
- (void)updateHeatMap:(BMKHeatMap *)heatMap;
 
- (void)removeHeatMap;
 
- (void)startHeatMapFrameAnimation;
 
- (void)stopHeatMapFrameAnimation;
 
- (void)setHeatMapFrameAnimationIndex:(NSInteger)index;
 
@end
 
@interface BMKMapView (HexagonHeatMapAPI)
@property (nonatomic, assign) BOOL showHexagonHeatMap;
- (void)addHexagonHeatMap:(BMKHexagonHeatMap *)hexagonHeatMap;
- (void)removeHexagonHeatMap;
@end
 
@interface BMKMapView (MapLayerAPI)
 
@property (nonatomic, assign) BOOL showOperateLayer;
@property (nonatomic, assign) BOOL showOperatePOILayer;
@property (nonatomic, assign) BOOL showTrafficUGCLayer;
- (BOOL)switchLayerOrder:(BMKLayerType)layer otherLayer:(BMKLayerType)otherLayer;
 
@property (nonatomic, assign) BOOL showDEMLayer;
 
- (BOOL)switchOverlayLayerAndNavigationLayer:(BOOL)isSwitch;
 
- (BOOL)switchOverlayLayerAndPOILayer:(BOOL)isSwitch;
 
- (BOOL)getPoiTagEnable:(BMKPoiTagType)poiTagType;
 
- (void)setPoiTagEnable:(BOOL)enable poiTagType:(BMKPoiTagType)poiTagType;
@end
 
@interface BMKMapView (ParticleEffect)
- (BOOL)showParticleEffect:(BMKMapParticleEffect)effect;
 
- (void)closeParticleEffect:(BMKMapParticleEffect)effect;
 
- (BOOL)customParticleEffect:(BMKMapParticleEffect)effect option:(BMKParticleEffectOption *)option;
@end
 
@interface BMKMapView (MapStyleAPI)
 
- (BOOL)downloadMapStyle:(NSString *)urlString;
 
@end
 
@protocol BMKMapViewDelegate <NSObject>
@optional
 
- (void)mapViewWillBackground:(BMKMapView *)mapView;
 
- (void)mapViewDidForeground:(BMKMapView *)mapView;
 
- (void)mapViewDidFinishLoading:(BMKMapView *)mapView;
 
- (void)mapViewDidRenderValidData:(BMKMapView *)mapView withError:(NSError *)error;
 
- (void)mapViewDidFinishRendering:(BMKMapView *)mapView;
 
- (void)mapView:(BMKMapView *)mapView onDrawMapFrame:(BMKMapStatus *)status;
 
- (void)mapView:(BMKMapView *)mapView regionWillChangeAnimated:(BOOL)animated;
 
- (void)mapView:(BMKMapView *)mapView regionWillChangeAnimated:(BOOL)animated reason:(BMKRegionChangeReason)reason;
 
- (void)mapView:(BMKMapView *)mapView regionDidChangeAnimated:(BOOL)animated;
 
- (void)mapView:(BMKMapView *)mapView regionDidChangeAnimated:(BOOL)animated reason:(BMKRegionChangeReason)reason;
 
- (nullable __kindof BMKAnnotationView *)mapView:(BMKMapView *)mapView viewForAnnotation:(id <BMKAnnotation>)annotation;
 
- (void)mapView:(BMKMapView *)mapView didAddAnnotationViews:(NSArray *)views;
 
- (void)mapView:(BMKMapView *)mapView clickAnnotationView:(BMKAnnotationView *)view;
 
- (void)mapView:(BMKMapView *)mapView didSelectAnnotationView:(BMKAnnotationView *)view;
 
- (void)mapView:(BMKMapView *)mapView didDeselectAnnotationView:(BMKAnnotationView *)view;
 
- (void)mapView:(BMKMapView *)mapView annotationView:(BMKAnnotationView *)view didChangeDragState:(BMKAnnotationViewDragState)newState
   fromOldState:(BMKAnnotationViewDragState)oldState;
 
- (void)mapView:(BMKMapView *)mapView annotationViewForBubble:(BMKAnnotationView *)view;
 
- (nullable __kindof BMKOverlayView *)mapView:(BMKMapView *)mapView viewForOverlay:(id <BMKOverlay>)overlay;
 
- (void)mapView:(BMKMapView *)mapView didAddOverlayViews:(NSArray *)overlayViews;
 
- (void)mapView:(BMKMapView *)mapView onClickedBMKOverlayView:(BMKOverlayView *)overlayView;
 
- (void)mapView:(BMKMapView *)mapView onClickedMapPoi:(BMKMapPoi *)mapPoi;
 
- (void)mapView:(BMKMapView *)mapView onClickedMapBlank:(CLLocationCoordinate2D)coordinate;
 
- (void)mapview:(BMKMapView *)mapView onDoubleClick:(CLLocationCoordinate2D)coordinate;
 
- (void)mapview:(BMKMapView *)mapView onLongClick:(CLLocationCoordinate2D)coordinate;
 
- (void)mapview:(BMKMapView *)mapView onForceTouch:(CLLocationCoordinate2D)coordinate force:(CGFloat)force maximumPossibleForce:(CGFloat)maximumPossibleForce;
 
- (void)mapStatusDidChanged:(BMKMapView *)mapView;
 
- (void)mapview:(BMKMapView *)mapView baseIndoorMapWithIn:(BOOL)flag baseIndoorMapInfo:(nullable BMKBaseIndoorMapInfo *)info;
 
- (void)mapView:(BMKMapView *)mapView didChangeUserTrackingMode:(BMKUserTrackingMode)mode;
 
- (void)mapViewOnClickCompass:(BMKMapView *)mapView;
 
@end
NS_ASSUME_NONNULL_END