sketchup-api-stubs 0.7.2 → 0.7.7

data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Toolbar class contains methods to create and manipulate SketchUp

data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb

@@ -1,11 +1,11 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Ruby WebDialog class allows you to create and interact with DHTML dialog
 # boxes from Ruby.
 #
 # If your goal is to simply display a website to your users, consider using
-# UI.getURL, which will show them a web page in their default browser rather
+# {UI.openURL}, which will show them a web page in their default browser rather
 # than inside a dialog in SketchUp.
 #
 # See this blog post for a detailed, step-by-step example:
@@ -428,7 +428,7 @@ class UI::WebDialog
   def set_background_color(color)
   end
 
-  # The #{set_file} method is used to identify a local HTML file to display in
+  # The {#set_file} method is used to identify a local HTML file to display in
   # the webdialog.
   #
   # @example

data/lib/sketchup-api-stubs/stubs/_top_level.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 
@@ -147,6 +147,8 @@
   PAGE_USE_ALL = nil # Stub value.
   PAGE_USE_CAMERA = nil # Stub value.
   PAGE_USE_HIDDEN = nil # Stub value.
+  PAGE_USE_HIDDEN_GEOMETRY = nil # Stub value.
+  PAGE_USE_HIDDEN_OBJECTS = nil # Stub value.
   PAGE_USE_LAYER_VISIBILITY = nil # Stub value.
   PAGE_USE_RENDERING_OPTIONS = nil # Stub value.
   PAGE_USE_SECTION_PLANES = nil # Stub value.

data/lib/sketchup-api-stubs/stubs/array.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SketchUp Array class adds additional methods to the standard Ruby Array

data/lib/sketchup-api-stubs/stubs/geom.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Geom module defines a number of Module methods that let you perform
@@ -167,6 +167,9 @@ module Geom
   # The {.linear_combination} method is used to compute the linear combination of
   # points or vectors.
   #
+  # A linear combination is a standard term for vector math. It is defined as
+  # vector = weight1 * vector1 + weight2 * vector2.
+  #
   # @example
   #   point1 = Geom::Point3d.new(1, 1, 1)
   #   point2 = Geom::Point3d.new(10, 10, 10)

data/lib/sketchup-api-stubs/stubs/languagehandler.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LanguageHandler class contains methods used to help make SketchUp

data/lib/sketchup-api-stubs/stubs/length.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Because length units are used so often in SketchUp, a special class has been

data/lib/sketchup-api-stubs/stubs/numeric.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A number of methods have been added to the Ruby Numeric class to do units

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Sketchup module contains a number of important utility methods for use in
@@ -291,6 +291,17 @@ module Sketchup
   def self.fix_shadow_strings?
   end
 
+  # The {.focus} method is used to focus the active model window.
+  #
+  # @example
+  #   Sketchup.focus
+  #
+  # @see UI::HtmlDialog.bring_to_front
+  #
+  # @version SketchUp 2021.1
+  def self.focus
+  end
+
   # The format_angle method takes a number as an angle in radians and formats it
   # into degrees. For example, format_angle(Math::PI) will return 180.0.
   #
@@ -306,7 +317,7 @@ module Sketchup
   def self.format_angle(number)
   end
 
-  # The #{format_area} method formats a number as an area using the current units
+  # The {.format_area} method formats a number as an area using the current units
   # settings.
   #
   # The +number+ must be in square inches.
@@ -363,7 +374,7 @@ module Sketchup
   def self.format_length(*args)
   end
 
-  # The #{format_volume} method formats a number as a volume using the current
+  # The {.format_volume} method formats a number as a volume using the current
   # units settings.
   #
   # The +number+ must be in cubic inches.
@@ -427,10 +438,9 @@ module Sketchup
   # The os_language method returns the language code for the language SketchUp
   # is running in. This is an alias for the get_locale method.
   #
-  # Valid return values are: en-US, fr, it, de, es, ja, ko, zh-CN, zh-TW,
-  # pt-BR, nl, ru.
-  # If the OS language does not have corresponding folder and files in the
-  # SketchUp Resources folder, the returned language is, by default, en-US.
+  # Examples of return values are: en-US, fr, it, de, es, ja, ko, zh-CN, zh-TW,
+  # pt-BR, nl, ru and sv. For an up to date list os supported languages, see
+  # the SketchUp download page.
   #
   # @example
   #   language = Sketchup.os_language
@@ -461,7 +471,7 @@ module Sketchup
   # The get_shortcuts method retrieves an array of all keyboard shortcuts
   # currently registered with SketchUp. Each shortcut is returned as a
   # string with the shortcut and the command separated by a tab, similar
-  # to "Ctrl+A\tEdit/Select All"
+  # to "Ctrl+A\\tEdit/Select All"
   #
   # @example
   #   shortcuts = Sketchup.get_shortcuts
@@ -502,9 +512,15 @@ module Sketchup
   #     UI.messagebox("Error during unzip: " + error)
   #   end
   #
-  # @param [String] filename
+  # @param [String] filepath
   #   The path to the RBZ or ZIP file to install.
   #
+  # @param [Boolean] show_warning
+  #   Whether to warn the user not to install untrusted extensions.
+  #   In certain cases the warning can be confusing and redundant, e.g. when
+  #   automatically updating a trusted extension. When the user has selected
+  #   the archive themselves, it is best to warn about the possible risks.
+  #
   # @raise [Exception] If the archive cannot be installed.
   #
   # @raise [Interrupt] If the user cancel the installation.
@@ -514,7 +530,7 @@ module Sketchup
   # @return [Boolean]
   #
   # @version SketchUp 8.0 M2
-  def self.install_from_archive(filename)
+  def self.install_from_archive(filepath, show_warning = true)
   end
 
   # This methods indicates whether the host SketchUp application is 64bit.
@@ -551,15 +567,15 @@ module Sketchup
   end
 
   # Returns a boolean flag indicating whether the application is SketchUp Pro.
-  # Note that after the free trial period, SketchUp Pro will revert to regular
-  # SketchUp and this method will return false until the user registers
-  # the product.
   #
   # @example
   #   if Sketchup.is_pro?
   #     UI.messagebox("You are running SU Pro.")
   #   end
   #
+  # @note In SketchUp Make this method will return +true+ during the Pro trial
+  #   period and revert to +false+ when the trial period is over.
+  #
   # @return [Boolean]
   #
   # @version SketchUp 7.0
@@ -603,28 +619,44 @@ module Sketchup
   def self.load(path)
   end
 
-  # The open_file method is used to open a file.
+  # The {.open_file} method is used to open a SketchUp model.
   #
   # @example
   #   result = Sketchup.open_file("C:\\model.skp")
   #
-  # @param [String] filename
-  #   The path and filename to open.
+  # @overload open_file(filename)
   #
-  # @return [Boolean] true if opening the file succeeded,
-  #   false otherwise.
+  #   @deprecated Prefer +with_status+ overload instead of this variant.
+  #   @param [String] filename  The model file to open.
+  #   @return [Boolean] +true+ if opening the file succeeded,
+  #     +false+ otherwise.
+  #
+  # @overload open_file(filename, with_status: true)
+  #
+  #   Starting with SketchUp 2021.0 SketchUp attempts to load newer SketchUp
+  #   models. If a newer model is loaded some information might have been skipped
+  #   and extensions should be careful to not save over the file they loaded from
+  #   as information might be lost.
+  #
+  #   Success status codes:
+  #   * {Sketchup::Model::LOAD_STATUS_SUCCESS}
+  #   * {Sketchup::Model::LOAD_STATUS_SUCCESS_MORE_RECENT}
+  #
+  #   @version SketchUp 2021.0
+  #   @param [String] filename  The model file to open.
+  #   @return [Integer, false]  status code if opening the file succeeded,
+  #     +false+ otherwise.
   #
   # @version SketchUp 6.0
-  def self.open_file(filename)
+  def self.open_file(*args)
   end
 
   # The os_language method returns the language code for the language SketchUp
   # is running in. This is an alias for the get_locale method.
   #
-  # Valid return values are: en-US, fr, it, de, es, ja, ko, zh-CN, zh-TW,
-  # pt-BR, nl, ru.
-  # If the OS language does not have corresponding folder and files in the
-  # SketchUp Resources folder, the returned language is, by default, en-US.
+  # Examples of return values are: en-US, fr, it, de, es, ja, ko, zh-CN, zh-TW,
+  # pt-BR, nl, ru and sv. For an up to date list os supported languages, see
+  # the SketchUp download page.
   #
   # @example
   #   language = Sketchup.os_language
@@ -751,6 +783,17 @@ module Sketchup
   def self.read_default(section, variable, default = nil)
   end
 
+  # The redo method is used redo the last transaction on the redo stack.
+  #
+  # @example
+  #   Sketchup.redo
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2021.0
+  def self.redo
+  end
+
   # The register_extension method is used to register an extension with
   # SketchUp's extension manager (in SketchUp preferences).
   #

data/lib/sketchup-api-stubs/stubs/sketchupextension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SketchupExtension class contains methods allowing you to create and

data/lib/sketchup-api-stubs/stubs/string.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The String class contains a method used to parse a string as a length value.

data/lib/sketchup-api-stubs/stubs/ui.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UI module contains a number of methods for creating simple UI elements
@@ -70,8 +70,8 @@ module UI
   #     UI.set_cursor(cursor_id)
   #   end
   #
-  # @param [String] filename
-  #   Filename for an image.
+  # @param [String] path
+  #   File path to an image.
   #
   # @param [Integer] hot_x
   #   An x coordinate that is the "hotpoint" for the cursor
@@ -88,7 +88,7 @@ module UI
   # @return [Integer] ID associated with the cursor
   #
   # @version SketchUp 6.0
-  def self.create_cursor(filename, hot_x, hot_y)
+  def self.create_cursor(path, hot_x, hot_y)
   end
 
   # Creates a dialog box for inputting user information. The dialog box contains
@@ -165,7 +165,7 @@ module UI
   # of SketchUp's menus.
   #
   # Valid menu names are: "File", "Edit", "View", "Camera", "Draw", "Tools",
-  # "Window", "Extensions" and "Help".
+  # "Window", "Extensions", "Help" and "Developer".
   #
   # @example
   #   tool_menu = UI.menu("Tools")
@@ -325,7 +325,9 @@ module UI
   end
 
   # The preferences_pages method is used to returns the names of all the
-  # preferences pages. These include windows like Extensions.
+  # preferences pages. These include windows like Templates.
+  #
+  # [SketchUp 2017] <code>"Extensions"</code> page was removed.
   #
   # @example
   #   prefs = UI.preferences_pages
@@ -469,7 +471,7 @@ module UI
   def self.select_directory(options = {})
   end
 
-  # The #{set_cursor} method is used to change the cursor to a new cursor with a
+  # The {.set_cursor} method is used to change the cursor to a new cursor with a
   # given cursor id. See UI.create_cursor and the Tool class for details
   # on creating your own tools with arbitrary cursors.
   #
@@ -539,11 +541,14 @@ module UI
   end
 
   # The {.show_model_info} method is used to display the model info dialog for a
-  # specific page. You can get the list of valid dialogs with
-  # {UI.model_info_pages}.
+  # specific page. You can get the list of valid page names with {UI.model_info_pages}.
   #
   # [SketchUp 2014] <code>"Classifications"</code> page was added.
-  # [SketchUp 2017] <code>"Extensions"</code> page was removed.
+  #
+  # @bug Until SketchUp 2021.1 SketchUp on Mac didn't display the desired page in,
+  #   but only selected it in the navigation.
+  #
+  # @bug Until SketchUp 2021.1 SketchUp on Mac didn't accept English page names on localized builds.
   #
   # @example
   #   UI.show_model_info('Credits')
@@ -558,9 +563,9 @@ module UI
   end
 
   # The show_preferences method is used to display a SketchUp preferences dialog.
-  # You can get the list of valid dialogs with UI.preferences_pages.
+  # You can get the list of valid dialogs with {UI.preferences_pages}.
   #
-  # Note that under OSX this method doesn't currently work.
+  # @bug Under OSX this method doesn't currently work.
   #
   # @example
   #   status = UI.show_preferences('GraphicsCard')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sketchup-api-stubs
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.7
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,7 @@ files:
 - lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb
@@ -156,6 +157,7 @@ files:
 - lib/sketchup-api-stubs/stubs/Sketchup/Set.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb
+- lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Style.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb
 - lib/sketchup-api-stubs/stubs/Sketchup/Text.rb
@@ -203,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key: 
 specification_version: 4
 summary: SketchUp Ruby API stubs.