sketchup-api-stubs 0.7.10 → 0.7.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e21be664656202509a24f77478a6d8473e9bfe373096b38ccc3c7638da8af639
-  data.tar.gz: f22ccc1dbdc608c0fa2f6a3574877fde54091702a0615ee183286f1c61ac366a
+  metadata.gz: ce48bf908bfd9e91aae631e26262a1c873fb9bfe1f69398f324eca2fbed29997
+  data.tar.gz: 99704ab5d21b6eeaf4b90bd149ea79f30a4ad83180b964b396cacd9c0430cd75
 SHA512:
-  metadata.gz: 39c0c18cfee2f04e82e8db0830df1c49d752d5b09a5cdcd020159e983537d23c9223a19a9676dfdc8f7fee5d371f7626fbe5e347a7c0065faf3f0c7090419c57
-  data.tar.gz: da7367e9bd3a35a9775de1ab2fb47e280f62c3186309f5667a8ae58798ba19b23bfe05039f7a799f02e9674f967fafff12f02e71d87e34f59d9bb30e2157a3b6
+  metadata.gz: e4355b2185598fe0b3b164a0e1df5d2c74d0ad9cf2c9ada54eed6d30a16bac04fde6cfe0905396e78d1b51be51c2c13d387d8d25f26611406f4eeb263326c367
+  data.tar.gz: 1b23aa71bbe0cf30b6d39ce68a851a2ce1baaac29ab75b0119ba0d9aec451553cdc53db886fbe92647baac6660e0202ac6760806f9121a0b04b18f07c251085a

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

@@ -21,6 +21,7 @@ require 'sketchup-api-stubs/stubs/Layout/AngularDimension.rb'
 require 'sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb'
 require 'sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb'
 require 'sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb'
+require 'sketchup-api-stubs/stubs/Layout/Dictionary.rb'
 require 'sketchup-api-stubs/stubs/Layout/Document.rb'
 require 'sketchup-api-stubs/stubs/Layout/Ellipse.rb'
 require 'sketchup-api-stubs/stubs/Layout/Entities.rb'
@@ -82,6 +83,9 @@ require 'sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Entities.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Environment.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/Environments.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Face.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb'
@@ -103,6 +107,7 @@ require 'sketchup-api-stubs/stubs/Sketchup/Licensing.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/LineStyle.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/LineStyles.rb'
+require 'sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Loop.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Material.rb'
 require 'sketchup-api-stubs/stubs/Sketchup/Materials.rb'
@@ -129,6 +134,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/Snap.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/Array.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 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/BoundingBox.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Bounding boxes are three-dimensional boxes (eight corners), aligned with the
@@ -141,7 +141,7 @@ class Geom::BoundingBox
   #   boundingbox.add([100, 200, -400], [200, 400, 100])
   #   # This will return Point3d(100, 200, -400).
   #   boundingbox.corner(0)
-  #   # This will return Point3d(100, 200, -400).
+  #   # This will return Point3d(100, 400, 100).
   #   boundingbox.corner(6)
   #
   # @param [Integer] corner_index

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The bounds2d class represents an axis aligned bounding box represented by
@@ -14,7 +14,10 @@ class Geom::Bounds2d
   # checks whether the point values are the same
   #
   # @example
-  #   entity.bounds == entity.untransformed_bounds
+  #   bounds1 = Geom::Bounds2d.new(0.0, 0.0, 5.0, 5.0)
+  #   bounds2 = Geom::Bounds2d.new([0, 0], [5, 5])
+  #   # Return true
+  #   bounds1 == bounds2
   #
   # @param [Geom::Bounds2d] other
   #
@@ -27,10 +30,10 @@ 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(5.0, 5.0, 1.0, 7.0)
   #   height = bounds.height
   #
-  # @return [Geom::Point2d]
+  # @return [Float]
   #
   # @version LayOut 2018
   def height
@@ -39,7 +42,11 @@ class Geom::Bounds2d
   # The {#initialize} method creates a new {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
+  #   bounds1 = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
+  #
+  #   upper_left = Geom::Point2d.new(1, 1)   # is equivalent to upper_left = [1, 1]
+  #   lower_right = Geom::Point2d.new(3, 3)   # is equivalent to lower_right = [3, 3]
+  #   bounds2 = Geom::Bounds2d.new(upper_left, lower_right)
   #
   # @overload initialize(other_bounds)
   #
@@ -80,8 +87,9 @@ class Geom::Bounds2d
   # corner of the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
-  #   l_r = bounds.lower_right
+  #   bounds = Geom::Bounds2d.new(2.0, 2.0, 1.0, 1.0)
+  #   # The result is a Point2d(3, 3)
+  #   lower_right = bounds.lower_right
   #
   # @return [Geom::Point2d]
   #
@@ -89,8 +97,9 @@ class Geom::Bounds2d
   def lower_right
   end
 
-  # The {#set!} method sets the {Geom::Bounds2d} to match another one.
-  # The argument is anything that can be converted into a {Geom::Bounds2d}.
+  # The {#set!} method is used to update the dimensions and position of a {Geom::Bounds2d} object so
+  # that it matches the specified bounds. The argument is anything that can be converted into a
+  # {Geom::Bounds2d}.
   #
   # @example
   #   bounds = Geom::Bounds2d.new(3.0, 3.0, 5.0, 5.0)
@@ -131,11 +140,11 @@ class Geom::Bounds2d
   def set!(*args)
   end
 
-  # The {#to_a} method returns an array which contains the {Geom::Point2d} that
+  # The {#to_a} method returns an array which contains the {Geom::Point2d}s that
   # define the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new
+  #   bounds = Geom::Bounds2d.new(2.0, 2.0, 5.0, 5.0)
   #   bounds.to_a.each { |point| p point.to_s }
   #
   # @return [Array(Geom::Point2d, Geom::Point2d)]
@@ -148,8 +157,9 @@ class Geom::Bounds2d
   # of the {Geom::Bounds2d}.
   #
   # @example
-  #   bounds = Geom::Bounds2d.new(0.0, 0.0, 1.0, 1.0)
-  #   u_l = bounds.upper_left
+  #   bounds = Geom::Bounds2d.new(2.0, 2.0, 1.0, 1.0)
+  #   # The result is a Point2d(2, 2)
+  #   upper_left = bounds.upper_left
   #
   # @return [Geom::Point2d]
   #
@@ -160,10 +170,10 @@ 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(5.0, 5.0, 7.0, 1.0)
   #   width = bounds.width
   #
-  # @return [Geom::Point2d]
+  # @return [Float]
   #
   # @version LayOut 2018
   def width

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LatLong class contains various methods for creating and manipulating
@@ -12,13 +12,13 @@ class Geom::LatLong
   # The new method creates a LatLong object.
   #
   # @example
-  #   ll = [40.01700, 105.28300]
-  #   latlong = Geom::LatLong.new(ll)
-  #   if (latlong)
-  #     UI.messagebox(latlong)
-  #   else
-  #     UI.messagebox("Failure")
-  #   end
+  #   # No arguments, creates a latlong with (0, 0)
+  #   latlong1 = Geom::LatLong.new
+  #
+  #   latlong2 = Geom::LatLong.new(40.01700, 105.28300)
+  #
+  #   array = [40.01700, 105.28300]
+  #   latlong3 = Geom::LatLong.new(array)
   #
   # @overload initialize
   #
@@ -36,8 +36,8 @@ class Geom::LatLong
   #
   # @overload initialize(lat, long)
   #
-  #   @param [Numeric] lat
-  #   @param [Numeric] long
+  #   @param [Numeric] latitude
+  #   @param [Numeric] longitude
   #   @return [Geom::LatLong]
   #
   # @version SketchUp 6.0
@@ -47,14 +47,9 @@ class Geom::LatLong
   # The Latitude method retrieves the latitude coordinate from a LatLong object.
   #
   # @example
-  #   ll = [40.01700, 105.28300]
-  #   latlong = Geom::LatLong.new(ll)
+  #   latlong = Geom::LatLong.new(40.01700, 105.28300)
+  #   # The result is 40.01700
   #   latitude = latlong.latitude
-  #   if (latitude)
-  #     UI.messagebox(latitude)
-  #   else
-  #     UI.messagebox("Failure")
-  #   end
   #
   # @return [Float] a latitude coordinate value
   #
@@ -66,14 +61,9 @@ class Geom::LatLong
   # object.
   #
   # @example
-  #   ll = [40.01700, 105.28300]
-  #   latlong = Geom::LatLong.new(ll)
+  #   latlong = Geom::LatLong.new(40.01700, 105.28300)
+  #   # The result is 105.28300
   #   longitude = latlong.longitude
-  #   if (longitude)
-  #     UI.messagebox(longitude)
-  #   else
-  #     UI.messagebox("Failure")
-  #   end
   #
   # @return [Float] a latitude coordinate value
   #
@@ -84,7 +74,7 @@ class Geom::LatLong
   # The {#to_a} method converts a LatLong object to an array of two values.
   #
   # @example
-  #   latlong = Geom::LatLong.new([40.01700, 105.28300])
+  #   latlong = Geom::LatLong.new(40.01700, 105.28300)
   #   array = latlong.to_a
   #
   # @return [Array(Float, Float)] an array of latitude and longitude
@@ -108,14 +98,9 @@ class Geom::LatLong
   # The to_utm method converts a LatLong object to a UTM object.
   #
   # @example
-  #   ll = [40.01700, 105.28300]
-  #   latlong = Geom::LatLong.new(ll)
+  #   latlong = Geom::LatLong.new(40.01700, 105.28300)
+  #   # The result is UTM(48 T 524150.82056 4429682.40743)
   #   utm = latlong.to_utm
-  #   if (utm)
-  #     UI.messagebox(utm)
-  #   else
-  #     UI.messagebox("Failure")
-  #   end
   #
   # @return [Geom::UTM]
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 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 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Geom::Point2d} class allows you to work with a point in 2D space.
@@ -10,14 +10,14 @@
 #
 # @example
 #   # No arguments, creates a point at the origin [0, 0]
-#   pt1 = Geom::Point2d.new
+#   point1 = Geom::Point2d.new
 #
 #   # Creates a point at x of 1, y of 2.
-#   pt2 = Geom::Point2d.new(1, 2)
+#   point2 = Geom::Point2d.new(1, 2)
 #
 #   # You can also create a point directly by simply assigning the x, and y
 #   # values to a variable as an array:
-#   pt3 = [1, 2]
+#   point3 = [1, 2]
 #
 # @version LayOut 2018
 class Geom::Point2d
@@ -28,10 +28,16 @@ class Geom::Point2d
   # {Geom::Point2d}, or to set the values of the {Geom::Point2d} by adding a
   # {Geom::Vector2d} to the {Geom::Point2d}.
   #
-  # @example
-  #   pt = [1, 1]
-  #   # the result is a Point2d(2, 3)
-  #   pt2 = pt + [1, 2]
+  # @example Translate Point2d with Vector2d
+  #   point = Geom::Point2d.new(1, 1)
+  #   vector = Geom::Vector2d.new(1, 2)
+  #   # The result is a Point2d(2, 3)
+  #   new_point = point + vector
+  #
+  # @example Translate Point2d with vector in Array form
+  #   point = Geom::Point2d.new(1, 1)
+  #   # The result is a Point2d(2, 3)
+  #   new_point = point + [1, 2]
   #
   # @param [Geom::Vector2d, Array(Numeric, Numeric)] vector
   #
@@ -44,23 +50,37 @@ class Geom::Point2d
   # The {#-} operator is a simple way to subtract from the current x and y values
   # of the {Geom::Point2d}.
   #
-  # @example
-  #   vec = Geom::Vector2d.new(1, 2)
-  #   # result is a Point2d(3, 0)
-  #   pt = [4, 2] - vec
-  #   # result is a Vector2d(1, 2)
-  #   vec2 = [4, 2] - pt
+  # @example Translate Point2d by vector in Array form
+  #   point = Geom::Point2d.new(4, 2)
+  #   # The result is a Vector2d(3, 0)
+  #   vector = point - [1, 2]
   #
-  # @overload -(vector)
+  # @example Calculate the Vector2d between two Point2d
+  #   point1 = Geom::Point2d.new(4, 2)
+  #   point2 = Geom::Point2d.new(1, 2)
+  #   # The result is a Vector2d(3, 0)
+  #   vector = point1 - point2
   #
-  #   @param [Geom::Vector2d, Array(Numeric, Numeric)] vector
-  #   @return [Geom::Point2d]
+  # @example Translate Point2d with Vector2d
+  #   point = Geom::Point2d.new(4, 2)
+  #   vector = Geom::Vector2d.new(3, 0)
+  #   # The result is a Point2d(1, 2)
+  #   new_point = point - vector
+  #
+  # @overload -(array2d)
   #
-  # @overload -(point)
+  #   @param [Array(Numeric, Numeric)] array2d
+  #   @return [Geom::Vector2d]
+  #
+  # @overload -(point2d)
   #
   #   @param [Geom::Point2d] point2d
-  #   @return [Geom::Vector2d] a vector indicating the difference between the two
-  #       points
+  #   @return [Geom::Vector2d]
+  #
+  # @overload -(vector2d)
+  #
+  #   @param [Geom::Vector2d] vector2d
+  #   @return [Geom::Point2d]
   #
   # @version LayOut 2018
   def -(arg)
@@ -72,6 +92,7 @@ class Geom::Point2d
   # @example
   #   point1 = Geom::Point2d.new(1, 1)
   #   point2 = Geom::Point2d.new(0, 1)
+  #   # Return false
   #   status = point1 == point2
   #
   # @param [Geom::Point2d, Array(Numeric, Numeric)] point
@@ -88,7 +109,7 @@ class Geom::Point2d
   # @example
   #   point = Geom::Point2d.new(1, 2)
   #
-  #   # returns the y value of 2
+  #   # Returns the y value of 2
   #   yvalue = point[1]
   #
   # @param [Integer] index
@@ -126,7 +147,7 @@ class Geom::Point2d
   #
   # @example
   #   point = Geom::Point2d.new(1, 2)
-  #   newpoint = point.clone
+  #   new_point = point.clone
   #
   # @return [Geom::Point2d] the cloned {Geom::Point2d} object
   #
@@ -140,7 +161,7 @@ class Geom::Point2d
   # @example
   #   point1 = Geom::Point2d.new(1, 1)
   #   point2 = Geom::Point2d.new(1, 4)
-  #   # result is a value of 3
+  #   # The result is 3
   #   distance = point1.distance(point2)
   #
   # @param [Geom::Point2d, Array(Numeric, Numeric)] point
@@ -155,14 +176,14 @@ class Geom::Point2d
   #
   # @example
   #   # No arguments, creates a point at the origin [0, 0]
-  #   pt1 = Geom::Point2d.new
+  #   point1 = Geom::Point2d.new
   #
   #   # Creates a point at x of 1 and y of 2.
-  #   pt2 = Geom::Point2d.new(1, 2)
+  #   point2 = Geom::Point2d.new(1, 2)
   #
   #   # You can also create a point directly by simply assigning the x and y
   #   # values to a variable as an array:
-  #   pt3 = [1, 2]
+  #   point3 = [1, 2]
   #
   # @overload initialize
   #
@@ -201,8 +222,8 @@ class Geom::Point2d
   # @example
   #   point = Geom::Point2d.new
   #   vector = Geom::Vector2d.new(0, 2)
-  #   # result is a Point2d(0, 1)
-  #   point2 = point1.offset(vector, 1)
+  #   # The result is a Point2d(0, 1)
+  #   new_point = point.offset(vector, 1)
   #
   # @overload offset(vector)
   #
@@ -226,8 +247,8 @@ class Geom::Point2d
   # @example
   #   point = Geom::Point2d.new
   #   vector = Geom::Vector2d.new(0, 2)
-  #   # result is a Point2d(0, 1)
-  #   point1.offset!(vector, 1)
+  #   # The result is a Point2d(0, 1)
+  #   point.offset!(vector, 1)
   #
   # @overload offset!(vector)
   #
@@ -270,6 +291,8 @@ class Geom::Point2d
   # @example
   #   point = Geom::Point2d.new(1, 2)
   #   array = point.to_a
+  #   # The result is [1, 2]
+  #   p array
   #
   # @return [Array(Numeric, Numeric)] an array of two numbers representing x, y
   #   of the {Geom::Point2d}
@@ -282,7 +305,7 @@ class Geom::Point2d
   #
   # @example
   #   point = Geom::Point2d.new(1, 2)
-  #   str = point.to_s
+  #   string = point.to_s
   #
   # @return [String]
   #
@@ -296,8 +319,8 @@ class Geom::Point2d
   # @example
   #   point = Geom::Point2d.new(4, 5)
   #   transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
-  #   # pt will be (6, 8)
-  #   pt = point.transform(transformation)
+  #   # The result is a Point2d(6, 8)
+  #   transformed_point = point.transform(transformation)
   #
   # @param [Geom::Transformation2d] transform
   #   A Transformation object to apply to the point.
@@ -314,7 +337,7 @@ class Geom::Point2d
   # @example
   #   point = Geom::Point2d.new(4, 5)
   #   transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
-  #   # point will be (6, 8)
+  #   # The result is a Point2d(6, 8)
   #   point.transform!(transformation)
   #
   # @param [Geom::Transformation2d] transform
@@ -329,13 +352,13 @@ class Geom::Point2d
   # The {#vector_to} method returns the vector between points.
   #
   # @example
-  #   pt1 = Geom::Point2d.new(1, 1)
-  #   pt2 = Geom::Point2d.new(3, 1)
+  #   point1 = Geom::Point2d.new(1, 1)
+  #   point2 = Geom::Point2d.new(3, 1)
   #
-  #   # result is a Vector2d(2, 0)
-  #   vec = pt1.vector_to(pt2) # is equivalent to (pt2 - pt1)
+  #   # The result is a Vector2d(2, 0)
+  #   vector = point1.vector_to(point2) # is equivalent to (point2 - point1)
   #
-  # @param [Geom::Point2d] point
+  # @param [Geom::Point2d, Array(Numeric, Numeric)] point
   #
   # @return [Geom::Vector2d]
   #