sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Sketchup/Entity.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the base class for all SketchUp entities. Entities are basically
@@ -121,17 +121,12 @@ class Sketchup::Entity
   def attribute_dictionary(name, create)
   end
 
-  # The delete_attribute method is used to delete an attribute from an entity.
+  # The {#delete_attribute} method is used to delete an attribute from an entity.
   #
   # If only the dictionary_name is given, then it deletes the entire
-  # AttributeDictionary. Otherwise, delete_attribute deletes the attribute with
+  # AttributeDictionary. Otherwise, {#delete_attribute} deletes the attribute with
   # the given key from the given dictionary.
   #
-  # In SketchUp 2018, special attribute dictionaries have been added. The name
-  # of these dictionaries are "SU_InstanceSet" and "SU_DefinitionSet". The
-  # dictionaries cannot be deleted via ruby and an ArgumentError will be raised.
-  # The key/value pairs in the dictionary can be deleted safely.
-  #
   # @example
   #   depth = 100
   #   width = 100
@@ -151,16 +146,23 @@ class Sketchup::Entity
   #   status = entity1.set_attribute "testdictionary", "test", 115
   #   status = entity1.delete_attribute "testdictionary"
   #
+  # @note In SketchUp 2018, special attribute dictionaries have been added.
+  #   The name of these dictionaries are "SU_InstanceSet" and "SU_DefinitionSet".
+  #   The dictionaries cannot be deleted via ruby and an ArgumentError will be
+  #   raised. The key/value pairs in the dictionary can be deleted safely.
+  #
+  # @note The return values are fixed in SketchUp 2019 M0.
+  #
   # @overload delete_attribute(dictionary_name)
   #
   #   @param dictionary_name [String] The name of an attribute dictionary.
-  #   @return                [nil]
+  #   @return                [Boolean]
   #
   # @overload delete_attribute(dictionary_name, key)
   #
   #   @param dictionary_name [String] The name of an attribute dictionary.
   #   @param key             [String] An attribute key.
-  #   @return                [nil]
+  #   @return                [Boolean]
   #
   # @version SketchUp 6.0
   def delete_attribute(*args)
@@ -241,12 +243,12 @@ class Sketchup::Entity
   # @param [String] dict_name
   #   The name of an attribute dictionary.
   #
-  # @param [Object] default_value
-  #   A default value to return if no attribute is found.
-  #
   # @param [String] key
   #   An attribute key.
   #
+  # @param [Object] default_value
+  #   A default value to return if no attribute is found.
+  #
   # @return [Object] the retrieved value
   #
   # @version SketchUp 6.0
@@ -344,14 +346,9 @@ class Sketchup::Entity
   #
   # The persistent id persistent between sessions.
   #
-  # Note that only a subset of entity types support PIDs. Refer to the table
-  # below for which and when support was added.
-  #
   # [SketchUp 2018]
   #   - {Sketchup::Page}
   # [SketchUp 2017]
-  #   - {Sketchup::Axes}
-  #   - {Sketchup::ComponentDefinition}
   #   - {Sketchup::ComponentInstance}
   #   - {Sketchup::ConstructionLine}
   #   - {Sketchup::ConstructionPoint}
@@ -359,21 +356,23 @@ class Sketchup::Entity
   #   - {Sketchup::Dimension}
   #   - {Sketchup::Edge}
   #   - {Sketchup::Face}
+  #   - {Sketchup::Group}
+  #   - {Sketchup::Image}
   #   - {Sketchup::SectionPlane}
   #   - {Sketchup::Text}
   #   - {Sketchup::Vertex}
   #   - Polyline3d entities exposed only as {Sketchup::Drawingelement} Use
   #     {#typename} to determine if a {Sketchup::Drawingelement} is
-  #     a <tt>"Polyline3d"</tt>.
+  #     a +"Polyline3d"+.
   #
   # @example
   #   model = Sketchup.active_model
   #   entities = model.active_entities
   #   pts = [
-  #     Geom::Point3d.new(0, 0, 0)
-  #     Geom::Point3d.new(9, 0, 0)
-  #     Geom::Point3d.new(9, 9, 0)
-  #     Geom::Point3d.new(0, 9, 0)
+  #     Geom::Point3d.new(0, 0, 0),
+  #     Geom::Point3d.new(9, 0, 0),
+  #     Geom::Point3d.new(9, 9, 0),
+  #     Geom::Point3d.new(0, 9, 0),
   #   ]
   #
   #   # Add the face to the entities in the model
@@ -383,6 +382,10 @@ class Sketchup::Entity
   #   # Exploding the group will preserve the pid.
   #   pid == face.persistent_id # Should return true
   #
+  # @note Only a subset of entity types support PIDs. Refer to the table
+  #   below for which and when support was added. In general it is entities that
+  #   you can iterate over in a {Sketchup::Entities} collection.
+  #
   # @return [Integer] the id for the {Sketchup::Entity} object
   #
   # @version SketchUp 2017
@@ -438,12 +441,12 @@ class Sketchup::Entity
   # @param [String] dict_name
   #   The name of an attribute dictionary.
   #
-  # @param [Object] value
-  #   The value for the attribute.
-  #
   # @param [String] key
   #   An attribute key.
   #
+  # @param [Object] value
+  #   The value for the attribute.
+  #
   # @return [Object] the newly set value if successful
   #
   # @version SketchUp 6.0

data/SketchUp/Sketchup/EntityObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to entity events. To

data/SketchUp/Sketchup/ExtensionsManager.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ExtensionsManager class provides a way of accessing the

data/SketchUp/Sketchup/Face.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Faces in SketchUp are flat, 2-sided polygons with 3 or more sides.
@@ -281,13 +281,13 @@ class Sketchup::Face < Sketchup::Drawingelement
   #   True if you want the texture coordinates for the front
   #   face, false if not. Defaults to true.
   #
-  # @param [Sketchup::TextureWriter] texturewriter
-  #   An optional TextureWriter object.
-  #
   # @param [Boolean] back
   #   True if you want the texture coordinates for the back
   #   face, false if not. Defaults to true.
   #
+  # @param [Sketchup::TextureWriter] texturewriter
+  #   An optional TextureWriter object.
+  #
   # @return [Sketchup::UVHelper] a UVHelper object
   #
   # @version SketchUp 6.0
@@ -596,13 +596,13 @@ class Sketchup::Face < Sketchup::Drawingelement
   # @param [Sketchup::Material] material
   #   a Material object.
   #
+  # @param [Array<Geom::Point3d>] pt_array
+  #   An array of Point3d objects used to position the material.
+  #
   # @param [Boolean] o_front
   #   true to position the texture on the front of the Face or
   #   false to position it on the back of the Face.
   #
-  # @param [Array<Geom::Point3d>] pt_array
-  #   An array of Point3d objects used to position the material.
-  #
   # @return [Sketchup::Face, false] the face upon success, false upon failure.
   #
   # @version SketchUp 6.0

data/SketchUp/Sketchup/FrameChangeObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to changes in camera
@@ -86,12 +86,12 @@ class Sketchup::FrameChangeObserver
   #   the +to_scene+ and then use that on a subsequent Scene selection to
   #   determine the last Page that the user was on.
   #
-  # @param [Sketchup::Page] to_scene
-  #   The selected scene page the view is transitioning towards.
-  #
   # @param [Sketchup::Page, nil] from_scene
   #   The previous scene page the view is transitioning from.
   #
+  # @param [Sketchup::Page] to_scene
+  #   The selected scene page the view is transitioning towards.
+  #
   # @param [Float] percent_done
   #   The percentage of transition between the two scene pages.
   #

data/SketchUp/Sketchup/Group.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A Group class contains methods for manipulating groups of entities.

data/SketchUp/Sketchup/Http.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::Http} module provides interfaces to create asynchronous HTTP

data/SketchUp/Sketchup/Http/Request.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Http::Request objects allows you to send HTTP request to HTTP servers.
@@ -240,8 +240,8 @@ class Sketchup::Http::Request
   #
   # @yield A block that is invoked when the request has finished.
   #
-  # @yieldparam [FileUploadRequest] request
-  #   The FileUploadRequest object.
+  # @yieldparam [Request] request
+  #   The request object.
   #
   # @yieldparam [Response] response
   #   The response object, use this to read the

data/SketchUp/Sketchup/Http/Response.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Http::Response objects allows you to get the response information from the

data/SketchUp/Sketchup/Image.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An Image object represents a raster image placed in the Model.

data/SketchUp/Sketchup/ImageRep.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an image representation object.
@@ -30,6 +30,9 @@ class Sketchup::ImageRep
   #   image_rep.load_file("/path/to/image.jpg")
   #   color = image_rep.color_at_uv(0.7, 0.5, false)
   #
+  # @param [Float] u
+  #   The U texture coordinate.
+  #
   # @param [Float] v
   #   The V texture coordinate.
   #
@@ -38,9 +41,6 @@ class Sketchup::ImageRep
   #   interpolates the colors instead of picking
   #   the nearest neighbor.
   #
-  # @param [Float] u
-  #   The U texture coordinate.
-  #
   # @return [Sketchup::Color, nil]
   #
   # @version SketchUp 2018
@@ -97,12 +97,12 @@ class Sketchup::ImageRep
   # @example Construct from file
   #   image_rep = Sketchup::ImageRep.new("/path/to/image.jpg")
   #
-  # @overload initialize(filepath)
+  # @overload initialize
   #
-  #   @param [String] filepath
   #
-  # @overload initialize
+  # @overload initialize(filepath)
   #
+  #   @param [String] filepath
   #
   # @raise [ArgumentError] if the file path or image is invalid.
   #
@@ -165,32 +165,32 @@ class Sketchup::ImageRep
   # @note The encoding of the pixel_data {String} parameter should be ASCII-8BIT.
   #   Any other encoding could corrupt the binary data.
   #
+  # @param [Integer] width
+  #   The width of the pixel data. Must be greater than 0.
+  #
   # @param [Integer] height
   #   The height of the pixel data.
   #   Must be greater than 0.
   #
-  # @param [Integer] width
-  #   The width of the pixel data. Must be greater than 0.
+  # @param [Integer] bits_per_pixel
+  #   The bits per pixel for the pixel data.
+  #   Must be either 8/24/32.
   #
   # @param [Integer] row_padding
   #   The row padding for the pixel data which is
   #   sized in bytes. Row padding is used to pad each row with zeros so that each
   #   scanline on the pixel data will end on the data-type boundry.
   #
-  # @param [Integer] bits_per_pixel
-  #   The bits per pixel for the pixel data.
-  #   Must be either 8/24/32.
-  #
   # @param [String] pixel_data
   #   The binary string containing the pixel data
   #   representing the new image.
   #
-  # @raise [TypeError] If width, height, bits_per_pixel or pixel_data are wrong
-  #   data types.
-  #
   # @raise [ArgumentError] If width, height, bits_per_pixel or pixel_data are
   #   invalid.
   #
+  # @raise [TypeError] If width, height, bits_per_pixel or pixel_data are wrong
+  #   data types.
+  #
   # @return [Sketchup::ImageRep]
   #
   # @version SketchUp 2018

data/SketchUp/Sketchup/Importer.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Importer interface lets you build your own importers for SketchUp. To

data/SketchUp/Sketchup/InputPoint.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The InputPoint used to pick entities that reside under the current cursor
@@ -218,6 +218,10 @@ class Sketchup::InputPoint
   #   starting_point = Geom::Point3d.new(100, 200, 300)
   #   ip2 = Sketchup::InputPoint.new(starting_point)
   #
+  # @note Prior to SketchUp 2019 it was not possible to
+  #   sub-class {Sketchup::InputPoint} due to a bug in how SketchUp initialized
+  #   the class.
+  #
   # @param pt_or_vertex
   #   An optional Point3d or Vertex where the new InputPoint
   #   should be created.
@@ -276,13 +280,13 @@ class Sketchup::InputPoint
   # @param x
   #   A x value.
   #
+  # @param y
+  #   A y value.
+  #
   # @param [optional] inputpoint
   #   A second input point used as a reference
   #   for the pick.
   #
-  # @param y
-  #   A y value.
-  #
   # @return status - true if a valid InputPoint was picked and it
   #   is different than it was before.
   #

data/SketchUp/Sketchup/InstanceObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to component instance

data/SketchUp/Sketchup/InstancePath.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::InstancePath} class represent the instance path to a given
@@ -42,11 +42,11 @@ class Sketchup::InstancePath
   #
   # @param [Integer] index
   #
-  # @raise [TypeError] if the instance path refer to deleted entities.
+  # @raise [IndexError] if the given index is out of bounds
   #
   # @raise [TypeError] if the index is not of integer type
   #
-  # @raise [IndexError] if the given index is out of bounds
+  # @raise [TypeError] if the instance path refer to deleted entities.
   #
   # @return [Sketchup::Entity]
   #
@@ -251,9 +251,6 @@ class Sketchup::InstancePath
   def to_a
   end
 
-  # overload transformation
-  #   @return [Sketchup::Transformation] the combined transformation up to the
-  #     the leaf entity.
   #
   # @example
   #   model = Sketchup.active_model
@@ -262,19 +259,25 @@ class Sketchup::InstancePath
   #   path = Sketchup::InstancePath.new([group, edge])
   #   tr = path.transformation
   #
-  # @param [Integer] index
+  # @overload transformation
   #
-  # @raise [TypeError] if the index is not of integer type
+  #   @return [Geom::Transformation] the combined transformation up to the
+  #     the leaf entity.
+  #
+  # @overload transformation(index)
+  #
+  #   @param [Integer] index
+  #   @return [Geom::Transformation]  the combined transformation up to the
+  #     the given index.
   #
   # @raise [IndexError] if the given index is out of bounds
   #
-  # @raise [TypeError] if the instance path refer to deleted entities.
+  # @raise [TypeError] if the index is not of integer type
   #
-  # @return [Sketchup::Transformation] the combined transformation up to the
-  #   the given index.
+  # @raise [TypeError] if the instance path refer to deleted entities.
   #
   # @version SketchUp 2017
-  def transformation(index)
+  def transformation(*args)
   end
 
   # An instance path is valid if it has at least one element and consist of