sketchup-api-stubs 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 971d247dca78409c1ad07c0ac8b617950e0f45fd
-  data.tar.gz: 1c357742608d50bc22df3031164b08589fa2f34c
+  metadata.gz: dfc2d857e68407892f7c072436c4e052dae7499d
+  data.tar.gz: 765ad1ffd1cbee5b0a8a73c8d8d077baf715f0a4
 SHA512:
-  metadata.gz: 17b8031751feab019808184440b8de1622d7afc79e24970ae281863588f857bb027e8038a3f7fa1e930d8e081b643bbaee58e223d273026c3a797eda07da8442
-  data.tar.gz: dba9df82eba6d586d3ddbc40c2d250a08e678ce255ce18aa047491b90d19a4ccca4a5ab23f1434e46717f48f9e84c04bc9c99f0cde1efffedddc983b5742d58f
+  metadata.gz: 1462594020825daf177b6593e5f2b9fc0aea0183041b91ce3c46c91995a3685ee461f68b30dd4ffbda1e54d9ca3bd33e71881612cc73999fea8786a6bbd0dda4
+  data.tar.gz: ecb41fc20697e4f2dcfc59a4fa98f2e3f45d63fc8e522c00a06bd86d4979b0dbe174612ae793462a4b51e4b16feac250499bc0f85e966bdce4afe3cc0a20ef8a

data/SketchUp/Geom/BoundingBox.rb

@@ -57,7 +57,7 @@ class Geom::BoundingBox
   #   @param [Array<Geom::Point3d, Geom::BoundingBox, Sketchup::Vertex>]
   #     points_or_bb
   #
-  # @return boundingbox - the new, resized, BoundingBox object if successful
+  # @return [Geom::BoundingBox]
   #
   # @version SketchUp 6.0
   def add(*args)
@@ -72,7 +72,7 @@ class Geom::BoundingBox
   #   # This will return a point Point3d(150, 300, -150).
   #   point = boundingbox.center
   #
-  # @return point - the Point3d at the center of the bounding box
+  # @return [Geom::Point3d] the Point3d at the center of the bounding box
   #   if successful
   #
   # @version SketchUp 6.0
@@ -95,7 +95,7 @@ class Geom::BoundingBox
   #   # This will return true.
   #   boundingbox.empty?
   #
-  # @return boundingbox - the BoundingBox object which was cleared
+  # @return [Geom::BoundingBox] the BoundingBox object which was cleared
   #
   # @version SketchUp 6.0
   def clear
@@ -114,8 +114,7 @@ class Geom::BoundingBox
   #
   # @param [Geom::Point3d, Geom::BoundingBox] point_or_bb
   #
-  # @return status - true if successful (bounding box contains a
-  #   Point3d or BoundingBox object), or false if unsuccessful.
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -147,11 +146,11 @@ class Geom::BoundingBox
   #   # This will return Point3d(100, 200, -400).
   #   boundingbox.corner(6)
   #
-  # @param corner_index
+  # @param [Integer] corner_index
   #   A number (from 0 to 7) representing point at the
   #   corner you want to retrieve.
   #
-  # @return point - a Point3d object if successful
+  # @return [Geom::Point3d] a Point3d object if successful
   #
   # @version SketchUp 6.0
   def corner(corner_index)
@@ -167,7 +166,7 @@ class Geom::BoundingBox
   #   # This will return a Length of 500.0.
   #   length = boundingbox.depth
   #
-  # @return depth - the depth of the bounding box if successful
+  # @return [Length] the depth of the bounding box if successful
   #
   # @version SketchUp 6.0
   def depth
@@ -184,7 +183,7 @@ class Geom::BoundingBox
   #   # This will return a point a Length of ~547.72.
   #   length = boundingbox.diagonal
   #
-  # @return diagonal - the size of the diagonal for the bounding
+  # @return [Length] the size of the diagonal for the bounding
   #   box if successful
   #
   # @version SketchUp 6.0
@@ -201,8 +200,7 @@ class Geom::BoundingBox
   #   # This will return false.
   #   boundingbox.empty?
   #
-  # @return status - true if the bounding box is empty, false if it
-  #   is not empty
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -220,7 +218,7 @@ class Geom::BoundingBox
   #   # This will return a Length of 200.0.
   #   length = boundingbox.height
   #
-  # @return height - the height of the bounding box
+  # @return [Length] the height of the bounding box
   #
   # @version SketchUp 6.0
   def height
@@ -231,7 +229,7 @@ class Geom::BoundingBox
   # @example
   #   boundingbox = Geom::BoundingBox.new
   #
-  # @return boundingbox - a BoundingBox object if successful
+  # @return [Geom::BoundingBox] a BoundingBox object if successful
   #
   # @version SketchUp 6.0
   def initialize
@@ -253,10 +251,10 @@ class Geom::BoundingBox
   #   boundingboxes actually overlap - then call this to get the resulting
   #   boundingbox.
   #
-  # @param boundingbox
+  # @param [Geom::BoundingBox] boundingbox
   #   A second boundbox which might intersect boundingbox1.
   #
-  # @return boundingbox - the resulting BoundingBox object if
+  # @return [Geom::BoundingBox] the resulting BoundingBox object if
   #   successful, an empty BoundingBox object if unsuccessful.
   #
   # @version SketchUp 6.0
@@ -275,7 +273,7 @@ class Geom::BoundingBox
   #   # This will return a point Point3d(700, 900, 800).
   #   point = boundingbox.max
   #
-  # @return point - a Point3d object representing the point where
+  # @return [Geom::Point3d] a Point3d object representing the point where
   #   x, y, and z are the maximum in the bounding box.
   #
   # @version SketchUp 6.0
@@ -291,7 +289,7 @@ class Geom::BoundingBox
   #   # This will return a point Point3d(100, 200, -400).
   #   point = boundingbox.min
   #
-  # @return point - a Point3d object representing the point where
+  # @return [Geom::Point3d] a Point3d object representing the point where
   #   x, y, and z are the maximum in the bounding box.
   #
   # @version SketchUp 6.0
@@ -307,8 +305,7 @@ class Geom::BoundingBox
   #   # This will return true.
   #   boundingbox.valid?
   #
-  # @return status - true if the bounding box is valid (not empty),
-  #   false if it is not valid (empty)
+  # @return [Boolean]
   #
   # @return [Boolean]
   #
@@ -326,7 +323,7 @@ class Geom::BoundingBox
   #   # This will return a Length of 100.0.
   #   length = boundingbox.width
   #
-  # @return width - the width of the bounding box
+  # @return [Length] the width of the bounding box
   #
   # @version SketchUp 6.0
   def width

data/SketchUp/Geom/Bounds2d.rb

@@ -0,0 +1,172 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The bounds2d class represents an axis aligned bounding box represented by
+# two {Geom::Point2d} objects, upper left and lower right positions. The
+# units utilized in the creation and modification {Geom::Bounds2d} are inches.
+#
+# @version LayOut 2018
+class Geom::Bounds2d
+
+  # Instance Methods
+
+  # The {#==} method checks to see if the two {Geom::Bounds2d}s are equal. This
+  # checks whether the point values are the same
+  #
+  # @example
+  #   entity.bounds == entity.untransformed_bounds
+  #
+  # @param [Geom::Bounds2d] other
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2018
+  def ==(other)
+  end
+
+  # The {#height} method returns the height of the {Geom::Bounds2d}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   height = bounds.height
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def height
+  end
+
+  # The {#initialize} method creates a new {Geom::Bounds2d}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #
+  # @overload initialize(other_bounds)
+  #
+  #   @param [Geom::Bounds2d] other_bounds
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload initialize(upper_left, lower_right)
+  #
+  #   @param [Geom::Point2d] upper_left
+  #   @param [Geom::Point2d] lower_right
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload initialize(float_array)
+  #
+  #   @param [Array(Float, Float, Float, Float)] float_array An array of four
+  #     floats (x, y, width, height)
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload initialize(point_array)
+  #
+  #   @param [Array(Geom::Point2d, Geom::Point2d)] point_array An array of two
+  #     {Geom::Point2d}s
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload initialize(x, y, width, height)
+  #
+  #   @param [Float] x
+  #   @param [Float] y
+  #   @param [Float] width
+  #   @param [Float] height
+  #   @return [Geom::Bounds2d]
+  #
+  # @version LayOut 2018
+  def initialize(*args)
+  end
+
+  # The {#lower_right} method returns the {Geom::Point2d} of the lower right
+  # corner of the {Geom::Bounds2d}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   l_r = bounds.lower_right
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  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}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(3.0, 3.0, 5.0, 5.0)
+  #   bounds.set!(Geom::Point2d.new(0.0, 0.0), Geom::Point2d.new(2.0, 2.0))
+  #
+  # @overload set!(other_bounds)
+  #
+  #   @param [Geom::Bounds2d] other_bounds
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload set!(upper_left, lower_right)
+  #
+  #   @param [Geom::Point2d] upper_left
+  #   @param [Geom::Point2d] lower_right
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload set!(float_array)
+  #
+  #   @param [Array(Float, Float, Float, Float)] float_array An array of four
+  #     floats (x, y, width, height)
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload set!(point_array)
+  #
+  #   @param [Array(Geom::Point2d, Geom::Point2d)] point_array An array of two
+  #     {Geom::Point2d}s
+  #   @return [Geom::Bounds2d]
+  #
+  # @overload set!(x, y, width, height)
+  #
+  #   @param [Float] x
+  #   @param [Float] y
+  #   @param [Float] width
+  #   @param [Float] height
+  #   @return [Geom::Bounds2d]
+  #
+  # @version LayOut 2018
+  def set!(*args)
+  end
+
+  # The {#to_a} method returns an array which contains the {Geom::Point2d} that
+  # define the {Geom::Bounds2d}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new
+  #   bounds.to_a.each { |point| p point.to_s }
+  #
+  # @return [Array(Geom::Point2d, Geom::Point2d)]
+  #
+  # @version LayOut 2018
+  def to_a
+  end
+
+  # The {#upper_left} method returns the {Geom::Point2d} of the upper left corner
+  # of the {Geom::Bounds2d}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   u_l = bounds.upper_left
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def upper_left
+  end
+
+  # The {#width} method returns the width of the {Geom::Bounds2d}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new({0.0, 0.0, 1.0, 1.0})
+  #   width = bounds.width
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def width
+  end
+
+end

data/SketchUp/Geom/LatLong.rb

@@ -15,18 +15,33 @@ class Geom::LatLong
   #   ll = [40.01700, 105.28300]
   #   latlong = Geom::LatLong.new(ll)
   #   if (latlong)
-  #     UI.messagebox latlong
+  #     UI.messagebox(latlong)
   #   else
-  #     UI.messagebox "Failure"
+  #     UI.messagebox("Failure")
   #   end
   #
-  # @param latlong
-  #   A latitude and longitude coordinate set as an Array.
+  # @overload initialize
   #
-  # @return latlong - a LatLong object
+  #   @return [Geom::LatLong]
+  #
+  # @overload initialize(latlong)
+  #
+  #   @param latlong [Geom::LatLong]
+  #   @return [Geom::LatLong]
+  #
+  # @overload initialize(lat, long)
+  #
+  #   @param lat  [Numeric]
+  #   @param long [Numeric]
+  #   @return [Geom::LatLong]
+  #
+  # @overload initialize(latlong_array)
+  #
+  #   @param latlong_array [Array(Numeric, Numeric)]
+  #   @return [Geom::LatLong]
   #
   # @version SketchUp 6.0
-  def initialize(latlong)
+  def initialize(*args)
   end
 
   # The Latitude method retrieves the latitude coordinate from a LatLong object.
@@ -36,12 +51,12 @@ class Geom::LatLong
   #   latlong = Geom::LatLong.new(ll)
   #   latitude = latlong.latitude
   #   if (latitude)
-  #     UI.messagebox latitude
+  #     UI.messagebox(latitude)
   #   else
-  #     UI.messagebox "Failure"
+  #     UI.messagebox("Failure")
   #   end
   #
-  # @return latitude - a latitude coordinate value
+  # @return [Float] a latitude coordinate value
   #
   # @version SketchUp 6.0
   def latitude
@@ -55,12 +70,12 @@ class Geom::LatLong
   #   latlong = Geom::LatLong.new(ll)
   #   longitude = latlong.longitude
   #   if (longitude)
-  #     UI.messagebox longitude
+  #     UI.messagebox(longitude)
   #   else
-  #     UI.messagebox "Failure"
+  #     UI.messagebox("Failure")
   #   end
   #
-  # @return longitude - a latitude coordinate value
+  # @return [Float] a latitude coordinate value
   #
   # @version SketchUp 6.0
   def longitude
@@ -90,19 +105,19 @@ class Geom::LatLong
   def to_s
   end
 
-  # The to_utm method converts a LatLong object to an array of two values.
+  # The to_utm method converts a LatLong object to a UTM object.
   #
   # @example
   #   ll = [40.01700, 105.28300]
   #   latlong = Geom::LatLong.new(ll)
   #   utm = latlong.to_utm
   #   if (utm)
-  #     UI.messagebox utm
+  #     UI.messagebox(utm)
   #   else
-  #     UI.messagebox "Failure"
+  #     UI.messagebox("Failure")
   #   end
   #
-  # @return array - an array of two values: latitude and longitude
+  # @return [Geom::UTM]
   #
   # @version SketchUp 6.0
   def to_utm

data/SketchUp/Geom/OrientedBounds2d.rb

@@ -0,0 +1,102 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The OrientedBounds2d class is a bounding box represented by four
+# {Geom::Point2d} objects, upper left, upper right, lower left and lower right
+# positions.
+#
+# @version LayOut 2018
+class Geom::OrientedBounds2d
+
+  # Instance Methods
+
+  # The {#==} method checks to see if the two {Geom::OrientedBounds2d}s are
+  # equal. This checks whether the point values are the same.
+  #
+  # @example
+  #   entity.bounds == entity.untransformed_bounds
+  #
+  # @param [Geom::OrientedBounds2d] other
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2018
+  def ==(other)
+  end
+
+  # The {#lower_left} method returns the {Geom::Point2d} of the lower left
+  # corner of the {Geom::OrientedBounds2d}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   entity = doc.shared_enities.first
+  #   bounds = entity.drawing_bounds
+  #   l_l = bounds.lower_left
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def lower_left
+  end
+
+  # The {#lower_right} method returns the {Geom::Point2d} of the lower right
+  # corner of the {Geom::OrientedBounds2d}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   entity = doc.shared_enities.first
+  #   bounds = entity.drawing_bounds
+  #   l_r = bounds.lower_right
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def lower_right
+  end
+
+  # The {#to_a} method returns an array which contains the {Geom::Point2d} that
+  # define the {Geom::OrientedBounds2d}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   entity = doc.shared_enities.first
+  #   bounds = entity.drawing_bounds
+  #   bounds.to_a.each { |point| p point.to_s }
+  #
+  # @return [Array(Geom::Point2d, Geom::Point2d, Geom::Point2d, Geom::Point2d)]
+  #
+  # @version LayOut 2018
+  def to_a
+  end
+
+  # The {#upper_left} method returns the {Geom::Point2d} of the upper left corner
+  # of the {Geom::OrientedBounds2d}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   entity = doc.shared_enities.first
+  #   bounds = entity.drawing_bounds
+  #   u_l = bounds.upper_left
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def upper_left
+  end
+
+  # The {#upper_right} method returns the {Geom::Point2d} of the upper right
+  # corner of the {Geom::OrientedBounds2d}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   entity = doc.shared_enities.first
+  #   bounds = entity.drawing_bounds
+  #   u_r = bounds.upper_right
+  #
+  # @return [Geom::Point2d]
+  #
+  # @version LayOut 2018
+  def upper_right
+  end
+
+end