sketchup-api-stubs 0.7.7 → 0.7.8

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layers class is a container class for all layers in a {Layout::Document}.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References a linear dimension entity. A {Layout::LinearDimension} is composed

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is raised whenever a method attempts to modify any {Layout::Entity}

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is raised whenever a method attempts to modify any {Layout::Entity}

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Class for a single page in a LayOut document.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a {Layout::Document}'s paper space information. The

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Pages class is a container class for all pages in a {Layout::Document}.
@@ -45,7 +45,7 @@ class Layout::Pages
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
   #   pages = doc.pages
-  #   new_page = doc.add
+  #   new_page = pages.add
   #
   # @param [String] name
   #   The name for the new page.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A path entity represents a continuous, multi-segment polyline or bezier

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A simple rectangular shape entity.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A SketchUp Model entity. This is an instance of a SketchUp Model that is
@@ -285,16 +285,15 @@ class Layout::SketchUpModel < Layout::Entity
   # The {#layers_modified?} method returns whether the layers of the
   # {Layout::SketchUpModel} has been modified.
   #
-  #
-  # @note: In SketchUp 2020, SketchUp "layers" were renamed to "tags". For
-  #   consistency with the SketchUp API, this will continue to refer to
-  #   "tags" as "layers".
-  #
   # @example
   #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
   #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
   #   modified = model.layers_modified?
   #
+  # @note In SketchUp 2020, SketchUp "layers" were renamed to "tags". For
+  #   consistency with the SketchUp API, this will continue to refer to
+  #   "tags" as "layers".
+  #
   # @return [Boolean]
   #
   # @version LayOut 2020.1
@@ -534,16 +533,15 @@ class Layout::SketchUpModel < Layout::Entity
   # The {#reset_layers} method resets the {Layout::SketchUpModel}'s layers to
   # the scene's setting.
   #
-  #
-  # @note: In SketchUp 2020, SketchUp "layers" were renamed to "tags". For
-  #   consistency with the SketchUp API, this will continue to refer to
-  #   "tags" as "layers".
-  #
   # @example
   #   bounds = Geom::Bounds2d.new(1, 1, 3, 3)
   #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
   #   model.reset_layers if model.layers_modified?
   #
+  # @note In SketchUp 2020, SketchUp "layers" were renamed to "tags". For
+  #   consistency with the SketchUp API, this will continue to refer to
+  #   "tags" as "layers".
+  #
   # @raise [LockedLayerError] if the {Layout::SketchUpModel} is on a locked
   #   {Layout::Layer}
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References a collection of style attributes that determine the visual

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::Table} is a series of rows and columns that holds data.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableCell} is a single cell from a table that contains data.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableColumn} is a single column from a table.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableColumn} is a single row from a table.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LayOut module is the root of the LayOut Ruby API. Many of the classes in

data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb}

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 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 → Numeric.rb}

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 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/Animation.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::Animation} interface is implemented to create animations

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to application events.
@@ -81,6 +81,18 @@ class Sketchup::AppObserver
   def onActivateModel(model)
   end
 
+  # The {#onExtensionsLoaded} method is called when SketchUp has finished loading
+  # all extensions when the application starts.
+  #
+  # @example
+  #   def onExtensionsLoaded
+  #     puts "onExtensionsLoaded"
+  #   end
+  #
+  # @version SketchUp 2022.0
+  def onExtensionsLoaded
+  end
+
   # The {#onNewModel} method is called when the application creates a new, empty
   # model.
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An ArcCurve is a Curve that makes up part of a circle. This is the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AttributeDictionaries class is a collection of all of the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AttributeDictionary class allows you to attach arbitrary collections of

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # SketchUp's drawing axes consist of three colored lines (red, green, blue),

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Behavior class is used to control the "behavior" of components, which

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Camera class contains methods for creating and manipulating a camera.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ClassificationSchema class represent schemas loaded in the model.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Classifications class is a container/manager for all classifications in

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Color class is used to create and manipulate colors within SketchUp

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ComponentDefinition} class is used to define the contents for
@@ -20,7 +20,7 @@
 # will be raised. The key/value pairs in the dictionary can be deleted safely.
 #
 # @version SketchUp 6.0
-class Sketchup::ComponentDefinition < DrawingElement
+class Sketchup::ComponentDefinition < Sketchup::Drawingelement
 
   # Includes
 
@@ -512,20 +512,62 @@ class Sketchup::ComponentDefinition < DrawingElement
   def remove_observer(observer)
   end
 
-  # The save_as method is used to save your definition as a SketchUp file at the
+  # The {#save_as} method is used to save your definition as a SketchUp file at the
   # specified file destination.
   #
+  # Use this method when the user has chosen a path. If you want to "silently" save
+  # out the definition, without changing the path it is associated with, use
+  # {#save_copy} instead.
+  #
   # @example
   #   my_definition = Sketchup.active_model.definitions[0]
-  #   success = my_definition.save_as "c:\\myComponent.skp"
+  #   my_definition.save_as("c:\\myComponent.skp")
+  #
+  # @overload save_as(file_path)
+  #
+  #   Save as the current SketchUp version.
+  #   @param [String] file_path
+  #   @version SketchUp 7.0
   #
-  # @param [String] file_path
-  #   Local file path to save the .skp file to.
+  # @overload save_as(file_path, version)
+  #
+  #   Save as a specific SketchUp version.
+  #   @param [String] file_path
+  #   @param [Integer] version
+  #     See {Sketchup::Model#save} for supported values.
+  #   @version SketchUp 2022.0
   #
   # @return [Boolean] true if successful
+  def save_as(*args)
+  end
+
+  # The {#save_copy} method is used to save your definition as a SketchUp file
+  # without changing the file path it is already associated with.
   #
-  # @version SketchUp 7.0
-  def save_as(file_path)
+  # This can be used to save out to a temporary file used by some other process,
+  # without having the temporary path permanentely written to the SketchUp
+  # model.
+  #
+  # @example
+  #   my_definition = Sketchup.active_model.definitions[0]
+  #   my_definition.save_copy("c:\\myComponent.skp")
+  #
+  # @overload save_copy(file_path)
+  #
+  #   Save as the current SketchUp version.
+  #   @param [String] file_path
+  #
+  # @overload save_copy(file_path, version)
+  #
+  #   Save as a specific SketchUp version.
+  #   @param [String] file_path
+  #   @param [Integer] version
+  #     See {Sketchup::Model#save} for supported values.
+  #
+  # @return [Boolean] true if successful
+  #
+  # @version SketchUp 2022.0
+  def save_copy(*args)
   end
 
   # Saves a component thumbnail image. The image format is specified by the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ComponentInstance} class is used to represent component
@@ -428,6 +428,11 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   # instances representing manifold solid volumes (this - arg).  If the specified
   # objects (this and arg) do not represent manifold volumes, this method fails.
   #
+  # resultant groups if the two objects (this and arg) represent manifold solids and the operation
+  # succeeds otherwise nil is returned. The 3 groups are as follows: The intersection of volume 1 &
+  # volume 2, the difference of volume 1 minus volume 2, and the reverse difference of volume 2 minus
+  # volume 1.
+  #
   # @example
   #   entities = Sketchup.active_model.entities
   #   instance1 = entities[0]
@@ -439,13 +444,7 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   # @param [Sketchup::ComponentInstance, nil] instance
   #   The instance to split this instance with.
   #
-  # @return [Array(Sketchup::Group, Sketchup::Group, Sketchup::Group)] A vector (array) of the three resultant groups
-  #   if the two objects (this and arg) represent manifold
-  #   solids and the operation succeeds otherwise nil is
-  #   returned. The 3 groups are as follows: The intersection
-  #   of volume 1 & volume 2, the difference of
-  #   volume 1 minus volume 2, and the reverse difference of
-  #   volume 2 minus volume 1.
+  # @return [Array(Sketchup::Group, Sketchup::Group, Sketchup::Group)] A vector (array) of the three
   #
   # @version SketchUp 8.0
   def split(instance)

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Console class is used by SketchUp to direct $stdout and $stderr to the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ConstructionLine class contains methods for modifying construction

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A construction point represents a point in the model that can be used to aid

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Curve class is used by SketchUp to unite a series of Edge objects into

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A DefinitionList object holds a list of all of the ComponentDefinition
@@ -6,7 +6,7 @@
 # definitions from the list.
 #
 # @version SketchUp 6.0
-class Sketchup::DefinitionList < Entity
+class Sketchup::DefinitionList < Sketchup::Entity
 
   # Includes
 
@@ -120,7 +120,7 @@ class Sketchup::DefinitionList < Entity
   #   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
+  #   +Enumerable+ mix-in module. Prior to that the {#count} method is an alias
   #   for {#length}.
   #
   # @return [Integer]
@@ -155,7 +155,8 @@ class Sketchup::DefinitionList < Entity
 
   # The {#import} method is used to import a (non-SketchUp) 3d model file as a definition.
   #
-  # Importers using the C API +SketchUpModelImporterInterface+ interface are supported (those in the +Importers/+ directory).
+  # Importers using the C API +SketchUpModelImporterInterface+ interface are supported (those in the
+  # +Importers/+ directory).
   #
   # See the {file:pages/importer_options.md Importer Options} file for information
   # on creating a valid hash for the various importers.
@@ -258,8 +259,8 @@ class Sketchup::DefinitionList < Entity
   # - +onFailure(message_string)+
   #
   # @bug Calling this method from an {UI::HtmlDialog}'s action callback on macOS will cause the
-  #   SketchUp application to become unresponsive. To work around this, defer the call from the
-  #   action callback with a non-repeating zero-delay timer;
+  #   SketchUp application to become unresponsive or crash. To work around this, defer the call
+  #   from the action callback with a non-repeating zero-delay timer;
   #   +UI.start_timer(0, false) { method_calling_load_from_url }+
   #
   # @example Download a component using a LoadHandler

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to component definition

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to events on a definitions

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Dimension class provides base functionality for classes DimensionLinear

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The DimensionLinear class represents linear dimensions.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to changes in dimension text.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The DimensionRadial class represents radius and diameter dimensions on

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Drawingelement is a base class for an item in the model that can be

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Edge class contains methods modifying and extracting information for

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The EdgeUse class defines how an Edge is used in the definition of a Face.