Merge remote-tracking branch 'openstreetmap/pull/1120'
[rails.git] / lib / bounding_box.rb
1 class BoundingBox
2   attr_reader :min_lon, :min_lat, :max_lon, :max_lat
3
4   LON_LIMIT = 180.0
5   LAT_LIMIT = 90.0
6   SCALED_LON_LIMIT = LON_LIMIT * GeoRecord::SCALE
7   SCALED_LAT_LIMIT = LAT_LIMIT * GeoRecord::SCALE
8
9   def initialize(min_lon, min_lat, max_lon, max_lat)
10     @min_lon = min_lon.to_f unless min_lon.nil?
11     @min_lat = min_lat.to_f unless min_lat.nil?
12     @max_lon = max_lon.to_f unless max_lon.nil?
13     @max_lat = max_lat.to_f unless max_lat.nil?
14   end
15
16   def self.from_s(s)
17     BoundingBox.new(*s.split(/,/)) if s.count(",") == 3
18   end
19
20   def self.from_bbox_params(params)
21     if params[:bbox] && params[:bbox].count(",") == 3
22       bbox_array = params[:bbox].split(",")
23     end
24     from_bbox_array(bbox_array)
25   end
26
27   def self.from_lon_lat_params(params)
28     if params[:minlon] && params[:minlat] && params[:maxlon] && params[:maxlat]
29       bbox_array = [params[:minlon], params[:minlat], params[:maxlon], params[:maxlat]]
30     end
31     from_bbox_array(bbox_array)
32   end
33
34   def self.from_lrbt_params(params)
35     if params[:l] && params[:b] && params[:t] && params[:t]
36       bbox_array = [params[:l], params[:b], params[:r], params[:t]]
37     end
38     from_bbox_array(bbox_array)
39   end
40
41   def expand!(bbox, margin = 0)
42     update!(bbox) unless complete?
43     # only try to expand the bbox if there is a value for every coordinate
44     # which there will be from the previous line as long as array does not contain a nil
45     if bbox.complete?
46       @min_lon = [-SCALED_LON_LIMIT,
47                   bbox.min_lon + margin * (min_lon - max_lon)].max if bbox.min_lon < min_lon
48       @min_lat = [-SCALED_LAT_LIMIT,
49                   bbox.min_lat + margin * (min_lat - max_lat)].max if bbox.min_lat < min_lat
50       @max_lon = [+SCALED_LON_LIMIT,
51                   bbox.max_lon + margin * (max_lon - min_lon)].min if bbox.max_lon > max_lon
52       @max_lat = [+SCALED_LAT_LIMIT,
53                   bbox.max_lat + margin * (max_lat - min_lat)].min if bbox.max_lat > max_lat
54     end
55     self
56   end
57
58   def check_boundaries
59     # check the bbox is sane
60     if min_lon > max_lon
61       raise OSM::APIBadBoundingBox.new(
62         "The minimum longitude must be less than the maximum longitude, but it wasn't")
63     end
64     if min_lat > max_lat
65       raise OSM::APIBadBoundingBox.new(
66         "The minimum latitude must be less than the maximum latitude, but it wasn't")
67     end
68     if min_lon < -LON_LIMIT || min_lat < -LAT_LIMIT || max_lon > +LON_LIMIT || max_lat > +LAT_LIMIT
69       raise OSM::APIBadBoundingBox.new("The latitudes must be between #{-LAT_LIMIT} and #{LAT_LIMIT}," +
70                                        " and longitudes between #{-LON_LIMIT} and #{LON_LIMIT}")
71     end
72     self
73   end
74
75   def check_size(max_area = MAX_REQUEST_AREA)
76     # check the bbox isn't too large
77     if area > max_area
78       raise OSM::APIBadBoundingBox.new("The maximum bbox size is " + max_area.to_s +
79         ", and your request was too large. Either request a smaller area, or use planet.osm")
80     end
81     self
82   end
83
84   ##
85   # returns area of the bbox as a rough comparative quantity
86   def area
87     if complete?
88       (max_lon - min_lon) * (max_lat - min_lat)
89     else
90       0
91     end
92   end
93
94   def complete?
95     !to_a.include?(nil)
96   end
97
98   def centre_lon
99     (min_lon + max_lon) / 2.0
100   end
101
102   def centre_lat
103     (min_lat + max_lat) / 2.0
104   end
105
106   def width
107     max_lon - min_lon
108   end
109
110   def height
111     max_lat - min_lat
112   end
113
114   def slippy_width(zoom)
115     width * 256.0 * 2.0**zoom / 360.0
116   end
117
118   def slippy_height(zoom)
119     min = min_lat * Math::PI / 180.0
120     max = max_lat * Math::PI / 180.0
121
122     Math.log((Math.tan(max) + 1.0 / Math.cos(max)) /
123              (Math.tan(min) + 1.0 / Math.cos(min))) *
124       (128.0 * 2.0**zoom / Math::PI)
125   end
126
127   # there are two forms used for bounds with and without an underscore,
128   # cater for both forms eg minlon and min_lon
129   def add_bounds_to(hash, underscore = "")
130     hash["min#{underscore}lat"] = min_lat.to_s
131     hash["min#{underscore}lon"] = min_lon.to_s
132     hash["max#{underscore}lat"] = max_lat.to_s
133     hash["max#{underscore}lon"] = max_lon.to_s
134     hash
135   end
136
137   def to_scaled
138     BoundingBox.new((min_lon * GeoRecord::SCALE),
139                     (min_lat * GeoRecord::SCALE),
140                     (max_lon * GeoRecord::SCALE),
141                     (max_lat * GeoRecord::SCALE))
142   end
143
144   def to_unscaled
145     BoundingBox.new((min_lon / GeoRecord::SCALE),
146                     (min_lat / GeoRecord::SCALE),
147                     (max_lon / GeoRecord::SCALE),
148                     (max_lat / GeoRecord::SCALE))
149   end
150
151   def to_a
152     [min_lon, min_lat, max_lon, max_lat]
153   end
154
155   def to_s
156     "#{min_lon},#{min_lat},#{max_lon},#{max_lat}"
157   end
158
159   class << self
160     private
161
162     def from_bbox_array(bbox_array)
163       unless bbox_array
164         raise OSM::APIBadUserInput.new(
165           "The parameter bbox is required, and must be of the form min_lon,min_lat,max_lon,max_lat")
166       end
167       # Take an array of length 4, create a bounding box with min_lon, min_lat, max_lon and
168       # max_lat within their respective boundaries.
169       min_lon = [[bbox_array[0].to_f, -LON_LIMIT].max, +LON_LIMIT].min
170       min_lat = [[bbox_array[1].to_f, -LAT_LIMIT].max, +LAT_LIMIT].min
171       max_lon = [[bbox_array[2].to_f, +LON_LIMIT].min, -LON_LIMIT].max
172       max_lat = [[bbox_array[3].to_f, +LAT_LIMIT].min, -LAT_LIMIT].max
173       BoundingBox.new(min_lon, min_lat, max_lon, max_lat)
174     end
175   end
176
177   def update!(bbox)
178     # ensure that bbox has no nils in it. if there are any
179     # nils, just use the bounding box update to write over them.
180     @min_lon = bbox.min_lon if min_lon.nil?
181     @min_lat = bbox.min_lat if min_lat.nil?
182     @max_lon = bbox.max_lon if max_lon.nil?
183     @max_lat = bbox.max_lat if max_lat.nil?
184   end
185 end