sketchup-api-stubs 0.4.0 → 0.5.0

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/Layer.rb

@@ -112,8 +112,6 @@ class Layout::Layer
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def locked?
   end
@@ -213,8 +211,6 @@ class Layout::Layer
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def shared?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/LockedEntityError.rb

@@ -5,6 +5,6 @@
 # that is individually locked.
 #
 # @version LayOut 2018
-class Layout::LockedEntityError < ArgError
+class Layout::LockedEntityError < ArgumentError
 
 end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/LockedLayerError.rb

@@ -6,6 +6,6 @@
 # shared attribute of a locked {Layout::Layer}.
 #
 # @version LayOut 2018
-class Layout::LockedLayerError < ArgError
+class Layout::LockedLayerError < ArgumentError
 
 end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/Page.rb

@@ -79,8 +79,6 @@ class Layout::Page
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def in_presentation?
   end
@@ -112,8 +110,6 @@ class Layout::Page
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def layer_visible?(layer)
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/PageInfo.rb

@@ -250,8 +250,6 @@ class Layout::PageInfo
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def print_margins?
   end
@@ -278,8 +276,6 @@ class Layout::PageInfo
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def print_paper_color?
   end
@@ -331,8 +327,6 @@ class Layout::PageInfo
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def show_margins?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/Path.rb

@@ -127,8 +127,6 @@ class Layout::Path < Layout::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def closed?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/SketchUpModel.rb

@@ -134,8 +134,6 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def current_scene_modified?
   end
@@ -204,8 +202,6 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def display_background?
   end
@@ -329,8 +325,6 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def perspective?
   end
@@ -364,8 +358,6 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def preserve_scale_on_resize?
   end
@@ -441,8 +433,6 @@ class Layout::SketchUpModel < Layout::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def render_needed?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Layout/Style.rb

@@ -144,8 +144,6 @@ class Layout::Style
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version LayOut 2018
   def self.arrow_type_filled?(arrow_type)
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Behavior.rb

@@ -78,8 +78,6 @@ class Sketchup::Behavior < Sketchup::Entity
   #   the camera, false if the component is not set to always
   #   face camera.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def always_face_camera?
   end
@@ -124,8 +122,6 @@ class Sketchup::Behavior < Sketchup::Entity
   # @return status - the status of the cuts_opening behavior
   #   (either true or false)
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def cuts_opening?
   end
@@ -169,8 +165,6 @@ class Sketchup::Behavior < Sketchup::Entity
   # @return status - the status of the 2D behavior (either true or
   #   false)
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def is2d?
   end
@@ -225,8 +219,6 @@ class Sketchup::Behavior < Sketchup::Entity
   # @return scale_mask - an integer describing which scale tool
   #   handles are hidden.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 7.0
   def no_scale_mask?
   end
@@ -275,8 +267,6 @@ class Sketchup::Behavior < Sketchup::Entity
   #   were facing the sun. False to cause the shadow to be
   #   cast from the component's current position.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def shadows_face_sun?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Camera.rb

@@ -258,8 +258,6 @@ class Sketchup::Camera
   #
   # @return bool - true if vertical, false otherwise
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2015
   def fov_is_height?
   end
@@ -389,8 +387,6 @@ class Sketchup::Camera
   #
   # @return Boolean - true if camera is in 2d mode, false otherwise
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2015
   def is_2d?
   end
@@ -430,8 +426,6 @@ class Sketchup::Camera
   #
   # @return status - true if perspective, false if orthographic
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def perspective?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/ComponentDefinition.rb

@@ -240,8 +240,6 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def group?
   end
@@ -269,8 +267,6 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def hidden?
   end
@@ -290,8 +286,6 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def image?
   end
@@ -365,8 +359,6 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def internal?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/ComponentInstance.rb

@@ -100,8 +100,6 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 8.0
   def equals?(instance)
   end
@@ -260,8 +258,6 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def locked?
   end
@@ -300,8 +296,6 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 8.0
   def manifold?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Console.rb

@@ -69,8 +69,6 @@ class Sketchup::Console
   #
   # @return true if visible, false if not.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2014
   def visible?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Curve.rb

@@ -112,8 +112,6 @@ class Sketchup::Curve < Sketchup::Entity
   # @return True if this edge was originally created by the polygon
   #   tool, otherwise false.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 7.1 M1
   def is_polygon?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/DefinitionList.rb

@@ -246,7 +246,7 @@ class Sketchup::DefinitionList < Sketchup::Entity
   #   object if successful
   #
   # @version SketchUp 7.0
-  def load_from_url(url, load_handler)
+  def load_from_url(url, load_handler = nil)
   end
 
   # The purge_unused method is used to remove the unused component definitions.

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Dimension.rb

@@ -101,8 +101,6 @@ class Sketchup::Dimension < Sketchup::Drawingelement
   # @return status - true if text is aligned to the dimension.
   #   False if dimension text is aligned to the screen.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 2014
   def has_aligned_text?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Drawingelement.rb

@@ -87,8 +87,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def casts_shadows?
   end
@@ -166,8 +164,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def hidden?
   end
@@ -335,8 +331,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def receives_shadows?
   end
@@ -389,8 +383,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def visible?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Edge.rb

@@ -491,8 +491,6 @@ class Sketchup::Edge < Sketchup::Drawingelement
   #
   # @return [Boolean]
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def used_by?(element)
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/EdgeUse.rb

@@ -182,8 +182,6 @@ class Sketchup::EdgeUse < Sketchup::Entity
   #
   # @return boolean - true if reversed, false if not reversed.
   #
-  # @return [Boolean]
-  #
   # @version SketchUp 6.0
   def reversed?
   end

data/{SketchUp → lib/sketchup-api-stubs/stubs}/Sketchup/Entities.rb

@@ -246,15 +246,18 @@ class Sketchup::Entities
   #   entities = Sketchup.active_model.entities
   #   curve = entities.add_curve [0,0,0], [0,10,0], [1,20,0]
   #
-  # @param [Array<Geom::Point3d>] pts_or_array
-  #   You can pass either a series of Point3d objects or a
-  #   single array containing Point3d objects.
+  # @overload add_curve(points)
   #
-  # @return [Array<Sketchup::Edge>] an array of Edges that make up the curve if
-  #   successful
+  #   @param [Array<Geom::Point3d>] points
+  #
+  # @overload add_curve(*points)
+  #
+  #   @param [Array<Geom::Point3d>] points
+  #
+  # @return [Array<Sketchup::Edge>]
   #
   # @version SketchUp 6.0
-  def add_curve(pts_or_array)
+  def add_curve(*args)
   end
 
   # The {#add_dimension_linear} method adds a linear dimension to the entities.
@@ -428,12 +431,18 @@ class Sketchup::Entities
   #   # Add the face to the entities in the model
   #   face = entities.add_face(pts)
   #
-  # @param [Array<Sketchup::Edge>, Array<Geom::Point3d>, Sketchup::Curve] some_entities
+  # @overload add_face(entities)
+  #
+  #   @param [Array<Sketchup::Edge>, Array<Geom::Point3d>, Sketchup::Curve] entities
   #
-  # @return [Sketchup::Face] a Face object if successful
+  # @overload add_face(*entities)
+  #
+  #   @param [Array<Sketchup::Edge>, Array<Geom::Point3d>] entities
+  #
+  # @return [Sketchup::Face, nil]
   #
   # @version SketchUp 6.0
-  def add_face(some_entities)
+  def add_face(*args)
   end
 
   # The {#add_faces_from_mesh} method is used to add Face objects to the
@@ -489,27 +498,29 @@ class Sketchup::Entities
   # The add_group method is used to create an empty group or a group with
   # entities.
   #
-  # NOTE: calling add_group with entities in its parameters has been known to
-  # crash SketchUp before version 8.0. It is preferable to create an empty
-  # group and then add things to its Entities collection.
-  #
   # @example
   #   model = Sketchup.active_model
   #   entities = model.active_entities
   #   group = entities.add_group
-  #   if (group)
-  #     UI.messagebox group
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
-  # @param [Array<Sketchup::Entity>] entities
-  #   an entities collection to add to the group.
+  # @note Calling add_group with entities in its parameters has been known to
+  #   crash SketchUp before version 8.0. It is preferable to create an empty
+  #   group and then add things to its Entities collection.
+  #
+  # @overload add_group(entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
+  #     an entities collection to add to the group.
+  #
+  # @overload add_group(*entities)
   #
-  # @return [Sketchup::Group] the new group
+  #   @param [Array<Sketchup::Entity>] entities
+  #     an entities collection to add to the group.
+  #
+  # @return [Sketchup::Group]
   #
   # @version SketchUp 6.0
-  def add_group(entities)
+  def add_group(*args)
   end
 
   # The add_image method is used to add an image to the collection of entities.
@@ -541,12 +552,13 @@ class Sketchup::Entities
   #
   # @param [Numeric] height
   #   height for the image if you want to control
-  #   width and height independently.
+  #   width and height independently. Leave as default +0.0+ when you want it
+  #   to be relative to the aspect ratio.
   #
-  # @return [Sketchup::Image] an Image object if successful.
+  # @return [Sketchup::Image, nil] an Image object if successful.
   #
   # @version SketchUp 6.0
-  def add_image(filename, point, width, height)
+  def add_image(filename, point, width, height = 0.0)
   end
 
   # The add_instance method adds a component instance to the collection of
@@ -833,13 +845,18 @@ class Sketchup::Entities
   #   entities.erase_entities entities[1]
   #   UI.messagebox entities
   #
-  # @param [Array<Sketchup::Entity>] entities
-  #   An entity or array of entities.
+  # @overload erase_entities(entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
+  #
+  # @overload erase_entities(*entities)
+  #
+  #   @param [Array<Sketchup::Entity>] entities
   #
   # @return [nil]
   #
   # @version SketchUp 6.0
-  def erase_entities(entities)
+  def erase_entities(*args)
   end
 
   # The {#fill_from_mesh} method is used to add faces and edges to the collection