RMMarker.h
8.04 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
//
// RMMarker.h
//
// Copyright (c) 2008-2013, Route-Me Contributors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice, this
// list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
#import <UIKit/UIKit.h>
#import "RMMapLayer.h"
#import "RMFoundation.h"
typedef enum : NSUInteger {
RMMarkerMapBoxImageSizeSmall,
RMMarkerMapBoxImageSizeMedium,
RMMarkerMapBoxImageSizeLarge
} RMMarkerMapBoxImageSize;
/** An RMMarker object is used for simple point annotations on a map view, represented as a single image. RMMarker objects do not change in size when the map view zooms in or out, but instead stay the same size to consistently represent a point on the map view. */
@interface RMMarker : RMMapLayer
{
// Text label, visible by default if it has content, but not required.
UIView *label;
UIColor *textForegroundColor;
UIColor *textBackgroundColor;
}
/** @name Setting Label Properties */
/** A custom label for the marker. The label is shown when first set. */
@property (nonatomic, strong) UIView *label;
/** The marker object's label text foreground color. Defaults to black. */
@property (nonatomic, strong) UIColor *textForegroundColor;
/** The marker object's label text background color. Defaults to clear. */
@property (nonatomic, strong) UIColor *textBackgroundColor;
/** The font used for labels when another font is not explicitly requested. The default is the system font with size `15`. */
+ (UIFont *)defaultFont;
/** @name Creating Markers With Images */
/** Initializes and returns a newly allocated marker object using the specified image.
* @param image An image to use for the marker. */
- (id)initWithUIImage:(UIImage *)image;
/** Initializes and returns a newly allocated marker object using the specified image and anchor point.
* @param image An image to use for the marker.
* @param anchorPoint A point representing a range from `0` to `1` in each of the height and width coordinate space, normalized to the size of the image, at which to place the image.
* @return An initialized marker object. */
- (id)initWithUIImage:(UIImage *)image anchorPoint:(CGPoint)anchorPoint;
/** @name Creating Markers Using MapBox Images */
/** Initializes and returns a newly allocated marker object using a red, medium-sized star pin image. */
- (id)initWithMapBoxMarkerImage;
/** Initializes and returns a newly allocated marker object using a red, medium-sized pin image and a given symbol name, e.g., `bus`.
* @param symbolName A symbol name from the [Maki](http://mapbox.com/maki/) icon set.
* @return An initialized RMMarker layer. */
- (id)initWithMapBoxMarkerImage:(NSString *)symbolName;
/** Initializes and returns a newly allocated marker object using a medium-sized pin image, a given symbol name, e.g., `bus`, and a given color.
* @param symbolName A symbol name from the [Maki](http://mapbox.com/maki/) icon set.
* @param color A color for the marker.
* @return An initialized RMMarker layer. */
- (id)initWithMapBoxMarkerImage:(NSString *)symbolName tintColor:(UIColor *)color;
/** Initializes and returns a newly allocated marker object using a pin image, a given symbol name, e.g., `bus`, a given color, and a given size.
* @param symbolName A symbol name from the [Maki](http://mapbox.com/maki/) icon set.
* @param color A color for the marker.
* @param size A size for the marker.
* @return An initialized RMMarker layer. */
- (id)initWithMapBoxMarkerImage:(NSString *)symbolName tintColor:(UIColor *)color size:(RMMarkerMapBoxImageSize)size;
/** Initializes and returns a newly allocated marker object using a medium-sized pin image, a given symbol name, e.g., `bus`, and a given HTML hex color, e.g., `ff0000`.
* @param symbolName A symbol name from the [Maki](http://mapbox.com/maki/) icon set.
* @param colorHex A color for the marker specified as an HTML hex code.
* @return An initialized RMMarker layer. */
- (id)initWithMapBoxMarkerImage:(NSString *)symbolName tintColorHex:(NSString *)colorHex;
/** Initializes and returns a newly allocated marker object using a pin image, a given symbol name, e.g., `bus`, a given HTML hex color, e.g., `ff0000`, and a given size, e.g., `large`.
* @param symbolName A symbol name from the [Maki](http://mapbox.com/maki/) icon set.
* @param colorHex A color for the marker specified as an HTML hex code.
* @param sizeString A size such as `small`, `medium`, or `large`.
* @return An initialized RMMarker layer. */
- (id)initWithMapBoxMarkerImage:(NSString *)symbolName tintColorHex:(NSString *)colorHex sizeString:(NSString *)sizeString;
/** Clears the local cache of Mapbox Marker images. Images are cached locally upon first use so that if the application goes offline, markers can still be used. */
+ (void)clearCachedMapBoxMarkers;
/** @name Altering Labels */
/** Changes the label to a UILabel with the supplied text and default marker font and using the existing text foreground and background colors.
* @param text The text for the label. */
- (void)changeLabelUsingText:(NSString *)text;
// changes the labelView to a UILabel with supplied #text and default marker font, positioning the text some weird way i don't understand yet. Uses existing text color/background color.
- (void)changeLabelUsingText:(NSString *)text position:(CGPoint)position;
/** Changes the label to a UILabel with the supplied text and font and using the given text foreground and background colors.
* @param text The text for the label.
* @param font A font to use for the label text.
* @param textColor The color for the label text.
* @param backgroundColor The color for the label background. */
- (void)changeLabelUsingText:(NSString *)text font:(UIFont *)font foregroundColor:(UIColor *)textColor backgroundColor:(UIColor *)backgroundColor;
// changes the labelView to a UILabel with supplied #text and default marker font, changing this marker's text foreground/background colors for this and future text strings; modifies position as in #changeLabelUsingText:position.
- (void)changeLabelUsingText:(NSString *)text position:(CGPoint)position font:(UIFont *)font foregroundColor:(UIColor *)textColor backgroundColor:(UIColor *)backgroundColor;
/** @name Showing and Hiding Labels */
/** Toggle the display of the marker's label, if any. If hidden, show and if shown, hide. */
- (void)toggleLabel;
/** Show the marker's label, if any. */
- (void)showLabel;
/** Hide the marker's label, if any. */
- (void)hideLabel;
/** @name Altering Images */
/** Replace the image for a marker.
* @param image An image to use for the marker. */
- (void)replaceUIImage:(UIImage *)image;
/** Replace the image for a marker using a custom anchor point.
* @param image An image to use for the marker.
* @param anchorPoint A point representing a range from `0` to `1` in each of the height and width coordinate space, normalized to the size of the image, at which to place the image. */
- (void)replaceUIImage:(UIImage *)image anchorPoint:(CGPoint)anchorPoint;
@end