Class: Kamelopard::Feature
- 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
Instance Attribute Summary collapse
-
#abstractView ⇒ Object
Returns the value of attribute abstractView.
-
#addressDetails ⇒ Object
Returns the value of attribute addressDetails.
-
#atom_author ⇒ Object
Returns the value of attribute atom_author.
-
#atom_link ⇒ Object
Returns the value of attribute atom_link.
-
#description ⇒ Object
Returns the value of attribute description.
-
#extendedData ⇒ Object
Returns the value of attribute extendedData.
-
#metadata ⇒ Object
Returns the value of attribute metadata.
-
#name ⇒ Object
Returns the value of attribute name.
-
#open ⇒ Object
Returns the value of attribute open.
-
#phoneNumber ⇒ Object
Returns the value of attribute phoneNumber.
-
#region ⇒ Object
Returns the value of attribute region.
-
#snippet ⇒ Object
readonly
Returns the value of attribute snippet.
-
#styles ⇒ Object
Returns the value of attribute styles.
-
#styleSelector ⇒ Object
Returns the value of attribute styleSelector.
-
#styleUrl ⇒ Object
Returns the value of attribute styleUrl.
-
#timeprimitive ⇒ Object
Returns the value of attribute timeprimitive.
-
#visibility ⇒ Object
Returns the value of attribute visibility.
Attributes included from Snippet
Attributes inherited from Object
#comment, #kml_id, #master_only
Class Method Summary collapse
Instance Method Summary collapse
- #extended_data_to_kml(elem) ⇒ Object
-
#hide ⇒ Object
Hides the object.
-
#initialize(name = nil, options = {}) ⇒ Feature
constructor
A new instance of Feature.
-
#show ⇒ Object
Shows the object.
- #styles_to_kml(elem) ⇒ Object
- #timespan ⇒ Object
- #timespan=(t) ⇒ Object
- #timestamp ⇒ Object
- #timestamp=(t) ⇒ Object
- #to_kml(elem = nil) {|elem| ... } ⇒ Object
Methods included from Snippet
Methods inherited from Object
#_alternate_to_kml, #change, #master_only?, parse
Constructor Details
#initialize(name = nil, options = {}) ⇒ Feature
Returns a new instance of Feature.
849 850 851 852 853 854 855 |
# File 'lib/kamelopard/classes.rb', line 849 def initialize (name = nil, = {}) @visibility = true @open = false @styles = [] super @name = name unless name.nil? end |
Instance Attribute Details
#abstractView ⇒ Object
Returns the value of attribute abstractView.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def abstractView @abstractView end |
#addressDetails ⇒ Object
Returns the value of attribute addressDetails.
845 846 847 |
# File 'lib/kamelopard/classes.rb', line 845 def addressDetails @addressDetails end |
#atom_author ⇒ Object
Returns the value of attribute atom_author.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def @atom_author end |
#atom_link ⇒ Object
Returns the value of attribute atom_link.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def atom_link @atom_link end |
#description ⇒ Object
Returns the value of attribute description.
845 846 847 |
# File 'lib/kamelopard/classes.rb', line 845 def description @description end |
#extendedData ⇒ Object
Returns the value of attribute extendedData.
845 846 847 |
# File 'lib/kamelopard/classes.rb', line 845 def extendedData @extendedData end |
#metadata ⇒ Object
Returns the value of attribute metadata.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def @metadata end |
#name ⇒ Object
Returns the value of attribute name.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def name @name end |
#open ⇒ Object
Returns the value of attribute open.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def open @open end |
#phoneNumber ⇒ Object
Returns the value of attribute phoneNumber.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def phoneNumber @phoneNumber end |
#region ⇒ Object
Returns the value of attribute region.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def region @region end |
#snippet ⇒ Object (readonly)
Returns the value of attribute snippet.
845 846 847 |
# File 'lib/kamelopard/classes.rb', line 845 def snippet @snippet end |
#styles ⇒ Object
Returns the value of attribute styles.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def styles @styles end |
#styleSelector ⇒ Object
Returns the value of attribute styleSelector.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def styleSelector @styleSelector end |
#styleUrl ⇒ Object
Returns the value of attribute styleUrl.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def styleUrl @styleUrl end |
#timeprimitive ⇒ Object
Returns the value of attribute timeprimitive.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def timeprimitive @timeprimitive end |
#visibility ⇒ Object
Returns the value of attribute visibility.
842 843 844 |
# File 'lib/kamelopard/classes.rb', line 842 def visibility @visibility end |
Class Method Details
.add_author(o, a) ⇒ Object
930 931 932 933 934 935 936 |
# File 'lib/kamelopard/classes.rb', line 930 def self.(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
965 966 967 968 969 970 971 972 |
# File 'lib/kamelopard/classes.rb', line 965 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
884 885 886 |
# File 'lib/kamelopard/classes.rb', line 884 def hide @visibility = false end |
#show ⇒ Object
Shows the object. See note for hide() method
889 890 891 |
# File 'lib/kamelopard/classes.rb', line 889 def show @visibility = true end |
#styles_to_kml(elem) ⇒ Object
974 975 976 977 978 979 980 |
# File 'lib/kamelopard/classes.rb', line 974 def styles_to_kml(elem) # XXX Remove this raise "done here" if elem.class == Array @styles.each do |a| a.to_kml(elem) # unless a.attached? end end |
#timespan ⇒ Object
897 898 899 |
# File 'lib/kamelopard/classes.rb', line 897 def timespan @timeprimitive end |
#timespan=(t) ⇒ Object
905 906 907 |
# File 'lib/kamelopard/classes.rb', line 905 def timespan=(t) @timeprimitive = t end |
#timestamp ⇒ Object
893 894 895 |
# File 'lib/kamelopard/classes.rb', line 893 def @timeprimitive end |
#timestamp=(t) ⇒ Object
901 902 903 |
# File 'lib/kamelopard/classes.rb', line 901 def (t) @timeprimitive = t end |
#to_kml(elem = nil) {|elem| ... } ⇒ Object
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 |
# File 'lib/kamelopard/classes.rb', line 938 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.(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 |