sketchup-api-stubs 0.7.10 → 0.7.11

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::ShadowInfo} class contains method to extract the shadow
@@ -93,13 +93,13 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # The set value []= method is used to set the value in the array of shadow
   # info options.
   #
+  # For numeric properties like "Dark", "Light", "Latitude", and "Longitude",
+  # this method is flexible and accepts any +Numeric+ value (+Integer+ or +Float+).
+  #
   # @example
   #   model = Sketchup.active_model
   #   shadowinfo = model.shadow_info
-  #   value = shadowinfo["City"]
-  #   UI.messagebox value
-  #   value = shadowinfo["City"]="Denver, CO"
-  #   UI.messagebox value
+  #   shadowinfo["City"]="Denver, CO"
   #
   # @param [String] key
   #   The key of the shadowinfo value to set.
@@ -107,6 +107,10 @@ class Sketchup::ShadowInfo < Sketchup::Entity
   # @param [Object] value
   #   The value to be set.
   #
+  # @raise A KeyError is raised if the key is invalid or read-only.
+  #
+  # @raise [TypeError] if the value is not the correct type for the key.
+  #
   # @return [Object] the value that was set if successful, or false
   #   if unsuccessful.
   #

data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.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 to the shadow

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Sketchup::Skp} module is used to read metadata from external SketchUp

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

@@ -0,0 +1,125 @@
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# A Snap is a custom grip used by SketchUp's Move tool.
+# Snaps can be added at strategic places such as connectors to help
+# assembling objects.
+#
+# rdoc-image:../images/snaps.png
+#
+# {#direction} is the direction a snap is "pointing". This can be thought of as
+# the normal direction of the snap. It can also be thought of as the direction
+# you move an object when plugging it into another object, e.g. inserting a
+# power coord.
+#
+# {#up} controls the rotation around the Snap's axis.
+#
+# When two objects are snapped together, the Snaps have opposite
+# {#direction} vectors but matching {#up} vectors.
+#
+# @example
+#   # Copy all snaps from source group/component to the corresponding
+#   # location in a target group/component, as if the objects have
+#   # have been snapped together.
+#   #
+#   # @param [Sketchup::Group, Sketchup::ComponentInstance] source
+#   # @param [Sketchup::Group, Sketchup::ComponentInstance] target
+#   def copy_snap(source, target)
+#     # Transformation for going from the coordinate system of the source to
+#     # that of the target.
+#     transformation =
+#       target.transformation.inverse * source.transformation
+#
+#     source.definition.entities.grep(Sketchup::Snap) do |source_snap|
+#       # Transform position and orientation between local coordinate systems.
+#       position = source_snap.position.transform(transformation)
+#       # Direction vector is reversed between two connected snaps;
+#       # the snaps point "into" each other.
+#       direction = source_snap.direction.transform(transformation).reverse
+#       # Up vector is aligned between two connected snaps.
+#       up = source_snap.up.transform(transformation)
+#
+#       target.entities.add_snap(position, direction, up)
+#     end
+#   end
+#
+# @version SketchUp 2025.0
+class Sketchup::Snap < Sketchup::Drawingelement
+
+  # Instance Methods
+
+  # The {#direction} method is used to get the direction this Snap is "pointing".
+  #
+  # When two Snaps are snapped into each other, they have the opposite {#direction}.
+  #
+  # @example
+  #   snap = Sketchup.active_model.entities.add_snap(ORIGIN)
+  #   direction = snap.direction
+  #
+  # @return [Geom::Vector3d]
+  #
+  # @version SketchUp 2025.0
+  def direction
+  end
+
+  # The {#position} method is used to get the position of this Snap.
+  #
+  # @example
+  #   snap = Sketchup.active_model.entities.add_snap(ORIGIN)
+  #   position = snap.position
+  #
+  # @return [Geom::Point3d]
+  #
+  # @version SketchUp 2025.0
+  def position
+  end
+
+  # The {#set} method is used to move and/or reorient a Snap.
+  #
+  # @example
+  #   snap = Sketchup.active_model.entities.add_snap(ORIGIN)
+  #   snap.set(Geom::Point3d.new(1.m, 0, 0))
+  #
+  # @overload set(position)
+  #
+  #   With only a position provided, the Snap keeps its current orientation.
+  #   @param [Geom::Point3d] position
+  #
+  # @overload set(position, direction)
+  #
+  #   With a position and a direction vector provided, but no up vector, SketchUp
+  #   tries to keep the Snap upright.
+  #   @param [Geom::Point3d] position
+  #   @param [Geom::Vector3d] direction
+  #
+  # @overload set(position, direction, up)
+  #
+  #   @param [Geom::Point3d] position
+  #   @param [Geom::Vector3d] direction
+  #   @param [Geom::Vector3d] up
+  #
+  # @raise ArgumentError if +direction+ and +up+ are parallel.
+  #
+  # @return [Sketchup::Snap] self
+  #
+  # @version SketchUp 2025.0
+  def set(*args)
+  end
+
+  # The {#up} method is used to get a vector representing the rotation of this
+  # Snap along its axis.
+  #
+  # When two Snaps are snapped into each other, they have the same aligned {#up}
+  # direction.
+  #
+  # @example
+  #   snap = Sketchup.active_model.entities.add_snap(ORIGIN)
+  #   up = snap.up
+  #
+  # @return [Geom::Vector3d]
+  #
+  # @version SketchUp 2025.0
+  def up
+  end
+
+end

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

@@ -1,10 +1,16 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Style class contains methods for modifying information about a specific
 # style. Styles are a collection of display settings that tell SketchUp how to
 # draw the model.
 #
+# In SketchUp, there are two important style objects in a model:
+# The {Sketchup::Styles#selected_style} is the style currently selected in the Styles Browser.
+# The {Sketchup::Styles#active_style} is a temporary copy of the selected style that allows
+# editing without committing changes. Changes to the active style are not saved unless you call
+# {Sketchup::Styles#update_selected_style}.
+#
 # @example
 #   styles = Sketchup.active_model.styles
 #   puts "Your first style is named #{styles.first.name}"
@@ -66,4 +72,17 @@ class Sketchup::Style < Sketchup::Entity
   def name=(name)
   end
 
+  # The {#path} method gets the file path the {Sketchup::Style} was loaded from.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   name = style.path
+  #
+  # @return [String] path The file path the style was loaded from.
+  #
+  # @version SketchUp 2025.0
+  def path
+  end
+
 end

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

@@ -1,9 +1,16 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Styles class contains methods for manipulating a collection of styles in
 # a model. Typically, you will access this via the active_model:
 #
+# There are two objects of this class that play important roles: the {#selected_style} and the
+# {#active_style}.
+#
+# The latter is a temporary copy made from the {#selected_style} that allows the user to edit
+# the style without committing to save anything. To save the changes, one should use
+# {#update_selected_style}.
+#
 # @example
 #   styles = Sketchup.active_model.styles
 #   puts "There are #{styles.size} styles in your model."
@@ -71,21 +78,33 @@ class Sketchup::Styles < Sketchup::Entity
   # The {#add_style} method is used to create and load a style from the given
   # file.
   #
-  # @example
+  # @example For SketchUp 2025.0 and older
   #   filename = File.expand_path('./MyStyle.style')
   #   styles = Sketchup.active_model.styles
   #   status = styles.add_style(filename, true)
   #
-  # @param [String] filename
+  # @example For SketchUp 2026.0 and newer
+  #   filename = File.expand_path('./MyStyle.style')
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.add_style(filename, true)
+  #
+  # @overload add_style(filename, select)
   #
-  # @param [Boolean] select
-  #   +true+ if you want to set the style to be the
-  #   active style.
+  #   @note Signature for versions prior to SketchUp 2026.0.
+  #   @version SketchUp 6.0
+  #   @param [String] filename The file path to the style file.
+  #   @param [Boolean] select +true+ if you want to set the style to be the active style.
+  #   @return [Boolean]
   #
-  # @return [Boolean]
+  # @overload add_style(filename, select = false)
   #
-  # @version SketchUp 6.0
-  def add_style(filename, select)
+  #   @version SketchUp 2026.0
+  #   @param [String] filename The file path to the style file.
+  #   @param [Boolean] select +true+ if you want to set the style to be the active style.
+  #
+  # @return [Sketchup::Style, nil] The newly created style or +nil+ if the the style could not be
+  #   added.
+  def add_style(*args)
   end
 
   #
@@ -151,12 +170,32 @@ class Sketchup::Styles < Sketchup::Entity
   #   styles = Sketchup.active_model.styles
   #   styles.purge_unused
   #
-  # @return [true]
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def purge_unused
   end
 
+  # The {#remove_style} method is used to remove a {Sketchup::Style} from the {Sketchup::Styles}.
+  #
+  # @example
+  #   filename = File.expand_path('./MyStyle.style')
+  #   styles = Sketchup.active_model.styles
+  #   status = styles.add_style(filename, true)
+  #   styles.remove(styles.first)
+  #
+  # @param [Sketchup::Style] style
+  #
+  # @raise [ArgumentError] If the style is not found in the Styles collection.
+  #
+  # @raise [ArgumentError] If the styles contains only one style.
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2026.0
+  def remove_style(style)
+  end
+
   # The {#selected_style} method is used to retrieve the style currently
   # selected in the Styles Browser.
   #
@@ -172,13 +211,20 @@ class Sketchup::Styles < Sketchup::Entity
 
   # The {#selected_style=} method is used to set the currently selected style.
   #
+  # @bug Prior to SketchUp 2025.0 setting the {#selected_style=} to the {#active_style} would chrash
+  #   SketchUp.
+  #
   # @example
   #   styles = Sketchup.active_model.styles
-  #   styles.selected_style = styles.last
+  #   filename = File.expand_path('./MyStyle.style')
+  #   styles.add_style(filename, true)
+  #   styles.selected_style = styles['[MyStyle]']
   #
   # @param [Sketchup::Style] style
   #
-  # @return [false]
+  # @raise [ArgumentError] If \p style is the {#active_style}.
+  #
+  # @return [nil]
   #
   # @version SketchUp 6.0
   def selected_style=(style)
@@ -206,7 +252,7 @@ class Sketchup::Styles < Sketchup::Entity
   #   styles = Sketchup.active_model.styles
   #   styles.update_selected_style
   #
-  # @return [true]
+  # @return [nil]
   #
   # @see #selected_style
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Text class contains method to manipulate a Text entity object.
@@ -11,8 +11,12 @@ class Sketchup::Text < Sketchup::Drawingelement
   # The arrow_type method retrieves the current arrow type used for the leader
   # text.
   #
-  # Valid arrow types are 0 for none, 2 for dot, 3 for closed arrow, 4 for open
-  # arrow.
+  # Valid arrow types are:
+  # - {Sketchup::Dimension::ARROW_NONE} (Deprecated: {DimensionArrowNone})
+  # - {Sketchup::Dimension::ARROW_SLASH} (Deprecated: {DimensionArrowSlash})
+  # - {Sketchup::Dimension::ARROW_DOT} (Deprecated: {DimensionArrowDot})
+  # - {Sketchup::Dimension::ARROW_CLOSED} (Deprecated: {DimensionArrowClosed})
+  # - {Sketchup::Dimension::ARROW_OPEN} (Deprecated: {DimensionArrowOpen})
   #
   # @example
   #   type = text.arrow_type=0
@@ -26,8 +30,12 @@ class Sketchup::Text < Sketchup::Drawingelement
 
   # The arrow_type= method sets the arrow type used for leader text.
   #
-  # Valid arrow types are 0 for none, 2 for dot, 3 for closed arrow, 4 for open
-  # arrow.
+  # Valid arrow types are:
+  # - {Sketchup::Dimension::ARROW_NONE} (Deprecated: {DimensionArrowNone})
+  # - {Sketchup::Dimension::ARROW_SLASH} (Deprecated: {DimensionArrowSlash})
+  # - {Sketchup::Dimension::ARROW_DOT} (Deprecated: {DimensionArrowDot})
+  # - {Sketchup::Dimension::ARROW_CLOSED} (Deprecated: {DimensionArrowClosed})
+  # - {Sketchup::Dimension::ARROW_OPEN} (Deprecated: {DimensionArrowOpen})
   #
   # @example
   #   arrow = text.arrow_type=type
@@ -110,7 +118,12 @@ class Sketchup::Text < Sketchup::Drawingelement
   def has_leader?
   end
 
-  # The leader_type method retrieves the currently set leader type.
+  # The {#leader_type} method retrieves the currently set leader type.
+  #
+  # Valid leaders types are:
+  # - {ALeaderNone}
+  # - {ALeaderView}
+  # - {ALeaderModel}
   #
   # @example
   #   leader = text.leader_type
@@ -122,17 +135,25 @@ class Sketchup::Text < Sketchup::Drawingelement
   def leader_type
   end
 
-  # The leader_type = method sets the leader type.
+  # The {#leader_type=} method sets the leader type.
   #
-  # Valid leader types are 0 for none, 1 for View-based, and 2 for Pushpin
+  # Valid leaders types are:
+  # - {ALeaderNone}
+  # - {ALeaderView}
+  # - {ALeaderModel}
   #
   # @example
   #   leader = text.leader_type=1
   #
+  # @note {ALeaderNone} cannot be set. It is only used internally as a default value.
+  #   Trying to set it will raise a warning.
+  #
   # @param [Integer] type
   #   A numerical value representing the leader type to be
   #   set.
   #
+  # @raise [RangeError] if the value is other than (ALeaderView, or ALeaderModel).
+  #
   # @return [Integer] a numerical value representing the leader type
   #   you just set.
   #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Texture class contains methods for obtaining information about textures
@@ -23,16 +23,11 @@ class Sketchup::Texture < Sketchup::Entity
   #     # Returns nil if not successful, path if successful
   #     m.texture = "c:\\Materials\\Carpet.jpg"
   #   rescue
-  #     UI.messagebox $!.message
+  #     puts $!.message
   #   end
   #   texture = m.texture
   #   # Returns a color object
   #   color = texture.average_color
-  #   if (color)
-  #     UI.messagebox color
-  #   else
-  #     UI.messagebox "Failure: No average color"
-  #   end
   #
   # @return [Sketchup::Color, nil] a color object (if successful), nil if
   #   unsuccessful.
@@ -41,8 +36,15 @@ class Sketchup::Texture < Sketchup::Entity
   def average_color
   end
 
-  # The {#filename} method retrieves the entire path, including the file, for a
-  # texture object.
+  # The {#filename} method retrieves the full path, if available, for a texture object.
+  #
+  # Textures for materials shipping with SketchUp might only have a filename,
+  # since the path would be invalid on the end user's machine. Textures
+  # dynamically created from ImageRep objects may have an empty path unless
+  # saved with {Sketchup::ImageRep#save_file} or until the texture is saved with
+  # {Sketchup::Texture#write}.
+  #
+  # If you need only the filename of the texture use +filename = File.basename(texture.filename)+.
   #
   # @example
   #   model = Sketchup.active_model
@@ -79,11 +81,6 @@ class Sketchup::Texture < Sketchup::Entity
   #
   # @example
   #   imageheight = texture.image_height
-  #   if (imageheight)
-  #     UI.messagebox imageheight
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @return [Integer] the height, in pixels, of the texture
   #   pattern
@@ -113,11 +110,6 @@ class Sketchup::Texture < Sketchup::Entity
   #
   # @example
   #   imagewidth = texture.image_width
-  #   if (imagewidth)
-  #     UI.messagebox imagewidth
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @return [Integer] the width, in pixels, of the texture
   #   pattern
@@ -134,18 +126,13 @@ class Sketchup::Texture < Sketchup::Entity
   #   imagewidth = texture.width
   #
   #   if (imagewidth)
-  #     UI.messagebox imagewidth
+  #     puts imagewidth
   #   else
-  #     UI.messagebox "Failure"
+  #     puts "Failure"
   #   end
   #
   #   # Using two values which will not preserve ratio
   #   width_height = texture.size = [10,100]
-  #   if (width_height)
-  #     UI.messagebox width_height
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @param [Integer, Array(Integer, Integer)] size
   #   The size, in inches, of the texture. This number will
@@ -168,11 +155,6 @@ class Sketchup::Texture < Sketchup::Entity
   #
   # @example
   #   status = texture.valid?
-  #   if (status)
-  #     UI.messagebox status
-  #   else
-  #     UI.messagebox status
-  #   end
   #
   # @return [Boolean]
   #

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

@@ -1,12 +1,12 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The TextureWriter class is used primarily for writing the textures used in a
 # SketchUp model out to files as part of an export for use in another
 # application. These methods are usually invoked in this order:
 #
-#   - 1. load - load one or more textures from a model into the TextureWriter.
-#   - 2. write_all or write - write the texture(s) to file.
+# 1. {#load} - load one or more textures from a model into the TextureWriter.
+# 2. {#write_all} or {#write} - write the texture(s) to file.
 #
 # @example
 #   # This code snippet sets up a texture writer and some variables that are
@@ -159,9 +159,9 @@ class Sketchup::TextureWriter
   # This method will return one of the following status messages. (These are
   # constants that are defined by the API.)
   #
-  #   - 0 = FILE_WRITE_OK
-  #   - 1 = FILE_WRITE_FAILED_INVALID_TIFF
-  #   - 2 = FILE_WRITE_FAILED_UNKNOWN
+  # - 0 = {FILE_WRITE_OK}
+  # - 1 = {FILE_WRITE_FAILED_INVALID_TYPE}
+  # - 2 = {FILE_WRITE_FAILED_UNKNOWN}
   #
   # @example
   #   tw.load(texturable_entities[0])
@@ -211,9 +211,9 @@ class Sketchup::TextureWriter
   # The write_all method is used to write all of the textures within the texture
   # writer to files. It will return one of three status numbers:
   #
-  #   - 0 = FILE_WRITE_OK
-  #   - 1 = FILE_WRITE_FAILED_INVALID_TIFF
-  #   - 2 = FILE_WRITE_FAILED_UNKNOWN
+  # - 0 = {FILE_WRITE_OK}
+  # - 1 = {FILE_WRITE_FAILED_INVALID_TYPE}
+  # - 2 = {FILE_WRITE_FAILED_UNKNOWN}
   #
   # @example
   #   tw.load(texturable_entities[0]