sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/geom.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Geom module defines a number of Module methods that let you perform
@@ -227,7 +227,7 @@ module Geom
   # @return [Boolean] +true+ if the point is inside the polygon.
   #
   # @version SketchUp 6.0
-  def self.point_in_polygon_2D(point, *polygon, check_border)
+  def self.point_in_polygon_2D(point, polygon, check_border)
   end
 
 end

data/SketchUp/languagehandler.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LanguageHandler class contains methods used to help make SketchUp

data/SketchUp/length.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Because length units are used so often in SketchUp, a special class has been

data/SketchUp/numeric.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A number of methods have been added to the Ruby Numeric class to do units
@@ -71,7 +71,7 @@ class Numeric
   def km
   end
 
-  # The m method is used to convert meters to inches.
+  # The m method is used to convert from meters to inches.
   #
   # @example
   #   meters = 1
@@ -95,7 +95,7 @@ class Numeric
   def mile
   end
 
-  # The mm method is used to convert a number to millimeters.
+  # The mm method is used to convert from millimeters to inches.
   #
   # It returns a Length value which is the same length as the given value. For
   # example len = 25.4.mm returns 1 inch.

data/SketchUp/sketchup.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Sketchup module contains a number of important utility methods for use in
@@ -386,14 +386,14 @@ module Sketchup
   def self.get_datfile_info(key, default_value)
   end
 
-  # The get_i18ndatfile_info method is used to retrieve the value for the
+  # The {.get_i18n_datfile_info} method is used to retrieve the value for the
   # given key from the internationalization file that SketchUp uses to work
   # in multiple languages.
   #
-  # If the key is not found, default_value is returned.
+  # If the +key+ is not found, +default_value+ is returned.
   #
   # @example
-  #   value = Sketchup.get_i18ndatfile_info(key, default_value)
+  #   value = Sketchup.get_i18n_datfile_info(key, default_value)
   #
   # @param [String] key
   #   The key whose value you want to retrieve.
@@ -402,7 +402,7 @@ module Sketchup
   #   The default value you want returned if key is not
   #   available.
   #
-  # @return [String] a string value if successful.
+  # @return [String]
   #
   # @version SketchUp 6.0
   def self.get_i18n_datfile_info(key, default_value)
@@ -730,12 +730,12 @@ module Sketchup
   # @param [String] section
   #   A section in an .INI or registry.
   #
-  # @param [Object] default
-  #   A default value if the value is not found.
-  #
   # @param [String] variable
   #   A variable within the section.
   #
+  # @param [Object] default
+  #   A default value if the value is not found.
+  #
   # @return [Object, nil] if unsuccessful, the value of the default
   #   if successful.
   #
@@ -1286,12 +1286,12 @@ module Sketchup
   #   A section in a .plist file (Mac) or the registry
   #   (Windows).
   #
-  # @param [Object] value
-  #   The value to store.
-  #
   # @param [String] key
   #   A key within the section.
   #
+  # @param [Object] value
+  #   The value to store.
+  #
   # @return [Boolean] True if successful, false if unsuccessful.
   #
   # @version SketchUp 6.0

data/SketchUp/sketchupextension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SketchupExtension class contains methods allowing you to create and
@@ -187,12 +187,16 @@ class SketchupExtension
   # @example
   #   # Create an entry in the Extension list that loads a script called
   #   # core.rb.
-  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core.rb')
+  #   extension = SketchupExtension.new('Stair Tools', 'StairTools/core')
   #
   #   # Then be sure to register it. By passing a 2nd param of true, you're
   #   # telling SketchUp to load the extension by default.
   #   Sketchup.register_extension(extension, true)
   #
+  # @note It is recommended to omit the file extension provided in the +path+
+  #   argument. SketchUp will resolve the file extension to +.rbe+, +.rbs+
+  #   or +.rb+.
+  #
   # @param [String] title
   #   The name of the extension
   #

data/SketchUp/string.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The String class contains a method used to parse a string as a length value.

data/SketchUp/ui.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UI module contains a number of methods for creating simple UI elements
@@ -73,6 +73,10 @@ module UI
   # @param [String] filename
   #   Filename for an image.
   #
+  # @param [Integer] hot_x
+  #   An x coordinate that is the "hotpoint" for the cursor
+  #   computed from the left edge of your cursor image.
+  #
   # @param [Integer] hot_y
   #   A y coordinate that is the "hotpoint" for the cursor
   #   computed from the top edge of the of your cursor image.
@@ -81,10 +85,6 @@ module UI
   #   the left edge of your cursor image and 10 pixels from
   #   the top edge of your cursor image.
   #
-  # @param [Integer] hot_x
-  #   An x coordinate that is the "hotpoint" for the cursor
-  #   computed from the left edge of your cursor image.
-  #
   # @return [Integer] ID associated with the cursor
   #
   # @version SketchUp 6.0
@@ -278,6 +278,9 @@ module UI
   # @param [String] title
   #   The title to apply to the open dialog box.
   #
+  # @param [String] directory
+  #   The default directory for the open panel.
+  #
   # @param [String] filename
   #   The default filename for the open panel. On Windows, you
   #   can alternatively pass a wildcard filter using this
@@ -289,9 +292,6 @@ module UI
   #   single line using a semicolon-separated list in the
   #   filter field: ui_name|wildcard1;wildcard2||.
   #
-  # @param [String] directory
-  #   The default directory for the open panel.
-  #
   # @return [String] the full path and name of the file selected, or
   #   nil if the dialog was canceled.
   #
@@ -377,6 +377,9 @@ module UI
   # @param [String] title
   #   The title to apply to the save dialog box.
   #
+  # @param [String] directory
+  #   The default directory for the save panel.
+  #
   # @param [String] filename
   #   The default filename for the save panel. On Windows, you
   #   can alternatively pass a mask, like "*.txt", to have all
@@ -385,9 +388,6 @@ module UI
   #   filename and separate them with a semicolon, like this:
   #   "*.txt;*.doc".
   #
-  # @param [String] directory
-  #   The default directory for the save panel.
-  #
   # @return [String] the full path and name of the file
   #   selected or nil if the dialog was canceled.
   #
@@ -580,13 +580,13 @@ module UI
   #   # Beep once after 10 seconds.
   #   id = UI.start_timer(10, false) { UI.beep }
   #
+  # @param [Numeric] seconds
+  #   The time in seconds before your code should be called.
+  #
   # @param [Boolean] repeat
   #   true if you want the timer to repeat, false
   #   (or omit) if you do not want it to repeat.
   #
-  # @param [Numeric] seconds
-  #   The time in seconds before your code should be called.
-  #
   # @return [Integer] a timer ID
   #
   # @version SketchUp 6.0

data/autoload/sketchup.rb

@@ -95,6 +95,8 @@ require '../SketchUp/Sketchup/Layers.rb'
 require '../SketchUp/Sketchup/LayersObserver.rb'
 require '../SketchUp/Sketchup/Licensing/ExtensionLicense.rb'
 require '../SketchUp/Sketchup/Licensing.rb'
+require '../SketchUp/Sketchup/LineStyle.rb'
+require '../SketchUp/Sketchup/LineStyles.rb'
 require '../SketchUp/Sketchup/Loop.rb'
 require '../SketchUp/Sketchup/Material.rb'
 require '../SketchUp/Sketchup/Materials.rb'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sketchup-api-stubs
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-06 00:00:00.000000000 Z
+date: 2019-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -137,6 +137,8 @@ files:
 - SketchUp/Sketchup/LayersObserver.rb
 - SketchUp/Sketchup/Licensing.rb
 - SketchUp/Sketchup/Licensing/ExtensionLicense.rb
+- SketchUp/Sketchup/LineStyle.rb
+- SketchUp/Sketchup/LineStyles.rb
 - SketchUp/Sketchup/Loop.rb
 - SketchUp/Sketchup/Material.rb
 - SketchUp/Sketchup/Materials.rb
@@ -209,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: SketchUp Ruby API stubs.