sketchup-api-stubs 0.3.1 → 0.4.0

data/SketchUp/Sketchup/ClassificationSchema.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ClassificationSchema class represent schemas loaded in the model.

data/SketchUp/Sketchup/Classifications.rb

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

data/SketchUp/Sketchup/Color.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Color class is used to create and manipulate colors within SketchUp

data/SketchUp/Sketchup/ComponentDefinition.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ComponentDefinition} class is used to define the contents for
@@ -548,11 +548,11 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   # @raise [NotImplementedError] when trying to set the value of "choice"
   #   attributes.
   #
+  # @raise [RuntimeError] if the attributes being set are corrupt.
+  #
   # @raise [TypeError] when trying to set a value that is not valid for the
   #   attribute.
   #
-  # @raise [RuntimeError] if the attributes being set are corrupt.
-  #
   # @return [Boolean] true if the path was valid, false otherwise.
   #
   # @version SketchUp 2015

data/SketchUp/Sketchup/ComponentInstance.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ComponentInstance} class is used to represent component
@@ -266,24 +266,24 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   def locked?
   end
 
-  # The make_unique method is used to create a component definition for this
+  # The {#make_unique} method is used to create a component definition for this
   # instance that is not used by any other instances.
   #
   # @example
-  #   point = Geom::Point3d.new 10,20,30
-  #   transform = Geom::Transformation.new point
+  #   point = Geom::Point3d.new(10,20,30)
+  #   transform = Geom::Transformation.new(point)
   #   model = Sketchup.active_model
   #   entities = model.active_entities
   #
-  #   path = Sketchup.find_support_file "Bed.skp",
-  #     "Components/Components Sampler/"
+  #   path = Sketchup.find_support_file("Bed.skp",
+  #     "Components/Components Sampler/")
   #   definitions = model.definitions
-  #   componentdefinition = definitions.load path
-  #   instance = entities.add_instance componentdefinition, transform
+  #   componentdefinition = definitions.load(path)
+  #   instance = entities.add_instance(componentdefinition, transform)
   #   # Returns unique component instance
-  #   status = instance.make_unique
+  #   instance.make_unique
   #
-  # @return [Boolean] true if successful, false if unsuccessful
+  # @return [Sketchup::ComponentInstance] returns itself
   #
   # @version SketchUp 6.0
   def make_unique

data/SketchUp/Sketchup/Console.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Console class is used by SketchUp to direct $stdout and $stderr to the
@@ -13,10 +13,6 @@
 # not produce any output.
 #
 # @example
-#   t = Thread.new { puts 'This will not be written to the console.' }
-#   t.join
-#
-# @example
 #   # By default $stdout is directed to SKETCHUP_CONSOLE.
 #   p $stdout
 #
@@ -24,6 +20,10 @@
 #   # SketchUp console is by using the SKETCHUP_CONSOLE constant.
 #   p SKETCHUP_CONSOLE
 #
+# @example
+#   t = Thread.new { puts 'This will not be written to the console.' }
+#   t.join
+#
 # @version SketchUp 2014
 class Sketchup::Console
 

data/SketchUp/Sketchup/ConstructionLine.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ConstructionLine class contains methods for modifying construction
@@ -214,25 +214,26 @@ class Sketchup::ConstructionLine < Sketchup::Drawingelement
   def start=(arg)
   end
 
-  # The stipple method is used to retrieve the stipple pattern used to display
+  # The {#stipple} method is used to retrieve the stipple pattern used to display
   # the construction line.
   #
   # @example
   #   model = Sketchup.active_model
   #   entities = model.active_entities
-  #   point1 = Geom::Point3d.new(0,0,0)
-  #   point2 = Geom::Point3d.new(20,20,20)
+  #   point1 = Geom::Point3d.new(0, 0, 0)
+  #   point2 = Geom::Point3d.new(20, 20, 20)
   #   constline = entities.add_cline(point1, point2)
-  #   UI.messagebox(constline.stipple)
+  #   puts constline.stipple
   #
-  # @return pattern - the stipple pattern being used
+  # @return [String]
   #
   # @version SketchUp 6.0
   def stipple
   end
 
-  # The stipple= method is used to set the stipple pattern used to display
+  # The {#stipple=} method is used to set the stipple pattern used to display
   # the construction line. The stipple pattern is given as a string.
+  #
   # Valid strings are:
   # - <code>"."</code> (Dotted Line),
   # - <code>"-"</code> (Short Dashes Line),
@@ -242,13 +243,12 @@ class Sketchup::ConstructionLine < Sketchup::Drawingelement
   # @example
   #   model = Sketchup.active_model
   #   entities = model.active_entities
-  #   point1 = Geom::Point3d.new(0,0,0)
-  #   point2 = Geom::Point3d.new(20,20,20)
+  #   point1 = Geom::Point3d.new(0, 0, 0)
+  #   point2 = Geom::Point3d.new(20, 20, 20)
   #   constline = entities.add_cline(point1, point2)
   #   constline.stipple = "-.-"
   #
-  # @param pattern
-  #   - the stipple pattern to use
+  # @param [String, Integer] pattern
   #
   # @version SketchUp 6.0
   def stipple=(pattern)

data/SketchUp/Sketchup/ConstructionPoint.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A construction point represents a point in the model that can be used to aid

data/SketchUp/Sketchup/Curve.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Curve class is used by SketchUp to unite a series of Edge objects into

data/SketchUp/Sketchup/DefinitionList.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A DefinitionList object holds a list of all of the ComponentDefinition
@@ -32,14 +32,14 @@ class Sketchup::DefinitionList < Sketchup::Entity
   #   @param [Integer] index The index for a specific component definition.
   #   @return [Sketchup::ComponentDefinition, nil]
   #
-  # @overload [](guid)
+  # @overload [](name)
   #
-  #   @param [String] guid The name of an existing component definition.
+  #   @param [String] name The unique GUID for the component definition.
   #   @return [Sketchup::ComponentDefinition, nil]
   #
-  # @overload [](name)
+  # @overload [](guid)
   #
-  #   @param [String] name The unique GUID for the component definition.
+  #   @param [String] guid The name of an existing component definition.
   #   @return [Sketchup::ComponentDefinition, nil]
   #
   # @version SketchUp 6.0
@@ -99,14 +99,14 @@ class Sketchup::DefinitionList < Sketchup::Entity
   #   @param [Integer] index The index for a specific component definition.
   #   @return [Sketchup::ComponentDefinition, nil]
   #
-  # @overload [](guid)
+  # @overload [](name)
   #
-  #   @param [String] guid The name of an existing component definition.
+  #   @param [String] name The unique GUID for the component definition.
   #   @return [Sketchup::ComponentDefinition, nil]
   #
-  # @overload [](name)
+  # @overload [](guid)
   #
-  #   @param [String] name The unique GUID for the component definition.
+  #   @param [String] guid The name of an existing component definition.
   #   @return [Sketchup::ComponentDefinition, nil]
   #
   # @version SketchUp 6.0
@@ -178,6 +178,9 @@ class Sketchup::DefinitionList < Sketchup::Entity
   # @param [String] path
   #   The path where the component definition file is located.
   #
+  # @raise RuntimeError If filename is an invalid SketchUp model. Added in
+  #   SketchUp 2019. Possible that prior versions of SketchUp will crash.
+  #
   # @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
   #   object if successful
   #

data/SketchUp/Sketchup/DefinitionObserver.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 component definition
@@ -47,23 +47,22 @@ class Sketchup::DefinitionObserver < Sketchup::EntityObserver
   # The {#onComponentInstanceRemoved} method is called when a component
   # instance is removed from a model.
   #
-  # implemented, this method is fired on a Move + Copy operation even
-  # though no {Sketchup::ComponentInstance} is apparently removed.
-  #
   # @example
   #   def onComponentInstanceRemoved(definition, instance)
   #     puts "onComponentInstanceRemoved(#{definition}, #{instance})"
   #   end
   #
   # @note Due to the underlying way that the SketchUp Move Tool is
-  #
-  # @param [Sketchup::ComponentInstance] instance
-  #   The removed instance
+  #   implemented, this method is fired on a Move + Copy operation even
+  #   though no {Sketchup::ComponentInstance} is apparently removed.
   #
   # @param [Sketchup::ComponentDefinition] definition
   #   The definition of the
   #   instance removed
   #
+  # @param [Sketchup::ComponentInstance] instance
+  #   The removed instance
+  #
   # @return [nil]
   #
   # @version SketchUp 6.0

data/SketchUp/Sketchup/DefinitionsObserver.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 events on a definitions
@@ -69,10 +69,10 @@ class Sketchup::DefinitionsObserver
   #
   # @note This methods fires twice for each Component/Group erased.
   #
-  # @param [Sketchup::ComponentDefinition] definition
-  #
   # @param [Sketchup::DefinitionList] definitions
   #
+  # @param [Sketchup::ComponentDefinition] definition
+  #
   # @return [nil]
   #
   # @version SketchUp 6.0

data/SketchUp/Sketchup/Dimension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Dimension class provides base functionality for classes DimensionLinear

data/SketchUp/Sketchup/DimensionLinear.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The DimensionLinear class represents linear dimensions.
@@ -108,6 +108,46 @@ class Sketchup::DimensionLinear < Sketchup::Dimension
   def end=(pt_or_entity)
   end
 
+  # The {#end_attached_to} method will return the attached end point via an array
+  # containing the {Sketchup::InstancePath} and {Geom::Point3d}.
+  #
+  # @example
+  #   # Assuming you have a valid dimension selected that is attached to a
+  #   # component instance
+  #   dim = Sketchup.active_model.selection[0]
+  #   dim.end_attached_to
+  #
+  # @return [Array(Sketchup::InstancePath, Geom::Point3d), nil]
+  #
+  # @version SketchUp 2019
+  def end_attached_to
+  end
+
+  # The {#end_attached_to=} method will attach the ending point to the
+  # {Sketchup::InstancePath} and {Geom::Point3d}.
+  #
+  # @example
+  #   # Assuming you have a valid dimension selected that is attached to a
+  #   # component instance
+  #   dim = Sketchup.active_model.selection[0]
+  #   # get the path (instance_path, point)
+  #   path = dim.end_attached_to
+  #   instance_path = path[0]
+  #   instance = instance_path.to_a[0]
+  #   point1 = Geom::Point3d.new(0, 0, 0)
+  #   point2 = Geom::Point3d.new(20, 20, 20)
+  #   instance.definition.entities.add_edges(point1, point2)
+  #   edge = instance.definition.entities.grep(Sketchup::Edge).first
+  #   new_instance_path = Sketchup::InstancePath.new([instance, edge])
+  #   point2 = point2.transform(new_instance_path.transformation.inverse)
+  #   dim.end_attached_to = [new_instance_path, point2]
+  #
+  # @param [Array(Sketchup::InstancePath, Geom::Point3d)] path
+  #
+  # @version SketchUp 2019
+  def end_attached_to=(path)
+  end
+
   # The offset_vector method returns the parallel offset vector from the
   # reference line to the dimension line measured from the 'start' reference
   # point.
@@ -189,6 +229,46 @@ class Sketchup::DimensionLinear < Sketchup::Dimension
   def start=(pt_or_entity)
   end
 
+  # The {#start_attached_to} method will return the attached start point via an
+  # array containing the {Sketchup::InstancePath} and {Geom::Point3d}.
+  #
+  # @example
+  #   # Assuming you have a valid dimension selected that is attached to a
+  #   # component instance
+  #   dim = Sketchup.active_model.selection[0]
+  #   dim.start_attached_to
+  #
+  # @return [Array(Sketchup::InstancePath, Geom::Point3d), nil]
+  #
+  # @version SketchUp 2019
+  def start_attached_to
+  end
+
+  # The {#start_attached_to=} method will attach the starting point to the
+  # {Sketchup::InstancePath} and {Geom::Point3d}.
+  #
+  # @example
+  #   # Assuming you have a valid dimension selected that is attached to a
+  #   # component instance
+  #   dim = Sketchup.active_model.selection[0]
+  #   # get the path (instance_path, point)
+  #   path = dim.start_attached_to
+  #   instance_path = path[0]
+  #   instance = instance_path.to_a[0]
+  #   point1 = Geom::Point3d.new(0, 0, 0)
+  #   point2 = Geom::Point3d.new(20, 20, 20)
+  #   instance.definition.entities.add_edges(point1, point2)
+  #   edge = instance.definition.entities.grep(Sketchup::Edge).first
+  #   new_instance_path = Sketchup::InstancePath.new([instance, edge])
+  #   point2 = point2.transform(new_instance_path.transformation.inverse)
+  #   dim.start_attached_to = [new_instance_path, point2]
+  #
+  # @param [Array(Sketchup::InstancePath, Geom::Point3d)] path
+  #
+  # @version SketchUp 2019
+  def start_attached_to=(path)
+  end
+
   # The text_position method returns the position of the text along the dimension
   # line. Valid values are class constants:
   # - DimensionLinear::TEXT_OUTSIDE_START

data/SketchUp/Sketchup/DimensionObserver.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 in dimension text.

data/SketchUp/Sketchup/DimensionRadial.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The DimensionRadial class represents radius and diameter dimensions on

data/SketchUp/Sketchup/Drawingelement.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Drawingelement is a base class for an item in the model that can be

data/SketchUp/Sketchup/Edge.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2017 Trimble Inc.
+# Copyright:: Copyright 2019 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Edge class contains methods modifying and extracting information for
@@ -209,32 +209,29 @@ class Sketchup::Edge < Sketchup::Drawingelement
   def find_faces
   end
 
-  # The length method is used to retrieve the length of an edge in current
+  # The {#length} method is used to retrieve the length of an edge in current
   # units.
   #
-  # You can pass in an optional Transformation (or an array that can represent a
-  # transformation), to correct for a parent group's transformation. For example,
-  # if an edge is inside of a group that is scaled to 200%, the length method
-  # will return the unscaled length of the edge. So by passing a 200%
-  # transformation object to this method, you can account for that to get the
-  # "visual" length of the edge.
+  # You can pass in an optional {Geom::Transformation} (or an array that can
+  # represent a transformation), to correct for a parent group's transformation.
+  # For example, if an edge is inside of a group that is scaled to 200%, the
+  # length method will return the unscaled length of the edge. So by passing a
+  # 200% transformation object to this method, you can account for that to get
+  # the "visual" length of the edge.
   #
   # @example
-  #   edge = Sketchup.active_model.entities.add_line([0,0,0],[100,100,0])
-  #   length = edge.length
-  #   if (length)
-  #     UI.messagebox length
-  #   end
+  #   edge = Sketchup.active_model.entities.add_line([0, 0, 0], [100, 100, 0])
+  #   puts "#{edge.length} (#{edge.length.inspect})"
   #
   # @overload length
   #
-  #   @return [Length] the length of the edge in current units
+  #   @return [Length] the length of the edge
   #
   # @overload length(transform)
   #
   #   @param transform [Geom::Transformation] A Transformation object or array
-  #                      that can be interpreted as a Transformation object.
-  #   @return [Length] the length of the edge in current units
+  #                       that can be interpreted as a Transformation object.
+  #   @return [Length] the length of the edge
   #
   # @version SketchUp 6.0
   def length(*args)