sketchup-api-stubs 0.7.2 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b0eca2ccacd66fa75d6313561acc6479ee2b1894b4d28cc320ac6fc8871400f
-  data.tar.gz: 856e9ae3ccb4ca48e1364e4bcf56e273d22f1a03adbefdfcd466ac1478da28b9
+  metadata.gz: cadfe482d643fffdb3be271161180ba4a638b17c7a9288a7c3a79b7ca6ea3929
+  data.tar.gz: db6ee2cadbbbd51330bee20e157b6f103c8cf2f9edcb9834f75e41a0e353a178
 SHA512:
-  metadata.gz: 517beb0f72925191e0e68ef2e646756638729c87df2c674ce28337fd4f69d8fd4ee5b83f104205838c937d97dbe7ddad7d6791aa923cb3a843fed950e9baadee
-  data.tar.gz: 5a8ee7afed96fe002fd6b7be8799b9947d7c92fa070e629a3fe6c477bef50dc900b1e260d0b2443f912d9ebf730fd2f9538845a82074d7aac2689be0ed4261f1
+  metadata.gz: 1044e24d7bd1012ce69b96c9b59f418c1f879be3e8fe35ab93ca8d39a3b06db6b7c43ce11ccf6d5e68a05e75c02aa5f60dee61a751bbf6aad8db18b8e7658d08
+  data.tar.gz: dacdb98cb9aced993ffec02a777929ef8774f93a98401edf2bfdbd673e7c21bf7b1e4ab077975688d39fde44ef63ec23dfcc38f53141e2410540ee7b55218b06

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

@@ -62,8 +62,8 @@ require 'sketchup-api-stubs/stubs/Sketchup/Camera.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Classifications.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Color.rb'
-require 'sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Console.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb'
@@ -94,6 +94,7 @@ require 'sketchup-api-stubs/stubs/Sketchup/InputPoint.rb'
 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/SelectionObserver.rb'
 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'

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

@@ -1,8 +1,8 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # 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 @@ class Geom::BoundingBox
   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 @@ class Geom::BoundingBox
   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 @@ class Geom::BoundingBox
   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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The bounds2d class represents an axis aligned bounding box represented by
@@ -27,7 +27,7 @@ class Geom::Bounds2d
   # 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 @@ class Geom::Bounds2d
   # 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 @@ class Geom::Bounds2d
   # 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 @@ class Geom::Bounds2d
   # 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]

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 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,12 +1,11 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# The {Geom::Vector2d} class allows you to work with a point in 2D space.
-# {Geom::Point2d} is basically just a series of values representing x and y
-# coordinates.
+# The {Geom::Point2d} class allows you to work with a point in 2D space.
+# {Geom::Point2d} is a series of values representing x and y coordinates.
 #
-# The values are specified as [x, y]. For example [1, 1].
-# To create a point call Geom::Point2d.new, where the creation method
+# The values are specified as +[x, y]+. For example [1, 1].
+# To create a point call +Geom::Point2d.new+, where the creation method
 # can take a variety of arguments:
 #
 # @example

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Point3d class allows you to work with a point in 3D space.
@@ -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 @@ class Geom::Point3d
   # @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 @@ class Geom::Point3d
   #
   # @overload set!(point3d)
   #
-  #   @param point3d [Geom::Point3d]
+  #   @param [Geom::Point3d] point3d
   #   @return [Geom::Point3d]
   #
   # @version SketchUp 6.0

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {#Geom::PolygonMesh} class contains methods to create polygon mesh
@@ -9,17 +9,18 @@
 # a mesh from it, and draws faces based on the mesh.
 #
 # You can construct a mesh manually using the methods of this class, or you
-# can get a mesh from a face by calling the Face.mesh method. See
+# can get a mesh from a face by calling the {Sketchup::Face#mesh} method. See
 # {Sketchup::Entities#add_faces_from_mesh} for an easy way to convert a mesh
 # back into faces.
 #
 # @example
-#   # Grab a mesh from a given face.
-#   my_mesh = some_face.mesh
+#   entities = Sketchup.active_model.active_entities
+#   face = entities.grep(Sketchup::Face).first
 #
-#   # Create a new group that we will populate with the mesh.
-#   group = Sketchup.active_model.entities.add_group
-#   group.entities.add_faces_from_mesh(my_mesh)
+#   mesh = face.mesh
+#
+#   group = entities.add_group
+#   group.entities.add_faces_from_mesh(mesh)
 #
 # @version SketchUp 6.0
 class Geom::PolygonMesh
@@ -166,13 +167,23 @@ class Geom::PolygonMesh
   def count_polygons
   end
 
-  # Create a new empty polygon mesh. The number of points and polygons are
-  # optional and are just used as a hint to decide how much space to
-  # pre-allocate to speed up adding points and polygons.
+  # Create a new empty polygon mesh.
+  #
+  # The number of points and polygons are optional and are used as a hint to
+  # decide how much space to pre-allocate to speed up adding points and polygons.
+  #
+  # As of SketchUp 2021.1 the performance of looking up and inserting points is
+  # significantly better provided the mesh was initialized with roughly the
+  # correct number of total points.
   #
   # @example
   #   mesh = Geom::PolygonMesh.new
   #
+  # @note When creating a mesh with normals and/or UVQ data it's critical that
+  #   the number of points estimated is equal to or higher than the final number
+  #   of points added. If fewer points are estimated the normals and UVQ data
+  #   might end up out of sync.
+  #
   # @overload initialize
   #
   #   @return [Geom::PolygonMesh]
@@ -353,6 +364,8 @@ class Geom::PolygonMesh
   #   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 +421,8 @@ class Geom::PolygonMesh
   # @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 +473,8 @@ class Geom::PolygonMesh
   # @example
   #   point = mesh.uv_at(1, true)
   #
+  # @note Index starts at 1.
+  #
   # @param [Integer] index
   #   The index for the texture coordinate.
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 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 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 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,8 +1,7 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# The Vector2d class represents vectors in a 2 dimensional space.
-# Vectors in LayOut have a direction and a length, but not a starting point.
+# The {Geom::Vector2d} class represents vectors in a 2 dimensional space.
 #
 # There are numerous tutorials on 2D vectors available on the internet.
 #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Vector3d class is used to represent vectors in a 3 dimensional space.
@@ -333,7 +333,7 @@ class Geom::Vector3d
   #
   # @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 @@ class Geom::Vector3d
   #
   # @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)

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 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 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an angular dimension entity. An {Layout::AngularDimension} is
@@ -536,6 +536,10 @@ class Layout::AngularDimension < Layout::Entity
   #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
   #   text = dim.text
   #
+  # @note With the addition of auto-text in dimensions for LayOut 2019.2, the
+  #   copy of the dimension text incorrectly provided the plain text when
+  #   requesting the display text. This has been fixed for LayOut 2020.1.
+  #
   # @return [Layout::FormattedText]
   #
   # @version LayOut 2018