sketchup-api-stubs 0.7.2 → 0.7.7

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

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

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Color class is used to create and manipulate colors within SketchUp
@@ -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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ComponentDefinition} class is used to define the contents for
@@ -20,7 +20,7 @@
 # will be raised. The key/value pairs in the dictionary can be deleted safely.
 #
 # @version SketchUp 6.0
-class Sketchup::ComponentDefinition < Sketchup::Drawingelement
+class Sketchup::ComponentDefinition < DrawingElement
 
   # Includes
 
@@ -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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ComponentInstance} class is used to represent component
@@ -123,73 +123,63 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
   def explode
   end
 
-  # The glued_to method is used to retrieve the entity that this instance is
+  # The {#glued_to} method is used to retrieve the entity that this instance is
   # glued to.
   #
-  # Returns nil if it is not glued to anything.
-  #
   # @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)
   #   status = instance.glued_to
   #
-  # @return [Sketchup::Face, nil] the Entity object that the instance is glued
-  #   to (if successful)
+  # @return [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil]
   #
   # @version SketchUp 6.0
   def glued_to
   end
 
-  # The glued_to= method glues this instance to a face.
+  # The {glued_to=} method glues this instance to a drawing element.
+  # When moving this other drawing elment with the Move tool, the glued instance moves with it.
   #
-  # This method will raise an exception if the instance cannot be glued to the
-  # given face. Instances cannot be glued if the definition of the instance
-  # doesn't support gluing or if the alignment is wrong.
+  # In SketchUp 2021.1 support for passing {Sketchup::Group}, {Sketchup::ComponentInstance} and
+  # {Sketchup::Image} was added.
   #
   # @example
-  #   depth = 100
-  #   width = 100
-  #   path=Sketchup.find_support_file "Bed.skp",
-  #     "Components/Components Sampler/"
   #   model = Sketchup.active_model
   #   entities = model.active_entities
-  #   pts = []
-  #   pts[0] = [0, 0, 0]
-  #   pts[1] = [width, 0, 0]
-  #   pts[2] = [width, depth, 0]
-  #   pts[3] = [0, depth, 0]
-  #   # Add the face to the entities in the model
-  #   face = entities.add_face pts
-  #   point = Geom::Point3d.new 10,10,0
-  #   transform = Geom::Transformation.new point
+  #
+  #   # Create a face
+  #   face = entities.add_face([[0, 0, 0], [100, 0, 0], [100, 100, 0], [0, 100, 0]])
+  #
+  #   # Add component
+  #   path = Sketchup.find_support_file("Bed.skp", "Components/Components Sampler/")
+  #   point = Geom::Point3d.new(10, 10, 0)
+  #   transformation = Geom::Transformation.new(point)
   #   definitions = model.definitions
-  #   componentdefinition = definitions.load path
-  #   instance = entities.add_instance componentdefinition, transform
-  #   begin
-  #     status = instance.glued_to = face
-  #   rescue
-  #     UI.messagebox $!.message
-  #   end
-  #   if (status)
-  #     UI.messagebox status.to_s
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   definition = definitions.load(path)
+  #   instance = entities.add_instance(definition, transformation)
   #
-  # @param [Sketchup::Face, nil] face
+  #   # Make component "gluable"
+  #   definition.behavior.is2d = true
   #
-  # @return [Sketchup::Face, nil] - the Face object where the component is glued if
-  #   successful
+  #   # Glue the component to the face.
+  #   # If you now move the face, the component will follow.
+  #   instance.glued_to = face
+  #
+  # @param [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil] drawing_element
+  #
+  # @raise ArgumentError if the {Sketchup::Behavior} for this component doesn't allow gluing,
+  #   if the alignment is wrong, or if this would lead to cyclic gluing.
+  #
+  # @return [Sketchup::Face, Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil] the entity the instance was glued to.
   #
   # @version SketchUp 6.0
-  def glued_to=(face)
+  def glued_to=(drawing_element)
   end
 
   # The guid method is used to get the base 64 encoded unique id
@@ -218,6 +208,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 +255,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 +293,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 +306,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 +434,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 +461,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 +509,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 +521,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 +537,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 +560,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/Console.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Console class is used by SketchUp to direct $stdout and $stderr to the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ConstructionLine class contains methods for modifying construction

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2020 Trimble Inc.
+# Copyright:: Copyright 2021 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Curve class is used by SketchUp to unite a series of Edge objects into
@@ -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)