sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/SelectionObserver.rb

@@ -0,0 +1,115 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to selection events. To
+# implement this observer, create a Ruby class of this type, override the
+# desired methods, and add an instance of the observer to the objects of
+# interests.
+#
+# @example
+#   # This is an example of an observer that watches the selection for
+#   # changes.
+#   class MySelectionObserver < Sketchup::SelectionObserver
+#     def onSelectionBulkChange(selection)
+#       puts "onSelectionBulkChange: #{selection}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::SelectionObserver
+
+  # Instance Methods
+
+  #
+  # @example
+  #   def onSelectionAdded(selection, entity)
+  #     puts "onSelectionAdded: #{entity}"
+  #   end
+  #
+  # @note This event might not trigger even if a single element is selected. For
+  #   instance the Selection tool will trigger #onSelectionBulkChange regardless.
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @return [nil]
+  #
+  # @see onSelectionBulkChange
+  #
+  # @version SketchUp 6.0
+  def onSelectionAdded(selection, entity)
+  end
+
+  # The {#onSelectionBulkChange} method is called whenever items are added or
+  # removed from the selection set.
+  #
+  # The {#onSelectionBulkChange} callback will not trigger if the selection
+  # is cleared by clicking on empty model space. Use the {#onSelectionCleared}
+  # method to catch this case.
+  #
+  # @example
+  #   def onSelectionBulkChange(selection)
+  #     puts "onSelectionRemoved: #{selection}"
+  #   end
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onSelectionBulkChange(selection)
+  end
+
+  # The {#onSelectionCleared} method is called when the selection is completely
+  # emptied.
+  #
+  # @example
+  #   def onSelectionCleared(selection)
+  #     puts "onSelectionCleared: #{selection}"
+  #   end
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onSelectionCleared(selection)
+  end
+
+  #
+  # @example
+  #   class MySelectionObserver < Sketchup::SelectionObserver
+  #     # Note that there is a bug that prevent this from being called. Instead
+  #     # listen to onSelectedRemoved until the bug is fixed.
+  #     def onSelectionRemoved(selection, entity)
+  #       puts "onSelectionRemoved: #{entity}"
+  #     end
+  #     # To work around this you must catch this event instead until the bug is
+  #     # fixed:
+  #     def onSelectedRemoved(selection, entity)
+  #       # You can forward it to the correct event to be future compatible.
+  #       onSelectionRemoved(selection, entity)
+  #     end
+  #   end
+  #
+  #   # Attach the observer.
+  #   Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
+  #
+  # @note Due to a bug in SketchUp this event doesn't trigger. Instead
+  #   +onSelectedRemoved+ is called.
+  #
+  # @param [Sketchup::Entity] entity
+  #
+  # @param [Sketchup::Selection] selection
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onSelectionRemoved(selection, entity)
+  end
+
+end

data/SketchUp/Sketchup/Set.rb

@@ -0,0 +1,253 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The set class represents a collection of unique objects. This class is useful
+# for keeping track of a group of related entities, kind of like a selection
+# set that stays around for as long as you need it to.
+#
+# To make a set of your own, create an empty one using Sketchup::Set.new, and
+# then add items to it.
+# Note that in SketchUp 2014 this class was changed from Set to Sketchup::Set
+# in order to avoid conflict with the Ruby Standard Library. The Sketchup::Set
+# class is deprecated and new extensions should make use of Ruby's Set class
+# unless they need backward compatibility.
+#
+# If you want to ensure backwards compatibility you can use this shim:
+#
+# @example
+#   module Example
+#
+#     # Shim for the Set class which was moved in SketchUp 2014
+#     if defined?(Sketchup::Set)
+#       Set = Sketchup::Set
+#     end
+#
+#     def self.test_set_shim
+#       s = Set.new
+#       s.insert('Hello')
+#       s.insert('World')
+#       puts s.to_a
+#     end
+#
+#   end
+#
+# @example
+#   my_set = Sketchup::Set.new
+#   my_set.insert entity1
+#   my_set.insert entity2
+#
+# @version SketchUp 6.0
+class Sketchup::Set
+
+  # Instance Methods
+
+  # The clear method is used to clear all objects out of the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   if (set.include? toolbar)
+  #     UI.messagebox "Success: Contains Toolbar Object"
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #   set.clear
+  #   if (set.include? toolbar)
+  #     UI.messagebox set
+  #   else
+  #     UI.messagebox "Set is empty"
+  #   end
+  #
+  # @return set - an empty Set object
+  #
+  # @version SketchUp 6.0
+  def clear
+  end
+
+  # The contains? method is an alias for include?. See also Set.include?
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   if (set.contains? toolbar)
+  #     UI.messagebox "Success: Contains Toolbar Object"
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param object
+  #   A Ruby object of any type.
+  #
+  # @return status - true if the set contains the object, false if
+  #   the set does not contain the object.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def contains?(object)
+  end
+
+  # The delete object is used to delete or remove an object from the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   if (set.include? toolbar)
+  #     UI.messagebox "Success: Contains Toolbar Object"
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #   set.delete toolbar
+  #   if (set.include? toolbar)
+  #     UI.messagebox set
+  #   else
+  #     UI.messagebox "Set is empty"
+  #   end
+  #
+  # @param object
+  #   The object to be deleted.
+  #
+  # @return object - the object that was deleted.
+  #
+  # @version SketchUp 6.0
+  def delete(object)
+  end
+
+  # The each method is used to iterate through all of the objects in the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   set.each { | item | UI.messagebox item }
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [item]
+  def each
+  end
+
+  # The empty? method is used to determine whether the set is empty.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   status = set.empty?
+  #   if (status)
+  #     UI.messagebox "Success: Set is Empty"
+  #   else
+  #     UI.messagebox "Failure: Set has an Item"
+  #   end
+  #
+  # @return status - true if the set is empty, false if it is not
+  #   empty.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def empty?
+  end
+
+  # The contains? method is an alias for include?. See also Set.include?
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   if (set.contains? toolbar)
+  #     UI.messagebox "Success: Contains Toolbar Object"
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param object
+  #   A Ruby object of any type.
+  #
+  # @return status - true if the set contains the object, false if
+  #   the set does not contain the object.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def include?(object)
+  end
+
+  # The insert method is used to insert an object into the set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   if (set.include? toolbar)
+  #     UI.messagebox "Success: Contains Toolbar Object"
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param object
+  #   The object to be inserted into the set.
+  #
+  # @return size - the number of objects in the set
+  #
+  # @version SketchUp 6.0
+  def insert(object)
+  end
+
+  # The length method is an alias for size. See also Set.size.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   length = set.length
+  #   if (length)
+  #     UI.messagebox length
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return length - the length (number of objects) in the set
+  #
+  # @version SketchUp 6.0
+  def length
+  end
+
+  # The length method is an alias for size. See also Set.size.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   toolbar = UI::Toolbar.new "Test"
+  #   set.insert toolbar
+  #   length = set.length
+  #   if (length)
+  #     UI.messagebox length
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return length - the length (number of objects) in the set
+  #
+  # @version SketchUp 6.0
+  def size
+  end
+
+  # The to_a method is used to get an Array of the entities in your Set.
+  #
+  # @example
+  #   set = Sketchup::Set.new
+  #   set.insert('Hello')
+  #   set.insert('World')
+  #   my_array = set.to_a
+  #   UI.messagebox my_array
+  #
+  # @return array - The Array of the entities in the Set.
+  #
+  # @version SketchUp 6.0
+  def to_a
+  end
+
+end

data/SketchUp/Sketchup/ShadowInfo.rb

@@ -0,0 +1,257 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The ShadowInfo class contains method to extract the shadow information for a
+# model. The majority of the shadow information returned exists in the Model
+# Info > Location and Model Info > Shadows dialogs inside SketchUp.
+#
+# The following shadow information keys are maintained in SketchUp:
+#
+# - +City+ (in Model Info > Geo-location > Set Manual Location...) Note that 'City' is called 'Location' in the UI
+# - +Country+ (in Model Info > Geo-location > Set Manual Location...)
+# - +Dark+ (in Window > Shadows)
+# - +DayOfYear+
+# - +DaylightSavings+
+# - +DisplayNorth+ (in View > Toolbars > Solar North) Note that 'Toolbar' is called 'Tool Palettes' on Mac
+# - +DisplayOnAllFaces+ (in Window > Shadows)
+# - +DisplayOnGroundPlane+ (in Window > Shadows)
+# - +DisplayShadows+ (in Window > Shadows)
+# - +EdgesCastShadows+ (in Window > Shadows)
+# - +Latitude+ (in Model Info > Geo-location > Set Manual Location...)
+# - +Light+ (in Window > Shadows)
+# - +Longitude+ (in Model Info > Geo-location > Set Manual Location...)
+# - +North+ Angle (in View > Toolbars > Solar North) Note that 'Toolbar' is called 'Tool Palettes' on Mac
+# - +ShadowTime+ (in Window > Shadows)
+# - +ShadowTime_time_t+ (ShadowTime in Epoch time)
+# - +SunDirection+ (Generated based on ShadowTime)
+# - +SunRise+ (Generated based on ShadowTime)
+# - +SunRise_time_t+ (SunRise in Epoch time)
+# - +SunSet+ (Generated based on ShadowTime)
+# - +SunSet_time_t+ (SunSet in Epoch time)
+# - +TZOffset+ (in Window > Shadows)
+# - +UseSunForAllShading+ (in Window > Shadows)
+#
+# You access the ShadowInfo object by calling Model.shadow_info:
+#
+# @example
+#   model = Sketchup.active_model
+#   shadowinfo = model.shadow_info
+#   UI.messagebox("My city is: " + shadowinfo["City"].to_s)
+#
+# @version SketchUp 6.0
+class Sketchup::ShadowInfo < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Class Methods
+
+  # The each_key method iterates through all of the shadow information keys.
+  #
+  # @example
+  #   shadowinfo.each_key { |key| UI.messagebox(key) }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key] Variable to hold each key as they are found.
+  def self.each_key
+  end
+
+  # The keys method is a class method that returns an array with all of the
+  # attribute keys
+  #
+  # @example
+  #   keys = Sketchup::ShadowInfo.keys
+  #
+  # @return keys - an array of keys
+  #
+  # @version SketchUp 6.0
+  def self.keys
+  end
+
+  # Instance Methods
+
+  # The [] method retrieves a value from the array of keys
+  #
+  # @example
+  #   value = shadowinfo["key"]
+  #
+  # @param key
+  #   The key of the shadowinfo value to retrieve.
+  #
+  # @return value - the value that is retrieved.
+  #
+  # @version SketchUp 6.0
+  def [](key)
+  end
+
+  # The set value []= method is used to set the value in the array of shadow
+  # info options.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   shadowinfo = model.shadow_info
+  #   value = shadowinfo["City"]
+  #   UI.messagebox value
+  #   value = shadowinfo["City"]="Denver, CO"
+  #   UI.messagebox value
+  #
+  # @param key
+  #   The key of the shadowinfo value to set.
+  #
+  # @param value
+  #   The value to be set.
+  #
+  # @return value - the value that was set if successful, or false
+  #   if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def []=(key, value)
+  end
+
+  # The add_observer method is used to add an observer to the current object.
+  #
+  # @example
+  #   status = object.add_observer observer
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def add_observer(observer)
+  end
+
+  # The count method is inherited from the Enumerable mix-in module.
+  #
+  # @example
+  #   shadow_info = Sketchup.active_model.shadow_info
+  #   number = shadow_info.count
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def count
+  end
+
+  # An alias for each. See ShadowInfo.each.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   shadowinfo = model.shadow_info
+  #   shadowinfo.each_pair { |key, value|
+  #     UI.messagebox(key.to_s + '=' + value.to_s)
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key, value]
+  #
+  # @yieldparam key
+  #   A variables that will hold each key as it is found.
+  #
+  # @yieldparam value
+  #   A variables that will hold each value as it is found.
+  def each
+  end
+
+  # The each_key method iterates through all of the shadow information keys.
+  #
+  # @example
+  #   shadowinfo.each_key { |key| UI.messagebox(key) }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key] Variable to hold each key as they are found.
+  def each_key
+  end
+
+  # An alias for each. See ShadowInfo.each.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   shadowinfo = model.shadow_info
+  #   shadowinfo.each_pair { |key, value|
+  #     UI.messagebox(key.to_s + '=' + value.to_s)
+  #   }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [key, value]
+  #
+  # @yieldparam key
+  #   A variables that will hold each key as it is found.
+  #
+  # @yieldparam value
+  #   A variables that will hold each value as it is found.
+  def each_pair
+  end
+
+  # The keys method is a class method that returns an array with all of the
+  # attribute keys
+  #
+  # @example
+  #   keys = Sketchup::ShadowInfo.keys
+  #
+  # @return keys - an array of keys
+  #
+  # @version SketchUp 6.0
+  def keys
+  end
+
+  # The {#length} method returns the number of options in the shadow options
+  # collection
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   shadow_info = Sketchup.active_model.shadow_info
+  #   number = shadow_info.length
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def length
+  end
+
+  # The remove_observer method is used to remove an observer from the current
+  # object.
+  #
+  # @example
+  #   status = object.remove_observer observer
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def remove_observer(observer)
+  end
+
+  # The {#length} method returns the number of options in the shadow options
+  # collection
+  #
+  # The {#size} method is an alias for {#length}.
+  #
+  # @example
+  #   shadow_info = Sketchup.active_model.shadow_info
+  #   number = shadow_info.length
+  #
+  # @return integer
+  #
+  # @version SketchUp 2014
+  def size
+  end
+
+end