sketchup-api-stubs 0.6.1 → 0.7.4

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

@@ -1,135 +1,135 @@
-# Copyright:: Copyright 2019 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# A {Layout::TableColumn} is a single row from a table.
-#
-# @example
-#   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-#   rows = 4
-#   columns = 4
-#   table = Layout::Table.new(bounds, rows, columns)
-#   rows.times { |index|
-#     row = table.row(index)
-#   }
-#
-# @version LayOut 2018
-class Layout::TableRow
-
-  # Instance Methods
-
-  # The {#bottom_edge_style} method returns the {Layout::Style} of a
-  # {Layout::TableRow}'s bottom edge.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = table.get_row(1).bottom_edge_style
-  #
-  # @return [Layout::Style]
-  #
-  # @version LayOut 2018
-  def bottom_edge_style
-  end
-
-  # The {#bottom_edge_style=} method sets the {Layout::Style} of a
-  # {Layout::TableRow}'s bottom edge.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = Layout::Style.new
-  #   style.stroke_width = 2.0
-  #   table.get_row(1).bottom_edge_style = style
-  #
-  # @param [Layout::Style] style
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def bottom_edge_style=(style)
-  end
-
-  # The {#height} method returns the height of the {Layout::TableRow}.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   height = table.get_row(1).height
-  #
-  # @return [Float]
-  #
-  # @version LayOut 2018
-  def height
-  end
-
-  # The {#height=} method sets the height of the {Layout::TableRow}.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   table.get_row(1).height = 3.0
-  #
-  # @param [Float] height
-  #
-  # @raise [ArgumentError] if height is not a valid height
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def height=(height)
-  end
-
-  # The {#top_edge_style} method returns the {Layout::Style} of a
-  # {Layout::TableRow}'s top edge.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = table.get_row(1).top_edge_style
-  #
-  # @return [Layout::Style]
-  #
-  # @version LayOut 2018
-  def top_edge_style
-  end
-
-  # The {#top_edge_style=} method sets the {Layout::Style} of a
-  # {Layout::TableRow}'s top edge.
-  #
-  # @example
-  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
-  #   rows = 4
-  #   columns = 4
-  #   table = Layout::Table.new(bounds, rows, columns)
-  #   style = Layout::Style.new
-  #   style.stroke_width = 2.0
-  #   table.get_row(1).top_edge_style = style
-  #
-  # @param [Layout::Style] style
-  #
-  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
-  #   {Layout::Layer}
-  #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
-  # @version LayOut 2018
-  def top_edge_style=(style)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A {Layout::TableColumn} is a single row from a table.
+#
+# @example
+#   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+#   rows = 4
+#   columns = 4
+#   table = Layout::Table.new(bounds, rows, columns)
+#   rows.times { |index|
+#     row = table.row(index)
+#   }
+#
+# @version LayOut 2018
+class Layout::TableRow
+
+  # Instance Methods
+
+  # The {#bottom_edge_style} method returns the {Layout::Style} of a
+  # {Layout::TableRow}'s bottom edge.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = table.get_row(1).bottom_edge_style
+  #
+  # @return [Layout::Style]
+  #
+  # @version LayOut 2018
+  def bottom_edge_style
+  end
+
+  # The {#bottom_edge_style=} method sets the {Layout::Style} of a
+  # {Layout::TableRow}'s bottom edge.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = Layout::Style.new
+  #   style.stroke_width = 2.0
+  #   table.get_row(1).bottom_edge_style = style
+  #
+  # @param [Layout::Style] style
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def bottom_edge_style=(style)
+  end
+
+  # The {#height} method returns the height of the {Layout::TableRow}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   height = table.get_row(1).height
+  #
+  # @return [Float]
+  #
+  # @version LayOut 2018
+  def height
+  end
+
+  # The {#height=} method sets the height of the {Layout::TableRow}.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   table.get_row(1).height = 3.0
+  #
+  # @param [Float] height
+  #
+  # @raise [ArgumentError] if height is not a valid height
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def height=(height)
+  end
+
+  # The {#top_edge_style} method returns the {Layout::Style} of a
+  # {Layout::TableRow}'s top edge.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = table.get_row(1).top_edge_style
+  #
+  # @return [Layout::Style]
+  #
+  # @version LayOut 2018
+  def top_edge_style
+  end
+
+  # The {#top_edge_style=} method sets the {Layout::Style} of a
+  # {Layout::TableRow}'s top edge.
+  #
+  # @example
+  #   bounds = Geom::Bounds2d.new(1, 1, 4, 4)
+  #   rows = 4
+  #   columns = 4
+  #   table = Layout::Table.new(bounds, rows, columns)
+  #   style = Layout::Style.new
+  #   style.stroke_width = 2.0
+  #   table.get_row(1).top_edge_style = style
+  #
+  # @param [Layout::Style] style
+  #
+  # @raise [LockedLayerError] if the {Layout::Table} is on a locked
+  #   {Layout::Layer}
+  #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
+  # @version LayOut 2018
+  def top_edge_style=(style)
+  end
+
+end

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

@@ -1,140 +1,140 @@
-# Copyright:: Copyright 2019 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The {Sketchup::Animation} interface is implemented to create animations
-# inside SketchUp. At any given time, a single animation can be active on a
-# {Sketchup::View}. To make your own, build a Ruby class that contains the
-# methods described below:
-#
-#   # This is an example of a simple animation that floats the camera up to
-#   # a z position of 200". The only required method for an animation is
-#   # nextFrame. It is called whenever you need to show the next frame of
-#   # the animation. If nextFrame returns false, the animation will stop.
-#   class FloatUpAnimation
-#     def nextFrame(view)
-#       new_eye = view.camera.eye
-#       new_eye.z = new_eye.z + 1.0
-#       view.camera.set(new_eye, view.camera.target, view.camera.up)
-#       view.show_frame
-#       return new_eye.z < 500.0
-#     end
-#   end
-#
-#   # This adds an item to the Camera menu to activate our custom animation.
-#   UI.menu("Camera").add_item("Run Float Up Animation") {
-#     Sketchup.active_model.active_view.animation = FloatUpAnimation.new
-#   }
-#
-# {Sketchup::Animation} objects are activated by using the
-# {Sketchup::View#animation=} method on a {Sketchup::View}
-# object. To stop an animation set the view's animation object to +nil+, like
-# so:
-#
-#   Sketchup.active_model.active_view.animation = nil
-#
-# @version SketchUp 6.0
-class Sketchup::Animation
-
-  # Instance Methods
-
-  # The {#nextFrame} method is invoked by SketchUp to tell the animation to
-  # display its next frame. This method should set up the camera and then call
-  # {Sketchup::View#show_frame}.
-  #
-  # The {#nextFrame} method is the only required method of the
-  # {Sketchup::Animation} interface that you must implement.
-  #
-  # @example
-  #   def nextFrame(view)
-  #     # Insert your handler code for updating the camera or other entities.
-  #     view.show_frame
-  #     return true
-  #   end
-  #
-  # @param [Sketchup::View] view
-  #   The view for the animation.
-  #
-  # @return [Boolean] continue - +true+ if you want the animation to continue
-  #   on to the next frame, +false+ if you want the animation
-  #   to stop after this frame.
-  #
-  # @version SketchUp 6.0
-  #
-  # @version SketchUp 6.0
-  def nextFrame(view)
-  end
-
-  # The {#pause} method is invoked by SketchUp when the animation is paused.
-  #
-  # This method is optional (you do not need to implement this method unless you
-  # want to perform some specialized function when the animation is paused). You
-  # cannot call this method in your code explicitly and expect an animation to
-  # pause, only certain SketchUp events cause the method to be called.
-  #
-  # @example
-  #   def pause
-  #     # Insert handler code for whatever you need to do when it is paused.
-  #   end
-  #
-  # @note The user interface for pausing and resuming animations isn't integrated
-  #   with the Ruby API in the current version, so this method is probably not
-  #   useful to you.
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def pause
-  end
-
-  # The {#resume} method is invoked by SketchUp when the animation is resumed
-  # after being paused.
-  #
-  # This method is optional (you do not need to implement this method unless you
-  # want to perform some specialized function when the animation is resumed).
-  # You cannot call this method in your code explicitly and expect an animation
-  # to stop, only certain SketchUp events cause the method to be called.
-  #
-  # @example
-  #   def resume
-  #     # Insert your handler code for whatever you need to do as you resume.
-  #   end
-  #
-  # @note The user interface for pausing and resuming animations isn't integrated
-  #   with the Ruby API in the current version, so this method is probably not
-  #   useful to you.
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def resume
-  end
-
-  # The {#stop} method is invoked by SketchUp when the animation is stopped.
-  #
-  # This method is optional (you do not need to implement this method unless you
-  # want to perform some specialized function when the animation is stopped). You
-  # cannot call this method in your code explicitly and expect an animation to
-  # stop, only certain SketchUp events cause the method to be called.
-  #
-  # Perhaps the most common way for this method to be called is when your Ruby
-  # code sets {Sketchup::View#animation=} to +nil+. See the class comments for
-  # an example of this.
-  #
-  # @example
-  #   class MyAnimation
-  #     def stop
-  #       # Insert your handler code for cleaning up after your animation.
-  #     end
-  #   end
-  #
-  # @note Do not call {#Sketchup::View#animation=} from this method. This will
-  #   cause a recursive loop and crash SketchUp 2017 and earlier versions.
-  #   As of SketchUp 2018 this will raise a +RunTimeError+.
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 6.0
-  def stop
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The {Sketchup::Animation} interface is implemented to create animations
+# inside SketchUp. At any given time, a single animation can be active on a
+# {Sketchup::View}. To make your own, build a Ruby class that contains the
+# methods described below:
+#
+#   # This is an example of a simple animation that floats the camera up to
+#   # a z position of 200". The only required method for an animation is
+#   # nextFrame. It is called whenever you need to show the next frame of
+#   # the animation. If nextFrame returns false, the animation will stop.
+#   class FloatUpAnimation
+#     def nextFrame(view)
+#       new_eye = view.camera.eye
+#       new_eye.z = new_eye.z + 1.0
+#       view.camera.set(new_eye, view.camera.target, view.camera.up)
+#       view.show_frame
+#       return new_eye.z < 500.0
+#     end
+#   end
+#
+#   # This adds an item to the Camera menu to activate our custom animation.
+#   UI.menu("Camera").add_item("Run Float Up Animation") {
+#     Sketchup.active_model.active_view.animation = FloatUpAnimation.new
+#   }
+#
+# {Sketchup::Animation} objects are activated by using the
+# {Sketchup::View#animation=} method on a {Sketchup::View}
+# object. To stop an animation set the view's animation object to +nil+, like
+# so:
+#
+#   Sketchup.active_model.active_view.animation = nil
+#
+# @version SketchUp 6.0
+class Sketchup::Animation
+
+  # Instance Methods
+
+  # The {#nextFrame} method is invoked by SketchUp to tell the animation to
+  # display its next frame. This method should set up the camera and then call
+  # {Sketchup::View#show_frame}.
+  #
+  # The {#nextFrame} method is the only required method of the
+  # {Sketchup::Animation} interface that you must implement.
+  #
+  # @example
+  #   def nextFrame(view)
+  #     # Insert your handler code for updating the camera or other entities.
+  #     view.show_frame
+  #     return true
+  #   end
+  #
+  # @param [Sketchup::View] view
+  #   The view for the animation.
+  #
+  # @return [Boolean] continue - +true+ if you want the animation to continue
+  #   on to the next frame, +false+ if you want the animation
+  #   to stop after this frame.
+  #
+  # @version SketchUp 6.0
+  #
+  # @version SketchUp 6.0
+  def nextFrame(view)
+  end
+
+  # The {#pause} method is invoked by SketchUp when the animation is paused.
+  #
+  # This method is optional (you do not need to implement this method unless you
+  # want to perform some specialized function when the animation is paused). You
+  # cannot call this method in your code explicitly and expect an animation to
+  # pause, only certain SketchUp events cause the method to be called.
+  #
+  # @example
+  #   def pause
+  #     # Insert handler code for whatever you need to do when it is paused.
+  #   end
+  #
+  # @note The user interface for pausing and resuming animations isn't integrated
+  #   with the Ruby API in the current version, so this method is probably not
+  #   useful to you.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def pause
+  end
+
+  # The {#resume} method is invoked by SketchUp when the animation is resumed
+  # after being paused.
+  #
+  # This method is optional (you do not need to implement this method unless you
+  # want to perform some specialized function when the animation is resumed).
+  # You cannot call this method in your code explicitly and expect an animation
+  # to stop, only certain SketchUp events cause the method to be called.
+  #
+  # @example
+  #   def resume
+  #     # Insert your handler code for whatever you need to do as you resume.
+  #   end
+  #
+  # @note The user interface for pausing and resuming animations isn't integrated
+  #   with the Ruby API in the current version, so this method is probably not
+  #   useful to you.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def resume
+  end
+
+  # The {#stop} method is invoked by SketchUp when the animation is stopped.
+  #
+  # This method is optional (you do not need to implement this method unless you
+  # want to perform some specialized function when the animation is stopped). You
+  # cannot call this method in your code explicitly and expect an animation to
+  # stop, only certain SketchUp events cause the method to be called.
+  #
+  # Perhaps the most common way for this method to be called is when your Ruby
+  # code sets {Sketchup::View#animation=} to +nil+. See the class comments for
+  # an example of this.
+  #
+  # @example
+  #   class MyAnimation
+  #     def stop
+  #       # Insert your handler code for cleaning up after your animation.
+  #     end
+  #   end
+  #
+  # @note Do not call {#Sketchup::View#animation=} from this method. This will
+  #   cause a recursive loop and crash SketchUp 2017 and earlier versions.
+  #   As of SketchUp 2018 this will raise a +RunTimeError+.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 6.0
+  def stop
+  end
+
+end