sketchup-api-stubs 0.7.10 → 0.7.11

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

@@ -0,0 +1,113 @@
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This observer interface is implemented to react to {Sketchup::Environment} 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
+#   {Sketchup::Environment} object.
+#
+# @example
+#   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+#     def onEnvironmentChange(environments, environment)
+#        puts "onEnvironmentChange: #{environment}"
+#     end
+#   end
+#
+#   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+#
+# @see Sketchup::Environments#add_observer
+#
+# @version SketchUp 2025.0
+class Sketchup::EnvironmentsObserver
+
+  # Instance Methods
+
+  # The {#onEnvironmentAdd} method is called whenever an environment is added to the
+  # {Sketchup::Environments}.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentAdd(environments, environment)
+  #       puts "onEnvironmentAdd: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentAdd(environments, environment)
+  end
+
+  # The {#onEnvironmentChange} method is called whenever the environment properties
+  # are changed.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentChange(environments, environment)
+  #       puts "onEnvironmentChange: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentChange(environments, environment)
+  end
+
+  # The {#onEnvironmentRemove} method is called whenever an environment is removed from the
+  # {Sketchup::Environments}.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentRemove(environments, environment)
+  #       puts "onEnvironmentRemove: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentRemove(environments, environment)
+  end
+
+  # The {#onEnvironmentSetCurrent} method is called whenever the current environment is changed.
+  #
+  # @example
+  #   class MyEnvironmentsObserver < Sketchup::EnvironmentsObserver
+  #     def onEnvironmentSetCurrent(environments, environment)
+  #       puts "onEnvironmentSetCurrent: #{environment}"
+  #     end
+  #   end
+  #
+  #   Sketchup.active_model.environments.add_observer(MyEnvironmentsObserver.new)
+  #
+  # @param [Sketchup::Environments] environments
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2025.0
+  def onEnvironmentSetCurrent(environments, environment)
+  end
+
+end

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The ExtensionsManager class provides a way of accessing the
@@ -21,7 +21,7 @@ class Sketchup::ExtensionsManager
   #
   # @example
   #   manager = Sketchup.extensions
-  #   extension = manager[1]
+  #   extension = manager[0]
   #   if (extension)
   #     puts extension.name
   #   else
@@ -34,7 +34,7 @@ class Sketchup::ExtensionsManager
   #   # You can also get extensions by ID.
   #   my_extension = manager['2475A758-6503-46D5-AC5E-16AEA0A3162A']
   #
-  # @note Index starts at 1.
+  # @note Index starts at 0.
   #
   # @param [Integer, String] index_or_name
   #   The index, name or ID of the SketchupExtension object.
@@ -83,9 +83,6 @@ class Sketchup::ExtensionsManager
   # @example
   #   manager = Sketchup.extensions
   #   keys = manager.keys
-  #   for key in keys
-  #     UI.messagebox('The next extension is named: ' + key)
-  #   end
   #
   # @return keys - Array of string keys
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Faces in SketchUp are flat, 2-sided polygons with 3 or more sides.
@@ -162,7 +162,7 @@ class Sketchup::Face < Sketchup::Drawingelement
   #     puts "#{pt.to_s} is outside the face"
   #   end
   #
-  #   # Check a point that should be outside inside the face.
+  #   # Check a point that should be inside the face.
   #   pt = Geom::Point3d.new(1, 1, 0)
   #   result = face.classify_point(pt)
   #   if result == Sketchup::Face::PointInside
@@ -227,6 +227,27 @@ class Sketchup::Face < Sketchup::Drawingelement
   def clear_texture_projection(frontside)
   end
 
+  # The {#coplanar_with?} method is used determine whether a face is coplanar with `other_face`.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   entities = model.active_entities
+  #
+  #   # Add the faces to the entities in the model
+  #   face = entities.add_face([0, 0, 0], [4, 0, 0], [4, 5, 0])
+  #   other_face = entities.add_face([5, 0, 0], [9, 0, 0], [9, 6, 0])
+  #
+  #   face.coplanar_with?(other_face)
+  #
+  # @param [Sketchup::Face] other_face
+  #   The face to compare with.
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2025.0
+  def coplanar_with?(other_face)
+  end
+
   # The edges method is used to get an array of edges that bound the face.
   #
   # @example
@@ -337,12 +358,12 @@ class Sketchup::Face < Sketchup::Drawingelement
   # The get_glued_instances method returns an Array any ComponentInstances
   # that are glued to the face.
   #
-  # ComponentInstance objects that are currently glued to the face.
-  #
   # @example
   #   # Create a series of points that define a new face.
   #   model = Sketchup.active_model
   #   entities = model.active_entities
+  #
+  #   # Create a rectangle face
   #   pts = []
   #   pts[0] = [0, 0, 0]
   #   pts[1] = [9, 0, 0]
@@ -351,9 +372,27 @@ class Sketchup::Face < Sketchup::Drawingelement
   #
   #   # Add the face to the entities in the model
   #   face = entities.add_face(pts)
+  #
+  #   # Create a component definition with 3D geometry
+  #   component_definition = model.definitions.add("ComponentExample")
+  #   component_entities = component_definition.entities
+  #
+  #   comp_face = component_entities.add_face([0, 0, 0], [2, 0, 0], [2, 2, 0], [0, 2, 0])
+  #   comp_face.pushpull(2)
+  #
+  #   # Place the component instance on the face
+  #   component_instance = entities.add_instance(component_definition, Geom::Transformation.new([3,
+  #   3, 0]))
+  #
+  #   # Enable gluing behavior and glue component to face
+  #   component_definition.behavior.is2d = true
+  #   component_instance.glued_to = face
+  #
+  #   # Get all component instances glued to the face
   #   glued_array = face.get_glued_instances
   #
   # @return [Array<Sketchup::ComponentInstance, Sketchup::Group, Sketchup::Image>] An array of
+  #   ComponentInstance objects that are currently glued to the face.
   #
   # @version SketchUp 7.0 M1
   def get_glued_instances
@@ -372,25 +411,37 @@ class Sketchup::Face < Sketchup::Drawingelement
   #   pts[0] = [0, 0, 1]
   #   pts[1] = [10, 0, 1]
   #   pts[2] = [10, 10, 1]
+  #   pts[3] = [0, 10, 1]
   #   face = entities.add_face(pts)
   #
-  #   # Export an image to use as a texture
-  #   path = Sketchup.temp_dir
-  #   full_name = File.join(path, "temp_image.jpg")
-  #   model.active_view.write_image(full_name, 500, 500, false, 0.0)
+  #   view = model.active_view
+  #   screenshot_path = File.join(Dir.tmpdir,"screenshot.png")
+  #   view.write_image(screenshot_path)
   #
-  #   # Create a material and assign the texture to it
   #   material = materials.add("Test Material")
-  #   material.texture = full_name
+  #   material.texture = screenshot_path
   #
   #   # Assign the new material to our face we created
   #   face.material = material
   #
   #   # Set the projection of the applied material
-  #   face.set_texture_projection(face.normal, true)
+  #   mapping = [
+  #     Geom::Point3d.new(0, 0, 0), # Model coordinate
+  #     Geom::Point3d.new(0, 0, 0), # UV coordinate
+  #     Geom::Point3d.new(10, 0, 0), # Model coordinate
+  #     Geom::Point3d.new(1, 0, 0), # UV coordinate
+  #     Geom::Point3d.new(0, 10, 0), # Model coordinate
+  #     Geom::Point3d.new(0, 1, 0) # UV coordinate
+  #   ]
+  #
+  #   direction = Geom::Vector3d.new(0, 0, 1) # Adjust direction vector
+  #
+  #   on_front = true
+  #   face.position_material(material, mapping, on_front, direction)
   #
   #   # Get the projection of the applied material
   #   vector = face.get_texture_projection(true)
+  #   puts "Texture projection vector : #{vector.inspect}"
   #
   # @param [Boolean] frontside
   #   +true+ for front side, +false+ for back side.
@@ -410,19 +461,32 @@ class Sketchup::Face < Sketchup::Drawingelement
   # face.
   #
   # @example
-  #   depth = 100
-  #   width = 100
   #   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]
+  #   entities= model.active_entities
   #
-  #   # Add the face to the entities in the model
-  #   face = entities.add_face(pts)
-  #   loops = face.loops
+  #   # Define points for the outer loop
+  #   outer_points = []
+  #   outer_points << Geom::Point3d.new(0, 0, 0)
+  #   outer_points << Geom::Point3d.new(100, 0, 0)
+  #   outer_points << Geom::Point3d.new(100, 100, 0)
+  #   outer_points << Geom::Point3d.new(0, 100, 0)
+  #
+  #   # Create the outer face
+  #   outer_face = entities.add_face(outer_points)
+  #
+  #   # Define points for the inner loop (hole)
+  #   inner_points = []
+  #   inner_points << Geom::Point3d.new(25, 25, 0)
+  #   inner_points << Geom::Point3d.new(75, 25, 0)
+  #   inner_points << Geom::Point3d.new(75, 75, 0)
+  #   inner_points << Geom::Point3d.new(25, 75, 0)
+  #
+  #   # Create the inner face and erase it to create a second loop
+  #   inner_face = entities.add_face(inner_points)
+  #   inner_face.erase!
+  #
+  #   # Get all loops of the outer face
+  #   loops = outer_face.loops
   #
   # @return [Array<Sketchup::Loop>] an array of Loop objects if successful
   #
@@ -644,6 +708,7 @@ class Sketchup::Face < Sketchup::Drawingelement
   # @overload position_material(material, points, on_front)
   #
   #   This variant positions a material on the face's plane without projection.
+  #   @version SketchUp 6.0
   #
   #   @param [Sketchup::Material] material
   #
@@ -658,7 +723,7 @@ class Sketchup::Face < Sketchup::Drawingelement
   #
   # @overload position_material(material, points, on_front, projection)
   #
-  #   @version SketchUp 2021.1
+  #   @version SketchUp 6.0
   #
   #   This variant positions a material on the face's plane with projection.
   #
@@ -691,8 +756,6 @@ class Sketchup::Face < Sketchup::Drawingelement
   # @see #get_texture_projection
   #
   # @see #clear_texture_projection
-  #
-  # @version SketchUp 6.0
   def position_material(*args)
   end
 
@@ -794,10 +857,16 @@ class Sketchup::Face < Sketchup::Drawingelement
   # @example
   #   model = Sketchup.active_model
   #   entities = model.active_entities
+  #
+  #   # Filter the entities to get only the faces
   #   faces = entities.grep(Sketchup::Face).select { |face|
+  #     # Select faces that have manually positioned textures
+  #     # Check both in front face (true) and the back face (false)
   #     face.texture_positioned?(true) || face.texture_positioned?(false)
   #   }
   #
+  #   # 'faces' will contain all faces with manually positioned textures
+  #
   # @param [Boolean] front
   #   +true+ Checks the front side of the face, +false+
   #   the back side.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This observer interface is implemented to react to changes in camera
@@ -75,7 +75,7 @@ class Sketchup::FrameChangeObserver
   #       if percent_done == 0.0
   #         puts "Animating to scene '#{to_scene.name}':"
   #       else
-  #         puts format("% 7.2f %",percent_done*100)
+  #         puts format("% 7.2f %%",percent_done*100)
   #       end
   #     end
   #   end

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A Group class contains methods for manipulating groups of entities.
@@ -113,11 +113,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   face = entities2.add_face pts
   #   group.description = "This is a Group with a 2d Face"
   #   description = group.description
-  #   if (description)
-  #     UI.messagebox description
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @param [String] description
   #   A string description.
@@ -150,11 +145,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   # Add a face to within the group
   #   face = entities2.add_face pts
   #   entities = group.entities
-  #   if (entities)
-  #     UI.messagebox entities
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @return [Sketchup::Entities] an Entities object if successful
   #
@@ -188,11 +178,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group.entities.add_line([0,0,0],[100,100,100])
   #
   #   array = group.explode
-  #   if array
-  #     UI.messagebox "Exploded the group"
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @return [Array<Sketchup::Drawingelement>] An array of entity objects if successful, false if
   #   unsuccessful.
@@ -346,7 +331,6 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   # Add the group to the entities in the model
   #   group = entities.add_group
   #   status = group.locked?
-  #   UI.messagebox status
   #
   # @return [Boolean]
   #
@@ -449,7 +433,7 @@ class Sketchup::Group < Sketchup::Drawingelement
   def name
   end
 
-  # The name= method is used to set the description for the group.
+  # The {#name=} method is used to set the name for the group.
   #
   # @example
   #   # Add a group to the model.
@@ -632,13 +616,8 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   # Add a face to within the group
   #   face = entities2.add_face pts
   #   UI.messagebox "Group before Move"
-  #   group = group.transform! t
-  #   if (group)
-  #     UI.messagebox "Group after move"
-  #     UI.messagebox group
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
+  #   group.transform! t
+  #   puts "Group after move\r\n" + group.to_s
   #
   # @param [Geom::Transformation] transform
   #   A Transformation object.
@@ -676,13 +655,19 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   new_transformation = Geom::Transformation.new([100,0,0])
   #   group.transformation = new_transformation
   #
+  # @note As of SketchUp 2026, this will raise an error if the
+  #   {Geom::Transformation} is not invertible. Prior to 2026 this would silently set the
+  #   transformation possibly causing rendering or editing problems.
+  #
   # @param [Geom::Transformation] transformation
   #
+  # @raise ArgumentError if the {Geom::Transformation} is not invertible (as of Sketchup 2026)
+  #
   # @version SketchUp 6.0
   def transformation=(transformation)
   end
 
-  # The trim method is used to compute the (non-destructive) boolean difference
+  # The {#trim} method is used to compute the (non-destructive) boolean difference
   # of the two groups representing manifold solid volumes (this - arg).  If
   # the specified objects (this and arg) do not represent manifold volumes, this
   # method fails.
@@ -693,6 +678,11 @@ class Sketchup::Group < Sketchup::Drawingelement
   #   group2 = entities[1]
   #   result = group1.trim(group2)
   #
+  # @note Trimming object group2 using group1 results in a new trimmed version of group2.
+  #   If the trim is successful the original group2 is erased and a newly trimmed
+  #   version is created. This new version, derived from the trimming operation,
+  #   will possess a new GUID and will be returned.
+  #
   # @note This method is not available in SketchUp Make.
   #
   # @param [Sketchup::Group, Sketchup::ComponentInstance] group

data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb

@@ -1,7 +1,7 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# Http::Request objects allows you to send HTTP request to HTTP servers.
+# {Sketchup::Http::Request} objects allows you to send HTTP request to HTTP servers.
 #
 # @version SketchUp 2017
 class Sketchup::Http::Request
@@ -52,6 +52,8 @@ class Sketchup::Http::Request
   #
   #   @request.cancel
   #
+  # @note Do not {#cancel} the request in the response callback.
+  #
   # @return [true]
   #
   # @version SketchUp 2017
@@ -93,17 +95,17 @@ class Sketchup::Http::Request
   def headers=(headers)
   end
 
-  # The default port is 80, to use a different port define it in the URL when
+  # The default port is +80+, to use a different port define it in the URL when
   # creating a new {Sketchup::Http::Request}.
   #
-  # The +method+ parameter accepts any custom HTTP method or one of the
+  # The {#method} parameter accepts any custom HTTP method or one of the
   # following:
-  # * +Sketchup::Http::GET+
-  # * +Sketchup::Http::POST+
-  # * +Sketchup::Http::PUT+
-  # * +Sketchup::Http::DELETE+
-  # * +Sketchup::Http::HEAD+
-  # * +Sketchup::Http::OPTIONS+
+  # - {Sketchup::Http::GET}
+  # - {Sketchup::Http::POST}
+  # - {Sketchup::Http::PUT}
+  # - {Sketchup::Http::DELETE}
+  # - {Sketchup::Http::HEAD}
+  # - {Sketchup::Http::OPTIONS}
   #
   # @example
   #   @request = Sketchup::Http::Request.new("http://localhost:8080", Sketchup::Http::GET)
@@ -116,6 +118,8 @@ class Sketchup::Http::Request
   #   making the download silently fail. This is especially noticeable for larger downloads that
   #   takes longer time.
   #
+  # @note Do not {#cancel} the request in the response callback.
+  #
   # @param [String] url
   #
   # @param [String] method
@@ -142,13 +146,14 @@ class Sketchup::Http::Request
   end
 
   # Sets the HTTP method that is going to be used when sending the request.
+  #
   # The value can be any custom HTTP method or one of the following:
-  # * +Sketchup::Http::GET+
-  # * +Sketchup::Http::POST+
-  # * +Sketchup::Http::PUT+
-  # * +Sketchup::Http::DELETE+
-  # * +Sketchup::Http::HEAD+
-  # * +Sketchup::Http::OPTIONS+
+  # - {Sketchup::Http::GET}
+  # - {Sketchup::Http::POST}
+  # - {Sketchup::Http::PUT}
+  # - {Sketchup::Http::DELETE}
+  # - {Sketchup::Http::HEAD}
+  # - {Sketchup::Http::OPTIONS}
   #
   # @example
   #   @request = Sketchup::Http::Request.new("http://localhost:8080")
@@ -184,7 +189,7 @@ class Sketchup::Http::Request
   #
   #   @request.start
   #
-  # @note +total+ is -1 if the server doesn't specify a file size in the response header.
+  # @note +total+ is +-1+ if the server doesn't specify a file size in the response header.
   #
   # @return [Boolean]
   #
@@ -236,6 +241,8 @@ class Sketchup::Http::Request
   #     puts "body: #{response.body}"
   #   end
   #
+  # @note Do not {#cancel} the request in the response callback.
+  #
   # @return [Boolean]
   #
   # @version SketchUp 2017

data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb

@@ -1,18 +1,20 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# Http::Response objects allows you to get the response information from the
-# server, you can only receive the Http::Response if you have attached a
-# callback block when calling start from the Http::Request object.
+# {Sketchup::Http::Response} objects allows you to get the response information from the
+# server, you can only receive the {Sketchup::Http::Response} if you have attached a
+# callback block when calling start from the {Sketchup::Http::Request} object.
+#
+# @note Do not {Sketchup::Http::Request#cancel} the request in the response callback.
 #
 # @version SketchUp 2017
 class Sketchup::Http::Response
 
   # Instance Methods
 
-  # Gets the http body that was received from the server as a string encoded
-  # using the charset provided in the Content-Type of the server response, if
-  # no charset is specified, ASCII-8BIT will be used.
+  # Gets the HTTP body that was received from the server as a string encoded
+  # using the charset provided in the +"Content-Type"+ header of the server response,
+  # if no charset is specified, +Encoding::ASCII_8BIT+ will be used.
   #
   # @example
   #   @request = Sketchup::Http::Request.new("http://localhost:8080")
@@ -27,7 +29,7 @@ class Sketchup::Http::Response
   def body
   end
 
-  # Returns the http headers that were sent by the server.
+  # Returns the HTTP headers that were sent by the server.
   #
   # @example
   #   @request = Sketchup::Http::Request.new("http://localhost:8080")
@@ -50,7 +52,7 @@ class Sketchup::Http::Response
   #   @request = Sketchup::Http::Request.new("http://localhost:8080")
   #
   #   @request.start do |request, response|
-  #     puts "http status code: #{response.status_code}"
+  #     puts "HTTP status code: #{response.status_code}"
   #   end
   #
   # @return [Integer]

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::Http} module provides interfaces to create asynchronous HTTP