sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Geom/Vector3d.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Vector3d class is used to represent vectors in a 3 dimensional space.
@@ -321,9 +321,9 @@ class Geom::Vector3d
   #   @param [Numeric] z
   #   @return [Geom::Vector3d]
   #
-  # @overload initialize(vector)
+  # @overload initialize(array3d)
   #
-  #   @param vector [Geom::Vector3d] A Vector3d object.
+  #   @param [Array(Numeric, Numeric, Numeric)] array3d
   #   @return [Geom::Vector3d]
   #
   # @overload initialize(array2d)
@@ -331,9 +331,9 @@ class Geom::Vector3d
   #   @param [Array(Numeric, Numeric)] array2d
   #   @return [Geom::Vector3d]
   #
-  # @overload initialize(array3d)
+  # @overload initialize(vector)
   #
-  #   @param [Array(Numeric, Numeric, Numeric)] array3d
+  #   @param vector [Geom::Vector3d] A Vector3d object.
   #   @return [Geom::Vector3d]
   #
   # @version SketchUp 6.0
@@ -508,11 +508,9 @@ class Geom::Vector3d
   #   vector = Geom::Vector3d.new(0,0,1)
   #   vector.set! 1,0,0
   #
-  # @overload set!(x, y, z)
+  # @overload set!(array3d)
   #
-  #   @param [Numeric] x
-  #   @param [Numeric] y
-  #   @param [Numeric] z
+  #   @param array3d [Array(Numeric, Numeric, Numeric)]
   #   @return [Geom::Vector3d]
   #
   # @overload set!(vector)
@@ -520,9 +518,11 @@ class Geom::Vector3d
   #   @param vector [Geom::Vector3d]
   #   @return [Geom::Vector3d]
   #
-  # @overload set!(array3d)
+  # @overload set!(x, y, z)
   #
-  #   @param array3d [Array(Numeric, Numeric, Numeric)]
+  #   @param [Numeric] x
+  #   @param [Numeric] y
+  #   @param [Numeric] z
   #   @return [Geom::Vector3d]
   #
   # @version SketchUp 6.0

data/SketchUp/Layout.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LayOut module is the root of the LayOut Ruby API. Many of the classes in

data/SketchUp/Layout/AngularDimension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an angular dimension entity. An {Layout::AngularDimension} is
@@ -83,11 +83,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Boolean] uses_custom_text
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def custom_text=(uses_custom_text)
   end
@@ -145,11 +145,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Geom::Point2d] end_point
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def end_connection_point=(end_point)
   end
@@ -187,11 +187,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Geom::Point2d] end_extent
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def end_extent_point=(end_extent)
   end
@@ -212,11 +212,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Numeric] offset_length
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def end_offset_length=(offset_length)
   end
@@ -284,14 +284,14 @@ class Layout::AngularDimension < Layout::Entity
   #   The extent point where the
   #   dimension line should start
   #
-  # @param [Boolean] inner_angle
-  #   Whether or not the {Layout::AngularDimension}
-  #   should measure the inner angle. If +false+, it will measure the outer angle.
-  #
   # @param [Geom::Point2d] end_extent_point
   #   The extent point where the dimension
   #   line should end
   #
+  # @param [Boolean] inner_angle
+  #   Whether or not the {Layout::AngularDimension}
+  #   should measure the inner angle. If +false+, it will measure the outer angle.
+  #
   # @return [Layout::AngularDimension]
   #
   # @version LayOut 2018
@@ -345,11 +345,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @raise [ArgumentError] if type is not a valid leader line type
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def leader_line_type=(type)
   end
@@ -388,11 +388,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @raise [ArgumentError] is radius is negative
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def radius=(radius)
   end
@@ -429,11 +429,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Geom::Point2d] start_point
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def start_connection_point=(start_point)
   end
@@ -471,11 +471,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Geom::Point2d] start_extent
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def start_extent_point=(start_extent)
   end
@@ -496,11 +496,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Numeric] offset_length
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def start_offset_length=(offset_length)
   end
@@ -557,11 +557,11 @@ class Layout::AngularDimension < Layout::Entity
   #
   # @param [Layout::FormattedText] formatted_text
   #
-  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
+  #
   # @version LayOut 2018
   def text=(formatted_text)
   end

data/SketchUp/Layout/AutoTextDefinition.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an auto text definition. Some auto text definitions are mandatory.
@@ -273,11 +273,11 @@ class Layout::AutoTextDefinition
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition} is a mandatory type
   #
-  # @raise [ArgumentError] if name is an empty string
-  #
   # @raise [ArgumentError] if name matches an existing
   #   {Layout::AutoTextDefinition}
   #
+  # @raise [ArgumentError] if name is an empty string
+  #
   # @version LayOut 2018
   def name=(name)
   end
@@ -325,11 +325,11 @@ class Layout::AutoTextDefinition
   #
   # @param [Integer] number_style
   #
-  # @raise [ArgumentError] if number_style is not a valid page numbering style
-  #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
   #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
   #
+  # @raise [ArgumentError] if number_style is not a valid page numbering style
+  #
   # @version LayOut 2018
   def page_number_style=(number_style)
   end

data/SketchUp/Layout/AutoTextDefinitions.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AutoTextDefinitions class is a container class for all

data/SketchUp/Layout/ConnectionPoint.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Connection Point. A

data/SketchUp/Layout/Document.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut document. A {Layout::Document} is the 2D
@@ -44,6 +44,7 @@ class Layout::Document
   VERSION_2016 = nil # Stub value.
   VERSION_2017 = nil # Stub value.
   VERSION_2018 = nil # Stub value.
+  VERSION_2019 = nil # Stub value.
   VERSION_3 = nil # Stub value.
   VERSION_CURRENT = nil # Stub value.
 
@@ -118,11 +119,11 @@ class Layout::Document
   # @raise [ArgumentError] if no {Layout::Page} is passed in and layer is
   #   non-shared
   #
-  # @raise [ArgumentError] if entity already belongs to a {Layout::Document}
+  # @raise [ArgumentError] if page does not belong to the {Layout::Document}
   #
   # @raise [ArgumentError] if layer does not belong to the {Layout::Document}
   #
-  # @raise [ArgumentError] if page does not belong to the {Layout::Document}
+  # @raise [ArgumentError] if entity already belongs to a {Layout::Document}
   #
   # @version LayOut 2018
   def add_entity(*args)
@@ -202,10 +203,10 @@ class Layout::Document
   #   @return [Layout::Document] an unsaved {Layout::Document} based on the
   #     template
   #
-  # @raise [ArgumentError] if the template file could not be found
-  #
   # @raise [RuntimeError] if there was an error reading the template file
   #
+  # @raise [ArgumentError] if the template file could not be found
+  #
   # @version LayOut 2018
   def initialize(*args)
   end

data/SketchUp/Layout/Ellipse.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A simple elliptical shape entity.

data/SketchUp/Layout/Entities.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Entities class is a container class for {Layout::Entity}s. A

data/SketchUp/Layout/Entity.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An entity is an object shown on a page of a LayOut document.
@@ -159,17 +159,17 @@ class Layout::Entity
   #
   # @param [Layout::Group] group
   #
-  # @raise [ArgumentError] if entity and group are not in the same
-  #   {Layout::Document}
-  #
   # @raise [LockedLayerError] if the {Layout::Entity} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [LockedEntityError] if the {Layout::Entity} is locked
+  # @raise [ArgumentError] if entity and group are not in the same
+  #   {Layout::Document}
+  #
+  # @raise [ArgumentError] if entity and group are not on the same {Layout::Page}
   #
   # @raise [ArgumentError] if of entity and group one is shared and one is not
   #
-  # @raise [ArgumentError] if entity and group are not on the same {Layout::Page}
+  # @raise [LockedEntityError] if the {Layout::Entity} is locked
   #
   # @version LayOut 2018
   def move_to_group(group)
@@ -201,15 +201,15 @@ class Layout::Entity
   # @raise [ArgumentError] if layer is shared and a valid array of non-duplicate
   #   {Layout::Page}s is not passed in
   #
-  # @raise [LockedEntityError] if the {Layout::Entity} is locked
+  # @raise [ArgumentError] if entity, layer, and pages are not all in the same
+  #   {Layout::Document}
   #
   # @raise [LockedLayerError] if the {Layout::Entity} is on a locked
   #   {Layout::Layer}
   #
   # @raise [LockedLayerError] if layer is locked
   #
-  # @raise [ArgumentError] if entity, layer, and pages are not all in the same
-  #   {Layout::Document}
+  # @raise [LockedEntityError] if the {Layout::Entity} is locked
   #
   # @version LayOut 2018
   def move_to_layer(*args)
@@ -272,11 +272,11 @@ class Layout::Entity
   #
   # @param [Layout::Style] style
   #
-  # @raise [LockedEntityError] if the {Layout::Entity} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Entity} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Entity} is locked
+  #
   # @version LayOut 2018
   def style=(style)
   end
@@ -292,11 +292,11 @@ class Layout::Entity
   #
   # @param [Geom::Transformation2d] transformation
   #
-  # @raise [LockedEntityError] if the {Layout::Entity} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::Entity} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::Entity} is locked
+  #
   # @version LayOut 2018
   def transform!(transformation)
   end
@@ -349,12 +349,12 @@ class Layout::Entity
   # @raise [ArgumentError] if the {Layout::Entity} does not have an explicit
   #   {Geom::Transformation2d}
   #
-  # @raise [ArgumentError] if the bounds are of zero size
+  # @raise [LockedLayerError] if the {Layout::Entity} is on a locked
+  #   {Layout::Layer}
   #
   # @raise [LockedEntityError] if the {Layout::Entity} is locked
   #
-  # @raise [LockedLayerError] if the {Layout::Entity} is on a locked
-  #   {Layout::Layer}
+  # @raise [ArgumentError] if the bounds are of zero size
   #
   # @version LayOut 2018
   def untransformed_bounds=(bounds)

data/SketchUp/Layout/FormattedText.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A formatted text entity.
@@ -56,11 +56,11 @@ class Layout::FormattedText < Entity
   #     {Layout::FormattedText} is set by anchor_point.
   #   @return [Layout::FormattedText]
   #
-  # @raise [ArgumentError] if path does not refer to a valid file
+  # @raise [ArgumentError] if the passed in string is empty
   #
   # @raise [ArgumentError] if bounds is zero size
   #
-  # @raise [ArgumentError] if the passed in string is empty
+  # @raise [ArgumentError] if path does not refer to a valid file
   #
   # @version LayOut 2018
   def self.new_from_file(*args)
@@ -84,11 +84,11 @@ class Layout::FormattedText < Entity
   #
   # @param [Layout::Style] style
   #
+  # @raise [ArgumentError] if plain_text is empty
+  #
   # @raise [LockedLayerError] if the {Layout::FormattedText} is on a locked
   #   {Layout::Layer}
   #
-  # @raise [ArgumentError] if plain_text is empty
-  #
   # @raise [LockedEntityError] if the {Layout::FormattedText} is locked
   #
   # @version LayOut 2018
@@ -105,18 +105,18 @@ class Layout::FormattedText < Entity
   #   style.text_bold = true
   #   text.apply_style(style, 2, 4)
   #
-  # @param [Integer] length
+  # @param [Layout::Style] style
   #
   # @param [Integer] index
   #
-  # @param [Layout::Style] style
+  # @param [Integer] length
   #
-  # @raise [RangeError] if the range specified by index and length is not
-  #   valid for this {Layout::FormattedText}
+  # @raise [IndexError] if index is out of range
   #
   # @raise [ArgumentError] if length is not greater than zero
   #
-  # @raise [IndexError] if index is out of range
+  # @raise [RangeError] if the range specified by index and length is not
+  #   valid for this {Layout::FormattedText}
   #
   # @raise [LockedLayerError] if the {Layout::FormattedText} is on a locked
   #   {Layout::Layer}
@@ -182,13 +182,13 @@ class Layout::FormattedText < Entity
   #   text = Layout::FormattedText.new("Test", anchor, Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
   #   text.grow_mode = GROW_MODE_UNBOUNDED
   #
-  # @raise [ArgumentError] if grow_mode is not a valid grow mode
-  #
   # @raise [LockedLayerError] if the {Layout::FormattedText} is on a locked
   #   {Layout::Layer}
   #
   # @raise [LockedEntityError] if the {Layout::FormattedText} is locked
   #
+  # @raise [ArgumentError] if grow_mode is not a valid grow mode
+  #
   # @return [Integer] grow_mode
   #
   # @version LayOut 2018
@@ -227,10 +227,10 @@ class Layout::FormattedText < Entity
   #     {Layout::FormattedText} is set by anchor_point.
   #   @return [Layout::FormattedText]
   #
-  # @raise [ArgumentError] if bounds is zero size
-  #
   # @raise [ArgumentError] if the passed in string is empty
   #
+  # @raise [ArgumentError] if bounds is zero size
+  #
   # @version LayOut 2018
   def initialize(*args)
   end
@@ -261,11 +261,11 @@ class Layout::FormattedText < Entity
   #
   # @raise [ArgumentError] if plain_text is empty
   #
-  # @raise [LockedEntityError] if the {Layout::FormattedText} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::FormattedText} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::FormattedText} is locked
+  #
   # @version LayOut 2018
   def plain_text=(plain_text)
   end
@@ -312,11 +312,11 @@ class Layout::FormattedText < Entity
   #
   # @raise [ArgumentError] if rtf_text is an empty string
   #
-  # @raise [LockedEntityError] if the {Layout::FormattedText} is locked
-  #
   # @raise [LockedLayerError] if the {Layout::FormattedText} is on a locked
   #   {Layout::Layer}
   #
+  # @raise [LockedEntityError] if the {Layout::FormattedText} is locked
+  #
   # @version LayOut 2018
   def rtf=(rtf_text)
   end
@@ -329,14 +329,14 @@ class Layout::FormattedText < Entity
   #   text = Layout::FormattedText.new("Test", anchor, Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT)
   #   style = text.style(0)
   #
-  # @param [Integer] length
-  #
   # @param [Integer] index
   #
-  # @raise [ArgumentError] if length is not greater than zero
+  # @param [Integer] length
   #
   # @raise [IndexError] if index is out of range
   #
+  # @raise [ArgumentError] if length is not greater than zero
+  #
   # @raise [RangeError] if the range specified by index and length is not
   #   valid for this {Layout::FormattedText}
   #