Class: Kamelopard::Feature

Inherits:
Object
  • Object
show all
Includes:
Snippet
Defined in:
lib/kamelopard/classes.rb

Overview

Abstract class corresponding to KML’s Feature object. – XXX Make this support alternate namespaces ++

Direct Known Subclasses

Container, NetworkLink, Overlay, Placemark

Instance Attribute Summary collapse

Attributes included from Snippet

#maxLines, #snippet_text

Attributes inherited from Object

#comment, #kml_id, #master_only

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Snippet

#snippet_to_kml

Methods inherited from Object

#_alternate_to_kml, #change, #master_only?

Constructor Details

#initialize(name = nil, options = {}) ⇒ Feature

Returns a new instance of Feature.


780
781
782
783
784
785
786
 
# File 'lib/kamelopard/classes.rb', line 780

def initialize (name = nil, options = {})
    @visibility = true
    @open = false
    @styles = []
    super options
    @name = name unless name.nil?
end

Instance Attribute Details

#abstractView ⇒ Object

Returns the value of attribute abstractView.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def abstractView
  @abstractView
end

#addressDetails ⇒ Object

Returns the value of attribute addressDetails.


776
777
778
 
# File 'lib/kamelopard/classes.rb', line 776

def addressDetails
  @addressDetails
end

#atom_author ⇒ Object

Returns the value of attribute atom_author.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def atom_author
  @atom_author
end

#atom_link ⇒ Object

Returns the value of attribute atom_link.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def atom_link
  @atom_link
end

#description ⇒ Object

Returns the value of attribute description.


776
777
778
 
# File 'lib/kamelopard/classes.rb', line 776

def description
  @description
end

#extendedData ⇒ Object

Returns the value of attribute extendedData.


776
777
778
 
# File 'lib/kamelopard/classes.rb', line 776

def extendedData
  @extendedData
end

#metadata ⇒ Object

Returns the value of attribute metadata.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def name
  @name
end

#open ⇒ Object

Returns the value of attribute open.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def open
  @open
end

#phoneNumber ⇒ Object

Returns the value of attribute phoneNumber.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def phoneNumber
  @phoneNumber
end

#region ⇒ Object

Returns the value of attribute region.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def region
  @region
end

#snippet ⇒ Object (readonly)

Returns the value of attribute snippet.


776
777
778
 
# File 'lib/kamelopard/classes.rb', line 776

def snippet
  @snippet
end

#styles ⇒ Object

Returns the value of attribute styles.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def styles
  @styles
end

#styleSelector ⇒ Object

Returns the value of attribute styleSelector.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def styleSelector
  @styleSelector
end

#styleUrl ⇒ Object

Returns the value of attribute styleUrl.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def styleUrl
  @styleUrl
end

#timeprimitive ⇒ Object

Returns the value of attribute timeprimitive.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def timeprimitive
  @timeprimitive
end

#visibility ⇒ Object

Returns the value of attribute visibility.


773
774
775
 
# File 'lib/kamelopard/classes.rb', line 773

def visibility
  @visibility
end

Class Method Details

.add_author(o, a) ⇒ Object 


861
862
863
864
865
866
867
 
# File 'lib/kamelopard/classes.rb', line 861

def self.add_author(o, a)
    e = XML::Node.new 'atom:name'
    e << a.to_s
    f = XML::Node.new 'atom:author'
    f << e
    o << f
end

Instance Method Details

#extended_data_to_kml(elem) ⇒ Object 


896
897
898
899
900
901
902
903
 
# File 'lib/kamelopard/classes.rb', line 896

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

#hide ⇒ Object

Hides the object. Note that this governs only whether the object is initially visible or invisible; to show or hide the feature dynamically during a tour, use an AnimatedUpdate object


815
816
817
 
# File 'lib/kamelopard/classes.rb', line 815

def hide
    @visibility = false
end

#show ⇒ Object

Shows the object. See note for hide() method


820
821
822
 
# File 'lib/kamelopard/classes.rb', line 820

def show
    @visibility = true
end

#styles_to_kml(elem) ⇒ Object 


905
906
907
908
909
910
 
# File 'lib/kamelopard/classes.rb', line 905

def styles_to_kml(elem)
    raise "done here" if elem.class == Array
    @styles.each do |a|
        a.to_kml(elem) unless a.attached?
    end
end

#timespan ⇒ Object 


828
829
830
 
# File 'lib/kamelopard/classes.rb', line 828

def timespan
    @timeprimitive
end

#timespan=(t) ⇒ Object 


836
837
838
 
# File 'lib/kamelopard/classes.rb', line 836

def timespan=(t)
    @timeprimitive = t
end

#timestamp ⇒ Object 


824
825
826
 
# File 'lib/kamelopard/classes.rb', line 824

def timestamp
    @timeprimitive
end

#timestamp=(t) ⇒ Object 


832
833
834
 
# File 'lib/kamelopard/classes.rb', line 832

def timestamp=(t)
    @timeprimitive = t
end

#to_kml(elem = nil) {|elem| ... } ⇒ Object

Yields:

  • (elem) 

869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/kamelopard/classes.rb', line 869

def to_kml(elem = nil)
    elem = XML::Node.new 'Feature' if elem.nil?
    super elem
    Kamelopard.kml_array(elem, [
            [@name, 'name'],
            [(@visibility.nil? || @visibility) ? 1 : 0, 'visibility'],
            [(! @open.nil? && @open) ? 1 : 0, 'open'],
            [@atom_author, lambda { |o| Feature.add_author(o, @atom_author) }],
            [@atom_link, 'atom:link'],
            [@address, 'address'],
            [@addressDetails, 'xal:AddressDetails'],
            [@phoneNumber, 'phoneNumber'],
            [@description, 'description'],
            [@styleUrl, 'styleUrl'],
            [@styleSelector, lambda { |o| @styleSelector.to_kml(o) }],
            [@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?
    yield(elem) if block_given?
    elem
end