sketchup-api-stubs 0.7.10 → 0.7.11

data/lib/sketchup-api-stubs/stubs/Geom.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Geom module defines a number of Module methods that let you perform
@@ -73,12 +73,12 @@ module Geom
   #   @param [Geom::Point3d] point1
   #   @param [Geom::Point3d] point2
   #   @param [Geom::Point3d] point3
-  #   @return [Array(Geom::Point3d, Geom::Vector3d)] A plane
+  #   @return [Array(Float, Float, Float, Float)] A plane
   #
   # @overload fit_plane_to_points(points)
   #
   #   @param [Array<Geom::Point3d>] points
-  #   @return [Array(Geom::Point3d, Geom::Vector3d)] A plane
+  #   @return [Array(Float, Float, Float, Float)] A plane
   #
   # @version SketchUp 6.0
   def self.fit_plane_to_points(*args)
@@ -125,7 +125,7 @@ module Geom
   #
   # @param [Array(Geom::Point3d, Geom::Vector3d)] line
   #
-  # @param [Array(Geom::Point3d, Geom::Point3d)] plane
+  # @param [Array(Geom::Point3d, Geom::Vector3d)] plane
   #
   # @return [Geom::Point3d, nil] A Point3d object. Returns +nil+ if they do not
   #   intersect.
@@ -149,11 +149,11 @@ module Geom
   #   # This will return a line [Point3d(10, 20, 0), Vector3d(0, 0, 1)].
   #   line = Geom.intersect_plane_plane(plane1, plane2)
   #
-  # @param [Array(Geom::Point3d, Geom::Point3d)] plane1
+  # @param [Array(Geom::Point3d, Geom::Vector3d)] plane1
   #   The first plane to
   #   intersect
   #
-  # @param [Array(Geom::Point3d, Geom::Point3d)] plane2
+  # @param [Array(Geom::Point3d, Geom::Vector3d)] plane2
   #   The second plane to
   #   intersect
   #

data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LanguageHandler class contains methods used to help make SketchUp

data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an angular dimension entity. An {Layout::AngularDimension} is

data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an auto-text definition. Some auto-text definitions are mandatory.
@@ -451,8 +451,8 @@ class Layout::AutoTextDefinition
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
   #
   # @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style}
-  #   method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
-  #   +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #   method that also works on +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ and
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
@@ -460,7 +460,9 @@ class Layout::AutoTextDefinition
   #     Layout::AutoTextDefinition::TYPE_PAGE_NUMBER) number_style = page_number_def.number_style
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
-  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
   #
   # @return [Integer]
   #
@@ -480,8 +482,8 @@ class Layout::AutoTextDefinition
   # [+Layout::AutoTextDefinition::NUMBER_STYLE_LC_ROMAN+]
   #
   # @deprecated LayOut 2022.0 This method is deprecated in favor of the more generic {#number_style=}
-  #   method that also works on +Layout::AutoTextDefintion::TYPE_PAGE_COUNT+ and
-  #   +Layout::AutoTextDefintion::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
+  #   method that also works on +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+ and
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+ {Layout::AutoTextDefinition}s.
   #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
@@ -492,7 +494,9 @@ class Layout::AutoTextDefinition
   # @param [Integer] number_style
   #
   # @raise [ArgumentError] if the {Layout::AutoTextDefinition}'s type is not
-  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+.
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+,
+  #   +Layout::AutoTextDefinition::TYPE_PAGE_COUNT+, or
+  #   +Layout::AutoTextDefinition::TYPE_SEQUENCE+.
   #
   # @raise [ArgumentError] if +number_style+ is not a valid page numbering style
   #

data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The AutoTextDefinitions class is a container class for all

data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Connection Point. A

data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb

@@ -0,0 +1,234 @@
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This is the interface to a LayOut dictionary. A {Layout::Dictionary} wraps key/value pairs.
+#
+# @example
+#   dict = Layout::Dictionary.new
+#
+# @version LayOut 2026.0
+class Layout::Dictionary
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method retrieves the value for a given key.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary['test'] = 115
+  #
+  #   # value will contain 115
+  #   value = dictionary["test"]
+  #
+  # @param [String] key
+  #   The name of the attribute.
+  #
+  # @return [String, Boolean, Integer, Float, Layout::Dictionary, nil]
+  #
+  # @version LayOut 2026.0
+  def [](key)
+  end
+
+  # The {#[]=} method sets a value for a given key.
+  #
+  # Creates a new dictionary entry for the given key if needed.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary['test'] = 110
+  #   value = dictionary['test2'] = 120
+  #   p value
+  #
+  # @param [String] key
+  #   The valid key.
+  #
+  # @param [String, Boolean, Integer, Float, Hash, Layout::Dictionary, nil] value
+  #
+  # @version LayOut 2026.0
+  def []=(key, value)
+  end
+
+  # The {#delete_key} method deletes a key/value pair from the dictionary.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attr_one"] = "one"
+  #   dictionary["attr_two"] = "two"
+  #
+  #   # Delete a key/value pair and get the deleted value.
+  #   value = dictionary.delete_key("attr_one")
+  #
+  # @param [String] key
+  #   The key to be deleted.
+  #
+  # @return [String, Boolean, Integer, Float, Layout::Dictionary, nil]
+  #
+  # @version LayOut 2026.0
+  def delete_key(key)
+  end
+
+  # The {#each_pair} method is an alias for {#each}.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attr_one"] = "one"
+  #   dictionary["attr_two"] = "two"
+  #
+  #   # iterates through all attributes and prints the key to the screen
+  #   dictionary.each_pair { | key, value |
+  #     puts "#{key} = #{value}"
+  #   }
+  #
+  # @see #each
+  #
+  # @version LayOut 2026.0
+  #
+  # @yield [key, value]
+  #
+  # @yieldparam [String] key
+  #
+  # @yieldparam [Object] value
+  def each
+  end
+
+  # The {#each_key} method iterates through all of the dictionary keys.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attr_one"] = "one"
+  #   dictionary["attr_two"] = "two"
+  #
+  #   # iterates through all attributes and prints the key to the screen
+  #   dictionary.each_key { |key| puts key }
+  #
+  # @version LayOut 2026.0
+  #
+  # @yieldparam [String] key
+  def each_key
+  end
+
+  # The {#each_pair} method is an alias for {#each}.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attr_one"] = "one"
+  #   dictionary["attr_two"] = "two"
+  #
+  #   # iterates through all attributes and prints the key to the screen
+  #   dictionary.each_pair { | key, value |
+  #     puts "#{key} = #{value}"
+  #   }
+  #
+  # @see #each
+  #
+  # @version LayOut 2026.0
+  #
+  # @yield [key, value]
+  #
+  # @yieldparam [String] key
+  #
+  # @yieldparam [Object] value
+  def each_pair
+  end
+
+  # The {#empty?} method checks if the dictionary is empty.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attribute_one"] = "1"
+  #   dictionary.empty? # Returns false
+  #
+  # @return [Boolean]
+  #
+  # @version LayOut 2026.0
+  def empty?
+  end
+
+  # The {#initialize} method creates a new {Layout::Dictionary}.
+  #
+  # @example
+  #   doc = Layout::Dictionary.new
+  #   doc2 = Layout::Dictionary.new({"String key" => "string value", "Number key" => 42})
+  #
+  # @overload initialize
+  #
+  #   @return [Layout::Dictionary]
+  #
+  # @overload initialize(dict)
+  #
+  #   @param [Hash, Layout::Dictionary] hash
+  #   @return [Layout::Dictionary]
+  #
+  # @raise [ArgumentError] if dict isn't a dictionary or hash
+  #
+  # @version LayOut 2026.0
+  def initialize(*args)
+  end
+
+  # The {#keys} method retrieves an array with all of the dictionary keys.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attr_one"] = "one"
+  #   dictionary["attr_two"] = "two"
+  #
+  #   # Gets an array of keys
+  #   keys = dictionary.keys
+  #
+  # @return [Array<String>] an array of keys within the dictionary if successful
+  #
+  # @version LayOut 2026.0
+  def keys
+  end
+
+  # The {#length} method retrieves the size (number of elements) of a dictionary.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary['Hello'] = 'World'
+  #   number = dictionary.length
+  #
+  # @return [Integer]
+  #
+  # @see #size
+  #
+  # @version LayOut 2026.0
+  def length
+  end
+
+  # The {#length} method retrieves the size (number of elements) of a dictionary.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary['Hello'] = 'World'
+  #   number = dictionary.length
+  #
+  # @return [Integer]
+  #
+  # @see #size
+  #
+  # @version LayOut 2026.0
+  def size
+  end
+
+  # The {#values} method retrieves an array with all of the dictionary values.
+  #
+  # @example
+  #   dictionary = Layout::Dictionary.new
+  #   dictionary["attr_one"] = "one"
+  #   dictionary["attr_two"] = "two"
+  #
+  #   # Gets an array of values
+  #   values = dictionary.values
+  #
+  # @return [Array<Object>] an array of values within the dictionary if successful
+  #
+  # @version LayOut 2026.0
+  def values
+  end
+
+end

data/lib/sketchup-api-stubs/stubs/Layout/Document.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut document. A {Layout::Document} is the 2D
@@ -129,10 +129,33 @@ class Layout::Document
   #
   # @raise [ArgumentError] if entity already belongs to a {Layout::Document}
   #
+  # @return [Layout::Entity] The {Layout::Entity} that was added to the {Layout::Document}.
+  #
   # @version LayOut 2018
   def add_entity(*args)
   end
 
+  # The {#attribute_dictionary} method returns a copy of the document's attribute dictionary with the
+  # given name.
+  #
+  # is no attribute dictionary
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   doc.set_attribute("jane_doe_doc_maker", "made_by_doc_maker", true)
+  #   attributes = doc.attribute_dictionary("jane_doe_doc_maker")
+  #   # Adding to this Layout::Dictionary does not apply to the document's attribute dictionary, use
+  #   #Layout::Document#set_attribute.
+  #   attributes.merge!(doc_id: 42)
+  #
+  # @param [String] name
+  #
+  # @return [Layout::Dictionary, nil] A copy of the document's attribute dictionary, or nil if there
+  #
+  # @version LayOut 2026.0
+  def attribute_dictionary(name)
+  end
+
   # The {#auto_text_definitions} method returns an array of
   # {Layout::AutoTextDefinition}'s in the {Layout::Document}.
   #
@@ -146,6 +169,33 @@ class Layout::Document
   def auto_text_definitions
   end
 
+  # The {#delete_attribute} method is used to delete an attribute from a document.
+  #
+  # @overload delete_attribute(dictionary_name)
+  #
+  #   @param [String] dictionary_name The name of an attribute dictionary.
+  #   @return [Boolean]
+  #
+  #   @example
+  #     doc = Layout::Document.open("C:/path/to/document.layout")
+  #     doc.set_attribute("jane_doe_doc_maker", "made_by_doc_maker", true)
+  #     doc.delete_attribute("jane_doe_doc_maker")
+  #
+  # @overload delete_attribute(dictionary_name, key)
+  #
+  #   @param [String] dictionary_name The name of an attribute dictionary.
+  #   @param [String] key An attribute key.
+  #   @return [Boolean]
+  #
+  #   @example
+  #     doc = Layout::Document.open("C:/path/to/document.layout")
+  #     doc.set_attribute("jane_doe_doc_maker", "made_by_doc_maker", true)
+  #     doc.delete_attribute("jane_doe_doc_maker", "made_by_doc_maker")
+  #
+  # @version LayOut 2026.0
+  def delete_attribute(*args)
+  end
+
   # The {#export} method exports the {Layout::Document} to a given file format.
   # It knows which format to export based on the file extension you place on the
   # file name. For example, a filename of "thing.pdf" will export a PDF file,
@@ -157,47 +207,64 @@ class Layout::Document
   #   doc = Layout::Document.open("c:/path/to/document.layout")
   #
   #   # Export pdf file on a PC, with default settings.
-  #   status = doc.export("c:/my_export.pdf")
+  #   doc.export("c:/my_export.pdf")
   #
   #   # Export pages one through three at high quality, compressing jpeg images
   #   # at 0.75 compression quality (valid range is 0.0 - 1.0). Note that the
   #   # first page of a {Layout::Document} is index 0.
   #   options = { start_page: 1,
   #               end_page: 3,
-  #               compress_images: TRUE,
+  #               compress_images: true,
   #               compress_quality: 0.75 }
   #
-  #   status = doc.export("c:/my_export.pdf", options)
+  #   doc.export("c:/my_export.pdf", options)
   #
   #   # Export pages one and three through five. Note that page_range starts at
   #   # index 1.
   #   # `page_range` support added in LayOut 2024.0.
   #   options = { page_range: "1,3-5",
-  #               compress_images: TRUE,
+  #               compress_images: true,
   #               compress_quality: 0.75 }
   #
-  #   status = doc.export("c:/my_export.pdf", options)
+  #   doc.export("c:/my_export.pdf", options)
   #
   # @example Image Set Export Examples
   #   doc = Layout::Document.open("c:/path/to/document.layout")
   #
   #   # Export png files on macOS, with default settings.
-  #   status = doc.export("/Users/<username>/Desktop/pngs/page.png")
+  #   doc.export("/Users/<username>/Desktop/pngs/page.png")
   #
   #   # Export pages one through three at 300 dpi as JPGs.
   #   options = { start_page: 1,
   #               end_page: 3,
   #               dpi: 300 }
-  #   status = doc.export('c:/page.jpg', options)
+  #   doc.export('c:/page.jpg', options)
   #
   #   # Export pages one and three through five. Note that page_range starts at
   #   # index 1.
   #   # `page_range` support added in LayOut 2024.0.
   #   options = { page_range: "1,3-5",
-  #               compress_images: TRUE,
+  #               compress_images: true,
   #               compress_quality: 0.75 }
   #
-  #   status = doc.export("c:/my_export.png", options)
+  #   doc.export("c:/my_export.png", options)
+  #
+  # @option options [Integer] :start_page The first page to export.
+  #
+  # @option options [Integer] :end_page The last page to export.
+  #
+  # @option options [String] :page_range A string specifying the range of pages to export. The
+  #   format can include individual page numbers and ranges of pages, separated by commas (e.g.,
+  #   "1,3-5"). This was added in LayOut 2024.0
+  #
+  # @option options [Boolean] :compress_images Whether to compress images in the document. This is
+  #   valid only for image compression for PDF exports.
+  #
+  # @option options [Float] :compress_quality The compression quality for JPEG images. This is
+  #   valid only for the quality of the compression of images for PDF exports.
+  #
+  # @option options [Integer] :dpi The resolution in dots per inch for the exported images. This
+  #   option is only valid for image exports.
   #
   # @param [String] file_path
   #   The file or image set to create. The directory
@@ -218,6 +285,37 @@ class Layout::Document
   def export(file_path, options = nil)
   end
 
+  # The {#get_attribute} method is used to retrieve the value of an attribute in
+  # the document's attribute dictionary.
+  #
+  # If the third parameter, +default_value+, is not passed and there is no
+  # attribute that matches the given name, it returns +nil+.
+  #
+  # If +default_value+ is provided and there is no matching attribute it returns
+  # the given value. It does not create an attribute with that name though.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   # Read an attribute value from the document. In this case this will return the
+  #   # default value provided: 42.
+  #   doc.get_attribute("jane_doe_doc_maker", "doc_id", 42)
+  #
+  # @param [String] name
+  #   The name of an attribute dictionary.
+  #
+  # @param [String] key
+  #   An attribute key.
+  #
+  # @param [String, Boolean, Integer, Float, Hash, Layout::Dictionary, nil] default_value
+  #   A default
+  #   value to return if no attribute is found.
+  #
+  # @return [String, Boolean, Integer, Float, Layout::Dictionary, nil] the retrieved value.
+  #
+  # @version LayOut 2026.0
+  def get_attribute(name, key, default_value = nil)
+  end
+
   # The {#grid} method returns the {Layout::Grid} for a {Layout::Document}.
   #
   # @example
@@ -486,6 +584,22 @@ class Layout::Document
   def save(*args)
   end
 
+  # The {#set_attribute} method adds an attribute to the document's attribute dictionary.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   doc.set_attribute "jane_doe_doc_maker", "doc_id", 42
+  #
+  # @param [String] name
+  #   The name of an attribute dictionary.
+  #   @param [String] key An attribute key.
+  #   @param [String, Boolean, Integer, Float, Hash, Layout::Dictionary, nil] value The value for the
+  #     attribute.
+  #
+  # @version LayOut 2026.0
+  def set_attribute(name, key, value)
+  end
+
   # The {#shared_entities} method returns the {Layout::Entities}
   # that exist on shared {Layout::Layer}s in the {Layout::Document}.
   #

data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A simple elliptical shape entity.

data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Entities class is a container class for {Layout::Entity}s. A