Merge branch 'master' into staging

Author: thomthom

assets/colors.html

@@ -92,8 +92,8 @@
 <td style="background-color:rgb(34,139,34)">&nbsp;</td></tr>
 <tr><td>Fuchsia</td><td>255,0,255</td>
 <td style="background-color:rgb(255,0,255)">&nbsp;</td></tr>
-<tr><td>Gainsboro</td><td>220,220,220,</td>
-<td style="background-color:rgb(220,220,220,)">&nbsp;</td></tr>
+<tr><td>Gainsboro</td><td>220,220,220</td>
+<td style="background-color:rgb(220,220,220)">&nbsp;</td></tr>
 <tr><td>GhostWhite</td><td>248,248,255</td>
 <td style="background-color:rgb(248,248,255)">&nbsp;</td></tr>
 <tr><td>Gold</td><td>255,215,0</td>

lib/sketchup-api-stubs/sketchup.rb

@@ -94,6 +94,7 @@
 require 'sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/InstancePath.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Layer.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Layers.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Licensing.rb'
@@ -123,6 +124,7 @@
 require 'sketchup-api-stubs/stubs/Sketchup/Set.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Skp.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Style.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Styles.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Text.rb'

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

@@ -2,7 +2,7 @@
 # License:: The MIT License (MIT)
 
 # Bounding boxes are three-dimensional boxes (eight corners), aligned with the
-# global axes, that surround entities within your model. There is a default
+# axes, that surround entities within your model. There is a default
 # bounding box for any new model that will surround all entities,
 # including all groups and components. Additionally, there are
 # bounding boxes for Drawingelement objects, including components and groups.
@@ -154,15 +154,17 @@ def contains?(point_or_bb)
   def corner(corner_index)
   end
 
-  # The {#depth} method is used to retrieve the depth of the bounding box.
+  # The {#depth} method is used to retrieve the Z extents of the bounding box.
   #
   # @example
   #   boundingbox = Geom::BoundingBox.new
   #   boundingbox.add([100, 200, -400], [200, 400, 100])
   #   # This will return a Length of 500.0.
-  #   length = boundingbox.depth
+  #   height = boundingbox.depth
   #
-  # @return [Length] the depth of the bounding box
+  # @note In SketchUp's coordinate system, this corresponds to the height.
+  #
+  # @return [Length]
   #
   # @version SketchUp 6.0
   def depth
@@ -200,15 +202,17 @@ def diagonal
   def empty?
   end
 
-  # The {#height} method is used to retrieve the height of the bounding box.
+  # The {#height} method is used to retrieve the Y extent of the bounding box.
   #
   # @example
   #   boundingbox = Geom::BoundingBox.new
   #   boundingbox.add([100, 200, -400], [200, 400, 100])
   #   # This will return a Length of 200.0.
-  #   length = boundingbox.height
+  #   depth = boundingbox.height
+  #
+  # @note In SketchUp's coordinate system, this corersponds to the depth.
   #
-  # @return [Length] the height of the bounding box
+  # @return [Length]
   #
   # @version SketchUp 6.0
   def height
@@ -301,15 +305,15 @@ def min
   def valid?
   end
 
-  # The {#width} method is used to retrieve the width of the bounding box.
+  # The {#width} method is used to retrieve the X extent of the bounding box.
   #
   # @example
   #   boundingbox = Geom::BoundingBox.new
   #   boundingbox.add([100, 200, -400], [200, 400, 100])
   #   # This will return a Length of 100.0.
-  #   length = boundingbox.width
+  #   width = boundingbox.width
   #
-  # @return [Length] the width of the bounding box
+  # @return [Length]
   #
   # @version SketchUp 6.0
   def width

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

@@ -27,7 +27,7 @@ def ==(other)
   # The {#height} method returns the height of the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
   #   height = bounds.height
   #
   # @return [Geom::Point2d]
@@ -80,7 +80,7 @@ def initialize(*args)
   # corner of the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
   #   l_r = bounds.lower_right
   #
   # @return [Geom::Point2d]
@@ -148,7 +148,7 @@ def to_a
   # of the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
   #   u_l = bounds.upper_left
   #
   # @return [Geom::Point2d]
@@ -160,7 +160,7 @@ def upper_left
   # The {#width} method returns the width of the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
   #   width = bounds.width
   #
   # @return [Geom::Point2d]

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

@@ -26,18 +26,18 @@ class Geom::LatLong
   #
   # @overload initialize(latlong)
   #
-  #   @param latlong [Geom::LatLong]
+  #   @param [Geom::LatLong] latlong
   #   @return [Geom::LatLong]
   #
   # @overload initialize(latlong_array)
   #
-  #   @param latlong_array [Array(Numeric, Numeric)]
+  #   @param [Array(Numeric, Numeric)] latlong_array
   #   @return [Geom::LatLong]
   #
   # @overload initialize(lat, long)
   #
-  #   @param lat  [Numeric]
-  #   @param long [Numeric]
+  #   @param [Numeric] lat
+  #   @param [Numeric] long
   #   @return [Geom::LatLong]
   #
   # @version SketchUp 6.0

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

@@ -31,8 +31,10 @@ class Geom::Point3d
 
   # Class Methods
 
-  # The linear_combination method is used to create a new point as a linear
-  # combination of two points. This method is generally used to get a point at
+  # The {.linear_combination} method is used to create a new point as a linear
+  # combination of two points.
+  #
+  # This method is generally used to get a point at
   # some percentage along a line connecting the two points.
   #
   # A linear combination is a standard term for vector math. It is defined as
@@ -41,26 +43,24 @@ class Geom::Point3d
   # @example
   #   point1 = Geom::Point3d.new(1,1,1)
   #   point2 = Geom::Point3d.new(10,10,10)
-  #   # Gets the point on the line segment connecting point1 and point2 that is
-  #   # 3/4 the way from point1 to point2.
+  #
+  #   # Get the point that is half the way from point1 to point2.
+  #   points = Geom::Point3d.linear_combination(0.5, point1, 0.5, point2)
+  #
+  #   # Get the point that is 3/4 the way from point1 to point2.
   #   point = Geom::Point3d.linear_combination(0.25, point1, 0.75, point2)
-  #   if (point)
-  #     UI.messagebox(point)
-  #   else
-  #     UI.messagebox("Failure")
-  #   end
+  #
+  #   # Get the point that is 70% the way from point1 to point2.
+  #   percentage = 0.7
+  #   point = Geom::Point3d.linear_combination(1.0 - percentage, point1, percentage, point2)
   #
   # @param [Float] weight1
-  #   A weight or percentage.
   #
-  # @param [Float] point1
-  #   The start point on the line.
+  # @param [Geom::Point3d] point1
   #
   # @param [Float] weight2
-  #   A weight or percentage.
   #
-  # @param [Float] point2
-  #   The end point of the line.
+  # @param [Geom::Point3d] point2
   #
   # @return [Geom::Point3d]
   #
@@ -226,7 +226,7 @@ def clone
   # @param [Geom::Point3d] point2
   #   The Point3d object to compute the distance to.
   #
-  # @return [Length] the distance in current units
+  # @return [Length]
   #
   # @version SketchUp 6.0
   def distance(point2)
@@ -484,7 +484,7 @@ def project_to_plane(plane)
   #
   # @overload set!(point3d)
   #
-  #   @param point3d [Geom::Point3d]
+  #   @param [Geom::Point3d] point3d
   #   @return [Geom::Point3d]
   #
   # @version SketchUp 6.0

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

@@ -353,6 +353,8 @@ def polygons
   #   index = mesh.add_point(point1)
   #   mesh.set_point(index, point2)
   #
+  # @note Index starts at 1.
+  #
   # @param [Integer] index
   #   The index where the point will be set.
   #
@@ -408,6 +410,8 @@ def set_point(index, point)
   # @note If you don't specify how many points you will be adding to the mesh
   #   when you initiate it you may risk the UV data becoming out of sync.
   #
+  # @note Index starts at 1.
+  #
   # @param [Integer] index
   #   An Integer representing the UV index.
   #
@@ -458,6 +462,8 @@ def transform!(transformation)
   # @example
   #   point = mesh.uv_at(1, true)
   #
+  # @note Index starts at 1.
+  #
   # @param [Integer] index
   #   The index for the texture coordinate.
   #

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

@@ -333,7 +333,7 @@ def dot(vector)
   #
   # @overload initialize(vector)
   #
-  #   @param vector [Geom::Vector3d] A Vector3d object.
+  #   @param [Geom::Vector3d] vector A Vector3d object.
   #   @return [Geom::Vector3d]
   #
   # @version SketchUp 6.0
@@ -504,12 +504,12 @@ def samedirection?(vector2)
   #
   # @overload set!(array3d)
   #
-  #   @param array3d [Array(Numeric, Numeric, Numeric)]
+  #   @param [Array(Numeric, Numeric, Numeric)] array3d
   #   @return [Geom::Vector3d]
   #
   # @overload set!(vector)
   #
-  #   @param vector [Geom::Vector3d]
+  #   @param [Geom::Vector3d] vector
   #   @return [Geom::Vector3d]
   #
   # @overload set!(x, y, z)

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

@@ -88,6 +88,11 @@ def add(name, type)
   #     puts auto_text.name
   #   }
   #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
   # @version LayOut 2018
   #
   # @yieldparam [Layout::AutoTextDefinition] auto_text

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

@@ -46,6 +46,7 @@ class Layout::Document
   VERSION_2018 = nil # Stub value.
   VERSION_2019 = nil # Stub value.
   VERSION_2020 = nil # Stub value.
+  VERSION_2021 = nil # Stub value.
   VERSION_3 = nil # Stub value.
   VERSION_CURRENT = nil # Stub value.
 
@@ -402,15 +403,15 @@ def remove_entity(entity)
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
   #   # Save the model using the current Layout format
-  #   filename = File.join(ENV['Home'], 'Desktop', 'mydoc.layout')
-  #   status = doc.save(filename)
+  #   path = File.join(ENV['Home'], 'Desktop', 'mydoc.layout')
+  #   status = doc.save(path)
   #   # Save the document to the current file using the current LayOut format
   #   status = doc.save
   #   # Save the document to the current file in LayOut 3 format
   #   status = doc.save(Layout::Document::VERSION_3)
   #   # Save the document in LayOut 2013 format
-  #   filename = File.join(ENV['Home'], 'Desktop', 'mydoc_v2013.layout')
-  #   status = doc.save(filename, Layout::Document::VERSION_2013)
+  #   path = File.join(ENV['Home'], 'Desktop', 'mydoc_v2013.layout')
+  #   status = doc.save(path, Layout::Document::VERSION_2013)
   #
   # @overload save
   #