sketchup-api-stubs 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c426719410dbcc07ba7a434afb41fc22dd3e8aaedffc9192066eb334bc8c1aed
-  data.tar.gz: 0b840332393dce9bf0534e4d32bd3cac7468b41cfcc8612142d83bbfeed42a5a
+  metadata.gz: e7515fa1b0378994644bdfad8f24f5f3c413c8f8eafe95157fe2c332c81c17a3
+  data.tar.gz: dc488129bd90c5bfdba9e210cf7ace6296b315bce1a51d0dfffb03d0417335c1
 SHA512:
-  metadata.gz: 246d6ca37d6bbfeee612b25c1147755cd11e0eeecbc303ade8b3a09c5cb3808bcc1f9c6a175be434343f42f65eb00bfa269a423efbbdb9b1dbf67ddd663b9ce7
-  data.tar.gz: 0c3a5160c05c964af0ba4604ae0637fdd3c480c4d39f28b4e2b8465d8b4effb380bf9403ef01a665abf63d3ecc2fd4adba7d2833fdd82d7f59946b9f7220982b
+  metadata.gz: 2d70441053546ca8f65e677403882a3ed9fe3d73589271c96a3cb55f9e661a3997f3149d51a0eee3883b7fef6b2b92313fd05d1d6b6d43089e10bebe157477fc
+  data.tar.gz: f55bc89cfd036c6690f047acd372d943daef6f532f981090022bf30d8fb728bff404cc0b0e7f291ab24971089f1e89e1ba929801589bfc3654e1174fcfb9177b

data/.yardopts

@@ -1,7 +1,9 @@
 --title "SketchUp Ruby API Documentation"
 --no-api
 --no-private
+--hide-api Internal
 --plugin yard-sketchup
+--asset images:images
 lib/sketchup-api-stubs/stubs/**/*.rb
 -
 pages/*.md

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Bounding boxes are three-dimensional boxes (eight corners), aligned with the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The bounds2d class represents an axis aligned bounding box represented by

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LatLong class contains various methods for creating and manipulating

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The OrientedBounds2d class is a bounding box represented by four

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Geom::Vector2d} class allows you to work with a point in 2D space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Point3d class allows you to work with a point in 3D space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {#Geom::PolygonMesh} class contains methods to create polygon mesh

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Transformations are a standard construct in the 3D world for representing

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UTM class lets you work with UTM map coordinates.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Vector2d class represents vectors in a 2 dimensional space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Vector3d class is used to represent vectors in a 3 dimensional space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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/Layout/AngularDimension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an angular dimension entity. An {Layout::AngularDimension} is

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an auto text definition. Some auto text definitions are mandatory.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AutoTextDefinitions class is a container class for all

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Connection Point. A

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut document. A {Layout::Document} is the 2D
@@ -45,6 +45,7 @@ class Layout::Document
   VERSION_2017 = nil # Stub value.
   VERSION_2018 = nil # Stub value.
   VERSION_2019 = nil # Stub value.
+  VERSION_2020 = nil # Stub value.
   VERSION_3 = nil # Stub value.
   VERSION_CURRENT = nil # Stub value.
 
@@ -368,6 +369,9 @@ class Layout::Document
   #
   # @raise [ArgumentError] if version is not a valid version
   #
+  # @raise [ArgumentError] if saving failed. This may be due to the LayOut file
+  #   being open in the LayOut application
+  #
   # @version LayOut 2018
   def save(*args)
   end

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A simple elliptical shape entity.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Entities class is a container class for {Layout::Entity}s. A

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An entity is an object shown on a page of a LayOut document.
@@ -7,16 +7,10 @@
 #   doc = Layout::Document.open("C:/path/to/document.layout")
 #   # Get the shared entities in the document. If there are no shared layers,
 #   # the resulting array will be empty.
-#   entities = doc.entities
-#   # Count how many of the entites are a rectangle
-#   rectangle_count = 0
+#   entities = doc.shared_entities
 #
-#   # Look at all of the entities in the array.
-#   entities.each { |entity|
-#     if entity.is_a?(Layout::Rectangle)
-#       rectangle_count = rectangle_count++
-#     end
-#   }
+#   # Count how many of the shared entites are rectangles.
+#   rectangle_count = entities.grep(Layout::Rectangle).size
 #
 # @version LayOut 2018
 class Layout::Entity

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A formatted text entity.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Class that references a {Layout::Document}'s grid settings.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A group is a special type of {Layout::Entity} that does not belong to a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A raster image entity.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is an interface to a label entity. A {Layout::Label} consists of a

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Layer Definition. A layer definition
@@ -9,7 +9,7 @@
 #   # Grab a handle to an existing LayOut document.
 #   doc = Layout::Document.open("C:/path/to/document.layout")
 #
-#   new_layer = doc.add_layer(true)
+#   new_layer = doc.layers.add(true)
 #   new_layer.name = "A new layer"
 #
 # @version LayOut 2018

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an instance of a {Layout::Layer}. A {Layout::LayerInstance}

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Pages class is a container class for all pages in a {Layout::Document}.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A SketchUp Model entity. This is an instance of a SketchUp Model that is
@@ -108,6 +108,10 @@ class Layout::SketchUpModel < Layout::Entity
   #   model = Layout::SketchUpModel.new("C:/Path/to/model.skp", bounds)
   #   model.current_scene = 1
   #
+  # @note LayOut automatically adds the scene "Last Saved SketchUp View" to each
+  #   {Layout::SketchUpModel}. This means that the {Sketchup::Model}'s scenes
+  #   start with index 1.
+  #
   # @param [Integer] index
   #   The index into the list of available scenes.
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableColumn} is a single row from a table.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to application events.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 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 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Camera class contains methods for creating and manipulating a camera.