sketchup-api-stubs 0.7.6 → 0.7.7

data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to changes in camera

data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A Group class contains methods for manipulating groups of entities.
@@ -201,6 +201,57 @@ class Sketchup::Group < Sketchup::Drawingelement
   def explode
   end
 
+  # The {#glued_to} method is used to retrieve the entity that this group is
+  # glued to.
+  #
+  # @example
+  #   point = Geom::Point3d.new(10, 20, 30)
+  #   transform = Geom::Transformation.new(point)
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   group = entities.add_group
+  #   group.entities.add_face([[0, 0, 0], [10, 0, 0], [10, 10, 0], [0, 10, 0]])
+  #   status = group.glued_to
+  #
+  # @return [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil]
+  #
+  # @version SketchUp 2021.1
+  def glued_to
+  end
+
+  # The {glued_to=} method glues this group to a drawing element.
+  # When moving this other drawing elment with the Move tool, the glued group moves with it.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #
+  #   # Create a face
+  #   face = entities.add_face([[0, 0, 0], [100, 0, 0], [100, 100, 0], [0, 100, 0]])
+  #
+  #   # Create a group
+  #   definitions = model.definitions
+  #   group = entities.add_group
+  #   group.entities.add_face([[0, 0, 0], [10, 0, 0], [10, 10, 0], [0, 10, 0]])
+  #
+  #   # Make group "gluable"
+  #   group.definition.behavior.is2d = true
+  #
+  #   # Glue the group to the face.
+  #   # If you now move the face, the group will follow.
+  #   group.glued_to = face
+  #
+  # @param [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil] drawing_element
+  #
+  # @raise ArgumentError if the {Sketchup::Behavior} for this group doesn't allow gluing,
+  #   if the alignment is wrong, or if this would lead to cyclic gluing.
+  #
+  # @return [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil] the entity the group was glued to.
+  #
+  # @version SketchUp 2021.1
+  def glued_to=(drawing_element)
+  end
+
   # The guid method is used to get the base 64 encoded unique id
   # for this SketchUp object.
   #

data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb

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

data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Http::Request objects allows you to send HTTP request to HTTP servers.
@@ -11,9 +11,9 @@ class Sketchup::Http::Request
   # Gets the http body that is going to be used when sending the request.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "body: #{request.body}"
   #   end
   #
@@ -26,10 +26,10 @@ class Sketchup::Http::Request
   # Sets the http body that is going to be used when sending the request.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #   request.body = "Hello World"
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request.body = "Hello World"
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "body: #{request.body}"
   #   end
   #
@@ -45,12 +45,12 @@ class Sketchup::Http::Request
   # Cancels the request.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #   request.start do |request, response|
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request.start do |request, response|
   #     puts "body: #{response.body}"
   #   end
   #
-  #   request.cancel
+  #   @request.cancel
   #
   # @return [true]
   #
@@ -61,10 +61,10 @@ class Sketchup::Http::Request
   # Returns the http headers that are going to be used when sending the request.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #   request.headers = { :key1 => "value1", :key2 => "value2" }
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request.headers = { :key1 => "value1", :key2 => "value2" }
   #
-  #   request.headers.each do |key, value|
+  #   @request.headers.each do |key, value|
   #     puts "#{key}: #{value}"
   #   end
   #
@@ -77,10 +77,10 @@ class Sketchup::Http::Request
   # Sets the http headers that are going to be used when sending the request.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #   request.headers = { :key1 => "value1", :key2 => "value2" }
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request.headers = { :key1 => "value1", :key2 => "value2" }
   #
-  #   request.headers.each do |key, value|
+  #   @request.headers.each do |key, value|
   #     puts "#{key}: #{value}"
   #   end
   #
@@ -96,10 +96,7 @@ class Sketchup::Http::Request
   # The new method is used to create a new Sketchup::Http::Request.
   #
   # The default port is 80, to use a different port define it in the URL when
-  # creating a new Http::Request
-  #
-  # Keeping a reference to the request is necessary in order to ensure the use of
-  # the response.
+  # creating a new {Sketchup::Http::Request}.
   #
   # The +method+ parameter accepts any custom http method or one of the
   # following:
@@ -111,12 +108,16 @@ class Sketchup::Http::Request
   # * +Sketchup::Http::OPTIONS+
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "body: #{response.body}"
   #   end
   #
+  # @note If no reference is kept to the {Sketchup::Http::Request}, it can be garbage collected,
+  #   making the download silently fail. This is especially noticeable for larger downloads that
+  #   takes longer time.
+  #
   # @param [String] url
   #   The targetted URL.
   #
@@ -133,9 +134,9 @@ class Sketchup::Http::Request
   # Returns the http method that is going to be used when sending the request.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "request.method: #{request.method}"
   #   end
   #
@@ -155,10 +156,10 @@ class Sketchup::Http::Request
   # * +Sketchup::Http::OPTIONS+
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #   request.method = Sketchup::Http::POST
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request.method = Sketchup::Http::POST
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "request.method: #{request.method}"
   #   end
   #
@@ -175,14 +176,20 @@ class Sketchup::Http::Request
   # have received data from the server until the download finishes.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #
-  #   request.set_download_progress_callback do |current, total|
-  #     puts "download current: #{current}"
-  #     puts "download total: #{total}"
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   @request.set_download_progress_callback do |current, total|
+  #     if total == -1
+  #       puts "#{current}B"
+  #     else
+  #       percentage = (current.to_f / total * 100).round
+  #       puts "#{current}B / #{total}B (#{percentage}%)"
+  #     end
   #   end
   #
-  #   request.start
+  #   @request.start
+  #
+  # @note +total+ is -1 if the server doesn't specify a file size in the response header.
   #
   # @return [Boolean]
   #
@@ -202,9 +209,9 @@ class Sketchup::Http::Request
   # uploaded data to the server until the upload finishes.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.set_upload_progress_callback do |current, total|
+  #   @request.set_upload_progress_callback do |current, total|
   #     puts "upload current: #{current}"
   #     puts "upload total: #{total}"
   #   end
@@ -228,9 +235,9 @@ class Sketchup::Http::Request
   # Starts the request and optionally add a callback block.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "body: #{response.body}"
   #   end
   #
@@ -257,9 +264,9 @@ class Sketchup::Http::Request
   # * +Sketchup::Http::STATUS_FAILED+
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
-  #   request.start
-  #   puts "response.status: #{request.status}"
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request.start
+  #   puts "response.status: #{@request.status}"
   #
   # @return [int]
   #
@@ -270,9 +277,9 @@ class Sketchup::Http::Request
   # Returns a copy of the Request's URL.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "url: #{request.url}"
   #   end
   #

data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Http::Response objects allows you to get the response information from the
@@ -15,9 +15,9 @@ class Sketchup::Http::Response
   # no charset is specified, ASCII-8BIT will be used.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "body: " + response.body
   #   end
   #
@@ -30,9 +30,9 @@ class Sketchup::Http::Response
   # Returns the http headers that were sent by the server.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     response.headers.each do |key, value|
   #       puts "#{key}: #{value}"
   #     end
@@ -47,9 +47,9 @@ class Sketchup::Http::Response
   # Returns the HTTP response status code as defined in rfc2616.
   #
   # @example
-  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
-  #   request.start do |request, response|
+  #   @request.start do |request, response|
   #     puts "http status code: #{response.status_code}"
   #   end
   #

data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An Image object represents a raster image placed in the Model.
@@ -39,6 +39,53 @@ class Sketchup::Image < Sketchup::Drawingelement
   def explode
   end
 
+  # The {#glued_to} method is used to retrieve the entity that this image is
+  # glued to.
+  #
+  # @example
+  #   point = Geom::Point3d.new(10, 20, 30)
+  #   transform = Geom::Transformation.new(point)
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   group = entities.add_group
+  #   group.entities.add_face([[0, 0, 0], [10, 0, 0], [10, 10, 0], [0, 10, 0]])
+  #   status = group.glued_to
+  #
+  # @return [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil]
+  #
+  # @version SketchUp 2021.1
+  def glued_to
+  end
+
+  # The {glued_to=} method glues this image to a drawing element.
+  # When moving this other drawing elment with the Move tool, the image moves with it.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #
+  #   # Create a face
+  #   face = entities.add_face([[0, 0, 0], [100, 0, 0], [100, 100, 0], [0, 100, 0]])
+  #
+  #   # Create a group
+  #   path = "Plugins/su_dynamiccomponents/images"
+  #   image_file = Sketchup.find_support_file("report_tool.png", path)
+  #   image = model.active_entities.add_image(image_file, ORIGIN, 300)
+  #
+  #   # Glue the group to the face.
+  #   # If you now move the face, the group will follow.
+  #   image.glued_to = face
+  #
+  # @param [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil] drawing_element
+  #
+  # @raise ArgumentError if this would lead to cyclic gluing.
+  #
+  # @return [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil] the entity the group was glued to.
+  #
+  # @version SketchUp 2021.1
+  def glued_to=(drawing_element)
+  end
+
   # The height method is used to retrieve the height of the image.
   #
   # The height is given in inches.
@@ -92,6 +139,8 @@ class Sketchup::Image < Sketchup::Drawingelement
   # The {#image_rep} method returns a copy of a {Sketchup::ImageRep} object
   # representing the pixel data.
   #
+  # @bug Prior to SketchUp 2021.1, SketchUp crashes when the Image is corrupt and lacks image data.
+  #
   # @example
   #   model = Sketchup.active_model
   #   path = "Plugins/su_dynamiccomponents/images"
@@ -99,6 +148,8 @@ class Sketchup::Image < Sketchup::Drawingelement
   #   image = model.active_entities.add_image(image_file, ORIGIN, 300)
   #   image_rep = image.image_rep
   #
+  # @raise ArgumentError if the Image is corrupt and lacks image data.
+  #
   # @return [Sketchup::ImageRep]
   #
   # @version SketchUp 2018

data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an image representation object.

data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb

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

data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::InputPoint} class is used to pick 3d points and/or entities

data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb

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

data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::InstancePath} class represent the instance path to a given

data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layer class contains methods modifying and extracting information for a

data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Allows layers to be organized in folders. Folders may have duplicate names.
@@ -39,7 +39,7 @@ class Sketchup::LayerFolder < Sketchup::Entity
   #   +0+ if the receiver and +other+ are equal.
   #   +nil+ if +other+ is not comparable with the receiver.
   #
-  # @version SketchUp 2020.2
+  # @version SketchUp 2021.0
   def <=>(other)
   end
 
@@ -165,7 +165,7 @@ class Sketchup::LayerFolder < Sketchup::Entity
   #   model = Sketchup.active_model
   #   layers = model.layers
   #   folder1 = layers.add_folder('Hello')
-  #   folder1.add_folder('World)
+  #   folder1.add_folder('World')
   #   folder1.each_folder { | folder | puts folder.name }
   #
   # @version SketchUp 2021.0