sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Geom/Transformation.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Transformations are a standard construct in the 3D world for representing
@@ -129,6 +129,13 @@ class Geom::Transformation
   #   @param [Float] zscale  The scale factor in the z direction for the transform.
   #   @return [Geom::Transformation]
   #
+  # @overload scaling(point, scale)
+  #
+  #   With two arguments, it does a uniform scale about an arbitrary point.
+  #   @param [Geom::Point3d] point
+  #   @param [Float] scale  The global scale factor for the transform.
+  #   @return [Geom::Transformation]
+  #
   # @overload scaling(point, xscale, yscale, zscale)
   #
   #   With four arguments it does a non-uniform scale about an arbitrary point.
@@ -138,13 +145,6 @@ class Geom::Transformation
   #   @param [Float] zscale  The scale factor in the z direction for the transform.
   #   @return [Geom::Transformation]
   #
-  # @overload scaling(point, scale)
-  #
-  #   With two arguments, it does a uniform scale about an arbitrary point.
-  #   @param [Geom::Point3d] point
-  #   @param [Float] scale  The global scale factor for the transform.
-  #   @return [Geom::Transformation]
-  #
   # @version SketchUp 6.0
   def self.scaling(*args)
   end
@@ -196,20 +196,20 @@ class Geom::Transformation
   #   @param [Geom::Transformation] transformation
   #   @return [Geom::Transformation]
   #
-  # @overload *(plane)
+  # @overload *(point)
   #
-  #   @param [Array<Float, Float, Float, Float>] plane
-  #   @return [Array<Float, Float, Float, Float>] transformed plane
+  #   @param [Array<Float, Float, Float>] point
+  #   @return [Array<Float, Float, Float>]
   #
   # @overload *(plane)
   #
   #   @param [Array<Geom::Point3d, Geom::Vector3d>] plane
   #   @return [Array<Float, Float, Float, Float>] transformed plane
   #
-  # @overload *(point)
+  # @overload *(plane)
   #
-  #   @param [Array<Float, Float, Float>] point
-  #   @return [Geom::Point3d]
+  #   @param [Array<Float, Float, Float, Float>] plane
+  #   @return [Array<Float, Float, Float, Float>] transformed plane
   #
   # @version SketchUp 6.0
   def *(arg)
@@ -232,13 +232,15 @@ class Geom::Transformation
   # {IDENTITY} transform.
   #
   # @example
-  #   tr = Geom::Transformation.new(ORIGIN)
+  #   point = Geom::Point3d.new(10, 20, 30)
+  #   tr = Geom::Transformation.new(point)
   #   # Returns false.
   #   status = tr.identity?
   #
   # @example
-  #   # Returns true.
-  #   status = IDENTITY.identity?
+  #   tr = Geom::Transformation.new(ORIGIN)
+  #   # Returns false.
+  #   status = tr.identity?
   #
   # @example
   #   tr = Geom::Transformation.new
@@ -246,10 +248,8 @@ class Geom::Transformation
   #   status = tr.identity?
   #
   # @example
-  #   point = Geom::Point3d.new(10, 20, 30)
-  #   tr = Geom::Transformation.new(point)
-  #   # Returns false.
-  #   status = tr.identity?
+  #   # Returns true.
+  #   status = IDENTITY.identity?
   #
   # @note As of SketchUp 2018, this now looks at the data to determine if the
   #   transformation is identity. Prior to SU2018, this only looks at the flag to
@@ -300,12 +300,12 @@ class Geom::Transformation
   #   @param [Array<Float>] Creates a Transformation from a 16 element Array.
   #   @return [Geom::Transformation]
   #
-  # @overload initialize(xaxis, yaxis, zaxis, origin)
+  # @overload initialize(scale)
   #
-  #   @param [Geom::Vector3d] xaxis
-  #   @param [Geom::Vector3d] yaxis
-  #   @param [Geom::Vector3d] zaxis
-  #   @param [Geom::Point3d] origin
+  #   Creates a transformation that does uniform scaling.
+  #   @note Versions prior to SU2018 would produce transformations which
+  #     didn't always work right in SketchUp. See {.scaling} for more info.
+  #   @param [Float] scale
   #   @return [Geom::Transformation]
   #
   # @overload initialize(origin, zaxis)
@@ -333,12 +333,12 @@ class Geom::Transformation
   #   @param [Float] angle
   #   @return [Geom::Transformation]
   #
-  # @overload initialize(scale)
+  # @overload initialize(xaxis, yaxis, zaxis, origin)
   #
-  #   Creates a transformation that does uniform scaling.
-  #   @note Versions prior to SU2018 would produce transformations which
-  #     didn't always work right in SketchUp. See {.scaling} for more info.
-  #   @param [Float] scale
+  #   @param [Geom::Vector3d] xaxis
+  #   @param [Geom::Vector3d] yaxis
+  #   @param [Geom::Vector3d] zaxis
+  #   @param [Geom::Point3d] origin
   #   @return [Geom::Transformation]
   #
   # @version SketchUp 6.0
@@ -404,9 +404,9 @@ class Geom::Transformation
   #   @param [Geom::Point3d] point
   #   @return [Geom::Transformation]
   #
-  # @overload set!(scale)
+  # @overload set!(vector)
   #
-  #   @param [Float] scale
+  #   @param [Geom::Vector3d] vector
   #   @return [Geom::Transformation]
   #
   # @overload set!(matrix)
@@ -414,9 +414,9 @@ class Geom::Transformation
   #   @param [Array<Float>] matrix  Array of 16 floats.
   #   @return [Geom::Transformation]
   #
-  # @overload set!(vector)
+  # @overload set!(scale)
   #
-  #   @param [Geom::Vector3d] vector
+  #   @param [Float] scale
   #   @return [Geom::Transformation]
   #
   # @version SketchUp 6.0

data/SketchUp/Geom/Transformation2d.rb

@@ -1,12 +1,126 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 #
 # @version LayOut 2018
 class Geom::Transformation2d
 
+  # Class Methods
+
+  # The {.rotation} method is used to create a transformation that does rotation
+  # about a point.
+  #
+  # @example
+  #   point = Geom::Point2d.new(10, 5)
+  #   angle = 45.degrees # Return 45 degrees in radians.
+  #   transformation = Geom::Transformation2d.rotation(point, angle)
+  #
+  # @param [Geom::Point2d] point
+  #
+  # @param [Float] angle
+  #   The angle in radians.
+  #
+  # @return [Geom::Transformation2d]
+  #
+  # @version LayOut 2019
+  def self.rotation(point, angle)
+  end
+
+  # The {.scaling} method is used to create a transformation that does scaling.
+  #
+  # @example
+  #   point = Geom::Point3d.new(20, 30, 0)
+  #   scale = 10
+  #   tr = Geom::Transformation2d.scaling(point, scale)
+  #
+  # @overload scaling(scale)
+  #
+  #   With one argument, it does a uniform scale about the origin.
+  #   @param [Float] scale  The global scale factor for the transform.
+  #   @return [Geom::Transformation2d]
+  #
+  # @overload scaling(xscale, yscale)
+  #
+  #   With two arguments, it does a non-uniform scale about the origin.
+  #   @param [Float] xscale  The scale factor in the x direction for the transform.
+  #   @param [Float] yscale  The scale factor in the y direction for the transform.
+  #   @return [Geom::Transformation2d]
+  #
+  # @overload scaling(point, scale)
+  #
+  #   With two arguments, it does a uniform scale about an arbitrary point.
+  #   @param [Geom::Point2d] point
+  #   @param [Float] scale  The global scale factor for the transform.
+  #   @return [Geom::Transformation2d]
+  #
+  # @overload scaling(point, xscale, yscale)
+  #
+  #   With three arguments it does a non-uniform scale about an arbitrary point.
+  #   @param [Geom::Point2d] point
+  #   @param [Float] xscale  The scale factor in the x direction for the transform.
+  #   @param [Float] yscale  The scale factor in the y direction for the transform.
+  #   @return [Geom::Transformation2d]
+  #
+  # @version LayOut 2019
+  def self.scaling(*args)
+  end
+
+  # The {.translation} method is used to create a transformation that does
+  # translation.
+  #
+  # @example
+  #   vector = Geom::Vector2d.new(0, 1)
+  #   tr = Geom::Transformation2d.translation(vector)
+  #
+  # @overload translation(vector)
+  #
+  #   @param [Geom::Vector2d] vector
+  #   @return [Geom::Transformation2d]
+  #
+  # @overload translation(point)
+  #
+  #   @param [Geom::Point2d] point
+  #   @return [Geom::Transformation2d]
+  #
+  # @version LayOut 2019
+  def self.translation(vector)
+  end
+
   # Instance Methods
 
+  # The {#*} method is used to do matrix multiplication using the transform.
+  #
+  # @example
+  #   point1 = Geom::Point2d.new(5, 10)
+  #   point2 = Geom::Point2d.new(2, 2)
+  #   tr = Geom::Transformation2d.new(point1)
+  #   # Returns Point2d(7, 12)
+  #   point3 = tr * point2
+  #
+  # @overload *(point)
+  #
+  #   @param [Geom::Point2d] point
+  #   @return [Geom::Point2d]
+  #
+  # @overload *(vector)
+  #
+  #   @param [Geom::Vector2d] vector
+  #   @return [Geom::Vector2d]
+  #
+  # @overload *(transformation)
+  #
+  #   @param [Geom::Transformation2d] transformation
+  #   @return [Geom::Transformation2d]
+  #
+  # @overload *(point)
+  #
+  #   @param [Array<Float, Float>] point
+  #   @return [Array<Float, Float>]
+  #
+  # @version LayOut 2019
+  def *(arg)
+  end
+
   # The {#==} method checks to see if the two {Geom::Transformation2d}s are equal.
   # This checks whether the values of the transformations are the same.
   #
@@ -38,19 +152,19 @@ class Geom::Transformation2d
   # {IDENTITY_2D} transform.
   #
   # @example
-  #   tr = Geom::Transformation2d.new
-  #   # Returns true.
+  #   array = {1.0, 0.0, 0.0, 1.0, 1.0, 0.0}
+  #   tr = Geom::Transformation2d.new(array)
+  #   # Returns false.
   #   status = tr.identity?
   #
   # @example
+  #   tr = Geom::Transformation2d.new
   #   # Returns true.
-  #   status = IDENTITY.identity?
+  #   status = tr.identity?
   #
   # @example
-  #   array = {1.0, 0.0, 0.0, 1.0, 1.0, 0.0}
-  #   tr = Geom::Transformation2d.new(array)
-  #   # Returns false.
-  #   status = tr.identity?
+  #   # Returns true.
+  #   status = IDENTITY_2D.identity?
   #
   # @return [Boolean] +true+ if the transform is the identity
   #
@@ -71,11 +185,6 @@ class Geom::Transformation2d
   #
   #   @return [Geom::Transformation2d] identity Transformation2d.
   #
-  # @overload initialize(array)
-  #
-  #   @param [Array<Float>] array A 6 element Array.
-  #   @return [Geom::Transformation2d]
-  #
   # @overload initialize(transformation)
   #
   #   Creates a Transformation2d that is a copy of another Transformation2d.
@@ -83,10 +192,41 @@ class Geom::Transformation2d
   #   @param [Geom::Transformation2d] transform
   #   @return [Geom::Transformation2d]
   #
+  # @overload initialize(array)
+  #
+  #   @param [Array<Float>] array A 6 element Array.
+  #   @return [Geom::Transformation2d]
+  #
   # @version LayOut 2018
   def initialize(*args)
   end
 
+  # The {#inverse} method is used to retrieve the inverse of a transformation.
+  #
+  # @example
+  #   point = Geom::Point2d.new(5, 10)
+  #   tr1 = Geom::Transformation2d.new(point)
+  #   tr2 = tr1.inverse
+  #
+  # @return [Geom::Transformation2d]
+  #
+  # @version LayOut 2019
+  def inverse
+  end
+
+  # The {#invert!} method sets the transformation to its inverse.
+  #
+  # @example
+  #   point = Geom::Point2d.new(5, 10)
+  #   tr = Geom::Transformation2d.new(point)
+  #   tr.invert!
+  #
+  # @return [Geom::Transformation2d]
+  #
+  # @version LayOut 2019
+  def invert!
+  end
+
   # The {#set!} method sets the {Geom::Transformation2d} to match another one.
   # The argument is anything that can be converted into a {Geom::Transformation2d}.
   #

data/SketchUp/Geom/UTM.rb

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

data/SketchUp/Geom/Vector2d.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Vector2d class represents vectors in a 2 dimensional space.
@@ -98,7 +98,7 @@ class Geom::Vector2d
   #   # retrieves the y value of 2
   #   yvalue = vector[1]
   #
-  # @param [Numeric] index
+  # @param [Integer] index
   #   The index into an array of two coordinates.
   #
   # @return [Numeric] The value for the x or y coordinate.
@@ -199,17 +199,17 @@ class Geom::Vector2d
   #
   #   @return [Geom::Vector2d]
   #
-  # @overload initialize(vector)
-  #
-  #   @param [Geom::Vector2d, Array(Numeric, Numeric)] vector
-  #   @return [Geom::Vector2d]
-  #
   # @overload initialize(x, y)
   #
   #   @param [Numeric] x The length in the x direction
   #   @param [Numeric] y The length in the y direction
   #   @return [Geom::Vector2d]
   #
+  # @overload initialize(vector)
+  #
+  #   @param [Geom::Vector2d, Array(Numeric, Numeric)] vector
+  #   @return [Geom::Vector2d]
+  #
   # @version LayOut 2018
   def initialize(*args)
   end
@@ -233,14 +233,14 @@ class Geom::Vector2d
   #   # returns 4
   #   l = vector.length
   #
-  # @return [Numeric] The length of the {Geom::Vector2d}
+  # @return [Length] The length of the {Geom::Vector2d}
   #
   # @version LayOut 2018
   def length
   end
 
   # The {#length=} method sets the length of the {Geom::Vector2d}. The new length
-  # must be greater than 0.
+  # must not be 0.
   #
   # @example
   #   vector = Geom::Vector2d.new(0, 4)
@@ -409,6 +409,42 @@ class Geom::Vector2d
   def to_s
   end
 
+  # The {#transform} method applies a transformation to a vector, returning a new
+  # vector. The original vector is unchanged by this method.
+  #
+  # @example
+  #   vector = Geom::Vector2d.new(4, 5)
+  #   transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
+  #   # vector2 will be (6, 8)
+  #   vector2 = vector.transform(transformation)
+  #
+  # @param [Geom::Transformation2d] transform
+  #   A transformation object to apply to the vector.
+  #
+  # @return [Geom::Vector2d] the newly transformed vector
+  #
+  # @version LayOut 2019
+  def transform(transform)
+  end
+
+  # The {#transform!} method applies a transformation to a vector. The vector
+  # itself is modified.
+  #
+  # @example
+  #   vector = Geom::Vector2d.new(4, 5)
+  #   transformation = Geom::Transformation2d.new([1, 0, 0, 1, 2, 3])
+  #   # vector will be (6, 8)
+  #   vector.transform!(transformation)
+  #
+  # @param [Geom::Transformation2d] transform
+  #   A Transformation object to apply to the vector.
+  #
+  # @return [Geom::Vector2d] the transformed vector
+  #
+  # @version LayOut 2019
+  def transform!(transform)
+  end
+
   # The {#unit_vector?} method returns whether the {Geom::Vector2d} is a unit
   # vector. This is equivalent to vector.length == 1.0
   #