sketchup-api-stubs 0.7.4 → 0.7.5

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

@@ -1,57 +1,59 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This observer interface is implemented to react to changes to the shadow
-# settings. To implement this observer, create a Ruby class of this type,
-# override the desired methods, and add an instance of the observer to the
-# {Sketchup::ShadowInfo} object.
-#
-# @example
-#   # This is an example of an observer that watches the selection for
-#   # changes.
-#   class MyShadowInfoObserver < Sketchup::ShadowInfoObserver
-#     def onShadowInfoChanged(shadow_info, type)
-#       puts "onShadowInfoChanged: #{type}"
-#     end
-#   end
-#
-#   # Attach the observer.
-#   Sketchup.active_model.shadow_info.add_observer(MyShadowInfoObserver.new)
-#
-# @version SketchUp 6.0
-class Sketchup::ShadowInfoObserver
-
-  # Instance Methods
-
-  # The {#onShadowInfoChanged} method is invoked whenever the user alters a
-  # setting inside the Shadows and Model Info dialogs. The type parameter
-  # contains a number identifying which option was altered. Here are the types to
-  # expect:
-  #
-  # - 0 = Time/Date sliders
-  # - 1 = Display Shadows checkbox
-  # - 2 = Light/Dark sliders
-  # - 3 = Geographic Location (in Model Info > Location)
-  # - 4 = Solar Orientation (in Model Info > Location)
-  # - 7 = Use Sun for Shading checkbox
-  # - 8 = Display from Edges checkbox
-  # - 9 = Display on Ground checkbox
-  # - 10 = Display on Faces checkbox
-  #
-  # @example
-  #   def onShadowInfoChanged(shadow_info, type)
-  #     puts "onShadowInfoChanged: #{type}"
-  #   end
-  #
-  # @param [Sketchup::ShadowInfo] shadow_info
-  #
-  # @param [Integer] type
-  #   A number identifying which setting was changed.
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def onShadowInfoChanged(shadow_info, type)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to changes to the shadow
+# settings.
+#
+# @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
+#   {Sketchup::ShadowInfo} object.
+#
+# @example
+#   # This is an example of an observer that watches the selection for
+#   # changes.
+#   class MyShadowInfoObserver < Sketchup::ShadowInfoObserver
+#     def onShadowInfoChanged(shadow_info, type)
+#       puts "onShadowInfoChanged: #{type}"
+#     end
+#   end
+#
+#   # Attach the observer.
+#   Sketchup.active_model.shadow_info.add_observer(MyShadowInfoObserver.new)
+#
+# @version SketchUp 6.0
+class Sketchup::ShadowInfoObserver
+
+  # Instance Methods
+
+  # The {#onShadowInfoChanged} method is invoked whenever the user alters a
+  # setting inside the Shadows and Model Info dialogs. The type parameter
+  # contains a number identifying which option was altered. Here are the types to
+  # expect:
+  #
+  # - 0 = Time/Date sliders
+  # - 1 = Display Shadows checkbox
+  # - 2 = Light/Dark sliders
+  # - 3 = Geographic Location (in Model Info > Location)
+  # - 4 = Solar Orientation (in Model Info > Location)
+  # - 7 = Use Sun for Shading checkbox
+  # - 8 = Display from Edges checkbox
+  # - 9 = Display on Ground checkbox
+  # - 10 = Display on Faces checkbox
+  #
+  # @example
+  #   def onShadowInfoChanged(shadow_info, type)
+  #     puts "onShadowInfoChanged: #{type}"
+  #   end
+  #
+  # @param [Sketchup::ShadowInfo] shadow_info
+  #
+  # @param [Integer] type
+  #   A number identifying which setting was changed.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def onShadowInfoChanged(shadow_info, type)
+  end
+
+end

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

@@ -0,0 +1,40 @@
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The {Sketchup::Skp} module is used to read metadata from external SketchUp
+# files without loading the whole file.
+#
+# @version SketchUp 2021.0
+module Sketchup::Skp
+
+  # Class Methods
+
+  # The {.read_guid} method is used to read the GUID, globally unique identifier,
+  # for an external model.
+  #
+  # In SketchUp, GUIDs are used to test if {Sketchup::ComponentDefinition}s and
+  # {Sketchup::Model}s match (a component being an embedded model).
+  # When you insert a component to a model, its GUID is compared to existing
+  # component definitions in that model, and if there is a match the existing
+  # component definition is re-used rather than a duplicate being added.
+  # When a component definition is modified or a model is saved, their GUIDs are
+  # renewed.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   definition = definitions.find { |definition| !definition.internal? }
+  #   # true if component matches its external file.
+  #   definition.guid == Sketchup::Skp.read_guid(definition.path)
+  #
+  # @param [String] filepath
+  #
+  # @raise [ArgumentError] if the file is missing or is not a SketchUp model.
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2021.0
+  def self.read_guid(filepath)
+  end
+
+end

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

@@ -1,69 +1,69 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The Style class contains methods for modifying information about a specific
-# style. Styles are a collection of display settings that tell SketchUp how to
-# draw the model.
-#
-# @example
-#   styles = Sketchup.active_model.styles
-#   puts "Your first style is named #{styles.first.name}"
-#
-# @version SketchUp 6.0
-class Sketchup::Style < Sketchup::Entity
-
-  # Instance Methods
-
-  # The {#description} method gets the description for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   puts "Your first style description is: #{style.description}"
-  #
-  # @return [String] description
-  #
-  # @version SketchUp 6.0
-  def description
-  end
-
-  # The {#description=} method sets the description for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   style.description = "My new style description."
-  #
-  # @param [String] description
-  #
-  # @version SketchUp 6.0
-  def description=(description)
-  end
-
-  # The {#name} method gets the name for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   name = style.name
-  #
-  # @return [String]
-  #
-  # @version SketchUp 6.0
-  def name
-  end
-
-  # The {#name=} method sets the name for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   style.name = 'My Very Own Style'
-  #
-  # @param [String] name
-  #
-  # @version SketchUp 6.0
-  def name=(name)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Style class contains methods for modifying information about a specific
+# style. Styles are a collection of display settings that tell SketchUp how to
+# draw the model.
+#
+# @example
+#   styles = Sketchup.active_model.styles
+#   puts "Your first style is named #{styles.first.name}"
+#
+# @version SketchUp 6.0
+class Sketchup::Style < Sketchup::Entity
+
+  # Instance Methods
+
+  # The {#description} method gets the description for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   puts "Your first style description is: #{style.description}"
+  #
+  # @return [String] description
+  #
+  # @version SketchUp 6.0
+  def description
+  end
+
+  # The {#description=} method sets the description for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   style.description = "My new style description."
+  #
+  # @param [String] description
+  #
+  # @version SketchUp 6.0
+  def description=(description)
+  end
+
+  # The {#name} method gets the name for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   name = style.name
+  #
+  # @return [String]
+  #
+  # @version SketchUp 6.0
+  def name
+  end
+
+  # The {#name=} method sets the name for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   style.name = 'My Very Own Style'
+  #
+  # @param [String] name
+  #
+  # @version SketchUp 6.0
+  def name=(name)
+  end
+
+end

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

@@ -1,211 +1,217 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The Styles class contains methods for manipulating a collection of styles in
-# a model. Typically, you will access this via the active_model:
-#
-# @example
-#   styles = Sketchup.active_model.styles
-#   puts "There are #{styles.size} styles in your model."
-#
-# @version SketchUp 6.0
-class Sketchup::Styles < Sketchup::Entity
-
-  # Includes
-
-  include Enumerable
-
-  # Instance Methods
-
-  # The {#[]} method is used to retrieves a style by either name or index.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style1 = styles[0]
-  #   style2 = styles["MyStyle"]
-  #
-  # @overload [](name)
-  #
-  #   @param [String] name  The name of the style to retrieve.
-  #   @return [Sketchup::Style, nil]
-  #
-  # @overload [](index)
-  #
-  #   @param [Integer] index  The index of the style to retrieve.
-  #   @return [Sketchup::Style, nil]
-  #
-  # @version SketchUp 6.0
-  def [](arg)
-  end
-
-  # The #{active_style} method is used to retrieve the active style.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.active_style
-  #
-  # @return [Sketchup::Style]
-  #
-  # @version SketchUp 6.0
-  def active_style
-  end
-
-  # The {#active_style_changed} method tells you if the active style has been
-  # edited by the user since it was last saved.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style_changed = styles.active_style_changed
-  #
-  # @return [Boolean]
-  #
-  # @version SketchUp 6.0
-  def active_style_changed
-  end
-
-  # The {#add_style} method is used to create and load a style from the given
-  # file.
-  #
-  # @example
-  #   filename = File.expand_path('./MyStyle.style')
-  #   styles = Sketchup.active_model.styles
-  #   status = styles.add_style(filename, true)
-  #
-  # @param [String] filename
-  #
-  # @param [Boolean] select
-  #   +true+ if you want to set the style to be the
-  #   active style.
-  #
-  # @return [Boolean]
-  #
-  # @version SketchUp 6.0
-  def add_style(filename, select)
-  end
-
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   number = styles.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]
-  #
-  # @version SketchUp 6.0
-  def count
-  end
-
-  # The {#each} method is used to iterate through styles.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   styles.each { |style|
-  #     puts style.name
-  #   }
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  #
-  # @yieldparam [Sketchup::Style] style
-  def each
-  end
-
-  # The {#length} method is an alias of {#size}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   number = styles.length
-  #
-  # @return [Integer]
-  #
-  # @see #size
-  #
-  # @version SketchUp 2014
-  def length
-  end
-
-  # The {#parent} method is used to return the model for the styles.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   model = styles.parent
-  #
-  # @return [Sketchup::Model]
-  #
-  # @version SketchUp 6.0
-  def parent
-  end
-
-  # The {#purge_unused} method is used to remove unused styles from the model.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   styles.purge_unused
-  #
-  # @return [true]
-  #
-  # @version SketchUp 6.0
-  def purge_unused
-  end
-
-  # The {#selected_style} method is used to retrieve the currently selected style.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.selected_style
-  #
-  # @return [Sketchup::Style] style
-  #
-  # @version SketchUp 6.0
-  def selected_style
-  end
-
-  # The {#selected_style=} method is used to set the currently selected style.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   styles.selected_style = styles.last
-  #
-  # @param [Sketchup::Style] style
-  #
-  # @return [false]
-  #
-  # @version SketchUp 6.0
-  def selected_style=(style)
-  end
-
-  # The {#size} method is used to retrieve the number of styles in the
-  # collection.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   number = styles.size
-  #
-  # @return [Integer]
-  #
-  # @see #length
-  #
-  # @version SketchUp 6.0
-  def size
-  end
-
-  # The {#update_selected_style} method commits the current style settings to the
-  # style selected in the Style Browser.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   styles.update_selected_style
-  #
-  # @return [true]
-  #
-  # @see #selected_style
-  #
-  # @version SketchUp 6.0
-  def update_selected_style
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The Styles class contains methods for manipulating a collection of styles in
+# a model. Typically, you will access this via the active_model:
+#
+# @example
+#   styles = Sketchup.active_model.styles
+#   puts "There are #{styles.size} styles in your model."
+#
+# @version SketchUp 6.0
+class Sketchup::Styles < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method is used to retrieves a style by either name or index.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style1 = styles[0]
+  #   style2 = styles["MyStyle"]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name  The name of the style to retrieve.
+  #   @return [Sketchup::Style, nil]
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index  The index of the style to retrieve.
+  #   @return [Sketchup::Style, nil]
+  #
+  # @version SketchUp 6.0
+  def [](arg)
+  end
+
+  # The {#active_style} method is used to retrieve the active style.
+  #
+  # While {#selected_style} is the style being selected in the Style Browser,
+  # the #{active_style} is a different object also including any unsaved style
+  # changes. These changes are silently dropped once a new style is selected.
+  # To save these changes to the selected style, call #{update_selected_style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.active_style
+  #
+  # @return [Sketchup::Style]
+  #
+  # @version SketchUp 6.0
+  def active_style
+  end
+
+  # The {#active_style_changed} method tells you if the active style has been
+  # edited by the user since it was last saved.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style_changed = styles.active_style_changed
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def active_style_changed
+  end
+
+  # The {#add_style} method is used to create and load a style from the given
+  # file.
+  #
+  # @example
+  #   filename = File.expand_path('./MyStyle.style')
+  #   styles = Sketchup.active_model.styles
+  #   status = styles.add_style(filename, true)
+  #
+  # @param [String] filename
+  #
+  # @param [Boolean] select
+  #   +true+ if you want to set the style to be the
+  #   active style.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 6.0
+  def add_style(filename, select)
+  end
+
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   number = styles.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]
+  #
+  # @version SketchUp 6.0
+  def count
+  end
+
+  # The {#each} method is used to iterate through styles.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   styles.each { |style|
+  #     puts style.name
+  #   }
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  #
+  # @yieldparam [Sketchup::Style] style
+  def each
+  end
+
+  # The {#length} method is an alias of {#size}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   number = styles.length
+  #
+  # @return [Integer]
+  #
+  # @see #size
+  #
+  # @version SketchUp 2014
+  def length
+  end
+
+  # The {#parent} method is used to return the model for the styles.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   model = styles.parent
+  #
+  # @return [Sketchup::Model]
+  #
+  # @version SketchUp 6.0
+  def parent
+  end
+
+  # The {#purge_unused} method is used to remove unused styles from the model.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   styles.purge_unused
+  #
+  # @return [true]
+  #
+  # @version SketchUp 6.0
+  def purge_unused
+  end
+
+  # The {#selected_style} method is used to retrieve the style currently
+  # selected in the Styles Browser.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.selected_style
+  #
+  # @return [Sketchup::Style] style
+  #
+  # @version SketchUp 6.0
+  def selected_style
+  end
+
+  # The {#selected_style=} method is used to set the currently selected style.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   styles.selected_style = styles.last
+  #
+  # @param [Sketchup::Style] style
+  #
+  # @return [false]
+  #
+  # @version SketchUp 6.0
+  def selected_style=(style)
+  end
+
+  # The {#size} method is used to retrieve the number of styles in the
+  # collection.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   number = styles.size
+  #
+  # @return [Integer]
+  #
+  # @see #length
+  #
+  # @version SketchUp 6.0
+  def size
+  end
+
+  # The {#update_selected_style} method commits the current style settings to the
+  # style selected in the Style Browser.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   styles.update_selected_style
+  #
+  # @return [true]
+  #
+  # @see #selected_style
+  #
+  # @version SketchUp 6.0
+  def update_selected_style
+  end
+
+end