sketchup-api-stubs 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: fcf4a6a29a08187ad0c998fa4267fe93668631a6b6809b390e33cb00c38271b5
-  data.tar.gz: 4ae462a23300aba5b2eb3bb9c8e31c5b9cd5b310b2814b416b2a553b4e2f1820
+SHA1:
+  metadata.gz: 2a743ad1c6d1c7150a4eb0adcc8888ffbc65dd9c
+  data.tar.gz: e3630910a907338ae16857ec747c73aa6b75035f
 SHA512:
-  metadata.gz: 6446929d6bfc2575cafa50436253a0554fb5b11d39daebc20e61aca04a4b4cd9c5a1aa02cc232afeaee59b1ed4cc01f2b89f1ee9aab747b876259711e1defe91
-  data.tar.gz: 1a79f2773808b57e683d24830a5c80fadcf6abddbb51b79854d22f4656f2732e5619f5bad96ffbc9df28423fe7b6c13c57eaf3cfb70ba36eb17aed95d715707a
+  metadata.gz: cdf38818748b0d56d4bfed840039b0a5cf7647cfe807ea25bf43ac5c5f44fe972e15d9414e044aa38a6b569e77b749b6c0bca6ac4299a349550390ceaecc241f
+  data.tar.gz: 386d1a9096e721fd4bf1ae587fc33b001e573bfe805d25ad5b08959900a9df8d53dbfe71ab3e5704974256f8b14ddd9c4522352418c66add645fe6ba6c5c58f3

data/.yardopts

@@ -1,7 +1,7 @@
---title "SketchUp Ruby API Documentation"
---no-api
---no-private
--p su-template
-SketchUp/**/*.rb
--
-pages/*.md
+--title "SketchUp Ruby API Documentation"
+--no-api
+--no-private
+-p su-template
+SketchUp/**/*.rb
+-
+pages/*.md

data/SketchUp/Geom/BoundingBox.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Bounding boxes are three-dimensional boxes (eight corners), aligned with the
@@ -156,9 +156,7 @@ class Geom::BoundingBox
   def corner(corner_index)
   end
 
-  # The depth method is used to retrieve the depth of the bounding box.
-  #
-  # The depth is returned in the currently set units (inches, by default).
+  # The {#depth} method is used to retrieve the depth of the bounding box.
   #
   # @example
   #   boundingbox = Geom::BoundingBox.new
@@ -166,17 +164,15 @@ class Geom::BoundingBox
   #   # This will return a Length of 500.0.
   #   length = boundingbox.depth
   #
-  # @return [Length] the depth of the bounding box if successful
+  # @return [Length] the depth of the bounding box
   #
   # @version SketchUp 6.0
   def depth
   end
 
-  # The diagonal method is used to get the length of the diagonal of the
+  # The {#diagonal} method is used to get the length of the diagonal of the
   # bounding box.
   #
-  # The diagonal is returned in the currently set units (inches, by default).
-  #
   # @example
   #   boundingbox = Geom::BoundingBox.new
   #   boundingbox.add([100, 200, -400], [200, 400, 100])
@@ -184,7 +180,7 @@ class Geom::BoundingBox
   #   length = boundingbox.diagonal
   #
   # @return [Length] the size of the diagonal for the bounding
-  #   box if successful
+  #   box
   #
   # @version SketchUp 6.0
   def diagonal
@@ -208,9 +204,7 @@ class Geom::BoundingBox
   def empty?
   end
 
-  # The height method is used to retrieve the height of the bounding box.
-  #
-  # The height is returned in the currently set units (inches, by default).
+  # The {#height} method is used to retrieve the height of the bounding box.
   #
   # @example
   #   boundingbox = Geom::BoundingBox.new
@@ -313,9 +307,7 @@ class Geom::BoundingBox
   def valid?
   end
 
-  # The width method is used to retrieve the width of the bounding box.
-  #
-  # The width is returned in the currently set units (inches, by default).
+  # The {#width} method is used to retrieve the width of the bounding box.
   #
   # @example
   #   boundingbox = Geom::BoundingBox.new

data/SketchUp/Geom/Bounds2d.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The bounds2d class represents an axis aligned bounding box represented by
@@ -39,7 +39,7 @@ class Geom::Bounds2d
   # The {#initialize} method creates a new {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)
   #
   # @overload initialize(other_bounds)
   #
@@ -52,10 +52,12 @@ class Geom::Bounds2d
   #   @param [Geom::Point2d] lower_right
   #   @return [Geom::Bounds2d]
   #
-  # @overload initialize(float_array)
+  # @overload initialize(x, y, width, height)
   #
-  #   @param [Array(Float, Float, Float, Float)] float_array An array of four
-  #     floats (x, y, width, height)
+  #   @param [Float] x
+  #   @param [Float] y
+  #   @param [Float] width
+  #   @param [Float] height
   #   @return [Geom::Bounds2d]
   #
   # @overload initialize(point_array)
@@ -64,12 +66,10 @@ class Geom::Bounds2d
   #     {Geom::Point2d}s
   #   @return [Geom::Bounds2d]
   #
-  # @overload initialize(x, y, width, height)
+  # @overload initialize(float_array)
   #
-  #   @param [Float] x
-  #   @param [Float] y
-  #   @param [Float] width
-  #   @param [Float] height
+  #   @param [Array(Float, Float, Float, Float)] float_array An array of four
+  #     floats (x, y, width, height)
   #   @return [Geom::Bounds2d]
   #
   # @version LayOut 2018
@@ -107,10 +107,12 @@ class Geom::Bounds2d
   #   @param [Geom::Point2d] lower_right
   #   @return [Geom::Bounds2d]
   #
-  # @overload set!(float_array)
+  # @overload set!(x, y, width, height)
   #
-  #   @param [Array(Float, Float, Float, Float)] float_array An array of four
-  #     floats (x, y, width, height)
+  #   @param [Float] x
+  #   @param [Float] y
+  #   @param [Float] width
+  #   @param [Float] height
   #   @return [Geom::Bounds2d]
   #
   # @overload set!(point_array)
@@ -119,12 +121,10 @@ class Geom::Bounds2d
   #     {Geom::Point2d}s
   #   @return [Geom::Bounds2d]
   #
-  # @overload set!(x, y, width, height)
+  # @overload set!(float_array)
   #
-  #   @param [Float] x
-  #   @param [Float] y
-  #   @param [Float] width
-  #   @param [Float] height
+  #   @param [Array(Float, Float, Float, Float)] float_array An array of four
+  #     floats (x, y, width, height)
   #   @return [Geom::Bounds2d]
   #
   # @version LayOut 2018

data/SketchUp/Geom/LatLong.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LatLong class contains various methods for creating and manipulating
@@ -29,15 +29,15 @@ class Geom::LatLong
   #   @param latlong [Geom::LatLong]
   #   @return [Geom::LatLong]
   #
-  # @overload initialize(lat, long)
+  # @overload initialize(latlong_array)
   #
-  #   @param lat  [Numeric]
-  #   @param long [Numeric]
+  #   @param latlong_array [Array(Numeric, Numeric)]
   #   @return [Geom::LatLong]
   #
-  # @overload initialize(latlong_array)
+  # @overload initialize(lat, long)
   #
-  #   @param latlong_array [Array(Numeric, Numeric)]
+  #   @param lat  [Numeric]
+  #   @param long [Numeric]
   #   @return [Geom::LatLong]
   #
   # @version SketchUp 6.0

data/SketchUp/Geom/OrientedBounds2d.rb

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

data/SketchUp/Geom/Point2d.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Geom::Vector2d} class allows you to work with a point in 2D space.
@@ -169,17 +169,17 @@ class Geom::Point2d
   #
   #   @return [Geom::Point2d]
   #
-  # @overload initialize(point)
-  #
-  #   @param [Geom::Point2d, Array(Numeric, Numeric)] point
-  #   @return [Geom::Point2d]
-  #
   # @overload initialize(x, y)
   #
   #   @param [Numeric] x The location along the x axis
   #   @param [Numeric] y The location along the y axis
   #   @return [Geom::Point2d]
   #
+  # @overload initialize(point)
+  #
+  #   @param [Geom::Point2d, Array(Numeric, Numeric)] point
+  #   @return [Geom::Point2d]
+  #
   # @version LayOut 2018
   def initialize(*args)
   end
@@ -291,6 +291,42 @@ class Geom::Point2d
   def to_s
   end
 
+  # The {#transform} method applies a transformation to a point, returning a new
+  # point. The original point is unchanged by this method.
+  #
+  # @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)
+  #
+  # @param [Geom::Transformation2d] transform
+  #   A Transformation object to apply to the point.
+  #
+  # @return [Geom::Point2d] the transformed point
+  #
+  # @version LayOut 2019
+  def transform(transform)
+  end
+
+  # The {#transform!} method applies a transformation to a point. The point
+  # itself is modified.
+  #
+  # @example
+  #   point = Geom::Point2d.new(4, 5)
+  #   transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
+  #   # point will be (6, 8)
+  #   point.transform!(transformation)
+  #
+  # @param [Geom::Transformation2d] transform
+  #   A Transformation object to apply to the point.
+  #
+  # @return [Geom::Point2d] the transformed point
+  #
+  # @version LayOut 2019
+  def transform!(transform)
+  end
+
   # The {#vector_to} method returns the vector between points.
   #
   # @example

data/SketchUp/Geom/Point3d.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Point3d class allows you to work with a point in 3D space.
@@ -53,14 +53,14 @@ class Geom::Point3d
   # @param [Float] weight1
   #   A weight or percentage.
   #
-  # @param [Float] point2
-  #   The end point of the line.
+  # @param [Float] point1
+  #   The start point on the line.
   #
   # @param [Float] weight2
   #   A weight or percentage.
   #
-  # @param [Float] point1
-  #   The start point on the line.
+  # @param [Float] point2
+  #   The end point of the line.
   #
   # @return [Geom::Point3d]
   #
@@ -70,20 +70,31 @@ class Geom::Point3d
 
   # Instance Methods
 
-  # The '+' operator is a fast way to add to the current x, y and z values of
-  # a point, or to set the values of a point by adding to other points together.
+  # The {#+} operator is a fast way to add to the current x, y and z values of
+  # a vector.
   #
-  # @example
-  #   pt2 = pt + vec
-  #   pt = pt + [10,10,10]
+  # @example Using vector
+  #   point1 = Geom::Point3d.new(1, 2, 3)
+  #   vector = Geom::Vector3d.new(4, 5, 6)
+  #   point2 = point1 + vector
   #
-  # @param [Geom::Point3d] point2
-  #   A Point3d object.
+  # @example Using array
+  #   point1 = Geom::Point3d.new(1, 2, 3)
+  #   point2 = point1 + [10,10,10]
+  #
+  # @example Using point
+  #   point1 = Geom::Point3d.new(1, 2, 3)
+  #   point2 = Geom::Point3d.new(4, 5, 6)
+  #   # This works because SketchUp treats the array of tripple numerics as
+  #   # a vector in this case.
+  #   point3 = point1 + point2.to_a
+  #
+  # @param [Geom::Vector3d] vector
   #
   # @return [Geom::Point3d]
   #
   # @version SketchUp 6.0
-  def +(point2)
+  def +(vector)
   end
 
   # The '-' operator is a fast way to subtract from the current x, y and z values
@@ -292,9 +303,9 @@ class Geom::Point3d
   #   @param [Geom::Point3d] point3d
   #   @return [Geom::Point3d]
   #
-  # @overload initialize(vertex)
+  # @overload initialize(array3d)
   #
-  #   @param [Sketchup::Vertex] vertex
+  #   @param [Array(Numeric, Numeric, Numeric)] array3d
   #   @return [Geom::Point3d]
   #
   # @overload initialize(array2d)
@@ -307,9 +318,9 @@ class Geom::Point3d
   #   @param [Sketchup::InputPoint] input_point
   #   @return [Geom::Point3d]
   #
-  # @overload initialize(array3d)
+  # @overload initialize(vertex)
   #
-  #   @param [Array(Numeric, Numeric, Numeric)] array3d
+  #   @param [Sketchup::Vertex] vertex
   #   @return [Geom::Point3d]
   #
   # @version SketchUp 6.0
@@ -470,14 +481,14 @@ class Geom::Point3d
   #   @param [Numeric] z The z value for the point.
   #   @return [Geom::Point3d] The newly set Point3d object
   #
-  # @overload set!(point3d)
+  # @overload set!(array3d)
   #
-  #   @param point3d [Geom::Point3d]
+  #   @param [Array(Numeric, Numeric, Numeric)] array3d
   #   @return [Geom::Point3d]
   #
-  # @overload set!(array3d)
+  # @overload set!(point3d)
   #
-  #   @param [Array(Numeric, Numeric, Numeric)] array3d
+  #   @param point3d [Geom::Point3d]
   #   @return [Geom::Point3d]
   #
   # @version SketchUp 6.0

data/SketchUp/Geom/PolygonMesh.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {#Geom::PolygonMesh} class contains methods to create polygon mesh
@@ -177,17 +177,19 @@ class Geom::PolygonMesh
   #
   #   @return [Geom::PolygonMesh]
   #
-  # @overload initialize(numpts, numpolys)
+  # @overload initialize(numpts)
   #
   #   @param [Integer] numpts    How many points will be in the mesh.
-  #   @param [Integer] numpolys  How many polygons will be in the mesh.
   #   @return [Geom::PolygonMesh]
   #
-  # @overload initialize(numpts)
+  # @overload initialize(numpts, numpolys)
   #
   #   @param [Integer] numpts    How many points will be in the mesh.
+  #   @param [Integer] numpolys  How many polygons will be in the mesh.
   #   @return [Geom::PolygonMesh]
   #
+  # @raise [RangeError] If number of points or polygons are negative numbers.
+  #
   # @version SketchUp 6.0
   def initialize(*args)
   end
@@ -201,7 +203,7 @@ class Geom::PolygonMesh
   #   mesh = face.mesh(flags)
   #   normal = mesh.normal_at(1)
   #
-  # @note Index is 1 based (starts at 1).
+  # @note Index starts at 1.
   #
   # @param [Integer] index
   #   The index in the mesh for the vertex normal to be
@@ -224,7 +226,7 @@ class Geom::PolygonMesh
   #   mesh.add_point(point2)
   #   point_from_index = mesh.point_at(1)
   #
-  # @note Index is 1 based (starts at 1).
+  # @note Index starts at 1.
   #
   # @param [Integer] index
   #   The index in the mesh for the point to be retrieved
@@ -277,12 +279,6 @@ class Geom::PolygonMesh
   # The {#polygon_at} method is used to retrieve an array of vertex index values
   # for a polygon at a specific index.
   #
-  # values with the sign indicating a hidden edge. For example, a return value of
-  # +[-1, 2, 3]+ indicates that the edge from +1+ to +2+ is hidden. The negative
-  # values should not be used as an index for point_at, take the positive value
-  # of the index value in the polygon array.  So if you get +[-1, 2,3]+ use +1+
-  # as the argument to {#point_at}.
-  #
   # @example
   #   mesh = Geom::PolygonMesh.new
   #   point1 = Geom::Point3d.new(0, 1, 2)
@@ -291,7 +287,14 @@ class Geom::PolygonMesh
   #   index = mesh.add_polygon(point1, point2, point3)
   #   polygon = mesh.polygon_at(index)
   #
-  # @note Index is 1 based (starts at 1).The returned array can contain negative
+  # @note Index starts at 1.
+  #
+  # @note The returned array can contain negative
+  #   values with the sign indicating a hidden edge. For example, a return value
+  #   of +[-1, 2, 3]+ indicates that the edge from +1+ to +2+ is hidden. The
+  #   negative values should not be used as an index for {#point_at}, take the
+  #   absolute value of the index value in the polygon array.  So if you
+  #   get +[-1, 2,3]+ use +1+ as the argument to {#point_at}.
   #
   # @param [Integer] index
   #   The index of the desired polygon.
@@ -313,6 +316,8 @@ class Geom::PolygonMesh
   #   index = mesh.add_polygon(point1, point2, point3)
   #   points = mesh.polygon_points_at(index)
   #
+  # @note Index starts at 1.
+  #
   # @param [Integer] index
   #   An index for a polygon in the mesh.
   #
@@ -403,14 +408,14 @@ 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.
   #
-  # @param [Boolean] front
-  #   A boolean representing the front or back.
+  # @param [Integer] index
+  #   An Integer representing the UV index.
   #
   # @param [Geom::Point3d] point
   #   A Point3d object representing UV coordinates.
   #
-  # @param [Integer] index
-  #   An Integer representing the UV index.
+  # @param [Boolean] front
+  #   A boolean representing the front or back.
   #
   # @return [nil]
   #