Authored by Hal Mueller

more Doxygen tags

... ... @@ -60,6 +60,8 @@
- (void)zoomByFactor: (float) zoomFactor near:(CGPoint) center;
- (void)removeSublayer:(CALayer *)layer;
- (void)removeSublayers:(NSArray *)layers;
/// (guess) recompute the screen coordinates for the sublayers (map markers, paths)
/// \deprecated name will change after 0.5
- (void) correctPositionOfAllSublayers;
- (BOOL) hasSubLayer:(CALayer *)layer;
... ...
... ... @@ -82,23 +82,26 @@ enum {
*/
@interface RMMapContents : NSObject
{
// TODO: Also support NSView.
/// This is the underlying UIView's layer.
CALayer *layer;
RMMarkerManager *markerManager;
/// subview for the image displayed while tiles are loading. Set its contents by providing your own "loading.png".
RMMapLayer *background;
/// subview for markers and paths
RMLayerSet *overlay;
/// (guess) the projection object to convert from latitude/longitude to meters.
/// Latlong is calculated dynamically from mercatorBounds.
RMProjection *projection;
id<RMMercatorToTileProjection> mercatorToTileProjection;
// RMTileRect tileBounds;
/// (guess) converts from projected meters to screen pixel coordinates
RMMercatorToScreenProjection *mercatorToScreenProjection;
/// controls what images are used. Can be changed while the view is visible, but see http://code.google.com/p/route-me/issues/detail?id=12
id<RMTileSource> tileSource;
RMTileImageSet *imagesOnScreen;
... ... @@ -107,9 +110,10 @@ enum {
RMMapRenderer *renderer;
NSUInteger boundingMask;
/// \bug These should probably not be here. Instead equivalent functions
/// should just fetch them when needed from the tileosurce.
float minZoom, maxZoom;
/// minimum zoom number allowed for the view. #minZoom and #maxZoom must be within the limits of #tileSource but can be stricter.
float minZoom;
/// maximum zoom number allowed for the view. #minZoom and #maxZoom must be within the limits of #tileSource but can be stricter.
float maxZoom;
id<RMTilesUpdateDelegate> tilesUpdateDelegate;
}
... ...
... ... @@ -34,12 +34,15 @@
extern NSString * const RMMarkerBlueKey;
extern NSString * const RMMarkerRedKey;
/// one marker drawn on the map. Note that RMMarker ultimately descends from CALayer, and has an image contents.
@interface RMMarker : RMMapLayer <RMMovingMapLayer> {
/// (guess) the anchorPoint of the image is plotted here
RMXYPoint location;
NSObject* data; // provided for storage of arbitrary user data
/// provided for storage of arbitrary user data
NSObject* data;
// A label which comes up when you tap the marker
/// A label which comes up when you tap the marker
UIView *labelView;
UIColor *textForegroundColor;
UIColor *textBackgroundColor;
... ... @@ -69,8 +72,11 @@ extern NSString * const RMMarkerRedKey;
- (void) setLabel: (UIView*)aView;
- (void) setTextLabel: (NSString*)text;
/// \deprecated name change or deletion pending after 0.0
- (void) setTextLabel: (NSString*)text toPosition:(CGPoint)position;
/// \deprecated name change or deletion pending after 0.0
- (void) setTextLabel: (NSString*)text withFont:(UIFont*)font withTextColor:(UIColor*)textColor withBackgroundColor:(UIColor*)backgroundColor;
/// \deprecated name change or deletion pending after 0.0
- (void) setTextLabel: (NSString*)text toPosition:(CGPoint)position withFont:(UIFont*)font withTextColor:(UIColor*)textColor withBackgroundColor:(UIColor*)backgroundColor;
- (void) toggleLabel;
- (void) showLabel;
... ...