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