sketchup-api-stubs 0.1.0

data/SketchUp/Sketchup/Http.rb

@@ -0,0 +1,27 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The {Sketchup::Http} module provides interfaces to create asynchronous HTTP
+# requests. This is an alternative to the Net::Http module that comes with
+# Ruby StdLib - which is known to have issues within SketchUp.
+#
+# @version SketchUp 2017
+module Sketchup::Http
+
+  # Constants
+
+  DELETE = nil # Stub value.
+  GET = nil # Stub value.
+  HEAD = nil # Stub value.
+  OPTIONS = nil # Stub value.
+  PATCH = nil # Stub value.
+  POST = nil # Stub value.
+  PUT = nil # Stub value.
+
+  STATUS_CANCELED = nil # Stub value.
+  STATUS_FAILED = nil # Stub value.
+  STATUS_PENDING = nil # Stub value.
+  STATUS_SUCCESS = nil # Stub value.
+  STATUS_UNKNOWN = nil # Stub value.
+
+end

data/SketchUp/Sketchup/Http/Request.rb

@@ -0,0 +1,285 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# Http::Request objects allows you to send HTTP request to HTTP servers.
+#
+# @version SketchUp 2017
+class Sketchup::Http::Request
+
+  # Instance Methods
+
+  # Gets the http body that is going to be used when sending the request.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     puts "body: #{request.body}"
+  #   end
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def body
+  end
+
+  # 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.start do |request, response|
+  #     puts "body: #{request.body}"
+  #   end
+  #
+  # @param [String] body
+  #   A String containing the body.
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def body=(body)
+  end
+
+  # Cancels the request.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   request.start do |request, response|
+  #     puts "body: #{response.body}"
+  #   end
+  #
+  #   request.cancel
+  #
+  # @return [true]
+  #
+  # @version SketchUp 2017
+  def cancel
+  end
+
+  # 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.headers.each do |key, value|
+  #     puts "#{key}: #{value}"
+  #   end
+  #
+  # @return [Hash]
+  #
+  # @version SketchUp 2017
+  def headers
+  end
+
+  # 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.headers.each do |key, value|
+  #     puts "#{key}: #{value}"
+  #   end
+  #
+  # @param [Hash] headers
+  #   A key/value pair hash.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def headers=(headers)
+  end
+
+  # 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.
+  #
+  # The +method+ parameter accepts any custom http method or one of the
+  # following:
+  # * +Sketchup::Http::GET+
+  # * +Sketchup::Http::POST+
+  # * +Sketchup::Http::PUT+
+  # * +Sketchup::Http::DELETE+
+  # * +Sketchup::Http::HEAD+
+  # * +Sketchup::Http::OPTIONS+
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)
+  #
+  #   request.start do |request, response|
+  #     puts "body: #{response.body}"
+  #   end
+  #
+  # @param [String] url
+  #   The targetted URL.
+  #
+  # @param [String] method
+  #   Optionally, the request method to use, the
+  #   default is Sketchup::Http::GET
+  #
+  # @return [Request]
+  #
+  # @version SketchUp 2017
+  def initialize(url, method)
+  end
+
+  # Returns the http method that is going to be used when sending the request.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     puts "request.method: #{request.method}"
+  #   end
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def method
+  end
+
+  # Sets the http method that is going to be used when sending the request.
+  # The value can be any custom http method or one of the following:
+  # * +Sketchup::Http::GET+
+  # * +Sketchup::Http::POST+
+  # * +Sketchup::Http::PUT+
+  # * +Sketchup::Http::DELETE+
+  # * +Sketchup::Http::HEAD+
+  # * +Sketchup::Http::OPTIONS+
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   request.method = Sketchup::Http::POST
+  #
+  #   request.start do |request, response|
+  #     puts "request.method: #{request.method}"
+  #   end
+  #
+  # @param [String] method
+  #   A string containing the http method name.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  def method=(method)
+  end
+
+  # Adds a download progress callback block that will get called everytime we
+  # 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}"
+  #   end
+  #
+  #   request.start
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  #
+  # @yield A block to be invoked everytime data is downloaded from the server.
+  #
+  # @yieldparam [Integer] current
+  #   Current bytes transferred.
+  #
+  # @yieldparam [Integer] total
+  #   Total bytes to transfer.
+  def set_download_progress_callback
+  end
+
+  # Adds a upload progress callback block that will get called everytime we have
+  # uploaded data to the server until the upload finishes.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.set_upload_progress_callback do |current, total|
+  #     puts "upload current: #{current}"
+  #     puts "upload total: #{total}"
+  #   end
+  #
+  #   request.start
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  #
+  # @yield A block to be invoked everytime data is sent to the server.
+  #
+  # @yieldparam [Integer] current
+  #   Current bytes transferred.
+  #
+  # @yieldparam [Integer] total
+  #   Total bytes to transfer.
+  def set_upload_progress_callback
+  end
+
+  # Starts the request and optionally add a callback block.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     puts "body: #{response.body}"
+  #   end
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2017
+  #
+  # @yield A block that is invoked when the request has finished.
+  #
+  # @yieldparam [FileUploadRequest] request
+  #   The FileUploadRequest object.
+  #
+  # @yieldparam [Response] response
+  #   The response object, use this to read the
+  #   server response.
+  def start
+  end
+
+  # Returns the internal status code. It can be one of the following:
+  # * +Sketchup::Http::STATUS_UNKNOWN+
+  # * +Sketchup::Http::STATUS_SUCCESS+
+  # * +Sketchup::Http::STATUS_PENDING+
+  # * +Sketchup::Http::STATUS_CANCELED+
+  # * +Sketchup::Http::STATUS_FAILED+
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #   request.start
+  #   puts "response.status: #{request.status}"
+  #
+  # @return [int]
+  #
+  # @version SketchUp 2017
+  def status
+  end
+
+  # Returns a copy of the Request's URL.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     puts "url: #{request.url}"
+  #   end
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def url
+  end
+
+end

data/SketchUp/Sketchup/Http/Response.rb

@@ -0,0 +1,62 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# Http::Response objects allows you to get the response information from the
+# server, you can only receive the Http::Response if you have attached a
+# callback block when calling start from the Http::Request object.
+#
+# @version SketchUp 2017
+class Sketchup::Http::Response
+
+  # Instance Methods
+
+  # Gets the http body that was received from the server as a string encoded
+  # using the charset provided in the Content-Type of the server response, if
+  # no charset is specified, ASCII-8BIT will be used.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     puts "body: " + response.body
+  #   end
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2017
+  def body
+  end
+
+  # Returns the http headers that were sent by the server.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     response.headers.each do |key, value|
+  #       puts "#{key}: #{value}"
+  #     end
+  #   end
+  #
+  # @return [Hash]
+  #
+  # @version SketchUp 2017
+  def headers
+  end
+
+  # Returns the HTTP response status code as defined in rfc2616.
+  #
+  # @example
+  #   request = Sketchup::Http::Request.new("http://localhost:8080")
+  #
+  #   request.start do |request, response|
+  #     puts "http status code: #{response.status_code}"
+  #   end
+  #
+  # @return [int]
+  #
+  # @version SketchUp 2017
+  def status_code
+  end
+
+end

data/SketchUp/Sketchup/Image.rb

@@ -0,0 +1,393 @@
+# Copyright:: Copyright 2017 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# An Image object represents a raster image placed in the Model.
+#
+# @version SketchUp 6.0
+class Sketchup::Image < Sketchup::Drawingelement
+
+  # Instance Methods
+
+  # The explode method is used to explode an image into a face with a texture
+  # on it.
+  #
+  # Note that current versions of SketchUp will return an empty array here.
+  # To work around this limitation you can iterate over your entities collection
+  # to determine which new entities were created.
+  #
+  # Versions prior to SketchUp 2015 returned an empty array due to a bug.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   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)
+  #   entities = image.explode
+  #
+  # @return entitiesarray - an Array object of entities if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def explode
+  end
+
+  # The height method is used to retrieve the height of the image.
+  #
+  # The height is given in inches.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   height = image.height
+  #   if (height)
+  #     UI.messagebox height
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return height - the height of the model if successful
+  #
+  # @version SketchUp 6.0
+  def height
+  end
+
+  # The height= method is used to set the height of the image.
+  #
+  # The height is set in inches.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   UI.messagebox "Before adjustment"
+  #   height = image.height = 400
+  #   if (height)
+  #     UI.messagebox height
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param height
+  #   The height, in inches, to set the image.
+  #
+  # @return height - the new height if successful
+  #
+  # @version SketchUp 6.0
+  def height=(height)
+  end
+
+  # The normal method is used to retrieve the 3D Vector that is perpendicular to
+  # the plane of the image.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   vector = image.normal
+  #   if (vector)
+  #     UI.messagebox vector
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return vector - a Vector3d object if successful
+  #
+  # @version SketchUp 6.0
+  def normal
+  end
+
+  # The origin method is used to retrieve the 3D point that defines the origin
+  # of the image.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   origin = image.origin
+  #   if (origin)
+  #     UI.messagebox origin
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return point - a Point3d object containing the origin location
+  #   if successful
+  #
+  # @version SketchUp 6.0
+  def origin
+  end
+
+  # The origin= method is used to set the 3D point as the origin of the image.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   pt2 = Geom::Point3d.new 100,100,100
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   UI.messagebox "Before Move"
+  #   origin = image.origin=pt2
+  #   if (origin)
+  #     UI.messagebox origin
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param point
+  #   A Point3d object with the new origin.
+  #
+  # @return point - the Point3d object representing the newly
+  #   established origin if successful
+  #
+  # @version SketchUp 6.0
+  def origin=(point)
+  end
+
+  # The path method is used to retrieve the path of the file defining the image.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   path = image.path
+  #   if (path)
+  #     UI.messagebox path
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return path - the path for the image file if successful
+  #
+  # @version SketchUp 6.0
+  def path
+  end
+
+  # The pixelheight method is used to retrieve the height of the image file in
+  # pixels.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   pixelheight = image.pixelheight
+  #   if (pixelheight)
+  #     UI.messagebox pixelheight
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return height - the height of the image in pixels if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def pixelheight
+  end
+
+  # The pixelwidth method is used to retrieve the width of the image file in
+  # pixels.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   pixelwidth = image.pixelwidth
+  #   if (pixelwidth)
+  #     UI.messagebox pixelwidth
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return width - the width of the image in pixels if successful
+  #
+  # @version SketchUp 6.0
+  def pixelwidth
+  end
+
+  # The size= method is used to set the width and height of the image, in inches.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   UI.messagebox "Before Resize"
+  #   size = image.size= 500,500
+  #   if (size)
+  #     UI.messagebox size
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param width
+  #   The width of the image.
+  #
+  # @param height
+  #   The height of the image.
+  #
+  # @return size - the new width and height of the image if
+  #   successful
+  #
+  # @version SketchUp 6.0
+  def size=(width, height)
+  end
+
+  # The transform! method is used to apply a transformation to the image.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   point = Geom::Point3d.new 100,100,100
+  #   t = Geom::Transformation.new point
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   UI.messagebox "Before Move"
+  #   image = image.transform! t
+  #   if (image)
+  #     UI.messagebox image
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param transform
+  #   A Transformation object.
+  #
+  # @return image - the transformed Image object if successful
+  #
+  # @version SketchUp 6.0
+  def transform!(transform)
+  end
+
+  # The transformation method is used to retrieve the transformation for the
+  # image.
+  #
+  # @example
+  #   # Add an image to the model.
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   path = Sketchup.find_support_file('report_tool.png', 'Plugins/su_dynamiccomponents/images')
+  #   point = Geom::Point3d.new(100,100,100)
+  #   image = entities.add_image(path, point, 300)
+  #
+  #   trans = image.transformation
+  #
+  # @return transformation - a Transformation object if successful
+  #
+  # @version SketchUp 2014
+  def transformation
+  end
+
+  # The transformation= method is used to set the transformation for the
+  # image.
+  #
+  # @example
+  #   # Add an image to the model.
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #   path = Sketchup.find_support_file('report_tool.png', 'Plugins/su_dynamiccomponents/images')
+  #   point = Geom::Point3d.new(100,100,100)
+  #   image = entities.add_image(path, point, 300)
+  #
+  #   new_transform = Geom::Transformation.new([100,0,0])
+  #   image.transformation = new_transform
+  #
+  # @param transform
+  #   The Transformation object to apply
+  #
+  # @return image - the newly transformed image
+  #
+  # @version SketchUp 2014
+  def transformation=(transform)
+  end
+
+  # The width method is used to retrieve the width of the image.
+  #
+  # The width is given in inches.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png",
+  #     "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   width = image.width
+  #   if (width)
+  #     UI.messagebox width
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return width - the width of the image if successful
+  #
+  # @version SketchUp 6.0
+  def width
+  end
+
+  # The width= method is used to set the width of the image.
+  #
+  # The width is set in inches.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   UI.messagebox "Before adjustment"
+  #   width = image.width=400
+  #   if (width)
+  #     UI.messagebox width
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @param width
+  #   The width, in inches, to set the image.
+  #
+  # @return width - the new width if successful
+  #
+  # @version SketchUp 6.0
+  def width=(width)
+  end
+
+  # The zrotation method is used to get the angle that the image is rotated
+  # about the normal vector from an arbitrary X axis.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   path = Sketchup.find_support_file "report_tool.png", "Tools/DynamicComponents/images"
+  #   pt = Geom::Point3d.new
+  #   entities = model.active_entities
+  #   image = entities.add_image path, pt, 300
+  #   zrotation = image.zrotation
+  #   if (zrotation)
+  #     UI.messagebox zrotation
+  #   else
+  #     UI.messagebox "Failure"
+  #   end
+  #
+  # @return vector - a Vector3d object if successful
+  #
+  # @version SketchUp 6.0
+  def zrotation
+  end
+
+end