kamelopard 0.0.5 → 0.0.6

data/lib/kamelopard/classes.rb

@@ -4,6 +4,8 @@
 # http://code.google.com/apis/kml/documentation/kmlreference.html for a
 # description of KML
 
+# XXX gx:balloonVisibility isn't represented here. Fix that.
+
 module Kamelopard
     require 'singleton'
     require 'kamelopard/pointlist'
@@ -11,6 +13,7 @@ module Kamelopard
     require 'yaml'
 
     @@sequence = 0
+    @@id_prefix = ''
 
     def Kamelopard.get_document
         Document.instance
@@ -21,6 +24,14 @@ module Kamelopard
         @@sequence
     end
 
+    def Kamelopard.id_prefix=(a)
+        @@id_prefix = a
+    end
+
+    def Kamelopard.id_prefix
+        @@id_prefix
+    end
+
     #--
     # Intelligently adds elements to a KML object. Expects the KML object as the
     # first argument, an array as the second.  Each entry in the array is itself an
@@ -54,7 +65,7 @@ module Kamelopard
     # Accepts XdX'X.X", XDXmX.XXs, XdXmX.XXs, or X.XXXX with either +/- or N/E/S/W
     #++
     def Kamelopard.convert_coord(a)    # :nodoc
-        a = a.to_s.upcase.strip
+        a = a.to_s.upcase.strip.gsub(/\s+/, '')
 
         mult = 1
         if a =~ /^-/ then
@@ -80,6 +91,10 @@ module Kamelopard
             # coord is in d'"
             p = a.split /[D"']/
             a = p[0].to_f + (p[2].to_f / 60.0 + p[1].to_f) / 60.0
+        elsif m = (a =~ /^(\d+)°(\d+)'(\d+\.\d+)?"$/) then
+            # coord is in °'"
+            b = a
+            a = $1.to_f + ($3.to_f / 60.0 + $2.to_f) / 60.0
         else
             raise "Couldn't determine coordinate format for #{a}"
         end
@@ -103,13 +118,17 @@ module Kamelopard
     end
 
     # Base class for all Kamelopard objects. Manages object ID and a single
-    # comment string associated with the object
+    # comment string associated with the object. Object IDs are stored in the
+    # kml_id attribute, and are prefixed with the value last passed to
+    # Kamelopard.id_prefix=, if anything. Note that assigning this prefix will
+    # *not* change the IDs of Kamelopard objects that are already
+    # initialized... just ones initialized thereafter.
     class Object
         attr_accessor :kml_id
         attr_reader :comment
 
         def initialize(options = {})
-            @kml_id = "#{self.class.name.gsub('Kamelopard::', '')}_#{ Kamelopard.get_next_id }"
+            @kml_id = "#{Kamelopard.id_prefix}#{self.class.name.gsub('Kamelopard::', '')}_#{ Kamelopard.get_next_id }"
 
             options.each do |k, v|
                 method = "#{k}=".to_sym
@@ -164,8 +183,8 @@ module Kamelopard
 
         def initialize(longitude = nil, latitude = nil, altitude = nil, options = {})
             super options
-            @longitude = longitude unless longitude.nil?
-            @latitude = latitude unless latitude.nil?
+            @longitude = Kamelopard.convert_coord(longitude) unless longitude.nil?
+            @latitude = Kamelopard.convert_coord(latitude) unless latitude.nil?
             @altitude = altitude unless altitude.nil?
         end
 
@@ -357,8 +376,8 @@ module Kamelopard
 
             @heading = 0
             @tilt = 0
-            @roll = 0
-            @range = 0
+            @roll = nil
+            @range = nil
             @altitudeMode = :clampToGround
             @viewerOptions = {}
 
@@ -523,6 +542,7 @@ module Kamelopard
     # Corresponds to KML's TimeSpan object. @begin and @end must be in a format KML
     # understands.
     class TimeSpan < TimePrimitive
+    # XXX Evidence suggests this doesn't support unbounded intervals. Fix that, if it's true.
         attr_accessor :begin, :end
         def initialize(ts_begin = nil, ts_end = nil, options = {})
             super options
@@ -564,14 +584,61 @@ module Kamelopard
         end
     end
 
+    # Corresponds to Data elements within ExtendedData
+    class Data
+        attr_accessor :name, :displayName, :value
+        def initialize(name, value, displayName = nil)
+            @name = name
+            @displayName = displayName
+            @value = value
+        end
+
+        def to_kml(elem = nil)
+            v = XML::Node.new 'Data'
+            v.attributes['name'] = @name
+            Kamelopard.kml_array(v, [
+                    [@value, 'value'],
+                    [@displayName, 'displayName']
+                ])
+            elem << v unless elem.nil?
+            v
+        end
+    end
+
+    # ExtendedData SchemaData objects
+    class SchemaData
+        attr_accessor :schemaUrl, :simpleData
+        def initialize(schemaUrl, simpleData = {})
+            @schemaUrl = schemaUrl
+            raise "SchemaData's simpleData attribute should behave like a hash" unless simpleData.respond_to? :keys
+            @simpleData = simpleData
+        end
+
+        def <<(a)
+            @simpleData.merge a
+        end
+
+        def to_kml(elem = nil)
+            s = XML::Node.new 'SchemaData'
+            s.attributes['schemaUrl'] = @schemaUrl
+            @simpleData.each do |k, v|
+                sd = XML::Node.new 'SimpleData', v
+                sd.attributes['name'] = k
+                s << sd
+            end
+            elem << v unless elem.nil?
+            v
+        end
+    end
+
     # Abstract class corresponding to KML's Feature object.
+    # XXX Make this support alternate namespaces
     class Feature < Object
         # Abstract class
         attr_accessor :visibility, :open, :atom_author, :atom_link, :name,
-            :phoneNumber, :description, :abstractView,
-            :timeprimitive, :styleUrl, :styleSelector, :region, :metadata,
-            :extendedData, :styles
-        attr_reader :addressDetails, :snippet
+            :phoneNumber, :description, :abstractView, :styles,
+            :timeprimitive, :styleUrl, :styleSelector, :region, :metadata
+        attr_reader :addressDetails, :snippet, :extendedData
 
         include Snippet
 
@@ -583,6 +650,11 @@ module Kamelopard
             @name = name unless name.nil?
         end
 
+        def extendedData=(a)
+            raise "extendedData attribute must respond to the 'each' method" unless a.respond_to? :each
+            @extendedData = a
+        end
+
         def styles=(a)
             if a.is_a? Array then
                 @styles = a
@@ -665,11 +737,11 @@ module Kamelopard
                     [@description, 'description'],
                     [@styleUrl, 'styleUrl'],
                     [@styleSelector, lambda { |o| @styleSelector.to_kml(o) }],
-                    [@metadata, 'Metadata' ],
-                    [@extendedData, 'ExtendedData' ]
+                    [@metadata, 'Metadata' ]
                 ])
             styles_to_kml(elem)
             snippet_to_kml(elem) unless @snippet_text.nil?
+            extended_data_to_kml(elem) unless @extendedData.nil?
             @abstractView.to_kml(elem) unless @abstractView.nil?
             @timeprimitive.to_kml(elem) unless @timeprimitive.nil?
             @region.to_kml(elem) unless @region.nil?
@@ -677,9 +749,18 @@ module Kamelopard
             elem
         end
 
+        def extended_data_to_kml(elem)
+            v = XML::Node.new 'ExtendedData'
+            @extendedData.each do |f|
+                v << f.to_kml
+            end
+            elem << v unless elem.nil?
+            v
+        end
+
         def styles_to_kml(elem)
             @styles.each do |a|
-                a.to_kml(elem)
+                a.to_kml(elem) unless a.attached?
             end
         end
     end
@@ -767,27 +848,26 @@ module Kamelopard
     # scripts can (for now) manage only one Document at a time.
     class Document < Container
         include Singleton
-        attr_accessor :flyto_mode, :doc_folders, :doc_tours, :uses_xal, :doc_styles
+        attr_accessor :flyto_mode, :folders, :tours, :uses_xal
 
         def initialize(options = {})
-            @doc_tours = []
-            @doc_folders = []
-            @doc_styles = []
+            @tours = []
+            @folders = []
             super
         end
 
         # Returns the current Tour object
         def tour
-            Tour.new if @doc_tours.length == 0
-            @doc_tours.last
+            Tour.new if @tours.length == 0
+            @tours.last
         end
 
         # Returns the current Folder object
         def folder
-            if @doc_folders.size == 0 then
+            if @folders.size == 0 then
                 Folder.new
             end
-            @doc_folders.last
+            @folders.last
         end
 
         def get_kml_document
@@ -813,15 +893,16 @@ module Kamelopard
             super d
 
             # Print styles first
-            @doc_styles.map do |a| d << a.to_kml unless a.attached? end
+            #! These get printed out in the call to super, in Feature.to_kml()
+            #@styles.map do |a| d << a.to_kml unless a.attached? end
 
             # then folders
-            @doc_folders.map do |a|
+            @folders.map do |a|
                 a.to_kml(d) unless a.has_parent?
             end
 
             # then tours
-            @doc_tours.map do |a| a.to_kml(d) end
+            @tours.map do |a| a.to_kml(d) end
 
             d
         end
@@ -949,12 +1030,12 @@ module Kamelopard
        attr_accessor :href, :x, :y, :w, :h, :refreshMode, :refreshInterval, :viewRefreshMode, :viewRefreshTime, :viewBoundScale, :viewFormat, :httpQuery
 
         def href=(h)
-            @icon_id = "Icon_#{Kamelopard.get_next_id}" if @icon_id.nil?
+            @icon_id = "#{Kamelopard.id_prefix}Icon_#{Kamelopard.get_next_id}" if @icon_id.nil?
             @href = h
         end
 
         def icon_to_kml(elem = nil)
-            @icon_id = "Icon_#{Kamelopard.get_next_id}" if @icon_id.nil?
+            @icon_id = "#{Kamelopard.id_prefix}Icon_#{Kamelopard.get_next_id}" if @icon_id.nil?
             k = XML::Node.new 'Icon'
             k.attributes['id'] = @icon_id
             Kamelopard.kml_array(k, [
@@ -1145,7 +1226,7 @@ module Kamelopard
         def initialize(options = {})
             super
             @attached = false
-            Document.instance.doc_styles << self
+            Document.instance.styles << self
         end
 
         def attached?
@@ -1261,6 +1342,8 @@ module Kamelopard
         def point
             if @geometry.kind_of? Point then
                 @geometry
+            elsif @geometry.respond_to? :point then
+                @geometry.point
             else
                 raise "This placemark uses a non-point geometry, but the operation you're trying requires a point object"
             end
@@ -1291,6 +1374,8 @@ module Kamelopard
         def view=(view)
             if view.kind_of? AbstractView then
                 @view = view
+            elsif view.respond_to? :abstractView then
+                @view = view.abstractView
             else
                 @view = LookAt.new view
             end
@@ -1684,11 +1769,8 @@ module Kamelopard
         def initialize(icon, options = {})
             @altitude = 0
             @altitudeMode = :clampToGround
+            @href = icon
             super options
-            @latlonbox = latlonbox
-            @latlonquad = latlonquad
-            @altitude = altitude
-            @altitudeMode = altitudeMode
         end
 
         def to_kml(elem = nil)
@@ -1932,6 +2014,7 @@ module Kamelopard
             @extrude = 0
             @altitudeMode = :clampToGround
             @inner = []
+            @outer = outer
             super options
         end
 
@@ -2039,5 +2122,31 @@ module Kamelopard
         end
     end
 
+    class Track < Geometry
+        attr_accessor :altitudeMode, :when, :coord, :angles, :model
+        def initialize(options = {})
+            @when = []
+            @coord = []
+            @angles = []
+            super
+        end
+
+        def to_kml(elem = nil)
+            e = XML::Node.new 'gx:Track'
+            [
+                [ @coord, 'gx:coord' ],
+                [ @when, 'when' ],
+                [ @angles, 'gx:angles' ],
+            ].each do |a|
+                a[0].each do |g|
+                    w = XML::Node.new a[1], g.to_s
+                    e << w
+                end
+            end
+            elem << e unless elem.nil?
+            e
+        end
+    end
+
 end
 # End of Kamelopard module

data/lib/kamelopard/functions.rb

@@ -1,7 +1,7 @@
 # vim:ts=4:sw=4:et:smartindent:nowrap
 def fly_to(p, d = 0, r = 100, m = nil)
     m = Kamelopard::Document.instance.flyto_mode if m.nil?
-    Kamelopard::FlyTo.new(p, r, d, m)
+    Kamelopard::FlyTo.new p, :range => r, :duration => d, :mode => m
 end
 
 def set_flyto_mode_to(a)
@@ -15,7 +15,7 @@ def mod_popup_for(p, v)
     end
     a = XML::Node.new 'Change'
     b = XML::Node.new 'Placemark'
-    b.attributes['targetId'] = p.obj_id
+    b.attributes['targetId'] = p.kml_id
     c = XML::Node.new 'visibility'
     c << XML::Node.new_text(v.to_s)
     b << c
@@ -32,7 +32,8 @@ def show_popup_for(p)
 end
 
 def point(lo, la, alt=0, mode=nil, extrude = false)
-    Kamelopard::Point.new(lo, la, alt, mode.nil? ? :clampToGround : mode, extrude)
+    m = ( mode.nil? ? :clampToGround : mode )
+    Kamelopard::Point.new(lo, la, alt, :altitudeMode => m, :extrude => extrude)
 end
 
 # Returns the KML that makes up the current Kamelopard::Document, as a string.
@@ -58,6 +59,7 @@ end
 
 def name_folder(a)
     Kamelopard::Document.instance.folder.name = a
+    return Kamelopard::Document.instance.folder
 end
 
 def zoom_out(dist = 1000, dur = 0, mode = nil)
@@ -127,3 +129,155 @@ end
 #         fly_to 
 #     end
 # end
+
+def set_prefix_to(a)
+    Kamelopard.id_prefix = a
+end
+
+def write_kml_to(file = 'doc.kml')
+    File.open(file, 'w') do |f| f.write get_kml.to_s.gsub(/balloonVis/, 'gx:balloonVis') end
+end
+
+def fade_overlay(ov, show, options = {})
+    color = '00ffffff'
+    color = 'ffffffff' if show
+    if ov.is_a? String then
+        id = ov  
+    else
+        id = ov.kml_id
+    end
+    k = Kamelopard::AnimatedUpdate.new "<Change><ScreenOverlay targetId=\"#{id}\"><color>#{color}</color></ScreenOverlay></Change>", options 
+    k
+end
+
+def mod_balloon_for(a, val)
+    c = a.change('gx:balloonVisibility', val).to_s
+    STDERR.puts c
+    Kamelopard::AnimatedUpdate.new c
+end
+
+def show_balloon_for(a)
+    Kamelopard::AnimatedUpdate.new %{<Change><Placemark targetId="#{a.kml_id}"><balloonVisibility>1</balloonVisibility></Placemark></Change>}
+end
+
+def hide_balloon_for(a)
+    Kamelopard::AnimatedUpdate.new %{<Change><Placemark targetId="#{a.kml_id}"><balloonVisibility>0</balloonVisibility></Placemark></Change>}
+end
+
+module TelemetryProcessor
+    Pi = 3.1415926535
+
+    def TelemetryProcessor.get_heading(p)
+        x1, y1, x2, y2 = [ p[1][0], p[1][1], p[2][0], p[2][1] ]
+
+        h = Math.atan((x2-x1) / (y2-y1)) * 180 / Pi
+        h = h + 180.0 if y2 < y1
+        h
+    end
+
+    def TelemetryProcessor.get_dist2(x1, y1, x2, y2)
+        Math.sqrt( (x2 - x1)**2 + (y2 - y1)**2).abs
+    end
+
+    def TelemetryProcessor.get_dist3(x1, y1, z1, x2, y2, z2)
+        Math.sqrt( (x2 - x1)**2 + (y2 - y1)**2 + (z2 - z1)**2 ).abs
+    end
+
+    def TelemetryProcessor.get_tilt(p)
+        x1, y1, z1, x2, y2, z2 = [ p[1][0], p[1][1], p[1][2], p[2][0], p[2][1], p[2][2] ]
+        smoothing_factor = 10.0
+        dist = get_dist3(x1, y1, z1, x2, y2, z2)
+        dist = dist + 1
+                # + 1 to avoid setting dist to 0, and having div-by-0 errors later
+        t = Math.atan((z2 - z1) / dist) * 180 / Pi / @@options[:exaggerate]
+                # the / 2.0 is just because it looked nicer that way
+        90.0 + t
+    end
+
+        # roll = get_roll(last_last_lon, last_last_lat, last_lon, last_lat, lon, lat)
+    def TelemetryProcessor.get_roll(p)
+        x1, y1, x2, y2, x3, y3 = [ p[0][0], p[0][1], p[1][0], p[1][1], p[2][0], p[2][1] ]
+        return 0 if x1.nil? or x2.nil?
+
+        # Measure roll based on angle between P1 -> P2 and P2 -> P3. To be really
+        # exact I ought to take into account altitude as well, but ... I don't want
+        # to
+
+        # Set x2, y2 as the origin
+        xn1 = x1 - x2
+        xn3 = x3 - x2
+        yn1 = y1 - y2
+        yn3 = y3 - y2
+        
+        # Use dot product to get the angle between the two segments
+        angle = Math.acos( ((xn1 * xn3) + (yn1 * yn3)) / (get_dist2(0, 0, xn1, yn1).abs * get_dist2(0, 0, xn3, yn3).abs) ) * 180 / Pi
+
+#    angle = angle > 90 ? 90 : angle
+        @@options[:exaggerate] * (angle - 180)
+    end
+
+    def TelemetryProcessor.fix_coord(a)
+        a = a - 360 if a > 180
+        a = a + 360 if a < -180
+        a
+    end
+
+    def TelemetryProcessor.add_flyto(p)
+        # p is an array of three points, where p[0] is the earliest. Each point is itself an array of [longitude, latitude, altitude].
+        p2 = TelemetryProcessor::normalize_points p
+        p = p2
+        heading = get_heading p
+        tilt = get_tilt p
+        # roll = get_roll(last_last_lon, last_last_lat, last_lon, last_lat, lon, lat)
+        roll = get_roll p
+        #p = Kamelopard::Point.new last_lon, last_lat, last_alt, { :altitudeMode => :absolute }
+        point = Kamelopard::Point.new p[1][0], p[1][1], p[1][2], { :altitudeMode => :absolute }
+        c = Kamelopard::Camera.new point, { :heading => heading, :tilt => tilt, :roll => roll, :altitudeMode => :absolute }
+        f = Kamelopard::FlyTo.new c, { :duration => @@options[:pause], :mode => :smooth }
+        f.comment = "#{p[1][0]} #{p[1][1]} #{p[1][2]} to #{p[2][0]} #{p[2][1]} #{p[2][2]}"
+    end
+
+    def TelemetryProcessor.options=(a)
+        @@options = a
+    end
+
+    def TelemetryProcessor.normalize_points(p)
+        # The whole point here is to prevent problems when you cross the poles or the dateline
+        # This could have serious problems if points are really far apart, like
+        # hundreds of degrees. This seems unlikely.
+        lons = ((0..2).collect { |i| p[i][0] })
+        lats = ((0..2).collect { |i| p[i][1] })
+
+        lon_min, lon_max = lons.minmax
+        lat_min, lat_max = lats.minmax
+
+        if (lon_max - lon_min).abs > 200 then
+            (0..2).each do |i|
+                lons[i] += 360.0 if p[i][0] < 0
+            end
+        end
+
+        if (lat_max - lat_min).abs > 200 then
+            (0..2).each do |i|
+                lats[i] += 360.0 if p[i][1] < 0
+            end
+        end
+
+        return [
+            [ lons[0], lats[0], p[0][2] ],
+            [ lons[1], lats[1], p[1][2] ],
+            [ lons[2], lats[2], p[2][2] ],
+        ]
+    end
+end
+
+def tour_from_points(points, options = {})
+    options.merge!({
+        :pause => 1,
+        :exaggerate => 1
+    }) { |key, old, new| old }
+    TelemetryProcessor.options = options
+    (0..(points.size-3)).each do |i|
+        TelemetryProcessor::add_flyto points[i,3]
+    end
+end

data/lib/kamelopard/pointlist.rb

@@ -59,14 +59,12 @@ class NDPointList
             raise "NDPointList of size #{@dim} has no Z element"
         end
     end
-
+    
     def each(&blk)
         @points.each(&blk)
     end
 
-    def interpolate(resolution = nil)
-        # XXX Figure out how to implement the "resolution" argument
-        STDERR.puts "resolution argument to NDPointList.interpolate is ignored" if resolution.nil?
+    def interpolate(resolution = [10])
         # Ruby implementation of Catmull-Rom splines (http://www.cubic.org/docs/hermite.htm)
         # Return NDPointList interpolating a path along all points in this list
 
@@ -79,6 +77,9 @@ class NDPointList
 
         result = NDPointList.new(@dim)
 
+        idx = 0
+        resolution = [resolution] if ! resolution.respond_to? []
+
         # Calculate spline between every two points
         (0..(self.size-2)).each do |i|
             p1 = self[i]
@@ -96,13 +97,16 @@ class NDPointList
             c = Matrix[p1, p2, t1.row(0), t2.row(0)]
 
             # Make a set of points
-            (0..10).each do |t|
+            point_count = (resolution[idx] * 1.0 / self.size).to_i
+            (0..point_count).each do |t|
                 r = t/10.0
                 s = Matrix[[r**3, r**2, r, 1]]
                 tmp = s * h
                 p = tmp * c
                 result << p.row(0).to_a
             end
+            idx += 1
+            idx = 0 if idx >= resolution.size
         end
         result
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: kamelopard
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Joshua Tolley
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-17 00:00:00 -07:00
-default_executable: 
+date: 2012-05-04 00:00:00 Z
 dependencies: []
 
 description: Various classes and functions used to ease development of KML files, in particular for development of Google Earth tours
@@ -36,7 +35,6 @@ files:
 - lib/kamelopard/functions.rb
 - lib/kamelopard/pointlist.rb
 - lib/kamelopard.rb
-has_rdoc: true
 homepage: http://www.endpoint.com/services/liquid_galaxy
 licenses: []
 
@@ -66,7 +64,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.3
+rubygems_version: 1.8.21
 signing_key: 
 specification_version: 3
 summary: Tools for building KML