sketchup-api-stubs 0.7.0 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7515fa1b0378994644bdfad8f24f5f3c413c8f8eafe95157fe2c332c81c17a3
-  data.tar.gz: dc488129bd90c5bfdba9e210cf7ace6296b315bce1a51d0dfffb03d0417335c1
+  metadata.gz: df20d75744c6496aa0a1c242f2c95a854a14b426252a6d96440c54671916f90b
+  data.tar.gz: d504706510a4267fd6651f8a4061cba83c2637266fc43a9b10de3134f4682207
 SHA512:
-  metadata.gz: 2d70441053546ca8f65e677403882a3ed9fe3d73589271c96a3cb55f9e661a3997f3149d51a0eee3883b7fef6b2b92313fd05d1d6b6d43089e10bebe157477fc
-  data.tar.gz: f55bc89cfd036c6690f047acd372d943daef6f532f981090022bf30d8fb728bff404cc0b0e7f291ab24971089f1e89e1ba929801589bfc3654e1174fcfb9177b
+  metadata.gz: f9b7449db18cac6f521868bfb57f38838c29d8d5387616fdde883f599ec1d30290c434850942e9451af38b260ce007a76ddf573fb9fabe03883e84d483fbbdac
+  data.tar.gz: 4ae01a4e7bc65fca2484d247d285873a344ca9e5fc2e43eee3d07e391ece4747a121db1cc08f89ea1b2afc64c636b217c51edf24c1d99f7fdf94317c351ec685

data/lib/sketchup-api-stubs/sketchup.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

@@ -2,7 +2,7 @@
 # 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

@@ -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

@@ -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/Point2d.rb

@@ -1,12 +1,11 @@
 # Copyright:: Copyright 2020 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

@@ -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

@@ -353,6 +353,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 +410,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 +462,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/Vector2d.rb

@@ -1,8 +1,7 @@
 # Copyright:: Copyright 2020 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

@@ -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/AngularDimension.rb

@@ -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

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

@@ -88,6 +88,11 @@ class Layout::AutoTextDefinitions
   #     puts auto_text.name
   #   }
   #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
   # @version LayOut 2018
   #
   # @yieldparam [Layout::AutoTextDefinition] auto_text
@@ -129,6 +134,7 @@ class Layout::AutoTextDefinitions
   # @version LayOut 2018
   def length
   end
+  alias_method :size, :length
 
   # The {#remove} method removes an {Layout::AutoTextDefinition} from the
   # {Layout::Document}.
@@ -170,17 +176,4 @@ class Layout::AutoTextDefinitions
   def remove(*args)
   end
 
-  # The {#length} method returns the number of {Layout::AutoTextDefinition}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   auto_texts = doc.auto_text_definitions
-  #   num_auto_texts = auto_texts.length
-  #
-  # @return [Integer]
-  #
-  # @version LayOut 2018
-  def size
-  end
-
 end

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

@@ -46,6 +46,7 @@ class Layout::Document
   VERSION_2018 = nil # Stub value.
   VERSION_2019 = nil # Stub value.
   VERSION_2020 = nil # Stub value.
+  VERSION_2021 = nil # Stub value.
   VERSION_3 = nil # Stub value.
   VERSION_CURRENT = nil # Stub value.
 
@@ -143,6 +144,61 @@ class Layout::Document
   def auto_text_definitions
   end
 
+  # The {#export} method exports the {Layout::Document} to a given file format.
+  # It knows which format to export based on the file extension you place on the
+  # file name. For example, a filename of "thing.pdf" will export a PDF file,
+  # whereas "thing.png" will export a set of PNG images.
+  #
+  # For LayOut version 2020.1, valid extensions include .pdf, .jpg, and .png.
+  #
+  # @example PDF Export Examples
+  #   doc = Layout::Document.open("c:/path/to/document.layout")
+  #
+  #   # Export pdf file on a PC, with default settings.
+  #   status = doc.export("c:/my_export.pdf")
+  #
+  #   # Export pages one through three at high quality, compressing jpeg images
+  #   # at 0.75 compression quality (valid range is 0.0 - 1.0). Note that the
+  #   # first page of a {Layout::Document} is index 0.
+  #   options = { start_page: 1,
+  #               end_page: 3,
+  #               output_resolution: Layout::PageInfo::RESOLUTION_HIGH,
+  #               compress_images: TRUE,
+  #               compress_quality: 0.75 }
+  #
+  #   status = doc.export("c:/my_export.pdf", options)
+  #
+  # @example Image Set Export Examples
+  #   doc = Layout::Document.open("c:/path/to/document.layout")
+  #
+  #   # Export png files on macOS, with default settings.
+  #   status = doc.export('/Users/username/Desktop/pngs/page.png')
+  #
+  #   # Export pages one through three at 300 dpi as JPGs.
+  #   options = { start_page: 1,
+  #               end_page: 3,
+  #               dpi: 300 }
+  #   status = doc.export('c:/page.jpg', options)
+  #
+  # @param [String] file_path
+  #   The file or image set to create. The directory
+  #   path must already exist. The path must include the file extension.
+  #
+  # @param [Hash, nil] options
+  #   An optional hash of settings for the export.
+  #
+  # @raise [TypeError] if an options value is the wrong type
+  #
+  # @raise [RangeError] if an options value is out of range
+  #
+  # @raise [ArgumentError] if the full file path does not exist
+  #
+  # @raise [ArgumentError] if the specified file type is missing or not supported
+  #
+  # @version LayOut 2020.1
+  def export(file_path, options = nil)
+  end
+
   # The {#grid} method returns the {Layout::Grid} for a {Layout::Document}.
   #
   # @example
@@ -347,15 +403,15 @@ class Layout::Document
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
   #   # Save the model using the current Layout format
-  #   filename = File.join(ENV['Home'], 'Desktop', 'mydoc.layout')
-  #   status = doc.save(filename)
+  #   path = File.join(ENV['Home'], 'Desktop', 'mydoc.layout')
+  #   status = doc.save(path)
   #   # Save the document to the current file using the current LayOut format
   #   status = doc.save
   #   # Save the document to the current file in LayOut 3 format
   #   status = doc.save(Layout::Document::VERSION_3)
   #   # Save the document in LayOut 2013 format
-  #   filename = File.join(ENV['Home'], 'Desktop', 'mydoc_v2013.layout')
-  #   status = doc.save(filename, Layout::Document::VERSION_2013)
+  #   path = File.join(ENV['Home'], 'Desktop', 'mydoc_v2013.layout')
+  #   status = doc.save(path, Layout::Document::VERSION_2013)
   #
   # @overload save
   #

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

@@ -86,6 +86,11 @@ class Layout::Entities
   #     puts entity
   #   }
   #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
   # @param [Hash{Symbol => Boolean}] flags
   #   A hash that allows skipping of
   #   {Layout::Entity}s on hidden or locked {Layout::Layers}
@@ -108,6 +113,7 @@ class Layout::Entities
   # @version LayOut 2018
   def length
   end
+  alias_method :size, :length
 
   # The {#reverse_each} method iterates through all of the {Layout::Entity}s in
   # reverse order. When iterating over a {Layout::LayerInstance}'s
@@ -139,17 +145,4 @@ class Layout::Entities
   def reverse_each(*args)
   end
 
-  # The {#length} method returns the number of {Layout::Entity}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   entities = doc.shared_entities
-  #   num_entities = entities.length
-  #
-  # @return [Integer]
-  #
-  # @version LayOut 2018
-  def size
-  end
-
 end