sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Sketchup/ModelObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to model events. To
@@ -57,9 +57,9 @@ class Sketchup::ModelObserver
   #
   # @return [nil]
   #
-  # @see Sketchup::Model#edit_transform
-  #
   # @see Sketchup::Model#active_path
+  #
+  # @see Sketchup::Model#edit_transform
   def onActivePathChanged(model)
   end
 

data/SketchUp/Sketchup/OptionsManager.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The OptionsManager class manages various kinds of OptionsProviders on a

data/SketchUp/Sketchup/OptionsProvider.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An OptionsProvider class provides various kinds of options on a Model. You
@@ -103,9 +103,9 @@ class Sketchup::OptionsProvider
   #
   # @yield [key, value]
   #
-  # @yieldparam [Object] value
-  #
   # @yieldparam [String] key
+  #
+  # @yieldparam [Object] value
   def each
   end
 
@@ -139,9 +139,9 @@ class Sketchup::OptionsProvider
   #
   # @yield [key, value]
   #
-  # @yieldparam [Object] value
-  #
   # @yieldparam [String] key
+  #
+  # @yieldparam [Object] value
   def each_pair
   end
 

data/SketchUp/Sketchup/OptionsProviderObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to operations provider

data/SketchUp/Sketchup/Page.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Page class contains methods to extract information and modify the

data/SketchUp/Sketchup/Pages.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Pages class contains methods for manipulating a collection of Pages
@@ -296,20 +296,25 @@ class Sketchup::Pages < Sketchup::Entity
   def selected_page=(page)
   end
 
-  # The show_frame_at method is used to show a frame in animation (of the slide
-  # show) at a given time in seconds.
+  # The {#show_frame_at} method is used to show a frame in animation (of the
+  # slide show) at a given time in seconds.
   #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
-  #   status = pages.add "Page 1"
-  #   status = pages.add "Page 2"
-  #   status = pages.show_frame_at 10
+  #   pages.add("Page 1")
+  #   pages.add("Page 2")
+  #   page, ratio = pages.show_frame_at(1.8)
   #
-  # @param seconds
+  # @note In versions prior to SketchUp 2019 this method will crash if called
+  #   when there are no pages in the model.
+  #
+  # @param [Float] seconds
   #   The time in seconds.
   #
-  # @return nil
+  # @return [Array(Sketchup::Page, Float), nil] Upon success it returns the
+  #   page that is displayed and a parameter between +0.0+ and +1.0+ that is
+  #   tells how far along the transition to next page you are at.
   #
   # @version SketchUp 6.0
   def show_frame_at(seconds)

data/SketchUp/Sketchup/PagesObserver.rb

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

data/SketchUp/Sketchup/PickHelper.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The PickHelper class is used to pick entities that reside under the current
@@ -174,10 +174,10 @@ class Sketchup::PickHelper
   def element_at(index)
   end
 
-  # The init method is used to initialize the PickHelper for testing points.
+  # The {#init} method is used to initialize the PickHelper for testing points.
   #
   # You do not normally need to call this method, but you can use this if you
-  # want to call test_point or pick_segment on a lot of points.
+  # want to call {#test_point} or {#pick_segment} on a lot of points.
   #
   # If the optional aperture is given, it is given in pixels.
   #
@@ -189,16 +189,16 @@ class Sketchup::PickHelper
   #     ph.test_point(point)
   #   }
   #
-  # @param x
+  # @param [Integer] x
   #   X screen coordinate for the pick.
   #
-  # @param y
+  # @param [Integer] y
   #   Y screen coordinate for the pick.
   #
-  # @param [optional] aperture
+  # @param [Integer] aperture
   #   aperture in pixels.
   #
-  # @return p - the (receiver) PickHelper Object
+  # @return [PickHelper] self
   #
   # @version SketchUp 6.0
   def init(x, y, aperture = 0)
@@ -255,17 +255,18 @@ class Sketchup::PickHelper
   def path_at(index)
   end
 
-  # The pick_segment method is used to pick a segment of a polyline curve that
+  # The {#pick_segment} method is used to pick a segment of a polyline curve that
   # is defined by an array of points.
   #
   # If you click on a point in a polyline curve, the index of
-  # the point in the curve is returned (starting at 0). If you click on a
-  # segment in the polyline curve, the index of the segment is returned.
-  # Segments start at index -1 (for the segment connecting the first two points)
-  # and increase by a factor of -1 (for example, the segment connecting second
-  # and third point is -2).
+  # the point in the curve is returned (starting at 0).
   #
-  # There is no need to invoke do_pick for this and the results are unrelated.
+  # If you click on a segment in the polyline curve, the index of the segment is
+  # returned. Segments are returned by negative indicies and start at index -1
+  # (for the segment connecting the first two points) and increase by a factor
+  # of -1 (for example, the segment connecting second and third point is -2).
+  #
+  # There is no need to invoke {#do_pick} for this and the results are unrelated.
   #
   # @example
   #   point1 = Geom::Point3d.new(0 ,0, 0)
@@ -275,29 +276,33 @@ class Sketchup::PickHelper
   #   # If testing many points this is the fastest way to test.
   #   ph.init(x, y)
   #   picked = ph.pick_segment(segment)
-  #   # This do not require init(
+  #   # This do not require .init
   #   picked = ph.pick_segment(segment, x, y)
   #
-  # @param array_or_list
-  #   A series of Point3d objects in the polyline as a list
-  #   of parameters or an array containing Point3d objects.
+  # @note The return value will be a negative index when a segment is picked.
   #
-  # @param [optional] x
-  #   screen mouse position in pixels.
+  # @overload pick_segment(points)
   #
-  # @param [optional but requires x and y] aperture
-  #   aperture in pixels.
+  #   This is more efficient if you need to test a number of segments for the
+  #   same set of screen coordinates. But then you must use {#init} first.
+  #   @param [Array<Geom::Point3d>] points  A series of points in the polyline as
+  #                        a list of parameters or an array containing Point3d
+  #                        objects.
+  #   @return [Integer, false]  an index on success, +false+ on failure
   #
-  # @param [optional(required if x given)] y
-  #   screen mouse position
-  #   in pixels.
+  # @overload pick_segment(points, x, y, aperture = 0)
   #
-  # @return index - an index of the point in the array if you
-  #   clicked on a point or an index of a segment if you
-  #   clicked on a segment (if successful)
+  #   @param [Array<Geom::Point3d>] points  A series of points in the polyline as
+  #                        a list of parameters or an array containing Point3d
+  #                        objects.
+  #   @param [Integer] x   screen mouse position in pixels.
+  #   @param [Integer] y   (required if x given) screen mouse position
+  #                        in pixels.
+  #   @param aperture      aperture in pixels.
+  #   @return [Integer, false]  an index on success, +false+ on failure
   #
   # @version SketchUp 6.0
-  def pick_segment(array_or_list, x, y, aperture = 0)
+  def pick_segment(*args)
   end
 
   # The picked_edge method is used to retrieve the "best" Edge picked.
@@ -352,18 +357,10 @@ class Sketchup::PickHelper
   def picked_face
   end
 
-  # The test_point method is used to test a point to see if it would be selected
-  # using the default or given pick aperture.
+  # The {#test_point} method is used to test a point to see if it would be
+  # selected using the default or given pick aperture.
   #
-  # In the first form, you must have initialized the PickHelper using the init
-  # method. This is more efficient if you want to test a lot of points using the
-  # same screen point.
-  #
-  # In the second and third forms, it initializes the
-  # PickHelper using a screen point and an optional pick aperture that you pass
-  # in as the 2nd-4th arguments.
-  #
-  # There is no need to invoke do_pick for this and the results are unrelated.
+  # There is no need to invoke {#do_pick} for this and the results are unrelated.
   #
   # @example
   #   ph = view.pick_helper
@@ -374,22 +371,24 @@ class Sketchup::PickHelper
   #   picked = ph.test_point(point, x, y)
   #   picked = ph.test_point(point, x, y, aperture)
   #
-  # @param point
-  #   Screen point.
+  # @overload test_point(point)
   #
-  # @param [optional] x
-  #   x position of pick.
+  #   This is more efficient if you want to test a lot of points using the same
+  #   screen point. But you *must* have called the {#init} method first for this
+  #   to work.
+  #   @param [Geom::Point3d] point
   #
-  # @param [optional] aperture
-  #   aperture in pixels.
+  # @overload test_point(point, x, y, aperture = 0)
   #
-  # @param [optional] y
-  #   y position of pick.
+  #   @param [Geom::Point3d] point
+  #   @param [Integer] x
+  #   @param [Integer] y
+  #   @param [Integer] aperture
   #
-  # @return would_be_selected - true or false
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
-  def test_point(point, x, y, aperture = 0)
+  def test_point(*args)
   end
 
   # The transformation_at method is used to get a transformation at a specific

data/SketchUp/Sketchup/RegionalSettings.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::RegionalSettings} module contains methods getting information about the

data/SketchUp/Sketchup/RenderingOptions.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The RenderingOptions class contains method to extract the rendering
@@ -255,11 +255,11 @@ class Sketchup::RenderingOptions < Sketchup::Entity
   #
   # @yield [key, value]
   #
-  # @yieldparam [Object] value
-  #   The value of each pair found.
-  #
   # @yieldparam [String] key
   #   The key of each pair found.
+  #
+  # @yieldparam [Object] value
+  #   The value of each pair found.
   def each
   end
 

data/SketchUp/Sketchup/RenderingOptionsObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to rendering options events.
@@ -30,13 +30,13 @@ class Sketchup::RenderingOptionsObserver
   #     puts "onRenderingOptionsChanged(#{rendering_options}, #{type})"
   #   end
   #
+  # @param [Sketchup::RenderingOptions] rendering_options
+  #
   # @param [Integer] type
   #   A number indicating which option was changed
   #   represented by one of the constants defined in
   #   {Sketchup::RenderingOptions}.
   #
-  # @param [Sketchup::RenderingOptions] rendering_options
-  #
   # @version SketchUp 6.0
   def onRenderingOptionsChanged(rendering_options, type)
   end

data/SketchUp/Sketchup/SectionPlane.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SectionPlane class represents a section plane in a SketchUp model. Note

data/SketchUp/Sketchup/Selection.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A set of the currently selected entities. Use the Model.selection method
@@ -271,10 +271,10 @@ class Sketchup::Selection
   #
   # @return [Integer]
   #
-  # @see #nitems
-  #
   # @see #size
   #
+  # @see #nitems
+  #
   # @version SketchUp 6.0
   def length
   end

data/SketchUp/Sketchup/SelectionObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to selection events. To
@@ -102,10 +102,10 @@ class Sketchup::SelectionObserver
   # @note Due to a bug in SketchUp this event doesn't trigger. Instead
   #   +onSelectedRemoved+ is called.
   #
-  # @param [Sketchup::Entity] entity
-  #
   # @param [Sketchup::Selection] selection
   #
+  # @param [Sketchup::Entity] entity
+  #
   # @return [nil]
   #
   # @version SketchUp 6.0

data/SketchUp/Sketchup/Set.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The set class represents a collection of unique objects. This class is useful

data/SketchUp/Sketchup/ShadowInfo.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ShadowInfo class contains method to extract the shadow information for a
@@ -156,9 +156,9 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   #
   # @yield [key, value]
   #
-  # @yieldparam [Object] value
-  #
   # @yieldparam [String] key
+  #
+  # @yieldparam [Object] value
   def each
   end
 

data/SketchUp/Sketchup/ShadowInfoObserver.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to changes to the shadow

data/SketchUp/Sketchup/Style.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Style class contains methods for modifying information about a specific

data/SketchUp/Sketchup/Styles.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Styles class contains methods for manipulating a collection of styles in

data/SketchUp/Sketchup/Text.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Text class contains method to manipulate a Text entity object.
@@ -43,6 +43,33 @@ class Sketchup::Text < Sketchup::Drawingelement
   def arrow_type=(type)
   end
 
+  # The {#attached_to} method returns an array of the attached
+  # {Sketchup::InstancePath} object and the {Geom::Point3d}.
+  #
+  # @example
+  #   # Have a text annotation attached to a drawing element and selected
+  #   Sketchup.active_model.selection[0].attached_to
+  #
+  # @return [Array(Sketchup::InstancePath, Geom::Point3d), nil]
+  #
+  # @version SketchUp 2019
+  def attached_to
+  end
+
+  # The {#attached_to=} method will attach the {Sketchup::Text} to another
+  # {Sketchup::DrawingElement}.
+  #
+  # @example
+  #   # Have a text annotation attached to a drawing element and selected
+  #   array = Sketchup.active_model.selection[0].attached_to
+  #   Sketchup.active_model.selection[0].attached_to = [array[0], Geom::Point3d.new(0, 0, 0)]
+  #
+  # @param [Array(Sketchup::InstancePath, Geom::Point3d)] path
+  #
+  # @version SketchUp 2019
+  def attached_to=(path)
+  end
+
   # The display_leader= method accepts true or false for whether to display the
   # leader.
   #