/MapView/Map/RMMercatorToTileProjection.h

 1//
 2//  RMMercatorToTileProjection.h
 3//
 4// Copyright (c) 2008-2009, Route-Me Contributors
 5// All rights reserved.
 6//
 7// Redistribution and use in source and binary forms, with or without
 8// modification, are permitted provided that the following conditions are met:
 9//
10// * Redistributions of source code must retain the above copyright notice, this
11//   list of conditions and the following disclaimer.
12// * Redistributions in binary form must reproduce the above copyright notice,
13//   this list of conditions and the following disclaimer in the documentation
14//   and/or other materials provided with the distribution.
15//
16// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
26// POSSIBILITY OF SUCH DAMAGE.
27
28#import <Foundation/Foundation.h>
29#import "RMFoundation.h"
30#import "RMTile.h"
31#import "RMMercatorToTileProjection.h"
32
33@class RMMercatorToScreenProjection;
34
35/// A tile projection is a projection which turns mercators into tile coordinates.
36/// At time of writing, read RMFractalTileProjection to see the implementation of this.
37@protocol RMMercatorToTileProjection<NSObject>
38
39-(RMTilePoint) project: (RMProjectedPoint)aPoint atZoom:(float)zoom;
40-(RMTileRect) projectRect: (RMProjectedRect)aRect atZoom:(float)zoom;
41
42-(RMTilePoint) project: (RMProjectedPoint)aPoint atScale:(float)scale;
43-(RMTileRect) projectRect: (RMProjectedRect)aRect atScale:(float)scale;
44
45/// This is a helper for projectRect above. Much simpler for the caller.
46-(RMTileRect) project: (RMMercatorToScreenProjection*)screen;
47
48-(RMTile) normaliseTile: (RMTile) tile;
49
50-(float) normaliseZoom: (float) zoom;
51
52-(float) calculateZoomFromScale: (float) scale;
53-(float) calculateNormalisedZoomFromScale: (float) scale;
54-(float) calculateScaleFromZoom: (float) zoom;
55
56/// bounds of the earth, in projected units (meters).
57@property(readonly, nonatomic) RMProjectedRect planetBounds;
58
59/// Maximum zoom for which we have tile images 
60@property(readonly, nonatomic) NSUInteger maxZoom;
61/// Minimum zoom for which we have tile images 
62@property(readonly, nonatomic) NSUInteger minZoom;
63
64/// Tile side length in pixels
65@property(readonly, nonatomic) NSUInteger tileSideLength;
66
67@end