sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/DefinitionList.rb

@@ -0,0 +1,312 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A DefinitionList object holds a list of all of the ComponentDefinition
+# objects in a model. This class contains methods for  adding and retrieving
+# definitions from the list.
+#
+# @version SketchUp 6.0
+class Sketchup::DefinitionList < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The [] method is used to retrieve a component definition from the list. You
+  # can give an integer index in the range 0 to length, a string which
+  # represents the GUID (a unique internal identifier), or a string that is
+  # the name of the definition.
+  #
+  # @example
+  #   path=Sketchup.find_support_file "Bed.skp",
+  #     "Components/Components Sampler/"
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   componentdefinition = definitions.load path
+  #   component = definitions[0]
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index for a specific component definition.
+  #   @return [Sketchup::ComponentDefinition, nil]
+  #
+  # @overload [](guid)
+  #
+  #   @param [String] guid The name of an existing component definition.
+  #   @return [Sketchup::ComponentDefinition, nil]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The unique GUID for the component definition.
+  #   @return [Sketchup::ComponentDefinition, nil]
+  #
+  # @version SketchUp 6.0
+  def [](arg)
+  end
+
+  # The add method is used to add a new component definition to the definition
+  # list with the given name.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   componentdefinition = definitions.add "BedTraditional"
+  #   component = definitions[0]
+  #
+  # @param def_name
+  #   The new component definition to add to the definition
+  #   list.
+  #
+  # @return componentdefinition - the ComponentDefinition object
+  #   that was added (if successful)
+  #
+  # @version SketchUp 6.0
+  def add(def_name)
+  end
+
+  # The add_observer method is used to add an observer to the current object.
+  #
+  # @example
+  #   definitions = Sketchup.active_model.definitions
+  #   status = definitions.add_observer observer
+  #
+  # @param observer
+  #   An observer.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 6.0
+  def add_observer(observer)
+  end
+
+  # The [] method is used to retrieve a component definition from the list. You
+  # can give an integer index in the range 0 to length, a string which
+  # represents the GUID (a unique internal identifier), or a string that is
+  # the name of the definition.
+  #
+  # @example
+  #   path=Sketchup.find_support_file "Bed.skp",
+  #     "Components/Components Sampler/"
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   componentdefinition = definitions.load path
+  #   component = definitions[0]
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index for a specific component definition.
+  #   @return [Sketchup::ComponentDefinition, nil]
+  #
+  # @overload [](guid)
+  #
+  #   @param [String] guid The name of an existing component definition.
+  #   @return [Sketchup::ComponentDefinition, nil]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The unique GUID for the component definition.
+  #   @return [Sketchup::ComponentDefinition, nil]
+  #
+  # @version SketchUp 6.0
+  def at(arg)
+  end
+
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   number = definitions.count
+  #
+  # @note Since SketchUp 2014 the count method is inherited from Ruby's
+  #   +Enumable+ mix-in module. Prior to that the {#count} method is an alias
+  #   for {#length}.
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 6.0
+  def count
+  end
+
+  # The each method is used to iterate through all of the component definitions
+  # in the definition list.
+  #
+  # Throws an exception if there are no component definitions.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   definitions.add("BedTraditional")
+  #   number = definitions.each { |definition| puts definition.name }
+  #
+  # @return nil
+  #
+  # @version SketchUp 6.0
+  #
+  # @yield [definition] A variable that will hold each ComponentDefinition
+  #   object as they are found.
+  def each
+  end
+
+  # The {#length} method is used to retrieve number of component definitions in
+  # the list.
+  #
+  # The {#size} method is an alias for {#length} added in SketchUp 2014.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   number = definitions.length
+  #
+  # @return [Integer] the number of component definitions in the
+  #   definition list if successful
+  #
+  # @version SketchUp 6.0
+  def length
+  end
+
+  # The load method is used to load a component from a file.
+  #
+  # @example
+  #   path=Sketchup.find_support_file "Bed.skp",
+  #     "Components/Components Sampler/"
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   componentdefinition = definitions.load path
+  #
+  # @param path
+  #   The path where the component definition file is located.
+  #
+  # @return componentdefinition - the loaded ComponentDefinition
+  #   object if successful
+  #
+  # @version SketchUp 6.0
+  def load(path)
+  end
+
+  # The load_from_url method loads a component from a location specified by
+  # string url. This method throws an exception if an url string is not
+  # given, or an error occurs during retrieval from url and a
+  # load_handler was not given. Optional second parameter load_handler can be
+  # used to pass in a ruby object that responds to the following methods:
+  #
+  #   - cancelled?(a_boolean)
+  #   - onPercentChange(a_float)
+  #   - onSuccess()
+  #   - onFailure(message_string)
+  #
+  # @example
+  #   class LoadHandler
+  #
+  #     attr :error
+  #
+  #     def onPercentChange(percent)
+  #       Sketchup::set_status_text("LOADING: #{percent}%")
+  #     end
+  #
+  #     def cancelled?
+  #       # You could, for example, show a messagebox after X seconds asking if the
+  #       # user wants to cancel the download. If this method returns true, then
+  #       # the download cancels.
+  #       return false
+  #     end
+  #
+  #     def onSuccess
+  #       Sketchup::set_status_text('')
+  #     end
+  #
+  #     def onFailure(error_message)
+  #       self.error = error_message
+  #       Sketchup::set_status_text('')
+  #     end
+  #
+  #   end
+  #
+  #   # Replace this with a real URL...
+  #   url = 'http://www.sketchup.com/model.skp'
+  #   model = Sketchup.active_model
+  #   definition = model.definitions.load_from_url(url, load_handler)
+  #
+  #   if definition.nil?
+  #     puts "Error: #{load_handler.error}"
+  #   end
+  #
+  # @param url
+  #   URL to load a .skp file from.
+  #
+  # @param [optional] load_handler
+  #   Ruby object that has methods defined
+  #   as described in the load_from_url details.
+  #
+  # @return componentdefinition - the loaded ComponentDefinition
+  #   object if successful
+  #
+  # @version SketchUp 7.0
+  def load_from_url(url, load_handler)
+  end
+
+  # The purge_unused method is used to remove the unused component definitions.
+  #
+  # @example
+  #   definitions = Sketchup.active_model.definitions
+  #   definitions.purge_unused
+  #
+  # @return Sketchup::DefinitionList object
+  #
+  # @version SketchUp 6.0
+  def purge_unused
+  end
+
+  # The remove_observer method is used to remove an observer from the current
+  # object.
+  #
+  # @example
+  #   definitions = Sketchup.active_model.definitions
+  #   status = definitions.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 is used to retrieve number of component definitions in
+  # the list.
+  #
+  # The {#size} method is an alias for {#length} added in SketchUp 2014.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   number = definitions.length
+  #
+  # @return [Integer] the number of component definitions in the
+  #   definition list if successful
+  #
+  # @version SketchUp 6.0
+  def size
+  end
+
+  # The unique_name is used to generate a unique name for a definition based on
+  # a base_name string. For example, a base_name of "Joe" might return "Joe #2"
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   new_name = definitions.unique_name "My Base Name"
+  #
+  # @param base_name
+  #
+  # @return new_name - the unique name.
+  #
+  # @version SketchUp 6.0
+  def unique_name(base_name)
+  end
+
+end

data/SketchUp/Sketchup/DefinitionObserver.rb

@@ -0,0 +1,73 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to component definition
+# 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
+# definitions of interests.
+#
+# @example
+#   # This is an example of an observer that watches a specific definition
+#   # for new component insertions.
+#   class MyDefObserver < Sketchup::DefinitionObserver
+#     def onComponentInstanceAdded(definition, instance)
+#       puts "onComponentInstanceAdded(#{definition}, #{instance})"
+#     end
+#   end
+#
+#   # Attach the observer
+#   Sketchup.active_model.definitions[0].add_observer(MyDefObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::DefinitionObserver < Sketchup::EntityObserver
+
+  # Instance Methods
+
+  # The {#onComponentInstanceAdded} method is called when a new component
+  # instance is added to a model.
+  #
+  # @example
+  #   def onComponentInstanceAdded(definition, instance)
+  #     puts "onComponentInstanceAdded(#{definition}, #{instance})"
+  #   end
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #   The definition of the
+  #   added instance
+  #
+  # @param [Sketchup::ComponentInstance] instance
+  #   The added instance
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentInstanceAdded(definition, instance)
+  end
+
+  # The {#onComponentInstanceRemoved} method is called when a component
+  # instance is removed from a model.
+  #
+  # implemented, this method is fired on a Move + Copy operation even
+  # though no {Sketchup::ComponentInstance} is apparently removed.
+  #
+  # @example
+  #   def onComponentInstanceRemoved(definition, instance)
+  #     puts "onComponentInstanceRemoved(#{definition}, #{instance})"
+  #   end
+  #
+  # @note Due to the underlying way that the SketchUp Move Tool is
+  #
+  # @param [Sketchup::ComponentInstance] instance
+  #   The removed instance
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #   The definition of the
+  #   instance removed
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentInstanceRemoved(definition, instance)
+  end
+
+end

data/SketchUp/Sketchup/DefinitionsObserver.rb

@@ -0,0 +1,102 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to events on a definitions
+# collection. To implement this observer, create a Ruby class of this type,
+# override the desired methods, and add an instance of the observer to the
+# collection of interest.
+#
+# @example
+#   class MyDefinitionsObserver < Sketchup::DefinitionsObserver
+#     def onComponentAdded(definitions, definition)
+#       puts "onComponentAdded: #{definition.name}"
+#     end
+#   end
+#
+#   Sketchup.active_model.definitions.add_observer(MyDefinitionsObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::DefinitionsObserver
+
+  # Instance Methods
+
+  # The {#onComponentAdded} method is called whenever a definition is added to
+  # the definitions collection.
+  #
+  # @example
+  #   def onComponentAdded(definitions, definition)
+  #     puts "onComponentAdded: #{definition}"
+  #   end
+  #
+  # @param [Sketchup::DefinitionList] definitions
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentAdded(definitions, definition)
+  end
+
+  # The {#onComponentPropertiesChanged} method is called whenever a definition's
+  # name or description are changed.
+  #
+  # This does not fire when "Glue To", "Cuts Opening", or "Face Camera" settings
+  # are changed.
+  #
+  # @example
+  #   def onComponentPropertiesChanged(definitions, definition)
+  #     puts "onComponentPropertiesChanged: #{definition}"
+  #   end
+  #
+  # @param [Sketchup::DefinitionList] definitions
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentPropertiesChanged(definitions, definition)
+  end
+
+  # The {#onComponentAdded} method is called whenever a definition is removed
+  # from the definitions collection.
+  #
+  # @example
+  #   def onComponentRemoved(definitions, definition)
+  #     puts "onComponentRemoved: #{definition}"
+  #   end
+  #
+  # @note This methods fires twice for each Component/Group erased.
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #
+  # @param [Sketchup::DefinitionList] definitions
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentRemoved(definitions, definition)
+  end
+
+  # The {#onComponentTypeChanged} event is fired when a component is converted to
+  # a group or vice versa. (In the underlying implementation, {Sketchup::Group}s
+  # are just a special kind of definition that is allowed to only have a single
+  # instance.)
+  #
+  # @example
+  #   def onComponentTypeChanged(definitions, definition)
+  #     puts "onComponentTypeChanged: #{definition}"
+  #   end
+  #
+  # @param [Sketchup::DefinitionList] definitions
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentTypeChanged(definitions, definition)
+  end
+
+end