sketchup-api-stubs 0.7.0 → 0.7.5

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

@@ -78,10 +78,10 @@ class Sketchup::Color
   #   color = Sketchup::Color.new "AliceBlue"
   #   alpha = color.alpha = 255
   #
-  # @param [Integer] alpha
+  # @param [Integer, Float] alpha
   #   The new opacity value.
   #
-  # @return [Integer]
+  # @return [Integer, Float]
   #
   # @version SketchUp 8.0 M1
   def alpha=(alpha)
@@ -133,10 +133,10 @@ class Sketchup::Color
   #   color = Sketchup::Color.new "AliceBlue"
   #   blue = color.blue = 200
   #
-  # @param [Integer] blue
+  # @param [Integer, Float] blue
   #   The blue value for the color.
   #
-  # @return [Integer]
+  # @return [Integer, Float]
   #
   # @version SketchUp 6.0
   def blue=(blue)
@@ -164,10 +164,10 @@ class Sketchup::Color
   #   color = Sketchup::Color.new "AliceBlue"
   #   green = color.green = 200
   #
-  # @param [Integer] green
+  # @param [Integer, Float] green
   #   The green value for the color.
   #
-  # @return [Integer]
+  # @return [Integer, Float]
   #
   # @version SketchUp 6.0
   def green=(green)
@@ -188,8 +188,6 @@ class Sketchup::Color
   #   face.material = color_from_rgba
   #   face.material.alpha = 0.5
   #
-  # @note When assigning colors via a hexadecimal, R and B will be flipped.
-  #
   # @overload initialize(red, green, blue, alpha = 255)
   #
   #   @param [Integer] red   A red value between 0 and 255.
@@ -198,6 +196,14 @@ class Sketchup::Color
   #   @param [Integer] alpha A alpha value between 0 and 255.
   #   @return [Sketchup::Color]
   #
+  # @overload initialize(red, green, blue, alpha = 1.0)
+  #
+  #   @param [Float] red   A red value between 0.0 and 1.0.
+  #   @param [Float] green A green value between 0.0 and 1.0.
+  #   @param [Float] blue  A blue value between 0.0 and 1.0.
+  #   @param [Float] alpha A alpha value between 0.0 and 1.0.
+  #   @return [Sketchup::Color]
+  #
   # @overload initialize(name)
   #
   #   @param [String] name  A string name of a color that currently exists in
@@ -205,6 +211,13 @@ class Sketchup::Color
   #     info.
   #   @return [Sketchup::Color]
   #
+  # @overload initialize(hex)
+  #
+  #   @param [Integer] hex  A hexadecimal color code.
+  #   @return [Sketchup::Color]
+  #   @note When assigning colors via a hexadecimal, R and B will be flipped.
+  #   @note When assigning colors via a hexadecimal, Alpha is not supported.
+  #
   # @version SketchUp 6.0
   def initialize(*args)
   end
@@ -231,10 +244,10 @@ class Sketchup::Color
   #   color = Sketchup::Color.new "AliceBlue"
   #   red = color.red=200
   #
-  # @param [Integer] red
+  # @param [Integer, Float] red
   #   The red value for the color.
   #
-  # @return [Integer]
+  # @return [Integer, Float]
   #
   # @version SketchUp 6.0
   def red=(red)

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

@@ -389,6 +389,25 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
   def invalidate_bounds
   end
 
+  # The {#live_component?} method is used to identify Live Components and
+  # sub-definitions of Live Components.
+  #
+  # @example Skipping Live Components
+  #   model = Sketchup.active_model
+  #   model.definitions.each { |definition|
+  #     next if definition.live_component?
+  #     puts definition.name
+  #   }
+  #
+  # @note These components are parametrically generated and API users should not
+  #   modify them.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2021.0
+  def live_component?
+  end
+
   # The name method retrieves the name of the component definition.
   #
   # @example
@@ -426,18 +445,14 @@ class Sketchup::ComponentDefinition < Sketchup::Drawingelement
 
   # The path method is used to retrieve the path where the component was loaded.
   #
-  # Returns nil if it is an internal component.
-  #
   # @example
-  #   path = Sketchup.find_support_file "Bed.skp",
-  #     "Components/Components Sampler/"
+  #   path = Sketchup.find_support_file("Bed.skp", "Components/Components Sampler/")
   #   model = Sketchup.active_model
   #   definitions = model.definitions
-  #   componentdefinition = definitions.load path
+  #   componentdefinition = definitions.load(path)
   #   path = componentdefinition.path
   #
-  # @return [String, false] a valid path if successful, false if
-  #   unsuccessful
+  # @return [String] Returns empty string if it is an internal component.
   #
   # @version SketchUp 6.0
   def path

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

@@ -218,6 +218,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.intersect(instance2)
   #
+  # @note This method is not available in SketchUp Make.
+  #
   # @param [Sketchup::ComponentInstance] instance
   #   The instance to intersect this instance with.
   #
@@ -263,7 +265,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   end
 
   # The {#make_unique} method is used to create a component definition for this
-  # instance that is not used by any other instances.
+  # instance that is not used by any other instances. If the component is already
+  # unique in the model, nothing happens.
   #
   # @example
   #   point = Geom::Point3d.new(10,20,30)
@@ -300,8 +303,9 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   def manifold?
   end
 
-  # The move! method is the same as the transform! method, except that it does
-  # not record the move as an undo operation.
+  # The {#move!} method is used to set the transformation of this component
+  # instance, similarly to {#transformation=} but without recording to the undo
+  # stack.
   #
   # This method is useful for moving entities inside of an animation or page
   # transition.
@@ -312,15 +316,17 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   transformation = Geom::Transformation.new([0,0,0])
   #   componentinstance = entities.add_instance(definition, transformation)
   #   new_transformation = Geom::Transformation.new([100,0,0])
-  #   componentinstance.move! new_transformation
+  #   componentinstance.move!(new_transformation)
   #
-  # @param [Geom::Transformation] transform
-  #   The transform object to apply to the component instance.
+  # @note Despite the name being similar to {#transform!}, this method closer
+  #   corresponds to {#transformation=}.
+  #
+  # @param [Geom::Transformation] transformation
   #
   # @return [Boolean] true if successful, false if unsuccessful
   #
   # @version SketchUp 6.0
-  def move!(transform)
+  def move!(transformation)
   end
 
   # The name method is used to get the name of this instance.
@@ -438,6 +444,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.split(instance2)
   #
+  # @note This method is not available in SketchUp Make.
+  #
   # @param [Sketchup::ComponentInstance, nil] instance
   #   The instance to split this instance with.
   #
@@ -463,6 +471,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.subtract(instance2)
   #
+  # @note This method is not available in SketchUp Make.
+  #
   # @param [Sketchup::ComponentInstance] instance
   #   The instance to subtract this instance from.
   #
@@ -509,8 +519,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   def transformation
   end
 
-  # The transformation= method is used to set the transformation on this
-  # instance.
+  # The {#transformation=} method is used to set the transformation of this
+  # component instance.
   #
   # @example
   #   entities = Sketchup.active_model.entities
@@ -521,9 +531,6 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   componentinstance.transformation = new_transformation
   #
   # @param [Geom::Transformation] transformation
-  #   A Transformation object to apply.
-  #
-  # @return [Sketchup::ComponentInstance] the transformed ComponentInstance
   #
   # @version SketchUp 6.0
   def transformation=(transformation)
@@ -540,6 +547,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.trim(instance2)
   #
+  # @note This method is not available in SketchUp Make.
+  #
   # @param [Sketchup::ComponentInstance] instance
   #   The instance to trim this instance against.
   #
@@ -561,6 +570,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   #   instance2 = entities[1]
   #   result = instance1.union(instance2)
   #
+  # @note This method is not available in SketchUp Make.
+  #
   # @param [Sketchup::ComponentInstance] instance
   #   The instance to union this instance with.
   #

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

@@ -50,7 +50,7 @@ class Sketchup::Curve < Sketchup::Entity
   #   edgearray = entities.add_circle centerpoint, vector2, 10
   #   edge = edgearray[0]
   #   curve = edge.curve
-  #   curve.each_edge {|e| UI.messagebox e}
+  #   curve.each_edge {|edge| puts "Edge {edge.entityID}: {edge.length}" }
   #
   # @return edge - a variable that will hold each Edge object as
   #   they are found.
@@ -150,22 +150,29 @@ class Sketchup::Curve < Sketchup::Entity
   #   curve = edge.curve
   #   length = curve.length
   #
-  # @return length - the length of the curve in current units if
-  #   successful
+  # @return [Length]
   #
   # @version SketchUp 6.0
   def length
   end
 
-  # The vertices method retrieves a collection of all vertices in a curve.
+  # The {#move_vertices} method moves the vertices in the curve to points.
   #
   # @example
-  #   # Need example ruby code here.
+  #   model = Sketchup.active_model
+  #   entities = model.entities
+  #   new_edges = entities.add_arc(ORIGIN, X_AXIS, Z_AXIS, 20.cm, 0, 270.degrees, 32)
+  #   curve = new_edges.first.curve
+  #   points = curve.vertices.map(&:position)
+  #   points.each_with_index { |pt, i| pt.z = i * 1.cm }
+  #   curve.move_vertices(points)
+  #
+  # @param [Array<Geom::Point3d>] point_array
   #
-  # @param point_array
-  #   Array of Point3d objects to move each vertex to match.
+  # @raise ArgumentError if the number of points doesn't match number of vertices
+  #   in curve
   #
-  # @return success - true or false
+  # @return [Boolean]
   #
   # @version SketchUp 6.0
   def move_vertices(point_array)

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

@@ -131,10 +131,8 @@ class Sketchup::DefinitionList < Sketchup::Entity
   def count
   end
 
-  # The each method is used to iterate through all of the component definitions
-  # in the definition list.
-  #
-  # Throws an exception if there are no component definitions.
+  # The {#each} method is used to iterate through all of the component
+  # definitions in the definition list.
   #
   # @example
   #   model = Sketchup.active_model
@@ -142,6 +140,11 @@ class Sketchup::DefinitionList < Sketchup::Entity
   #   definitions.add("BedTraditional")
   #   number = definitions.each { |definition| puts definition.name }
   #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
   # @return [nil]
   #
   # @version SketchUp 6.0
@@ -166,29 +169,55 @@ class Sketchup::DefinitionList < Sketchup::Entity
   def length
   end
 
-  # The load method is used to load a component from a file.
+  # The {#load} method is used to load a component from a file.
+  #
+  # @bug In SketchUp versions prior to SketchUp 2019 the application would crash
+  #   if you tried to open a newer model instead of raising the expected
+  #   +RuntimeError+.
   #
   # @example
-  #   path=Sketchup.find_support_file "Bed.skp",
-  #     "Components/Components Sampler/"
+  #   path = Sketchup.find_support_file("Bed.skp",
+  #     "Components/Components Sampler/")
   #   model = Sketchup.active_model
   #   definitions = model.definitions
-  #   componentdefinition = definitions.load path
+  #   definition = definitions.load(path)
+  #
+  # @overload load(path)
+  #
+  #   @param [String] path
+  #     The path where the component definition file is located.
+  #
+  # @overload load(path, allow_newer: true)
+  #
+  #   Starting with SketchUp 2021.0 SketchUp attempts to load newer SketchUp
+  #   models. If a newer model is loaded some information might have been skipped
+  #   and extensions should be careful to not save over the file they loaded from
+  #   as information might be lost.
   #
-  # @param [String] path
-  #   The path where the component definition file is located.
+  #   @version SketchUp 2021.0
+  #   @param [String] path
+  #     The path where the component definition file is located.
+  #   @param [Boolean] allow_newer
+  #     Indicate that it is ok to load a model with of a newer version.
   #
-  # @raise RuntimeError If filename is an invalid SketchUp model. Added in
-  #   SketchUp 2019. Possible that prior versions of SketchUp will crash.
+  # @raise IOError If the file is not a valid SketchUp model.
+  #
+  # @raise RuntimeError If the file is the same as the model being loaded into.
+  #
+  # @raise IOError If the file is an empty component.
+  #
+  # @raise RuntimeError If the file contains only screen text.
+  #
+  # @raise RuntimeError If the file is of a newer file version that the executing
+  #   SketchUp version cannot open.
   #
   # @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
-  #   object if successful
   #
   # @version SketchUp 6.0
-  def load(path)
+  def load(*args)
   end
 
-  # The load_from_url method loads a component from a location specified by
+  # The {#load_from_url} method loads a component from a location specified by
   # string url. This method throws an exception if an url string is not
   # given, or an error occurs during retrieval from url and a
   # load_handler was not given. Optional second parameter load_handler can be
@@ -201,11 +230,10 @@ class Sketchup::DefinitionList < Sketchup::Entity
   #
   # @example
   #   class LoadHandler
-  #
-  #     attr :error
+  #     attr_accessor :error
   #
   #     def onPercentChange(percent)
-  #       Sketchup::set_status_text("LOADING: #{percent}%")
+  #       Sketchup::set_status_text("loading: #{percent.round}%")
   #     end
   #
   #     def cancelled?
@@ -223,30 +251,35 @@ class Sketchup::DefinitionList < Sketchup::Entity
   #       self.error = error_message
   #       Sketchup::set_status_text('')
   #     end
-  #
   #   end
   #
   #   # Replace this with a real URL...
   #   url = 'http://www.sketchup.com/model.skp'
   #   model = Sketchup.active_model
+  #   load_handler = LoadHandler.new
   #   definition = model.definitions.load_from_url(url, load_handler)
   #
   #   if definition.nil?
   #     puts "Error: #{load_handler.error}"
   #   end
   #
-  # @param [String] url
-  #   URL to load a .skp file from.
+  # @overload load_from_url(url)
   #
-  # @param [Object] load_handler
-  #   Ruby object that has methods defined
-  #   as described in the load_from_url details.
+  #   @param [String] url
+  #     URL to load a .skp file from.
   #
-  # @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
-  #   object if successful
+  # @overload load_from_url(url, load_handler)
+  #
+  #   @param [String] url
+  #     URL to load a .skp file from.
+  #   @param [Object] load_handler
+  #     Ruby object that has methods defined
+  #     as described in the load_from_url details.
+  #
+  # @return [Sketchup::ComponentDefinition]
   #
   # @version SketchUp 7.0
-  def load_from_url(url, load_handler = nil)
+  def load_from_url(*args)
   end
 
   # The purge_unused method is used to remove the unused component definitions.

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

@@ -2,9 +2,11 @@
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to component definition
-# events. To implement this observer, create a Ruby class of this type,
-# override the desired methods, and add an instance of the observer to the
-# definitions of interests.
+# events.
+#
+# @abstract To implement this observer, create a Ruby class of this type,
+#   override the desired methods, and add an instance of the observer to the
+#   definitions of interests.
 #
 # @example
 #   # This is an example of an observer that watches a specific definition