MPLocationDisplayRule.h

Go to the documentation of this file.

//
//  MPDisplayRule.h
//  MapsIndoors SDK for iOS
//
//  Created by Daniel Nielsen on 7/30/13.
//  Copyright (c) 2017 MapsPeople A/S. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>
#import "MPJSONModel.h"
#import "MPLocation.h"
 
 
@class MPLocation;
 
 
@interface MPLocationDisplayRule : MPJSONModel
 
@property (nonatomic, strong, nullable) NSString<Ignore>* name;
 
@property (nonatomic, strong, nullable) NSNumber* zOn;
 
@property (nonatomic, strong, nullable) NSNumber* zOff;
 
@property (nonatomic, strong, nullable) NSString* iconPath;
 
@property (nonatomic, strong, nullable) NSString* label;
 
@property (nonatomic, strong, nullable) UIColor<Optional>* highlightOutlineColor;
 
@property (nonatomic) UIColor<Optional>* _Nullable highlightFillColor;
 
@property (nonatomic) NSNumber<Optional>* _Nullable highlightStrokeWidth;
 
@property (nonatomic, strong, nullable) UIImage<Ignore>* icon;
 
@property (assign, nonatomic) BOOL showLabel;
 
@property (assign, nonatomic) BOOL showIcon;
 
@property (assign, nonatomic) BOOL showOutline;
 
@property (assign, nonatomic) BOOL visible;
 
@property (assign, nonatomic) CGSize iconSize;
 
@property (nonatomic, assign) NSUInteger labelMaxWidth;
 
- (BOOL)show:(CGFloat)zLevel;
 
- (nullable NSString*)getLabelContent:(nonnull MPLocation*)location;
 
- (void)fetchIcon: (nonnull NSString*) basePathOrBundle;
 
- (nullable instancetype)initWithName:(nullable NSString*) name AndZoomLevelOn: (CGFloat) zOn AndShowLabel:(BOOL) doShowLabel;
 
- (nullable instancetype)initWithName:(nullable NSString*) name AndIcon: (nullable UIImage*) icon AndZoomLevelOn: (CGFloat) zOn;
 
- (nullable instancetype)initWithName:(nullable NSString*) name AndIcon: (nullable UIImage*) icon AndZoomLevelOn: (CGFloat) zOn AndShowLabel:(BOOL) doShowLabel;
 
- (nullable instancetype)initWithName:(nullable NSString*) name AndIconURL: (nullable NSString*) iconURL AndZoomLevelOn: (CGFloat) zOn AndShowLabel:(BOOL) doShowLabel;
 
 
#pragma mark - POI overlap resolution related properties (POI Grouping, clustering)
 
@property (nonatomic, strong, nullable) NSString<Optional>*   clusteringId;
 
@property (nonatomic) NSInteger     displayRank;
 
 
#pragma mark - Polygon support
 
@property (nonatomic) BOOL   showPolygon;
 
@property (nonatomic, strong, nullable) NSNumber*   zOnPolygon;         // nullable float
 
@property (nonatomic, strong, nullable) NSNumber*   zOffPolygon;        // nullable float
 
@property (nonatomic, strong, nullable) NSNumber*   polygonStrokeWidth; // nullable float
 
@property (nonatomic, strong, nullable) UIColor*    polygonStrokeColor;
 
@property (nonatomic, strong, nullable) UIColor*    polygonFillColor;
 
#pragma mark - 2D Model support
 
@property (nonatomic, strong, nullable, readonly) NSNumber* model2DBearing;
@property (nonatomic, strong, nullable, readonly) NSNumber* model2DHeightMeters;
@property (nonatomic, strong, nullable, readonly) NSString* model2DModel;
@property (nonatomic, assign, readonly) BOOL model2DVisible;
@property (nonatomic, strong, nullable, readonly) NSNumber* model2DWidthMeters;
@property (nonatomic, strong, nullable, readonly) NSNumber* model2DZoomFrom;
@property (nonatomic, strong, nullable, readonly) NSNumber* model2DZoomTo;
 
@end