MPMapControl.h

Go to the documentation of this file.

//
//  MPMapControl.h
//  MapsIndoors SDK for iOS
//
//  Created by Daniel Nielsen on 9/17/13.
//  Copyright (c) 2017 MapsPeople A/S. All rights reserved.
//
 
#import "MPBuilding.h"
#import "MPFloorSelectorProtocol.h"
#import "MPPositionProvider.h"
#import "MPVenueProvider.h"
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
 
FOUNDATION_EXPORT double MapsIndoorsVNum;
 
FOUNDATION_EXPORT const unsigned char MapsIndoorsVStr[];
 
@class GMSMarker;
@class MPFloorSelectorControl;
@class MPLocation;
@class MPLocationDisplayRule;
@class MPMapStyle;
@class MPPositionIndicator;
@class MPPositionResult;
@protocol GMSMapViewDelegate;
@protocol MPFloorSelectorProtocol;
@protocol MPOnlineTileLayer;
 
#pragma mark - MPMapControlDelegate
 
 
@protocol MPMapControlDelegate <NSObject>
@optional
- (void) mapContentReady;
 
@optional
- (void) floorDidChange:(nonnull NSNumber*)floor;
 
@optional
- (void) focusedBuildingDidChange:(nullable MPLocation*)building;
 
@optional
- (BOOL) allowAutomaticSwitchToFloor:(nonnull NSNumber*)toFloor;
 
@optional
- (BOOL) didTapAtCoordinate:(CLLocationCoordinate2D)coordinate withLocations:(nullable NSArray<MPLocation*>*)locations;
 
@optional
- (BOOL) didTapMarker:(GMSMarker*_Nonnull)marker forLocationCluster:(nullable NSArray<MPLocation*>*)locations moreZoomPossible:(BOOL)moreZoomPossible;
 
@optional
- (nullable UIView*) infoWindowForLocationCluster:(NSArray<MPLocation*>* _Nonnull)locationCluster;
 
@optional
- (CGSize) getImageSizeForLocationClusterWithCount:(NSUInteger)count clusterId:(NSString* _Nonnull)clusterId;
 
@optional
- (nullable UIImage*) getImageForLocationCluster:(NSArray<MPLocation*>* _Nonnull)locationCluster imageSize:(CGSize)imageSize clusterId:(NSString* _Nonnull)clusterId;
 
@optional
- (BOOL) getImageForLocationCluster:(NSArray<MPLocation*>* _Nonnull)locationCluster imageSize:(CGSize)imageSize clusterId:(NSString* _Nonnull)clusterId completion:(void(^_Nonnull)(UIImage* _Nullable image))completion;
 
@optional
- (void) onPositionUpdate:(nonnull MPPositionResult*)positionResult;
 
@optional
- (void) willUpdateLocationsOnMap:(nonnull NSArray<MPLocation*>*)locations NS_SWIFT_NAME(willUpdateLocationsOnMap(locations:));;
 
@optional
- (void) onError:(NSError* _Nonnull)error;
 
@end
 
 
#pragma mark - MPMapControl
 
 
@interface MPMapControl : NSObject<MPFloorSelectorDelegate, MPBuildingDelegate, MPVenueProviderDelegate, MPPositionProviderDelegate>
 
@property (nonatomic, weak, nullable) id<MPMapControlDelegate> delegate;
 
@property (nonatomic, strong, nullable) id<MPFloorSelectorProtocol>       customFloorSelector;
 
@property (readonly, nullable) MPFloorSelectorControl* floorSelector;
 
@property (nonatomic) BOOL floorSelectorHidden;
 
@property (nonatomic, nullable, readonly) MPPositionIndicator* currentPosition  DEPRECATED_ATTRIBUTE;
@property (nonatomic, nullable) MPLocation* selectedLocation;
@property (nonatomic, nullable) NSArray<MPLocation*>* searchResult;
@property (nonatomic, nullable) NSNumber* currentFloor;
@property (nonatomic, nullable) MPMapStyle* mapStyle;
@property (nonatomic) BOOL mapLocationsHidden;
@property (nonatomic, nullable) NSString* venue;
 
@property (nonatomic, readonly) BOOL    mapContentReady;
 
- (nullable instancetype)initWithMap:(nonnull GMSMapView*) map;
 
- (void) setupMapWithVenue:(nonnull NSString*)venueName;
 
- (nullable MPLocation*)getLocation:(nonnull GMSMarker*) marker;
 
- (nullable MPLocation*)getLocationById:(nonnull NSString*) idString;
 
- (void)showSearchResult:(BOOL)fitBounds;
 
 
#pragma mark - Display rule support
 
- (void) setDisplayRule:(nullable MPLocationDisplayRule*)rule;
 
- (void) setDisplayRules:(nonnull NSArray<MPLocationDisplayRule*>*)rules;
 
- (void) setDisplayRule:(nonnull MPLocationDisplayRule*)rule forLocation:(nullable MPLocation*)location;
 
- (void) setDisplayRule:(nonnull MPLocationDisplayRule*)rule forLocations:(nonnull NSArray<MPLocation*>*)locations;
 
- (void) setDisplayRuleNamed:(nonnull NSString*)ruleName forLocation:(nonnull MPLocation*)location;
 
- (MPLocationDisplayRule* _Nullable) getDisplayRuleForTypeNamed:(nonnull NSString*)ruleName;
 
- (MPLocationDisplayRule* _Nullable) getEffectiveDisplayRuleForLocation:(nonnull MPLocation*)location;
 
- (void) resetDisplayRuleForLocation:(nonnull MPLocation*)location;
 
- (void) resetDisplayRulesForLocations:(nonnull NSArray<MPLocation*>*)locations;
 
@property (nonatomic, strong, readonly) MPLocationDisplayRule* _Nullable      locationHighlightDisplayRule;
 
@property (nonatomic, strong, readonly) MPLocationDisplayRule* _Nullable      defaultDisplayRule;
 
 
#pragma mark - Configuration
@property (class, nullable) UIFont* mapLabelFont;
 
@property (class, nullable) UIColor* mapLabelColor;
 
@property(class) CGSize mapIconSize;
 
+ (BOOL)isMapLabelHaloEnabled;
 
+ (void)setMapLabelFont:(UIFont * _Nullable)mapLabelFont showHalo: (BOOL) showHalo;
 
@property(class) BOOL   locationClusteringEnabled;
 
@property(class) BOOL   locationHideOnIconOverlapEnabled;
 
@property (class) BOOL hideIconsOverlappingRoute;
 
@property (readonly) NSRange        zIndexRangeForMapsIndoorsOverlays;
 
@property (readonly) NSRange        zIndexRangeForPolygonOverlays;
 
@property (readonly) NSRange zIndexRangeFor2DModelOverlays;
 
@property (readonly) int zIndexForUserLocationMarker;
 
@property (readonly) int zIndexForPositioningAccuracyCircle;
 
@property (readonly) int zIndexForBuildingOutlineHighlight;
 
@property (readonly) int zIndexForLocationOutlineHighlight;
 
@property (readonly) NSRange        zIndexRangeForMapsIndoorsTileLayers;
 
 
#pragma mark -
 
- (void)clearTileCache;
 
- (void)clearMap;
 
- (void)showUserPosition:(BOOL)show;
 
- (void)goTo:(nonnull MPLocation*)location;
 
- (void) showAreaOfLocation:(nonnull MPLocation*)location;
 
 
#pragma mark - Accessibility support
 
@property (nonatomic, strong, nullable) NSString*   userLocationAccessibilityLabel;
 
@property (nonatomic, strong, nullable) NSString*   userLocationAccuracyAccessibilityLabel;
 
 
 
#pragma mark - Deprecations
- (void) addDisplayRule:(nonnull MPLocationDisplayRule*)rule DEPRECATED_ATTRIBUTE;
 
- (void) addDisplayRules:(nonnull NSArray<MPLocationDisplayRule*>*)rules DEPRECATED_ATTRIBUTE;
 
@end