sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Layout/Style.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References a collection of style attributes that determine the visual
@@ -15,16 +15,8 @@ class Layout::Style
 
   # Constants
 
-  ALIGN_CENTER = nil # Stub value.
-  ALIGN_LEFT = nil # Stub value.
-  ALIGN_RIGHT = nil # Stub value.
-
   ARCHITECTURAL_INCHES = nil # Stub value.
 
-  ANCHOR_BOTTOM = nil # Stub value.
-  ANCHOR_CENTER = nil # Stub value.
-  ANCHOR_TOP = nil # Stub value.
-
   ARROW_FILLED_CIRCLE = nil # Stub value.
   ARROW_FILLED_DIAMOND = nil # Stub value.
   ARROW_FILLED_SKINNY_TRIANGLE = nil # Stub value.
@@ -45,10 +37,24 @@ class Layout::Style
   ARROW_T = nil # Stub value.
   ARROW_UNDERRUN = nil # Stub value.
 
+  ALIGN_CENTER = nil # Stub value.
+  ALIGN_LEFT = nil # Stub value.
+  ALIGN_RIGHT = nil # Stub value.
+
+  ANCHOR_BOTTOM = nil # Stub value.
+  ANCHOR_CENTER = nil # Stub value.
+  ANCHOR_TOP = nil # Stub value.
+
   CAP_STYLE_FLAT = nil # Stub value.
   CAP_STYLE_ROUND = nil # Stub value.
   CAP_STYLE_SQUARE = nil # Stub value.
 
+  DIMENSION_END_EXTENSION_LINE = nil # Stub value.
+  DIMENSION_LEADER_LINE = nil # Stub value.
+  DIMENSION_LINE = nil # Stub value.
+  DIMENSION_START_EXTENSION_LINE = nil # Stub value.
+  DIMENSION_TEXT = nil # Stub value.
+
   DECIMAL_CENTIMETERS = nil # Stub value.
   DECIMAL_FEET = nil # Stub value.
   DECIMAL_INCHES = nil # Stub value.
@@ -58,12 +64,6 @@ class Layout::Style
 
   DEGREES = nil # Stub value.
 
-  DIMENSION_END_EXTENSION_LINE = nil # Stub value.
-  DIMENSION_LEADER_LINE = nil # Stub value.
-  DIMENSION_LINE = nil # Stub value.
-  DIMENSION_START_EXTENSION_LINE = nil # Stub value.
-  DIMENSION_TEXT = nil # Stub value.
-
   DIMENSION_TEXT_ABOVE = nil # Stub value.
   DIMENSION_TEXT_BELOW = nil # Stub value.
   DIMENSION_TEXT_CENTER = nil # Stub value.
@@ -88,8 +88,6 @@ class Layout::Style
 
   RADIANS = nil # Stub value.
 
-  SUPER_SCRIPT = nil # Stub value.
-
   STROKE_PATTERN_CENTER = nil # Stub value.
   STROKE_PATTERN_DASH = nil # Stub value.
   STROKE_PATTERN_DASH_DASH_DOT = nil # Stub value.
@@ -101,10 +99,13 @@ class Layout::Style
   STROKE_PATTERN_DASH_SPACE = nil # Stub value.
   STROKE_PATTERN_DOT = nil # Stub value.
   STROKE_PATTERN_PHANTOM = nil # Stub value.
+  STROKE_PATTERN_SHORT_DASH = nil # Stub value.
   STROKE_PATTERN_SOLID = nil # Stub value.
 
   SUB_SCRIPT = nil # Stub value.
 
+  SUPER_SCRIPT = nil # Stub value.
+
   UNDERLINE_DOUBLE = nil # Stub value.
   UNDERLINE_NONE = nil # Stub value.
   UNDERLINE_SINGLE = nil # Stub value.

data/SketchUp/Layout/Table.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::Table} is a series of rows and columns that holds data.
@@ -152,12 +152,12 @@ class Layout::Table < Layout::Entity
   #
   # @param [Integer] columns
   #
-  # @raise [ArgumentError] if bounds is zero size
-  #
   # @raise [ArgumentError] if rows is less than 1
   #
   # @raise [ArgumentError] if columns is less than 1
   #
+  # @raise [ArgumentError] if bounds is zero size
+  #
   # @return [Layout::Table]
   #
   # @version LayOut 2018
@@ -177,11 +177,11 @@ class Layout::Table < Layout::Entity
   #
   # @raise [IndexError] if index is not a valid index for the {Layout::Table}
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def insert_column(index)
   end
@@ -199,11 +199,11 @@ class Layout::Table < Layout::Entity
   #
   # @raise [IndexError] if index is not a valid index for the {Layout::Table}
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def insert_row(index)
   end
@@ -226,7 +226,8 @@ class Layout::Table < Layout::Entity
   #
   # @param [Integer] end_column
   #
-  # @raise [ArgumentError] if the specified range of cells contains a merged cell
+  # @raise [IndexError] if the passed in indices are not a valid for the
+  #   {Layout::Table}
   #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
@@ -236,8 +237,7 @@ class Layout::Table < Layout::Entity
   # @raise [ArgumentError] if the specified range of cells only spans a single
   #   cell
   #
-  # @raise [IndexError] if the passed in indices are not a valid for the
-  #   {Layout::Table}
+  # @raise [ArgumentError] if the specified range of cells contains a merged cell
   #
   # @version LayOut 2018
   def merge(start_row, start_column, end_row, end_column)
@@ -256,11 +256,11 @@ class Layout::Table < Layout::Entity
   #
   # @raise [IndexError] if index is not a valid index for the {Layout::Table}
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def remove_column(index)
   end
@@ -278,11 +278,11 @@ class Layout::Table < Layout::Entity
   #
   # @raise [IndexError] if index is not a valid index for the {Layout::Table}
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def remove_row(index)
   end

data/SketchUp/Layout/TableCell.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableCell} is a single cell from a table that contains data.
@@ -65,11 +65,11 @@ class Layout::TableCell
   #
   # @param [Layout::Entity] entity
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def data=(entity)
   end
@@ -118,11 +118,11 @@ class Layout::TableCell
   # @raise [ArgumentError] if the cell is invalid due to residing within a
   #   merged cell
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def rotation=(cell_rotation)
   end

data/SketchUp/Layout/TableColumn.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableColumn} is a single column from a table.
@@ -49,11 +49,11 @@ class Layout::TableColumn
   #
   # @param [Layout::Style] style
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def left_edge_style=(style)
   end
@@ -90,11 +90,11 @@ class Layout::TableColumn
   #
   # @param [Layout::Style] style
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def right_edge_style=(style)
   end
@@ -127,11 +127,11 @@ class Layout::TableColumn
   #
   # @raise [ArgumentError] if width is not a valid width
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Table} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Table} is locked
+  #
   # @version LayOut 2018
   def width=(width)
   end

data/SketchUp/Layout/TableRow.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A {Layout::TableColumn} is a single row from a table.
@@ -47,11 +47,11 @@ class Layout::TableRow
   #
   # @param [Layout::Style] style
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @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
@@ -84,11 +84,11 @@ class Layout::TableRow
   #
   # @raise [ArgumentError] if height is not a valid height
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @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
@@ -123,11 +123,11 @@ class Layout::TableRow
   #
   # @param [Layout::Style] style
   #
-  # @raise [LockedEntityError] if the {Layout::Table} is locked
-  #
   # @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

data/SketchUp/Sketchup/Animation.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::Animation} interface is implemented to create animations

data/SketchUp/Sketchup/AppObserver.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 application events.

data/SketchUp/Sketchup/ArcCurve.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An ArcCurve is a Curve that makes up part of a circle. This is the

data/SketchUp/Sketchup/AttributeDictionaries.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AttributeDictionaries class is a collection of all of the

data/SketchUp/Sketchup/AttributeDictionary.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AttributeDictionary class allows you to attach arbitrary collections of
@@ -126,11 +126,11 @@ class Sketchup::AttributeDictionary < Sketchup::Entity
   #
   # @yield [key, value]
   #
-  # @yieldparam [Object] value
-  #   The value of each attribute as it is found.
-  #
   # @yieldparam [String] key
   #   The key of each attribute as it is found.
+  #
+  # @yieldparam [Object] value
+  #   The value of each attribute as it is found.
   def each
   end
 
@@ -177,11 +177,11 @@ class Sketchup::AttributeDictionary < Sketchup::Entity
   #
   # @yield [key, value]
   #
-  # @yieldparam [Object] value
-  #   The value of each attribute as it is found.
-  #
   # @yieldparam [String] key
   #   The key of each attribute as it is found.
+  #
+  # @yieldparam [Object] value
+  #   The value of each attribute as it is found.
   def each_pair
   end
 

data/SketchUp/Sketchup/Axes.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # SketchUp's drawing axes consist of three colored lines (red, green, blue),
@@ -54,12 +54,12 @@ class Sketchup::Axes < Sketchup::Entity
   # @param xaxis
   #   Vector3d - The x axis to set.
   #
-  # @param zaxis
-  #   Vector3d - The z axis to set.
-  #
   # @param yaxis
   #   Vector3d - The y axis to set.
   #
+  # @param zaxis
+  #   Vector3d - The z axis to set.
+  #
   # @return Axes - the axes object being set.
   #
   # @version SketchUp 2016

data/SketchUp/Sketchup/Behavior.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Behavior class is used to control the "behavior" of components, which

data/SketchUp/Sketchup/Camera.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Camera class contains methods for creating and manipulating a camera.
@@ -353,37 +353,32 @@ class Sketchup::Camera
   end
 
   # Returns a new camera with eye (where the camera is) and targets (where the
-  # camera is looking) of type Point3d, up direction of type Vector3d, optional
-  # perspective flag of value true or false, and optional field-of-view value in
-  # degrees of type Float.
+  # camera is looking).
   #
   # @example
-  #   camera = Sketchup::Camera.new
-  #   if (camera)
-  #     UI.messagebox camera
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   eye = Geom::Point3d.new(20, 5, 30)
+  #   target = Geom::Point3d.new(20, 60, 25)
+  #   up = Z_AXIS
+  #   camera = Sketchup::Camera.new(eye, target, up)
   #
-  # @param target
-  #   See {#target}.
+  # @example Default paramaters
+  #   camera = Sketchup::Camera.new
   #
-  # @param eye
-  #   See {#eye}.
+  # @overload initialize
   #
-  # @param up
-  #   See {#up}.
+  #   @return [Sketchup::Camera]
   #
-  # @param fov
-  #   see {#fov}.
+  # @overload initialize(eye, target, up, perspective = true, fov = 30.0)
   #
-  # @param perspective
-  #   see {#perspective?}.
-  #
-  # @return camera - a new Camera object if successful
+  #   @param [Geom::Point3d] eye  See {#eye}.
+  #   @param [Geom::Point3d] target  See {#target}.
+  #   @param [Geom::Point3d] up  See {#up}.
+  #   @param [Boolean] perspective  see {#perspective?}.
+  #   @param [Float] fov  see {#fov}.
+  #   @return [Sketchup::Camera]
   #
   # @version SketchUp 6.0
-  def initialize(eye, target, up, perspective = true, fov = 30.0)
+  def initialize(*args)
   end
 
   # The is_2d? method indicates if the camera is in 2d mode. 2 point
@@ -456,33 +451,27 @@ class Sketchup::Camera
   def scale_2d
   end
 
-  # The set method sets the camera orientation. You have to set the camera eye,
+  # The {#set} method sets the camera orientation. You have to set the camera eye,
   # target and up parameters at the same time to make sure that you have a valid
   # camera definition.
   #
   # @example
   #   camera = Sketchup::Camera.new
-  #   eye = camera.eye
-  #   target = camera.target
-  #   up = camera.up
-  #   # We just set it to exactly what it was pointing at in the first place
-  #   camera.set eye, target, up
-  #   if (camera)
-  #     UI.messagebox camera.to_s
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   eye = Geom::Point3d.new(20, 5, 30)
+  #   target = Geom::Point3d.new(20, 60, 25)
+  #   up = Z_AXIS
+  #   camera.set(eye, target, up)
   #
-  # @param eye
-  #   See Camera.eye.
+  # @param [Geom::Point3d] eye
+  #   See {#eye}.
   #
-  # @param target
-  #   See Camera.target.
+  # @param [Geom::Point3d] target
+  #   See {#target}.
   #
-  # @param up
-  #   See Camera.up.
+  # @param [Geom::Point3d] up
+  #   See {#up}.
   #
-  # @return camera - the modified camera
+  # @return [Sketchup::Camera]
   #
   # @version SketchUp 6.0
   def set(eye, target, up)