Class: Geokit::Bounds
- Inherits:
-
Object
- Object
- Geokit::Bounds
- Defined in:
- lib/geokit/mappable.rb
Overview
Bounds represents a rectangular bounds, defined by the SW and NE corners
Instance Attribute Summary collapse
-
#ne ⇒ Object
sw and ne are LatLng objects.
-
#sw ⇒ Object
sw and ne are LatLng objects.
Class Method Summary collapse
-
.from_point_and_radius(point, radius, options = {}) ⇒ Object
returns an instance of bounds which completely encompases the given circle.
-
.normalize(thing, other = nil) ⇒ Object
Takes two main combinations of arguments to create a bounds: point,point (this is the only one which takes two arguments [point,point] . . . where a point is anything LatLng#normalize can handle (which is quite a lot).
Instance Method Summary collapse
-
#==(other) ⇒ Object
Returns true if the candidate object is logically equal.
-
#center ⇒ Object
returns the a single point which is the center of the rectangular bounds.
-
#contains?(point) ⇒ Boolean
Returns true if the bounds contain the passed point.
-
#crosses_meridian? ⇒ Boolean
returns true if the bounds crosses the international dateline.
-
#initialize(sw, ne) ⇒ Bounds
constructor
provide sw and ne to instantiate a new Bounds instance.
-
#to_a ⇒ Object
a two-element array of two-element arrays: sw,ne.
-
#to_s ⇒ Object
a simple string representation:sw,ne.
-
#to_span ⇒ Object
Equivalent to Google Maps API’s .toSpan() method on GLatLng’s.
Constructor Details
Instance Attribute Details
#ne ⇒ Object
sw and ne are LatLng objects
442 443 444 |
# File 'lib/geokit/mappable.rb', line 442 def ne @ne end |
#sw ⇒ Object
sw and ne are LatLng objects
442 443 444 |
# File 'lib/geokit/mappable.rb', line 442 def sw @sw end |
Class Method Details
.from_point_and_radius(point, radius, options = {}) ⇒ Object
returns an instance of bounds which completely encompases the given circle
502 503 504 505 506 507 508 509 510 511 |
# File 'lib/geokit/mappable.rb', line 502 def from_point_and_radius(point,radius,={}) point=LatLng.normalize(point) p0=point.endpoint(0,radius,) p90=point.endpoint(90,radius,) p180=point.endpoint(180,radius,) p270=point.endpoint(270,radius,) sw=Geokit::LatLng.new(p180.lat,p270.lng) ne=Geokit::LatLng.new(p0.lat,p90.lng) Geokit::Bounds.new(sw,ne) end |
.normalize(thing, other = nil) ⇒ Object
Takes two main combinations of arguments to create a bounds: point,point (this is the only one which takes two arguments
- point,point
-
. . . where a point is anything LatLng#normalize can handle (which is quite a lot)
NOTE: everything combination is assumed to pass points in the order sw, ne
519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/geokit/mappable.rb', line 519 def normalize (thing,other=nil) # maybe this will be simple -- an actual bounds object is passed, and we can all go home return thing if thing.is_a? Bounds # no? OK, if there's no "other," the thing better be a two-element array thing,other=thing if !other && thing.is_a?(Array) && thing.size==2 # Now that we're set with a thing and another thing, let LatLng do the heavy lifting. # Exceptions may be thrown Bounds.new(Geokit::LatLng.normalize(thing),Geokit::LatLng.normalize(other)) end |
Instance Method Details
#==(other) ⇒ Object
Returns true if the candidate object is logically equal. Logical equivalence is true if the lat and lng attributes are the same for both objects.
485 486 487 |
# File 'lib/geokit/mappable.rb', line 485 def ==(other) other.is_a?(Bounds) ? self.sw == other.sw && self.ne == other.ne : false end |
#center ⇒ Object
returns the a single point which is the center of the rectangular bounds
451 452 453 |
# File 'lib/geokit/mappable.rb', line 451 def center @sw.midpoint_to(@ne) end |
#contains?(point) ⇒ Boolean
Returns true if the bounds contain the passed point. allows for bounds which cross the meridian
467 468 469 470 471 472 473 474 475 476 |
# File 'lib/geokit/mappable.rb', line 467 def contains?(point) point=Geokit::LatLng.normalize(point) res = point.lat > @sw.lat && point.lat < @ne.lat if crosses_meridian? res &= point.lng < @ne.lng || point.lng > @sw.lng else res &= point.lng < @ne.lng && point.lng > @sw.lng end res end |
#crosses_meridian? ⇒ Boolean
returns true if the bounds crosses the international dateline
479 480 481 |
# File 'lib/geokit/mappable.rb', line 479 def crosses_meridian? @sw.lng > @ne.lng end |
#to_a ⇒ Object
a two-element array of two-element arrays: sw,ne
461 462 463 |
# File 'lib/geokit/mappable.rb', line 461 def to_a [@sw.to_a, @ne.to_a] end |
#to_s ⇒ Object
a simple string representation:sw,ne
456 457 458 |
# File 'lib/geokit/mappable.rb', line 456 def to_s "#{@sw.to_s},#{@ne.to_s}" end |
#to_span ⇒ Object
Equivalent to Google Maps API’s .toSpan() method on GLatLng’s.
Returns a LatLng object, whose coordinates represent the size of a rectangle defined by these bounds.
493 494 495 496 497 |
# File 'lib/geokit/mappable.rb', line 493 def to_span lat_span = (@ne.lat - @sw.lat).abs lng_span = (crosses_meridian? ? 360 + @ne.lng - @sw.lng : @ne.lng - @sw.lng).abs Geokit::LatLng.new(lat_span, lng_span) end |