kml_polygon 2.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWQ1ZTIzMTI4MzNiNTE3OTI3NWMzOThlNDRiN2RlMTk2MmY3Y2JjMQ==
+  data.tar.gz: !binary |-
+    OTc4NWRkN2JjZGZkNmViMzk5NDMxMDZiODM2MTkzNzViMjQ5YzRjYg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YTJlMjBmNGRjYjdkMTM2NjBmMjc3YzMzNmQ5NDlhYzkyYjg3MmIxZTEyMGUx
+    OWJiNGJjOTNiZjcwNzZmZmNiZDBmZjQ1M2ZhMDRmOGY3NTAwZGIzMzlmOTk1
+    NmYzNDFkZGU5NGI5MjZmZTM5NGM3YTdkOGQ5NzEwNWRhN2MyMzE=
+  data.tar.gz: !binary |-
+    ODkxZTM0YjI1MzAyZWFiMjM1ZTE3NThhOTVhMDRhZDVkYmViNDE2NmE3YzEz
+    YmJjY2Y2ZTk4NjBkZjU3MWUyZGI4YTM2MjFkYWQxZWZhZDA5YmNlOGUzYzk0
+    MjAxM2VhMTY5ODYzN2Q2YjJiNmMzNDgzMTFjMjdmMTY4NDIwYTI=

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kml_polygon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2007 Nick Galbreath, (c) 2013 Matthew Brookes
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/README.md

@@ -0,0 +1,82 @@
+
+=======
+kml_polygon
+===========
+
+Google earth doesn't provide polygon primitives, leaving you to generate them as a series of points.
+
+Given only a center-point (longitude/latitude) and radius, this Gem makes it easy to create
+(n) sided polygons (sufficient sides giving a circle) or stars, for inclusion in a KML file.
+
+All credit to  Nick Galbreath for the original code, and for providing it an a portable format. Thanks!
+(http://blog.client9.com/2007/09/drawing-circles-and-stars-on-google.html)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kml_polygon', :git => 'git://github.com/mbrookes/kml_polygon.git'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kml_polygon
+
+## Usage
+
+    kml_regular_polygon(longitude, latitude, radius, [sides=20, rotate=0])
+    kml_star(longitude, latitude, radius, inner_radius, [sides=10, rotate=0])
+
+Returns a string suitable for adding into a KML file.
+
+### kml_regular_polygon
+
+    kml_regular_polygon(longitude, latitude, radius, [sides=0, rotate=0])
+
+Regular polygon
+
+    longitude, latitude - center point in decimal degrees
+    radius              - radius in meters
+    segments            - number of sides, > 20 looks like a circle (optional, default: 20)
+    rotate              - rotate polygon <rotate> degrees (optional, default: 0)
+
+### kml_star
+
+    kml_star(longitude, latitude, radius, inner_radius, [sides=10, rotate=0])
+
+Make a "star" or "burst" pattern
+
+    longitude, latitude - center point in decimal degrees
+    radius              - radius in meters
+    inner_radius        - radius in meters, typically < outer_radius
+    segments            - number of "points" on the star (optional, default: 10)
+    rotate              - rotate polygon by <rotate> degrees (optional, default: 0)
+
+### For Example:
+    # kml_polygon_example.rb
+    include kml_polygon
+    circle = kml_regular_polygon(-95, 50, 70000)
+    star = kml_star(-95,45, 70000, 50000)
+    puts "<kml><Document>
+          <Style id='polygon1'><PolyStyle><color>7fff0000</color></PolyStyle></Style>
+          <Style id='polygon2'><PolyStyle><color>7f0000ff</color></PolyStyle></Style>
+          <Placemark><styleUrl>polygon1</styleUrl><Polygon>" << circle << "</Polygon></Placemark>
+          <Placemark><styleUrl>polygon2</styleUrl><Polygon>" << star << "</Polygon></Placemark>
+          </Document></kml>"
+
+Outputs a minimal but funtional KML file with one circle and one star in semi-transparent colors.
+
+## Contributing
+
+1. Fork it (`git clone git://github.com/mbrookes/kml_polygon.git`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kml_polygon.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require './lib/kml_polygon/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "kml_polygon"
+  gem.version       = KmlPolygon::VERSION
+  gem.authors       = ["Nick Galbreath", "Matthew Brookes"]
+  gem.email         = ["kml_polygon@nospam.33m.co"]
+  gem.description   = %q{Generate KML polygons (circle, star etc.) from lat/long and radius
+                         A port of http://blog.client9.com/2007/09/drawing-circles-and-stars-on-google.html}
+  gem.summary       = %q{Output a KML fragment defining a polygon (eg. a circle or star) about a point}
+  gem.homepage      = "https://github.com/mbrookes/kml_polygon"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.license       = "MIT"
+end

data/lib/kml_polygon.rb

@@ -0,0 +1,193 @@
+#
+#The MIT License
+#
+# Copyright (c) 2007 Nick Galbreath, (c) 2013 Matthew Brookes
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+#
+
+#
+# Version 2.0.2 - 29-Mar-2013 More idomatic Ruby,
+#                             Renamed to kml_polygon to better reflection function
+# Version 2.0.1 - 29-Mar-2013 Translation to Ruby Gem
+#                             No CLI
+# Version 2     - 12-Sept-2007 Simplified XML output
+#                              Added commandline interface
+#
+# Version 1     - 10-Sept-2007 Initial release
+#
+
+#require 'kml_polygon/version'
+
+module KmlPolygon
+  extend self
+
+  include Math
+
+  # constant to convert to degrees
+  DEGREES = 180.0 / PI
+  # constant to convert to radians
+  RADIANS = PI / 180.0
+  # Mean Radius of Earth, radius
+  EARTH_MEAN_RADIUS = 6378.1 * 1000.0
+
+#
+# Convert (x,y,z) on unit sphere
+# back to (longitude, latitude)
+#
+# p is vector of three elements
+#
+  def to_earth(p)
+    p[0] == 0.0 ? longitude = PI / 2.0 :longitude = Math.atan(p[1]/p[0])
+    latitude = PI / 2.0 - Math.acos(p[2])
+
+    # select correct branch of arctan
+    (p[1] <= 0.0 ? longitude = -(PI - longitude) : longitude = PI + longitude) if p[0] < 0.0
+    [longitude * DEGREES, latitude * DEGREES]
+  end
+
+#
+# convert longitude, latitude IN RADIANS to (x,y,z)
+#
+  def to_cart(longitude, latitude)
+    theta = longitude
+    # spherical coordinate use "co-latitude", not "latitude"
+    # lattiude = [-90, 90] with 0 at equator
+    # co-latitude = [0, 180] with 0 at north pole
+    phi = PI / 2.0 - latitude
+    [Math.cos(theta) * Math.sin(phi), Math.sin(theta) * Math.sin(phi), Math.cos(phi)]
+  end
+
+# spoints -- get raw list of points in longitude,latitude format
+#
+# radius: radius of polygon in meters
+# sides:  number of sides
+# rotate: rotate polygon by number of degrees
+#
+# Returns a list of points comprising the object
+#
+  def spoints(longitude, latitude, radius, sides, rotate=0)
+
+    rotate_radians = rotate * RADIANS
+
+    # compute longitude degrees (in radians) at given latitude
+    r = radius / (EARTH_MEAN_RADIUS * Math.cos(latitude * RADIANS))
+
+    vector = to_cart(longitude * RADIANS, latitude * RADIANS)
+    point = to_cart(longitude * RADIANS + r, latitude * RADIANS)
+    points = []
+
+    for side in 0...sides
+      points << to_earth(rotate_point(vector, point, rotate_radians + (2.0 * PI/sides)*side))
+    end
+
+    # Connect to starting point exactly
+    # Not sure if required, but seems to help when the polygon is not filled
+    points << points[0]
+  end
+
+#
+# rotate point around unit vector by phi radians
+# http://blog.modp.com/2007/09/rotating-point-around-vector.html
+#
+  def rotate_point(vector, point, phi)
+    # remap vector for sanity
+    u, v, w, x, y, z = vector[0], vector[1], vector[2], point[0], point[1], point[2]
+
+    a = u*x + v*y + w*z
+    d = Math.cos(phi)
+    e = Math.sin(phi)
+
+    [(a*u + (x - a*u)*d + (v*z - w*y) * e),
+     (a*v + (y - a*v)*d + (w*x - u*z) * e),
+     (a*w + (z - a*w)*d + (u*y - v*x) * e)]
+  end
+
+  #
+  # Output points formatted as a KML string
+  #
+  # You may want to edit this function to change "extrude" and other XML nodes.
+  #
+  def points_to_kml(points)
+
+    kml_string = "<Polygon>\n"
+    kml_string << "  <outerBoundaryIs><LinearRing><coordinates>\n"
+
+    points.each do |point|
+      kml_string << "    " << point[0].to_s << "," << point[1].to_s << "\n"
+    end
+
+    kml_string << "  </coordinates></LinearRing></outerBoundaryIs>\n"
+    kml_string << "</Polygon>\n"
+
+    # kml_string << "  <extrude>1</extrude>\sides"
+    # kml_string << "  <altitudeMode>clampToGround</altitudeMode>\sides"
+  end
+
+#
+# kml_regular_polygon    - Regular polygon
+#
+#  (longitude, latitude) - center point in decimal degrees
+#  radius                - radius in meters
+#  segments              - number of sides, > 20 looks like a circle (optional, default: 20)
+#  rotate                - rotate polygon by number of degrees (optional, default: 0)
+#
+# Returns a string suitable for adding into a KML file.
+#
+  def kml_regular_polygon(longitude, latitude, radius, segments=20, rotate=0)
+    points_to_kml(spoints(longitude, latitude, radius, segments, rotate))
+  end
+
+#
+# kml_star - Make a "star" or "burst" pattern
+#
+#  (longitude, latitude) - center point in decimal degrees
+#  radius                - radius in meters
+#  innner_radius         - radius in meters, typically < outer_radius
+#  segments              - number of "points" on the star (optional, default: 10)
+#  rotate                - rotate polygon by number of degrees (optional, default: 0)
+#
+# Returns a string suitable for adding into a KML file.
+#
+  def kml_star(longitude, latitude, radius, inner_radius, segments=10, rotate=0)
+    outer_points = spoints(longitude, latitude, radius, segments, rotate)
+    inner_points = spoints(longitude, latitude, inner_radius, segments, rotate + 180.0 / segments)
+
+    # interweave the radius and inner_radius points
+    # I'm sure there is a better way
+    points = []
+    for point in 0...outer_points.length
+      points << outer_points[point]
+      points << inner_points[point]
+    end
+
+    # MTB - Drop the last overlapping point leaving start and end points connecting
+    # (resulting output differs from orig, but is more correct)
+    points.pop
+
+    points_to_kml(points)
+  end
+
+end
+
+#
+# Examples
+#
+# puts KmlPolygon::kml_star(45,45, 70000, 50000)
+# puts KmlPolygon::kml_regular_polygon(50, 50, 70000)

data/lib/kml_polygon/version.rb

@@ -0,0 +1,3 @@
+module KmlPolygon
+  VERSION = "2.0.2"
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: kml_polygon
+version: !ruby/object:Gem::Version
+  version: 2.0.2
+platform: ruby
+authors:
+- Nick Galbreath
+- Matthew Brookes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-30 00:00:00.000000000 Z
+dependencies: []
+description: ! "Generate KML polygons (circle, star etc.) from lat/long and radius\n
+  \                        A port of http://blog.client9.com/2007/09/drawing-circles-and-stars-on-google.html"
+email:
+- kml_polygon@nospam.33m.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- kml_polygon.gemspec
+- lib/kml_polygon.rb
+- lib/kml_polygon/version.rb
+homepage: https://github.com/mbrookes/kml_polygon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Output a KML fragment defining a polygon (eg. a circle or star) about a point
+test_files: []