sketchup-api-stubs 0.7.4 → 0.7.5

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 2020 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 2020 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

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

@@ -1,165 +1,165 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The Dimension class provides base functionality for classes DimensionLinear
-# and DimensionRadial. It's not instantiable.
-#
-# @version SketchUp 2014
-class Sketchup::Dimension < Sketchup::Drawingelement
-
-  # Constants
-
-  ARROW_CLOSED = nil # Stub value.
-  ARROW_DOT = nil # Stub value.
-  ARROW_NONE = nil # Stub value.
-  ARROW_OPEN = nil # Stub value.
-  ARROW_SLASH = nil # Stub value.
-
-  # Instance Methods
-
-  # The add_observer method is used to add a DimensionObserver to the dimension.
-  #
-  # @example
-  #   observer = MyDimObserver.new
-  #   dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
-  #         [100, 10, 0], [0, 20, 0])
-  #   status = dim.add_observer(observer)
-  #
-  # @note If the given observer responds to +onTextChanged+, it will be
-  #   added as a {Sketchup::DimensionObserver}. If not, the base
-  #   {Sketchup::Entity#add_observer} will be called.
-  #
-  # @param observer
-  #   A DimensionObserver.
-  #
-  # @return true if successful, false if unsuccessful.
-  #
-  # @version SketchUp 2014
-  def add_observer(observer)
-  end
-
-  # The arrow_type method retrieves the current arrow type of the dimension.
-  # Valid arrow types are class constants:
-  # - +Dimension::ARROW_NONE,+
-  # - +Dimension::ARROW_SLASH+
-  # - +Dimension::ARROW_DOT+
-  # - +Dimension::ARROW_CLOSED+
-  # - +Dimension::ARROW_OPEN+
-  #
-  # @example
-  #   type = dim.arrow_type
-  #   if type == Sketchup::Dimension::ARROW_CLOSED
-  #     puts "Arrow type is closed"
-  #   end
-  #
-  # @return a numerical representation of the arrow type
-  #
-  # @version SketchUp 2014
-  def arrow_type
-  end
-
-  # The arrow_type= method sets the arrow type of the dimension.
-  # Valid arrow types are class constants:
-  # - +Dimension::ARROW_NONE,+
-  # - +Dimension::ARROW_SLASH+
-  # - +Dimension::ARROW_DOT+
-  # - +Dimension::ARROW_CLOSED+
-  # - +Dimension::ARROW_OPEN+
-  #
-  # @example
-  #   dim.arrow_type = Sketchup::Dimension::ARROW_CLOSED
-  #
-  # @param type
-  #   a numerical representation of the arrow type.
-  #
-  # @return the arrow type that was set.
-  #
-  # @version SketchUp 2014
-  def arrow_type=(type)
-  end
-
-  # The has_aligned_text= method accepts true or false indicating whether the
-  # dimension's text is aligned to the dimension or to the screen.
-  #
-  # @example
-  #   dim.has_aligned_text = true
-  #
-  # @param [Boolean] value
-  #
-  # @return the alignment flag that was set
-  #
-  # @version SketchUp 2014
-  def has_aligned_text=(value)
-  end
-
-  # The has_aligned_text method is used to determine whether the dimension's text
-  # is aligned to the dimension or to the screen.
-  #
-  # @example
-  #   aligned = dim.has_aligned_text?
-  #
-  # @return [Boolean] status - true if text is aligned to the dimension.
-  #   False if dimension text is aligned to the screen.
-  #
-  # @version SketchUp 2014
-  def has_aligned_text?
-  end
-
-  # The plane method is used to retrieve the plane of the dimension. Refer to the
-  # Geom module for information on how planes are represented.
-  #
-  # @example
-  #   plane = dim.plane
-  #
-  # @return the plane of the dimension
-  #
-  # @version SketchUp 2014
-  def plane
-  end
-
-  # The remove_observer method is used to remove a DimensionObserver from the
-  # dimension. Note that, if the given observer responds to 'onTextChanged', it
-  # will be removed as a DimensionObserver. If not, the base
-  # Entity.remove_observer will be called.
-  #
-  # @example
-  #   observer = MyDimObserver.new
-  #   dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
-  #         [100, 10, 0], [0, 20, 0])
-  #   status = dim.add_observer(observer)
-  #   status = dim.remove_observer(observer)
-  #
-  # @param observer
-  #   A DimensionObserver.
-  #
-  # @return true if successful, false if unsuccessful.
-  #
-  # @version SketchUp 2014
-  def remove_observer(observer)
-  end
-
-  # The text method is used to retrieve the dimension text.
-  #
-  # @example
-  #   dimtext = dim.text
-  #
-  # @return the dimension text
-  #
-  # @version SketchUp 2014
-  def text
-  end
-
-  # The text= method is used to set an override on the dimension text.
-  #
-  # @example
-  #   dim.text= "text"
-  #
-  # @param [String] text
-  #
-  # @return the newly set text override
-  #
-  # @version SketchUp 2014
-  def text=(text)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Dimension class provides base functionality for classes DimensionLinear
+# and DimensionRadial. It's not instantiable.
+#
+# @version SketchUp 2014
+class Sketchup::Dimension < Sketchup::Drawingelement
+
+  # Constants
+
+  ARROW_CLOSED = nil # Stub value.
+  ARROW_DOT = nil # Stub value.
+  ARROW_NONE = nil # Stub value.
+  ARROW_OPEN = nil # Stub value.
+  ARROW_SLASH = nil # Stub value.
+
+  # Instance Methods
+
+  # The add_observer method is used to add a DimensionObserver to the dimension.
+  #
+  # @example
+  #   observer = MyDimObserver.new
+  #   dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
+  #         [100, 10, 0], [0, 20, 0])
+  #   status = dim.add_observer(observer)
+  #
+  # @note If the given observer responds to +onTextChanged+, it will be
+  #   added as a {Sketchup::DimensionObserver}. If not, the base
+  #   {Sketchup::Entity#add_observer} will be called.
+  #
+  # @param observer
+  #   A DimensionObserver.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 2014
+  def add_observer(observer)
+  end
+
+  # The arrow_type method retrieves the current arrow type of the dimension.
+  # Valid arrow types are class constants:
+  # - +Dimension::ARROW_NONE,+
+  # - +Dimension::ARROW_SLASH+
+  # - +Dimension::ARROW_DOT+
+  # - +Dimension::ARROW_CLOSED+
+  # - +Dimension::ARROW_OPEN+
+  #
+  # @example
+  #   type = dim.arrow_type
+  #   if type == Sketchup::Dimension::ARROW_CLOSED
+  #     puts "Arrow type is closed"
+  #   end
+  #
+  # @return a numerical representation of the arrow type
+  #
+  # @version SketchUp 2014
+  def arrow_type
+  end
+
+  # The arrow_type= method sets the arrow type of the dimension.
+  # Valid arrow types are class constants:
+  # - +Dimension::ARROW_NONE,+
+  # - +Dimension::ARROW_SLASH+
+  # - +Dimension::ARROW_DOT+
+  # - +Dimension::ARROW_CLOSED+
+  # - +Dimension::ARROW_OPEN+
+  #
+  # @example
+  #   dim.arrow_type = Sketchup::Dimension::ARROW_CLOSED
+  #
+  # @param type
+  #   a numerical representation of the arrow type.
+  #
+  # @return the arrow type that was set.
+  #
+  # @version SketchUp 2014
+  def arrow_type=(type)
+  end
+
+  # The has_aligned_text= method accepts true or false indicating whether the
+  # dimension's text is aligned to the dimension or to the screen.
+  #
+  # @example
+  #   dim.has_aligned_text = true
+  #
+  # @param [Boolean] value
+  #
+  # @return the alignment flag that was set
+  #
+  # @version SketchUp 2014
+  def has_aligned_text=(value)
+  end
+
+  # The has_aligned_text method is used to determine whether the dimension's text
+  # is aligned to the dimension or to the screen.
+  #
+  # @example
+  #   aligned = dim.has_aligned_text?
+  #
+  # @return [Boolean] status - true if text is aligned to the dimension.
+  #   False if dimension text is aligned to the screen.
+  #
+  # @version SketchUp 2014
+  def has_aligned_text?
+  end
+
+  # The plane method is used to retrieve the plane of the dimension. Refer to the
+  # Geom module for information on how planes are represented.
+  #
+  # @example
+  #   plane = dim.plane
+  #
+  # @return the plane of the dimension
+  #
+  # @version SketchUp 2014
+  def plane
+  end
+
+  # The remove_observer method is used to remove a DimensionObserver from the
+  # dimension. Note that, if the given observer responds to 'onTextChanged', it
+  # will be removed as a DimensionObserver. If not, the base
+  # Entity.remove_observer will be called.
+  #
+  # @example
+  #   observer = MyDimObserver.new
+  #   dim = Sketchup.active_model.entities.add_dimension_linear([50, 10, 0],
+  #         [100, 10, 0], [0, 20, 0])
+  #   status = dim.add_observer(observer)
+  #   status = dim.remove_observer(observer)
+  #
+  # @param observer
+  #   A DimensionObserver.
+  #
+  # @return true if successful, false if unsuccessful.
+  #
+  # @version SketchUp 2014
+  def remove_observer(observer)
+  end
+
+  # The text method is used to retrieve the dimension text.
+  #
+  # @example
+  #   dimtext = dim.text
+  #
+  # @return the dimension text
+  #
+  # @version SketchUp 2014
+  def text
+  end
+
+  # The text= method is used to set an override on the dimension text.
+  #
+  # @example
+  #   dim.text= "text"
+  #
+  # @param [String] text
+  #
+  # @return the newly set text override
+  #
+  # @version SketchUp 2014
+  def text=(text)
+  end
+
+end