Merge branch 'staging'

lib/sketchup-api-stubs/stubs/Array.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The SketchUp Array class adds additional methods to the standard Ruby Array

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Geom module defines a number of Module methods that let you perform

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Bounding boxes are three-dimensional boxes (eight corners), aligned with the

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The bounds2d class represents an axis aligned bounding box represented by

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LatLong class contains various methods for creating and manipulating

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The OrientedBounds2d class is a bounding box represented by four

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Geom::Point2d} class allows you to work with a point in 2D space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Point3d class allows you to work with a point in 3D space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {#Geom::PolygonMesh} class contains methods to create polygon mesh

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Transformations are a standard construct in the 3D world for representing

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 #

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The UTM class lets you work with UTM map coordinates.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The {Geom::Vector2d} class represents vectors in a 2 dimensional space.

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Vector3d class is used to represent vectors in a 3 dimensional space.

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The LayOut module is the root of the LayOut Ruby API. Many of the classes in

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an auto-text definition. Some auto-text definitions are mandatory.

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

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

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

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

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut document. A {Layout::Document} is the 2D
@@ -164,7 +164,15 @@ def auto_text_definitions
   #   # first page of a {Layout::Document} is index 0.
   #   options = { start_page: 1,
   #               end_page: 3,
-  #               output_resolution: Layout::PageInfo::RESOLUTION_HIGH,
+  #               compress_images: TRUE,
+  #               compress_quality: 0.75 }
+  #
+  #   status = 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_quality: 0.75 }
   #
@@ -174,14 +182,23 @@ def auto_text_definitions
   #   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')
+  #   status = 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)
   #
+  #   # 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_quality: 0.75 }
+  #
+  #   status = doc.export("c:/my_export.png", options)
+  #
   # @param [String] file_path
   #   The file or image set to create. The directory
   #   path must already exist. The path must include the file extension.
@@ -398,6 +415,41 @@ def precision=(precision)
   def remove_entity(entity)
   end
 
+  # The {#render_mode_override} method returns the override setting for output render modes
+  # of {Layout::SketchUpModel}s in the {Layout::Document}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   render_mode = doc.render_mode_override
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2023.1
+  def render_mode_override
+  end
+
+  # The {#render_mode_override=} method sets the override setting for output render modes
+  # of {Layout::SketchUpModel}s in the {Layout::Document}. Setting this to +NO_OVERRIDE+
+  # will prevent overriding the individual {Layout::SketchUpModel} render mode setting during
+  # export. This override will only affect raster rendered {Layout::SketchUpModel}s, if a
+  # viewport is set to vector or hybrid, it will retain that render mode as its output render
+  # mode.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   doc.render_mode_override = Layout::SketchUpModel::VECTOR_RENDER
+  #
+  # @param [Integer] render_mode
+  #   +NO_OVERRIDE+, +VECTOR_RENDER+, or +HYBRID_RENDER+
+  #
+  # @raise [ArgumentError] if render_mode is not a valid render mode
+  #
+  # @raise [ArgumentError] if render_mode is +RASTER_RENDER+
+  #
+  # @version LayOut 2023.1
+  def render_mode_override=(render_mode)
+  end
+
   # The {#save} method saves the {Layout::Document} to a file at the given path.
   # Passing an empty path string will save the {Layout::Document} at its current
   # path.

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

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

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

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

lib/sketchup-api-stubs/stubs/Layout/Entity.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An entity is an object shown on a page of a LayOut document.
@@ -175,6 +175,9 @@ def move_to_group(group)
   # {Layout::Entity} must belong to the same {Layout::Document} as the the
   # {Layout::Layer} and the {Layout::Page}s.
   #
+  # @bug In LayOut versions prior to LayOut 2024.0 this method would fail to move
+  #   entities from non-shared layers.
+  #
   # @example
   #   doc = Layout::Document.open("C:/path/to/document.layout")
   #   entities = doc.pages.first.entities

lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A formatted text entity.

lib/sketchup-api-stubs/stubs/Layout/Grid.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Class that references a {Layout::Document}'s grid settings.

lib/sketchup-api-stubs/stubs/Layout/Group.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A group is a special type of {Layout::Entity} that does not belong to a

lib/sketchup-api-stubs/stubs/Layout/Image.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # A raster image entity.

lib/sketchup-api-stubs/stubs/Layout/Label.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is an interface to a label entity. A {Layout::Label} consists of a

lib/sketchup-api-stubs/stubs/Layout/Layer.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a LayOut Layer Definition. A layer definition

lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an instance of a {Layout::Layer}. A {Layout::LayerInstance}

lib/sketchup-api-stubs/stubs/Layout/Layers.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Layers class is a container class for all layers in a {Layout::Document}.

lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References a linear dimension entity. A {Layout::LinearDimension} is composed

lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is raised whenever a method attempts to modify any {Layout::Entity}

lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is raised whenever a method attempts to modify any {Layout::Entity}

lib/sketchup-api-stubs/stubs/Layout/Page.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # Class for a single page in a LayOut document.

lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2023 Trimble Inc.
+# Copyright:: Copyright 2024 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # This is the interface to a {Layout::Document}'s paper space information. The
@@ -140,6 +140,78 @@ def height
   def height=(height)
   end
 
+  # The {#image_display_resolution} method returns the on screen image quality.
+  #
+  # The resolution can be one of the following values:
+  # [+Layout::PageInfo::RESOLUTION_LOW+]
+  # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
+  # [+Layout::PageInfo::RESOLUTION_HIGH+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   image_quality = doc.page_info.image_display_resolution
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2023.1
+  def image_display_resolution
+  end
+
+  # The {#image_display_resolution=} method sets the on screen image quality.
+  #
+  # The resolution can be one of the following values:
+  # [+Layout::PageInfo::RESOLUTION_LOW+]
+  # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
+  # [+Layout::PageInfo::RESOLUTION_HIGH+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   doc.page_info.image_display_resolution = Layout::PageInfo::RESOLUTION_LOW
+  #
+  # @param [Integer] resolution
+  #
+  # @raise [ArgumentError] if resolution is not a valid resolution value
+  #
+  # @version LayOut 2023.1
+  def image_display_resolution=(resolution)
+  end
+
+  # The {#image_output_resolution} method returns the output image quality.
+  #
+  # The resolution can be one of the following values:
+  # [+Layout::PageInfo::RESOLUTION_LOW+]
+  # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
+  # [+Layout::PageInfo::RESOLUTION_HIGH+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   image_quality = doc.page_info.image_output_resolution
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2023.1
+  def image_output_resolution
+  end
+
+  # The {#image_output_resolution=} method sets the output image quality.
+  #
+  # The resolution can be one of the following values:
+  # [+Layout::PageInfo::RESOLUTION_LOW+]
+  # [+Layout::PageInfo::RESOLUTION_MEDIUM+]
+  # [+Layout::PageInfo::RESOLUTION_HIGH+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   doc.page_info.image_output_resolution = Layout::PageInfo::RESOLUTION_HIGH
+  #
+  # @param [Integer] resolution
+  #
+  # @raise [ArgumentError] if resolution is not a valid resolution value
+  #
+  # @version LayOut 2023.1
+  def image_output_resolution=(resolution)
+  end
+
   # The {#left_margin} method returns the paper's left margin in document units.
   #
   # @example