sketchup-api-stubs 0.7.4 → 0.7.8

data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb

@@ -1,72 +1,74 @@
-# Copyright:: Copyright 2020 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.
-  #
-  # @example
-  #   def onComponentInstanceRemoved(definition, instance)
-  #     puts "onComponentInstanceRemoved(#{definition}, #{instance})"
-  #   end
-  #
-  # @note Due to the underlying way that the SketchUp Move Tool is
-  #   implemented, this method is fired on a Move + Copy operation even
-  #   though no {Sketchup::ComponentInstance} is apparently removed.
-  #
-  # @param [Sketchup::ComponentDefinition] definition
-  #   The definition of the
-  #   instance removed
-  #
-  # @param [Sketchup::ComponentInstance] instance
-  #   The removed instance
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onComponentInstanceRemoved(definition, instance)
-  end
-
-end
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to component definition
+# events.
+#
+# @abstract 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.
+  #
+  # @example
+  #   def onComponentInstanceRemoved(definition, instance)
+  #     puts "onComponentInstanceRemoved(#{definition}, #{instance})"
+  #   end
+  #
+  # @note Due to the underlying way that the SketchUp Move Tool is
+  #   implemented, this method is fired on a Move + Copy operation even
+  #   though no {Sketchup::ComponentInstance} is apparently removed.
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #   The definition of the
+  #   instance removed
+  #
+  # @param [Sketchup::ComponentInstance] instance
+  #   The removed instance
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onComponentInstanceRemoved(definition, instance)
+  end
+
+end

data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb

@@ -1,102 +1,104 @@
-# Copyright:: Copyright 2020 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::DefinitionList] definitions
-  #
-  # @param [Sketchup::ComponentDefinition] definition
-  #
-  # @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
+# Copyright:: Copyright 2022 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to events on a definitions
+# collection.
+#
+# @abstract 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::DefinitionList] definitions
+  #
+  # @param [Sketchup::ComponentDefinition] definition
+  #
+  # @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