sketchup-api-stubs 0.6.1 → 0.7.0

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Command class is the preferred class for adding tools to the menus and

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Ruby HtmlDialog class allows you to create and interact with HTML dialog

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # UI::Notification objects allows you to show native notifications in the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Toolbar class contains methods to create and manipulate SketchUp

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Ruby WebDialog class allows you to create and interact with DHTML dialog

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 
@@ -66,6 +66,8 @@
   CMD_SHADED = nil # Stub value.
   CMD_SHOWGUIDES = nil # Stub value.
   CMD_SHOWHIDDEN = nil # Stub value.
+  CMD_SHOWHIDDENGEOMETRY = nil # Stub value.
+  CMD_SHOWHIDDENOBJECTS = nil # Stub value.
   CMD_SKETCHAXES = nil # Stub value.
   CMD_SKETCHCS = nil # Stub value.
   CMD_TEXT = nil # Stub value.
@@ -169,6 +171,10 @@
   TextAlignCenter = nil # Stub value.
   TextAlignLeft = nil # Stub value.
   TextAlignRight = nil # Stub value.
+  TextVerticalAlignBaseline = nil # Stub value.
+  TextVerticalAlignBoundsTop = nil # Stub value.
+  TextVerticalAlignCapHeight = nil # Stub value.
+  TextVerticalAlignCenter = nil # Stub value.
 
   VK_DELETE = nil # Stub value.
   VK_DOWN = nil # Stub value.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SketchUp Array class adds additional methods to the standard Ruby Array

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Geom module defines a number of Module methods that let you perform
@@ -230,4 +230,119 @@ module Geom
   def self.point_in_polygon_2D(point, polygon, check_border)
   end
 
+  # Tessellates a polygon, represented as a collection of 3D points. Can include
+  # holes by providing collections of points describing the inner loops. This is
+  # intended to be used for planar polygons.
+  #
+  # Useful to draw concave polygons using {Sketchup::View#draw} or
+  # {Sketchup::View#draw2d}.
+  #
+  # It can also be useful for importers where the input format describes only the
+  # loops for a polygon and you want to work with a collection of triangles.
+  #
+  # <b>Polygon with two holes, one empty and one filled:</b>
+  #
+  # <i>(See "Drawing a polygon with holes from a custom tool" example)</i>
+  #
+  # rdoc-image:images/geom-tesselation-polygon-with-holes.png
+  #
+  # @example Iterate over each triangle in the returned set
+  #   polygon = [
+  #     Geom::Point3d.new(0, 0, 0),
+  #     Geom::Point3d.new(90, 0, 0),
+  #     Geom::Point3d.new(60, 40, 0),
+  #     Geom::Point3d.new(90, 90, 0),
+  #     Geom::Point3d.new(30, 70, 0),
+  #   ]
+  #   triangles = Geom.tesselate(polygon)
+  #   triangles.each_slice(3) { |triangle|
+  #     # Work with each triangle set...
+  #   }
+  #   # Or get an array of triangles:
+  #   triangles_set = triangles.each_slice(3).to_a
+  #
+  # @example Drawing a polygon with holes from a custom tool
+  #   class ExampleTool
+  #
+  #     def initialize
+  #       polygon = [
+  #         Geom::Point3d.new(0, 0, 0),
+  #         Geom::Point3d.new(90, 0, 0),
+  #         Geom::Point3d.new(60, 40, 0),
+  #         Geom::Point3d.new(90, 90, 0),
+  #         Geom::Point3d.new(30, 70, 0),
+  #       ] # Counter-clockwise order
+  #       hole1 = [
+  #         Geom::Point3d.new(20, 10, 0),
+  #         Geom::Point3d.new(40, 10, 0),
+  #         Geom::Point3d.new(45, 25, 0),
+  #         Geom::Point3d.new(30, 20, 0),
+  #         Geom::Point3d.new(25, 25, 0),
+  #       ].reverse # Clockwise order - empty hole
+  #       hole2 = [
+  #         Geom::Point3d.new(30, 40, 0),
+  #         Geom::Point3d.new(50, 40, 0),
+  #         Geom::Point3d.new(50, 50, 0),
+  #         Geom::Point3d.new(30, 50, 0),
+  #       ].reverse # Counter-clockwise order - filled hole
+  #       @triangles = Geom.tesselate(polygon, hole1, hole2)
+  #     end
+  #
+  #     def activate
+  #       Sketchup.active_model.active_view.invalidate
+  #     end
+  #
+  #     def onMouseMove(flags, x, y, view)
+  #       view.invalidate
+  #     end
+  #
+  #     def getExtents
+  #       bounds = Geom::BoundingBox.new
+  #       bounds.add(@triangles)
+  #       bounds
+  #     end
+  #
+  #     def draw(view)
+  #       view.drawing_color = Sketchup::Color.new(192, 0, 0)
+  #       view.draw(GL_TRIANGLES, @triangles)
+  #     end
+  #
+  #   end
+  #
+  #   Sketchup.active_model.select_tool(ExampleTool.new)
+  #
+  # @note The winding order of the polygons matter. The outer loop should be
+  #   in counter-clockwise order. To cut an empty hole the inner loops should be
+  #   in clockwise order, otherwise they will create a loop filled with
+  #   triangles.
+  #
+  # @note The tesselation is using the same logic as SketchUp its rendering
+  #   pipeline. But the exact result is an implementation detail which may change
+  #   between versions. In particularly the results of degenerate polygons and
+  #   non-planar  polygons is undefined  as part of the API contract. Such
+  #   polygons are for example polygons where all points are colinear, polygons
+  #   with duplicate points, non-planar polygons.
+  #
+  # @note If you want the triangles from an existing {Sketchup::Face} it's better
+  #   to use {Sketchup::Face#mesh}.
+  #
+  # @param [Array<Geom::Point3d>] polygon_loop_points
+  #
+  # @param [Array<Array<Geom::Point3d>>] inner_loop_points
+  #
+  # @raise [ArgumentError] if any of the loops contain less than three points.
+  #
+  # @raise [RuntimeError] if the tesselator returned an error.
+  #
+  # @return [Array<Geom::Point3d>] an array of points with a stride of three
+  #   representing a set of triangles.
+  #
+  # @see Sketchup::View#draw
+  #
+  # @see Sketchup::View#draw2d
+  #
+  # @version SketchUp 2020.0
+  def self.tesselate(polygon_loop_points, *inner_loop_points)
+  end
+
 end

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Because length units are used so often in SketchUp, a special class has been
@@ -28,22 +28,30 @@
 #   - +Length::Millimeter+
 #   - +Length::Centimeter+
 #   - +Length::Meter+
+#   (Added in SketchUp 2020.0)
+#   - +Length::Yard+
 #
 # [Area Unit]
-#   (Added in SketchUp 2019.1)
+#   (Added in SketchUp 2019.2)
 #   - +Length::SquareInches+
 #   - +Length::SquareFeet+
 #   - +Length::SquareMillimeter+
 #   - +Length::SquareCentimeter+
 #   - +Length::SquareMeter+
+#   (Added in SketchUp 2020.0)
+#   - +Length::SquareYard+
 #
 # [Volume Unit]
-#   (Added in SketchUp 2019.1)
+#   (Added in SketchUp 2019.2)
 #   - +Length::CubicInches+
 #   - +Length::CubicFeet+
 #   - +Length::CubicMillimeter+
 #   - +Length::CubicCentimeter+
 #   - +Length::CubicMeter+
+#   (Added in SketchUp 2020.0)
+#   - +Length::CubicYard+
+#   - +Length::Liter+
+#   - +Length::USGallon+
 #
 # @note Prior to SketchUp 2015, +Length+ used to be derived from +Float+. This
 #   is no longer the case.
@@ -62,6 +70,7 @@ class Length < Float
   CubicInches = nil # Stub value.
   CubicMeter = nil # Stub value.
   CubicMillimeter = nil # Stub value.
+  CubicYard = nil # Stub value.
 
   Decimal = nil # Stub value.
 
@@ -73,6 +82,8 @@ class Length < Float
 
   Inches = nil # Stub value.
 
+  Liter = nil # Stub value.
+
   Millimeter = nil # Stub value.
 
   Meter = nil # Stub value.
@@ -82,6 +93,11 @@ class Length < Float
   SquareInches = nil # Stub value.
   SquareMeter = nil # Stub value.
   SquareMillimeter = nil # Stub value.
+  SquareYard = nil # Stub value.
+
+  USGallon = nil # Stub value.
+
+  Yard = nil # Stub value.
 
   # Instance Methods
 

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A number of methods have been added to the Ruby Numeric class to do units

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Sketchup module contains a number of important utility methods for use in
@@ -339,7 +339,7 @@ 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".

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SketchupExtension class contains methods allowing you to create and

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2019 Trimble Inc.
+# Copyright:: Copyright 2020 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UI module contains a number of methods for creating simple UI elements
@@ -246,7 +246,14 @@ module UI
   def self.model_info_pages
   end
 
-  # The {.openURL} method is used to open the default Web browser to a URL.
+  # The {.openURL} method is used to open the default browser to a URL.
+  #
+  # @bug Before SketchUp 2019.3 the mac version would URL encode the given URL.
+  #   This could inadvertently mangle some URLs, if for example if they had
+  #   URL fragments (# character).
+  #   The Windows version would not. As of SketchUp 2019.3 both platforms do
+  #   not perform URL encoding and the API user is expected to provide a valid
+  #   URL.
   #
   # @example
   #   status = UI.openURL("http://www.sketchup.com")
@@ -419,7 +426,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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sketchup-api-stubs
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-05 00:00:00.000000000 Z
+date: 2020-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler