sketchup-api-stubs 0.5.0 → 0.6.0

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

@@ -878,37 +878,20 @@ class Sketchup::View
   def vpwidth
   end
 
-  # The write_image method is used to write the current view to an image file.
+  # The {#write_image} method is used to write the current view to an image file.
   #
-  # All arguments except for the filename are optional.
-  #
-  # If antialias is specified, it should be either true or false.
-  #
-  # If a hash is passed as the first parameter, then the contents of that hash
-  # define how the image is exported.
-  #
-  # @example With options hash.
-  #   options = {
-  #     :filename => "c:/tmp/write_image.png",
-  #     :width => 640,
-  #     :height => 480,
-  #     :antialias => false,
-  #     :compression => 0.9,
-  #     :transparent => true
-  #   }
-  #   model = Sketchup.active_model
-  #   view = model.active_view
-  #   view.write_image(options)
+  # @overload write_image(filename, width = view.vpwidth, height = view.vpheight, antialias = false, compression = 1.0)
   #
-  # @example Legacy arguments variant.
-  #   filename => "c:/tmp/write_image.png"
-  #   antialias => false
-  #   compression => 0.9
-  #   model = Sketchup.active_model
-  #   view = model.active_view
-  #   view.write_image(filename, 640, 480, antialias, compression)
+  #   @note Prefer the overload with option hash instead of this variant. This
+  #     overload is not updated with new options.
   #
-  # @overload write_image(filename, width = view.vpwidth, height = view.vpheight, antialias = false, compression = 1.0)
+  #   @example
+  #     filename => "c:/tmp/write_image.png"
+  #     antialias => false
+  #     compression => 0.9
+  #     model = Sketchup.active_model
+  #     view = model.active_view
+  #     view.write_image(filename, 640, 480, antialias, compression)
   #
   #   @param [String] filename
   #     The filename for the saved image
@@ -917,23 +900,61 @@ class Sketchup::View
   #   @param [Integer] height
   #     Height in pixels, defaults to the current viewport height {#vpheight}.
   #   @param [Boolean] antialias
-  #     true or false
   #   @param [Float] compression
-  #     Float compression factor for JPEG images,
-  #     between 0.0 and 1.0
+  #     Compression factor for JPEG images, between +0.0+ and +1.0+.
   #
   # @overload write_image(options)
   #
+  #   @example
+  #     options = {
+  #       :filename => "c:/tmp/write_image.png",
+  #       :width => 640,
+  #       :height => 480,
+  #       :antialias => false,
+  #       :compression => 0.9,
+  #       :transparent => true
+  #     }
+  #     model = Sketchup.active_model
+  #     view = model.active_view
+  #     view.write_image(options)
+  #
   #   @version SketchUp 7
   #   @param [Hash] options
   #   @option options [String] filename  The filename for the saved image.
-  #   @option options [Integer] width (#vpwidth)  Width in pixels (max 16000).
-  #   @option options [Integer] height (#vpheight)  Height in pixels (max 16000).
+  #   @option options [Integer] width (#vpwidth)  Width in pixels (max +1600+).
+  #   @option options [Integer] height (#vpheight)  Height in pixels (max +16000+).
+  #   @option options [Float] scale_factor (1.0)  Scaling factor for
+  #     elements that are viewport dependent, such as text heights, arrow heads,
+  #     line widths, stipple patterns, etc. (Added in  SketchUp 2019.1)
   #   @option options [Boolean] antialias (false)
   #   @option options [Float] compression (1.0)  Compression factor for JPEG,
-  #     images between 0.0 and 1.0
+  #     images between +0.0+ and +1.0+.
   #   @option options [Boolean] transparent (false) Added in SketchUp 8.
   #
+  # @overload write_image(options)
+  #
+  #   It is possible to dump the framebuffer to file by setting +:source+ to
+  #   +:framebuffer+. When saving the framebuffer only the following options are
+  #   valid.
+  #
+  #   @example
+  #     options = {
+  #       :filename => "c:/tmp/write_image.png",
+  #       :source => :framebuffer,
+  #       :compression => 0.9,
+  #     }
+  #     model = Sketchup.active_model
+  #     view = model.active_view
+  #     view.write_image(options)
+  #
+  #   @version SketchUp 7
+  #   @param [Hash] options
+  #   @option options [String] filename  The filename for the saved image.
+  #   @option options [Boolean] source (:image) Set to +:framebuffer+ to dump the
+  #     current framebuffer.
+  #   @option options [Float] compression (1.0)  Compression factor for JPEG,
+  #     images between +0.0+ and +1.0+.
+  #
   # @return [Boolean]
   #
   # @version SketchUp 6.0

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

@@ -24,6 +24,9 @@ class Sketchup::ViewObserver
   # The {#onViewChanged} method is called whenever the view is altered, such as
   # when the user uses the Pan, Orbit, or Zoom tools are used.
   #
+  # @bug Prior to SketchUp 2019.2 this event did not trigger when the viewport
+  #   size changed.
+  #
   # @example
   #   def onViewChanged(view)
   #     puts "onViewChanged: #{view}"

data/lib/sketchup-api-stubs/stubs/_top_level.rb

@@ -5,16 +5,19 @@
 
   # Constants
 
+  ALT_MODIFIER_KEY = nil # Stub value.
+  ALT_MODIFIER_MASK = nil # Stub value.
+
   ALeaderModel = nil # Stub value.
   ALeaderNone = nil # Stub value.
   ALeaderView = nil # Stub value.
 
-  ALT_MODIFIER_KEY = nil # Stub value.
-  ALT_MODIFIER_MASK = nil # Stub value.
-
   COPY_MODIFIER_KEY = nil # Stub value.
   COPY_MODIFIER_MASK = nil # Stub value.
 
+  CONSTRAIN_MODIFIER_KEY = nil # Stub value.
+  CONSTRAIN_MODIFIER_MASK = nil # Stub value.
+
   CMD_ARC = nil # Stub value.
   CMD_CAMERA_UNDO = nil # Stub value.
   CMD_CIRCLE = nil # Stub value.
@@ -83,9 +86,6 @@
   CMD_ZOOM_EXTENTS = nil # Stub value.
   CMD_ZOOM_WINDOW = nil # Stub value.
 
-  CONSTRAIN_MODIFIER_KEY = nil # Stub value.
-  CONSTRAIN_MODIFIER_MASK = nil # Stub value.
-
   DimensionArrowClosed = nil # Stub value.
   DimensionArrowDot = nil # Stub value.
   DimensionArrowNone = nil # Stub value.
@@ -107,6 +107,9 @@
   GL_TRIANGLE_FAN = nil # Stub value.
   GL_TRIANGLE_STRIP = nil # Stub value.
 
+  IDENTITY = nil # Stub value.
+  IDENTITY_2D = nil # Stub value.
+
   IDABORT = nil # Stub value.
   IDCANCEL = nil # Stub value.
   IDIGNORE = nil # Stub value.
@@ -115,9 +118,6 @@
   IDRETRY = nil # Stub value.
   IDYES = nil # Stub value.
 
-  IDENTITY = nil # Stub value.
-  IDENTITY_2D = nil # Stub value.
-
   LAYER_HIDDEN_BY_DEFAULT = nil # Stub value.
   LAYER_IS_HIDDEN_ON_NEW_PAGES = nil # Stub value.
   LAYER_IS_VISIBLE_ON_NEW_PAGES = nil # Stub value.
@@ -151,12 +151,12 @@
   PAGE_USE_SHADOWINFO = nil # Stub value.
   PAGE_USE_SKETCHCS = nil # Stub value.
 
-  SKETCHUP_CONSOLE = nil # Stub value.
-
   SB_PROMPT = nil # Stub value.
   SB_VCB_LABEL = nil # Stub value.
   SB_VCB_VALUE = nil # Stub value.
 
+  SKETCHUP_CONSOLE = nil # Stub value.
+
   SnapTo_Arbitrary = nil # Stub value.
   SnapTo_Horizontal = nil # Stub value.
   SnapTo_Sloped = nil # Stub value.

data/lib/sketchup-api-stubs/stubs/array.rb

@@ -393,8 +393,6 @@ class Array
   #   @return [Boolean] +true+ if the point is on the line, +false+ if the
   #     point is not on the line.
   #
-  # @return [Boolean]
-  #
   # @see Geom
   #   The Geom module for instructions on how to create a line.
   #

data/lib/sketchup-api-stubs/stubs/length.rb

@@ -9,28 +9,80 @@
 # stores values in inches as well. A number of methods have been added to the
 # Ruby Numeric class to do units conversions.
 #
-# Constants:
-# Length Format:
-# - Length::Decimal
-# - Length::Architectural
-# - Length::Engineering
-# - Length::Fractional
-# Length Unit:
-# - Length::Inches
-# - Length::Feet
-# - Length::Millimeter
-# - Length::Centimeter
-# - Length::Meter
-# The setting for the Length format and Length unit can be retrieved from the
-# model options by querying the "UnitsOptions" OptionsProvider for
-# "LengthFormat" and "LengthUnit" respectively.
+# The setting for the Length Format and Length Unit can be retrieved from the
+# {Sketchup::Model#options} by querying the +"UnitsOptions"+
+# {Sketchup::OptionsProvider} for +"LengthFormat"+ and +"LengthUnit"+
+# respectively.
 #
-# @note Prior to SketchUp 2015, Length used to be derived from Float. This is
-#   no longer the case.
+# *Constants:*
+#
+# [Length Format]
+#   - +Length::Decimal+
+#   - +Length::Architectural+
+#   - +Length::Engineering+
+#   - +Length::Fractional+
+#
+# [Length Unit]
+#   - +Length::Inches+
+#   - +Length::Feet+
+#   - +Length::Millimeter+
+#   - +Length::Centimeter+
+#   - +Length::Meter+
+#
+# [Area Unit]
+#   (Added in SketchUp 2019.1)
+#   - +Length::SquareInches+
+#   - +Length::SquareFeet+
+#   - +Length::SquareMillimeter+
+#   - +Length::SquareCentimeter+
+#   - +Length::SquareMeter+
+#
+# [Volume Unit]
+#   (Added in SketchUp 2019.1)
+#   - +Length::CubicInches+
+#   - +Length::CubicFeet+
+#   - +Length::CubicMillimeter+
+#   - +Length::CubicCentimeter+
+#   - +Length::CubicMeter+
+#
+# @note Prior to SketchUp 2015, +Length+ used to be derived from +Float+. This
+#   is no longer the case.
 #
 # @version SketchUp 6.0
 class Length < Float
 
+  # Constants
+
+  Architectural = nil # Stub value.
+
+  Centimeter = nil # Stub value.
+
+  CubicCentimeter = nil # Stub value.
+  CubicFeet = nil # Stub value.
+  CubicInches = nil # Stub value.
+  CubicMeter = nil # Stub value.
+  CubicMillimeter = nil # Stub value.
+
+  Decimal = nil # Stub value.
+
+  Engineering = nil # Stub value.
+
+  Fractional = nil # Stub value.
+
+  Feet = nil # Stub value.
+
+  Inches = nil # Stub value.
+
+  Millimeter = nil # Stub value.
+
+  Meter = nil # Stub value.
+
+  SquareCentimeter = nil # Stub value.
+  SquareFeet = nil # Stub value.
+  SquareInches = nil # Stub value.
+  SquareMeter = nil # Stub value.
+  SquareMillimeter = nil # Stub value.
+
   # Instance Methods
 
   # The < method is used to see if one length is less than another length.

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

@@ -306,19 +306,19 @@ module Sketchup
   def self.format_angle(number)
   end
 
-  # The format_area method formats a number as an area using the current units
+  # The #{format_area} method formats a number as an area using the current units
   # settings.
   #
-  # The default unit setting is inches. For example, 10 becomes 10 inches
-  # squared.
+  # The +number+ must be in square inches.
   #
   # @example
-  #   area = Sketchup.format_area(number)
+  #   number = 3.m * 4.m # This will result in 12m2 in inches.
+  #   formatted_area = Sketchup.format_area(number)
   #
   # @param [Numeric] number
   #   A number to be formatted.
   #
-  # @return [String] an area if successful, false if unsuccessful.
+  # @return [String]
   #
   # @version SketchUp 6.0
   def self.format_area(number)
@@ -339,24 +339,46 @@ module Sketchup
   def self.format_degrees(number)
   end
 
-  # The format_length method formats a number as a length using the current
+  # The {#format_length} method formats a number as a length using the current
   # units settings.
   #
   # The default unit setting is inches. For example, 10 becomes 10".
   #
   # @example
   #   length = Sketchup.format_length(10)
-  #   if length
-  #     UI.messagebox(length)
-  #   end
+  #
+  # @overload format_length(number)
+  #
+  #   @param [Numeric] number  A number to be formatted.
+  #
+  # @overload format_length(number, precision)
+  #
+  #   @param [Numeric] number  A number to be formatted.
+  #   @param [Integer] number  A custom precision. Negative number will strip
+  #                            trailing zeros.
+  #
+  # @return [String]
+  #
+  # @version SketchUp 6.0
+  def self.format_length(*args)
+  end
+
+  # The #{format_volume} method formats a number as a volume using the current
+  # units settings.
+  #
+  # The +number+ must be in cubic inches.
+  #
+  # @example
+  #   number = 3.m * 4.m * 5.m # This will result in 60m3 in inches.
+  #   formatted_volume = Sketchup.format_area(number)
   #
   # @param [Numeric] number
   #   A number to be formatted.
   #
-  # @return [String] length if successful, false if unsuccessful
+  # @return [String]
   #
-  # @version SketchUp 6.0
-  def self.format_length(number)
+  # @version SketchUp 2019.2
+  def self.format_volume(number)
   end
 
   # The get_datfile_info method is used to retrieve the value for the given key
@@ -983,7 +1005,8 @@ module Sketchup
   # - 21096: select the Circle tool
   # - 21098: open the Open Window
   # - 21100: select the Offset tool
-  # - 21101: slect all objects
+  # - 21101: select all objects
+  # - 21107: invert selection
   # - 21112: open the Import Window
   # - 21124: launch the validity check tool
   # - 21126: select the Axes tool

data/lib/sketchup-api-stubs/stubs/ui.rb

@@ -419,7 +419,7 @@ module UI
   def self.scale_factor
   end
 
-  # The {.select_directory} method is used to display the OS dialog for selecting
+  # The {#select_directory} method is used to display the OS dialog for selecting
   # one or several directories from the file system.
   #
   # @example
@@ -462,7 +462,7 @@ module UI
   def self.select_directory(options = {})
   end
 
-  # The set_cursor method is used to change the cursor to a new cursor with a
+  # The #{set_cursor} method is used to change the cursor to a new cursor with a
   # given cursor id. See UI.create_cursor and the Tool class for details
   # on creating your own tools with arbitrary cursors.
   #
@@ -478,7 +478,7 @@ module UI
   # @param [Integer] cursor_id
   #   The id of the cursor you want to display.
   #
-  # @return [nil]
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def self.set_cursor(cursor_id)

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: sketchup-api-stubs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.15.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -46,7 +52,7 @@ extra_rdoc_files: []
 files:
 - ".yardopts"
 - lib/sketchup-api-stubs.rb
-- lib/sketchup-api-stubs/autoload.rb
+- lib/sketchup-api-stubs/sketchup.rb
 - lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb
 - lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb
 - lib/sketchup-api-stubs/stubs/Geom/LatLong.rb