/MapView/Map/RMProjection.h

 1//
 2//  RMProjection.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 <CoreLocation/CoreLocation.h>
30
31#import "RMFoundation.h"
32#import "RMLatLong.h"
33
34/// Objective-C wrapper for PROJ4 map projection definitions.
35@interface RMProjection : NSObject
36{
37	/// This is actually a PROJ4 projPJ, but it is typed as void* so the proj_api doesn't have to be included
38	void*		internalProjection;
39	
40	/// the size of the earth, in projected units (meters, most often)
41	RMProjectedRect	planetBounds;
42	
43	/// hardcoded to YES in #initWithString:InBounds:
44	BOOL		projectionWrapsHorizontally;
45}
46
47@property (readonly) void* internalProjection;
48@property (readonly) RMProjectedRect planetBounds;
49@property (readwrite) BOOL projectionWrapsHorizontally;
50
51/// If #projectionWrapsHorizontally, returns #aPoint with its easting adjusted modulo Earth's diameter to be within projection's planetBounds. if !#projectionWrapsHorizontally, returns #aPoint unchanged.
52- (RMProjectedPoint) wrapPointHorizontally: (RMProjectedPoint) aPoint;
53
54/// applies #wrapPointHorizontally to aPoint, and then clamps northing (Y coordinate) to projection's planetBounds
55- (RMProjectedPoint) constrainPointToBounds: (RMProjectedPoint) aPoint;
56
57+ (RMProjection *) googleProjection;
58+ (RMProjection *) EPSGLatLong;
59+ (RMProjection *) OSGB;
60
61/// anybody know what the InBounds: parameter means?
62- (id) initWithString: (NSString*)params InBounds: (RMProjectedRect) projBounds;
63
64/// inverse project meters, return latitude/longitude
65/// \deprecated rename pending after 0.5
66- (RMLatLong)pointToLatLong:(RMProjectedPoint)aPoint;
67/// forward project latitude/longitude, return meters
68/// \deprecated rename pending after 0.5
69- (RMProjectedPoint)latLongToPoint:(RMLatLong)aLatLong;
70
71@end