QMapView.h

//
//  QMapView.h
//  QMapKit
//
//  Created by tabsong on 17/5/15.
//  Copyright © 2017年 tencent. All rights reserved.
//
 
#import <UIKit/UIKit.h>
#import "QGeometry.h"
#import "QAnnotation.h"
#import "QAnnotationView.h"
#import "QOverlayView.h"
#import "QBasicMapViewLayer.h"
#import "QTypes.h"
#import "QUserLocationPresentation.h"
#import "QTileOverlay.h"
#import "QCustomLayer.h"
#import "QAOILayer.h"
#import "QText.h"
#import "QMarker.h"
#import "QMarkerViewDefines.h"
#import "QMaskingLayer.h"
 
typedef NS_ENUM(NSInteger, QUserTrackingMode)
{
    QUserTrackingModeNone              = 0,    
    QUserTrackingModeFollow            = 1,    
    QUserTrackingModeFollowWithHeading = 2     
};
 
typedef NS_ENUM(NSUInteger, QMapLogoAnchor)
{
    QMapLogoAnchorRightBottom   = 0,    
    QMapLogoAnchorLeftBottom,           
    QMapLogoAnchorLeftTop,              
    QMapLogoAnchorRightTop,             
    QMapLogoAnchorMax                   
};
 
@class QUserLocation, QPolygon;
@class QTrafficStyle;
@protocol QMapViewDelegate;
 
 
#pragma mark - QMapView

@interface QMapView : UIView

@property (nonatomic, assign, getter = isHandDrawMapEnabled) BOOL handDrawMapEnabled;

@property (nonatomic, assign) BOOL showsTraffic;

- (void)setTrafficStyle:(QTrafficStyle *)trafficStyle;
 
#pragma mark - Resources

+ (void)loadPrefferedResourceFilesFromDirectory:(NSString *)path;
 
#pragma mark - Basic

@property (nonatomic, weak) id<QMapViewDelegate> delegate;
 
/*@
 *  @brief  地图类型
 */
@property (nonatomic, assign) QMapType mapType;
 

- (void)setStyleType:(QMapStyleType)styleType DEPRECATED_ATTRIBUTE;

- (void)setMapStyle:(int)styleType;

@property (nonatomic) BOOL showsScale;

@property (nonatomic) BOOL showsBuildings;

@property (nonatomic) BOOL shows3DBuildings;

@property (nonatomic) BOOL showsPoi;

@property (nonatomic) QMapLabelSize labelSize;

@property (nonatomic) BOOL showsBaseMap;

@property (nonatomic) BOOL showsCompass;

@property (nonatomic) NSInteger preferredFramesPerSecond;

- (void)setCompassOffset:(CGPoint)offset;

- (void)setForeignLanguage:(QMapLanguage)language;

- (void)setWorldMapEnable:(BOOL)enable;

- (void)setMapViewRenderWhenDetachedFromWindowEnabled:(BOOL)enabled;

- (void)setMapViewRenderWhenAppInactiveEnabled:(BOOL)enabled;

- (void)setCenterOffsetY:(float)offset __attribute__ ((deprecated("use - (void)setCenterOffsetV2:(CGPoint)offset animated:(BOOL)animated instead")));

- (void)setCenterOffset:(CGPoint)offset __attribute__ ((deprecated("use - (void)setCenterOffsetV2:(CGPoint)offset animated:(BOOL)animated instead")));

- (void)setCenterOffset:(CGPoint)offset animated:(BOOL)animated __attribute__ ((deprecated("use - (void)setCenterOffsetV2:(CGPoint)offset animated:(BOOL)animated instead")));

@property(nonatomic) CGPoint centerOffsetV2;

- (void)setCenterOffsetV2:(CGPoint)offset animated:(BOOL)animated;

- (void)setLogoOffset:(CGPoint)offset DEPRECATED_ATTRIBUTE;

- (void)setLogoMargin:(CGPoint)margin anchor:(QMapLogoAnchor)anchor;

- (void)setLogoScale:(CGFloat)scale;
 

@property (nonatomic, assign) CGPoint logoCenter;

@property (nonatomic, readonly) CGSize logoSize;

- (void)setScaleViewOffset:(CGPoint)offset;

@property (nonatomic, assign) CGPoint scaleOrigin;

@property (nonatomic, readonly) CGSize scaleSize;

- (void) setScaleViewFadeEnable:(BOOL)enable;

- (void)setRoadEventVisible:(BOOL)visible DEPRECATED_ATTRIBUTE;

- (void)setBuildingBlackList:(QMapRect*)noBuildingList count:(int)count;

@property (nonatomic, readonly) QBasicMapViewLayer *animationLayer;

- (void)setGLMapDefaultGroundColor:(UIColor *)defaultColor;
 
#pragma mark - MapStatus

@property (nonatomic, assign) CLLocationCoordinate2D centerCoordinate;

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

@property (nonatomic, assign) CGFloat zoomLevel;

@property (nonatomic, readonly) CGFloat minZoomLevel;

@property (nonatomic, readonly) CGFloat maxZoomLevel;

- (void)setMinZoomLevel:(CGFloat)minZoomLevel maxZoomLevel:(CGFloat)maxZoomLevel;

- (void)setZoomLevelMultiplierForZoomIn:(CGFloat)zoomInMultiplier zoomOut:(CGFloat)zoomOutMultiplier;

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

@property (nonatomic, assign) CGFloat rotation;

- (void)setRotation:(CGFloat)rotation animated:(BOOL)animated;

@property (nonatomic, assign) CGFloat overlooking;

- (void)enableAutoMaxOverlooking:(BOOL)enable;

- (void)setOverlooking:(CGFloat)overlooking animated:(BOOL)animated;

@property (nonatomic) QMapRect visibleMapRect;

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

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

@property (nonatomic) QCoordinateRegion region;

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

- (void)setRegion:(QCoordinateRegion)region edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;

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

- (QMapRect)mapRectThatFits: (QMapRect)mapRect
        containsCalloutView:(BOOL)bContainsCalloutView
                annotations:(NSArray<id<QAnnotation> >*)annotations
                edgePadding:(UIEdgeInsets)insets;

- (CGFloat)zoomLevelThatFits:(QMapRect)mapRect edgePadding:(UIEdgeInsets)insets outCenterCoordinate:(CLLocationCoordinate2D *)outCoordinate;

-(void)setLimitMapRect:(QMapRect)mapRect mode:(QMapLimitRectFitMode)mode;

- (float *)glViewMatrix;

- (float *)glProjectionMatrix;

- (CGPoint)glVertexForCoordinate:(CLLocationCoordinate2D)coordinate;

- (CGFloat)glPointRatio;

@property (nonatomic, readonly) double metersPerPointAtCurrentZoomLevel;

- (double)metersPerPointAtLatitude:(CLLocationDegrees)latitude zoomLevel:(CGFloat)zoomLevel;
 
#pragma mark - Gesture Control

@property(nonatomic, getter=isZoomEnabled) BOOL zoomEnabled;
 
/*
 *  @brief 以地图中心为中心, 默认为NO（即以手势为中心）
 */
@property (nonatomic, assign, getter = isKeepCenterDuringZoom) BOOL keepCenterDuringZoom;

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

@property (nonatomic, assign, getter=isOverlookingEnabled) BOOL overlookingEnabled;

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

@property (nonatomic, assign) BOOL alwaysTriggerDidTapCoordinateEnabled;
 
#pragma mark - Coordinate Convert

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

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

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

- (QCoordinateRegion)convertRect:(CGRect)rect toRegionFromView:(UIView *)view;
 
@end

@interface QMapView (UserLocation)

@property (nonatomic, readonly) QUserLocationPresentation *userLocatorPresentation;

- (void)configureUserLocationPresentation:(QUserLocationPresentation *)presentation;

@property (nonatomic, assign) BOOL showsUserLocation;

@property (nonatomic, assign) QOverlayLevel locatorDisplayLevel;

@property (nonatomic, assign) int locatorZIndex;

@property (nonatomic, readonly) QUserLocation *userLocation;

@property (nonatomic) CLLocationAccuracy desiredAccuracy;

@property (nonatomic) CLLocationDistance distanceFilter;
 

@property (nonatomic) CLLocationDegrees headingFilter;

@property(assign, nonatomic) BOOL allowsBackgroundLocationUpdates;

@property(assign, nonatomic) BOOL pausesLocationUpdatesAutomatically;

@property(nonatomic, readonly) CLAccuracyAuthorization accuracyAuthorization API_AVAILABLE(ios(14));

@property(nonatomic, readonly) CLAuthorizationStatus authorizationStatus API_AVAILABLE(ios(14));

@property (nonatomic) QUserTrackingMode userTrackingMode;

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

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

- (void)setUserLocationHidden:(BOOL)hidden;

- (void)setUserLocationCompassHidden:(BOOL)hidden;

- (void)setUserLocationNavigationGravitylineHidden:(BOOL)hidden;

- (void)requestTempPrecisedLocation:(QMapView *)mapView purposeKey:(NSString *)key completion:(void(^)(NSError * error))completion API_AVAILABLE(ios(14));
 
@end

@interface QMapView (Annotation)

@property(nonatomic, readonly) NSArray *annotations;

@property (nonatomic, copy) NSArray<id<QAnnotation>> *selectedAnnotations;

- (NSSet<id <QAnnotation>> *)annotationsInMapRect:(QMapRect)mapRect;

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

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

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

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

- (QAnnotationView *)viewForAnnotation:(id <QAnnotation>)annotation;

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

- (void)bringAnnotationToFront:(id <QAnnotation>)annotation DEPRECATED_ATTRIBUTE;

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

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

- (void)showAnnotations:(NSArray<id<QAnnotation>> *)annotations edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;
 
@end
 
 
#pragma mark - Overlay

@interface QMapView (Overlay)

@property (nonatomic, readonly) NSArray *overlays;

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

- (void)addOverlays:(NSArray<id <QOverlay>> *)overlays;

- (void)addMultiPolygons:(NSArray <QPolygon *> *)polygons;

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

- (void)removeOverlays:(NSArray<id <QOverlay>> *)overlays;

- (QOverlayView *)viewForOverlay:(id <QOverlay>)overlay;

- (void)showOverlays:(NSArray<id<QOverlay>> *)overlays edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;

- (void)showQMarkers:(NSArray<QMarker *> *)markers edgePadding:(UIEdgeInsets)insets animated:(BOOL)animated;
 
@end
 
 
#pragma mark - CustomLayer

@interface QMapView (CustomLayer)

- (void)addCustomLayer:(QCustomLayer *)layer;

- (void)removeCustomLayer:(QCustomLayer *)layer;
 
@end
 
#pragma mark - POILayer
 
@interface QMapView (AOILayer)

 
- (void)addAOILayer:(QAOILayer *)layer callback:(void(^)(BOOL success))callback;

- (void)removeAOILayer:(QAOILayer *)layer;
 
@end
 
#pragma mark - QMaskingLayer
 
@interface QMapView (QMaskingLayer)

- (void)addMaskingLayer:(QMaskingLayer *)layer;

- (void)updateMaskingLayer:(QMaskingLayer *)layer;

- (void)removeMaskingLayer:(QMaskingLayer *)layer;

@property (nonatomic, readonly) NSArray <QMaskingLayer *> *maskingLayers;
 
@end
 
 
#pragma mark - Snapshot
@interface QMapView (Snapshot)

- (UIImage *)takeSnapshot __attribute__ ((deprecated("use - (void)takeSnapshotInRect:(CGRect)rect completion:(void (^)(UIImage *resultImage))completion instead")));

- (void)takeSnapshotInRect:(CGRect)rect completion:(void (^)(UIImage *resultImage))completion;

- (void)takeSnapshotInRect:(CGRect)rect timeout:(CFTimeInterval)timeout completion:(void (^)(UIImage *resultImage))completion;

- (void)takeSnapshotInRect:(CGRect)rect timeout:(CFTimeInterval)timeout afterScreenUpdates:(BOOL)afterUpdates completion:(void (^)(UIImage *resultImage))completion;
 
@end
 
#pragma mark - QPoiInfo

@interface QPoiInfo : NSObject

@property (nonatomic, copy) NSString *uid;

@property (nonatomic, copy) NSString *name;

@property (nonatomic, assign) CLLocationCoordinate2D coordinate;
 
@end

@interface QIndoorPoiInfo : QPoiInfo

@property (nonatomic, copy) NSString *levelName;

@property (nonatomic, copy) NSString *buildingGUID;

@property (nonatomic, copy) NSString *buildingName;
 
@end

@interface QPointEventInfo : QPoiInfo

@property (nonatomic, copy) NSString *source;

@property (nonatomic, copy) NSString *eventName;

@property (nonatomic, copy) NSString *road;

@property (nonatomic, copy) NSString *detail;

@property (nonatomic, assign) NSTimeInterval startTime;

@property (nonatomic, assign) NSTimeInterval endTime;

@property (nonatomic, assign) NSTimeInterval updateTime;
 
@end

 
@interface QSubPoiInfo : QPoiInfo

@property (nonatomic, copy) NSString *parentID;
 
@end

@interface QMapView (Debug)

- (NSString *)getDebugError;
 
@end
 
@interface QMapView (Cache)

+ (void)clearMapCache;
 
@end
 
#pragma mark - QMapViewDelegate

@protocol QMapViewDelegate <NSObject>
 
@optional

- (void)mapViewAuthenticationDidComplete:(QMapView *)mapView;

- (void)mapViewAuthentication:(QMapView *)mapView didFailWithError:(NSError *)error;

- (void)mapViewInitComplete:(QMapView *)mapView;

- (void)mapViewFirstRenderDidComplete:(QMapView *)mapView;

- (void)mapViewStatusChangesCompleted:(QMapView *)mapView;

- (void)mapViewDidMoveToCameraRestricted:(QMapView *)mapView;

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

- (void)mapView:(QMapView *)mapView regionWillChangeAnimated:(BOOL)animated gesture:(BOOL)bGesture;

- (void)mapViewRegionChange:(QMapView *)mapView;

- (void)mapView:(QMapView *)mapView regionDidChangeAnimated:(BOOL)animated gesture:(BOOL)bGesture;

- (void)mapView:(QMapView *)mapView willMoveAnimated:(BOOL)animated gesture:(BOOL)bGesture;

- (void)mapView:(QMapView *)mapView didMoveAnimated:(BOOL)animated gesture:(BOOL)bGesture;

- (void)mapView:(QMapView *)mapView willZoomAnimated:(BOOL)animated gesture:(BOOL)bGesture;

- (void)mapView:(QMapView *)mapView didZoomAnimated:(BOOL)animated gesture:(BOOL)bGesture;

- (void)mapView:(QMapView *)mapView scaleViewChanged:(CGFloat)unitLength;

- (void)mapView:(QMapView *)mapView gestureDidTrigger:(QGestureType)gestureType;

- (void)mapView:(QMapView *)mapView gestureDidEnd:(QGestureType)gestureType;

- (void)mapViewDrawFrame:(QMapView *)mapView;

- (void)mapUpdateFinished:(QMapView *)mapView;

- (void)mapView:(QMapView *)mapView didTapAtCoordinate:(CLLocationCoordinate2D)coordinate;

- (void)mapView:(QMapView *)mapView didTapPoi:(QPoiInfo *)poi;

- (void)mapView:(QMapView *)mapView didTapOverlay:(id<QOverlay>)overlay __attribute__ ((deprecated("use - (void)mapView:(QMapView *)mapView didTapOverlay:(id<QOverlay>)overlay coordinate:(CLLocationCoordinate2D)coordinate instead")));

- (void)mapView:(QMapView *)mapView didTapOverlay:(id<QOverlay>)overlay coordinate:(CLLocationCoordinate2D)coordinate;

- (void)mapView:(QMapView *)mapView didTapMarkerOverlayCallout:(QMarker *)markerOverlay;

- (void)mapView:(QMapView *)mapView markerOverlay:(QMarker *)markerOverlay didChangeDragState:(QMarkerViewDragState)newState
   fromOldState:(QMarkerViewDragState)oldState;

- (void)mapView:(QMapView *)mapView didTapMyLocation:(CLLocationCoordinate2D)location;

- (QAnnotationView *)mapView:(QMapView *)mapView viewForAnnotation:(id <QAnnotation>)annotation;

- (UIView *)mapView:(QMapView *)mapView customCalloutForAnnotationView:(QAnnotationView *)annotationView;

- (void)mapView:(QMapView *)mapView didAddAnnotationViews:(NSArray<QAnnotationView *> *)views;

- (void)mapView:(QMapView *)mapView didSelectAnnotationView:(QAnnotationView *)view;

- (void)mapView:(QMapView *)mapView didAnnotationViewTapped:(QAnnotationView *)view;

- (void)mapView:(QMapView *)mapView didDeselectAnnotationView:(QAnnotationView *)view;

- (void)mapView:(QMapView *)mapView annotationView:(QAnnotationView *)view collidedViewsDidShow:(NSArray <UIView *> *)shownViews;

- (void)mapView:(QMapView *)mapView annotationView:(QAnnotationView *)view collidedViewsDidHide:(NSArray <UIView *> *)hiddenViews;

- (void)mapView:(QMapView *)mapView annotationView:(QAnnotationView *)view didChangeDragState:(QAnnotationViewDragState)newState
   fromOldState:(QAnnotationViewDragState)oldState;

- (void)mapView:(QMapView *)mapView annotationView:(QAnnotationView *)view calloutAccessoryControlTapped:(UIControl *)control;

- (void)mapView:(QMapView *)mapView annotationViewCalloutTapped:(QAnnotationView *)view;

- (QOverlayView *)mapView:(QMapView *)mapView viewForOverlay:(id <QOverlay>)overlay;

- (void)mapView:(QMapView *)mapView didAddOverlayViews:(NSArray *)overlayViews;

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

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

- (void)mapView:(QMapView *)mapView didUpdateUserLocation:(QUserLocation *)userLocation fromHeading:(BOOL)fromHeading;
- (void)mapView:(QMapView *)mapView didFailToLocateUserWithError:(NSError *)error;

- (void)mapView:(QMapView *)mapView didChangeUserTrackingMode:(QUserTrackingMode)mode animated:(BOOL)animated;

- (void)locationManagerDidChangeAuthorization:(QMapView *)mapView;

- (void)mapViewLogger:(QMapView *)mapView logMessage:(NSString *)text;
 
@end