sketchup-api-stubs 0.7.10 → 0.7.11

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An Overlay provides contextual model information directly in the viewport.
@@ -13,8 +13,6 @@
 # It is also not allowed to perform model changes from overlay events. Doing
 # so will result in a +RuntimeError+ being thrown.
 #
-# @api Overlays
-#
 # @example
 #   class ExampleOverlay < Sketchup::Overlay
 #
@@ -64,8 +62,6 @@ class Sketchup::Overlay
 
   # This is a short user facing description of the overlay that will appear in the UI.
   #
-  # @api Overlays
-  #
   # @example
   #   Sketchup.active_model.overlays.each { |overlay|
   #     puts "#{overlay.name}: #{overlay.description}"
@@ -80,8 +76,6 @@ class Sketchup::Overlay
   # Sets a short user facing description of the overlay that will appear in the UI.
   # Set this before adding to the {Sketchup::OverlaysManager}.
   #
-  # @api Overlays
-  #
   # @example
   #   Sketchup.active_model.overlays.each { |overlay|
   #     puts "#{overlay.name}: #{overlay.description}"
@@ -96,8 +90,6 @@ class Sketchup::Overlay
   #
   # @abstract It is called whenever the view updates.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -143,8 +135,6 @@ class Sketchup::Overlay
   def draw(view)
   end
 
-  #
-  # @api Overlays
   #
   # @note In most cases, extensions doesn't need to expose any new UI for
   #   enabling them. This can be done from the Overlays panel. However, in some
@@ -160,8 +150,6 @@ class Sketchup::Overlay
   def enabled=(enabled)
   end
 
-  #
-  # @api Overlays
   #
   # @example
   #   Sketchup.active_model.overlays.each { |overlay|
@@ -189,8 +177,6 @@ class Sketchup::Overlay
   #   in 3D space doesn't appear clipped. If the overlay only draws in 2D this
   #   isn't needed.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -221,8 +207,6 @@ class Sketchup::Overlay
   def getExtents
   end
 
-  #
-  # @api Overlays
   #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
@@ -256,8 +240,6 @@ class Sketchup::Overlay
 
   # This is a user facing display name that will appear in the UI.
   #
-  # @api Overlays
-  #
   # @example
   #   Sketchup.active_model.overlays.each { |overlay|
   #     puts "#{overlay.name} (#{overlay.overlay_id}) Enabled: #{overlay.enabled?}"
@@ -275,8 +257,6 @@ class Sketchup::Overlay
   # @abstract It can be used by implementing sub-classes to react to
   #   mouse movement in the viewport.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -315,8 +295,6 @@ class Sketchup::Overlay
   # @abstract It can be used by implementing sub-classes to react to
   #   mouse movement in the viewport.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -342,8 +320,6 @@ class Sketchup::Overlay
   # @abstract It can be used by implementing sub-classes to react to
   #   mouse movement in the viewport.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -360,24 +336,29 @@ class Sketchup::Overlay
   #
   #   end
   #
-  # @param [Integer] flags
-  #   A bit mask that tells the state of the modifier
-  #   keys and other mouse buttons at the time.
+  # @overload onMouseMove(flags, x, y, view)
   #
-  # @param [Integer] x
-  #   The X coordinate on the screen where the event occurred.
+  #   @note Signature for versions prior to SketchUp 2025.0
+  #   @version SketchUp 2023.0
+  #   @param [Integer] flags A bit mask that tells the state of the modifier
+  #                          keys and other mouse buttons at the time.
+  #   @param [Integer] x  Screen coordinate in physical pixels.
+  #   @param [Integer] y  Screen coordinate in physical pixels.
+  #   @param [Sketchup::View] view
   #
-  # @param [Integer] y
-  #   The Y coordinate on the screen where the event occurred.
+  # @overload onMouseMove(flags, x, y, view)
   #
-  # @param [Sketchup::View] view
+  #   @version SketchUp 2025.0
+  #   @param [Integer] flags  A bit mask that tells the state of the modifier
+  #                           keys and other mouse buttons at the time.
+  #   @param [Float] x  Screen coordinate in logical pixels.
+  #   @param [Float] y  Screen coordinate in logical pixels.
+  #   @param [Sketchup::View] view
   #
   # @version SketchUp 2023.0
-  def onMouseMove(flags, x, y, view)
+  def onMouseMove
   end
 
-  #
-  # @api Overlays
   #
   # @example Implementing
   #   class ExampleOverlay < Sketchup::Overlay
@@ -402,8 +383,6 @@ class Sketchup::Overlay
   # Describes the source associated with the overlay. This is automatically inferred
   # when the overlay instance is initialized.
   #
-  # @api Overlays
-  #
   # @example
   #   Sketchup.active_model.overlays.each { |overlay|
   #     puts "#{overlay.name} (Extension: #{overlay.source})"
@@ -419,8 +398,6 @@ class Sketchup::Overlay
   # @abstract It can be used by implementing sub-classes to react when the overlay
   #   becomes active, for instance when the user turns it on.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -442,8 +419,6 @@ class Sketchup::Overlay
   # @abstract It can be used by implementing sub-classes to react when the overlay
   #   becomes inactive, for instance when the user turns it off.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #
@@ -464,8 +439,6 @@ class Sketchup::Overlay
   # Indicates whether the overlay is valid. An overlay becomes invalid after
   # being removed from the model and cannot be reused.
   #
-  # @api Overlays
-  #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
   #     def initialize

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # An overlay added to a model is invalidated once it's removed from the model.
@@ -10,8 +10,6 @@
 #
 # A model can not have multiple overlays with the same id.
 #
-# @api Overlays
-#
 # @example
 #   Sketchup.active_model.overlays.each { |overlay|
 #     puts "#{overlay.name} (#{overlay.overlay_id}) Enabled: #{overlay.enabled?}"
@@ -29,8 +27,6 @@ class Sketchup::OverlaysManager
 
   # Instance Methods
 
-  #
-  # @api Overlays
   #
   # @example
   #   overlay = Sketchup.active_model.overlays[0]
@@ -42,8 +38,6 @@ class Sketchup::OverlaysManager
   end
   alias_method :at, :[]
 
-  #
-  # @api Overlays
   #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
@@ -63,8 +57,6 @@ class Sketchup::OverlaysManager
   def add(service)
   end
 
-  #
-  # @api Overlays
   #
   # @example
   #   Sketchup.active_model.overlays.each { |overlay|
@@ -79,8 +71,6 @@ class Sketchup::OverlaysManager
   def each
   end
 
-  #
-  # @api Overlays
   #
   # @example
   #   class ExampleOverlay < Sketchup::Overlay
@@ -100,8 +90,6 @@ class Sketchup::OverlaysManager
   def remove(service)
   end
 
-  #
-  # @api Overlays
   #
   # @example
   #   num_overlays = Sketchup.active_model.overlays.size

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

@@ -1,31 +1,71 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
-# The Page class contains methods to extract information and modify the
-# properties of an individual page.
+# The Page class contains methods to extract information and modify the properties of
+# an individual page.
 #
 # Note that inside the SketchUp user interface pages are called "Scenes".
 #
+# Since SketchUp 2026.0, modifying the {Sketchup::Axes}, {Sketchup::Camera},
+# {Sketchup::RenderingOptions}, and {Sketchup::ShadowInfo} properties of a page is an undoable
+# operation and should be wrapped between {Sketchup::Model#start_operation} and
+# {Sketchup::Model#commit_operation}.
+# Example:
+#    model = Sketchup.active_model
+#    pages = model.pages
+#    origin = Geom::Point3d.new(10, 0, 0)
+#
+#    model.start_operation("Set Page Properties")
+#    page = pages.add("My Page")
+#    page.axes.set(origin, Y_AXIS, X_AXIS, Z_AXIS)
+#    page.camera.fov = 56.78
+#    page.shadow_info["City"] = "Brasov, Romania"
+#    page.rendering_options["BackgroundColor"] = "Pink"
+#    model.commit_operation
+#
 # @version SketchUp 6.0
 class Sketchup::Page < Sketchup::Entity
 
   # Instance Methods
 
+  # The {#active_section_planes} method is used to retrieve the active section
+  # plane for the {Sketchup::Page}.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add('My Page')
+  #   page.active_section_planes
+  #
+  # @return [Array<Sketchup::SectionPlane>, nil] Returns +nil+ if the page does
+  #   not use section planes.
+  #
+  # @version SketchUp 2026.0
+  def active_section_planes
+  end
+
   # The axes method returns the drawing axes for the page.
   #
+  # Since SketchUp 2026.0, modifying the axes of a scene is an undoable operation.
+  #
   # @example
-  #   page = Sketchup.active_model.pages.add("Example Page")
+  #   model = Sketchup.active_model
+  #   page = model.pages.add("Example Page")
   #   xaxis = Geom::Vector3d.new(3, 5, 0)
   #   yaxis = xaxis * Z_AXIS
   #   page.axes.set([10,0,0], xaxis, yaxis, Z_AXIS)
+  #   page.update(PAGE_USE_ALL)
+  #   page.axes
   #
-  # @return Axes - the axes for the page.
+  # @return [Sketchup::Axes]
   #
   # @version SketchUp 2016
   def axes
   end
 
-  # The camera method retrieves the camera for a particular page.
+  # The {#camera} method retrieves the camera for a particular page.
+  #
+  # Since SketchUp 2026.0, modifying the camera properties of a scene is an undoable operation.
   #
   # @example
   #   model = Sketchup.active_model
@@ -33,8 +73,7 @@ class Sketchup::Page < Sketchup::Entity
   #   page = pages.add "My Page"
   #   camera = page.camera
   #
-  # @return camera - a Camera object if successful, nil if the page
-  #   does not save camera information
+  # @return [Sketchup::Camera]
   #
   # @version SketchUp 6.0
   def camera
@@ -114,6 +153,40 @@ class Sketchup::Page < Sketchup::Entity
   def description=(description)
   end
 
+  # The {#environment} method is used to retrieve the {Sketchup::Environment}
+  # for the scene.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add('My Page')
+  #   page.environment
+  #
+  # @return [Sketchup::Environment]
+  #
+  # @version SketchUp 2025.0
+  def environment
+  end
+
+  # The {#environment=} method is used to set the {Sketchup::Environment}
+  # for the scene.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add('My Page')
+  #   path = 'path/to/environment.hdr'
+  #   environment = model.environments.add('My Environment', path)
+  #   page.environment = environment
+  #
+  # @param [Sketchup::Environment] environment
+  #
+  # @return [Sketchup::Environment]
+  #
+  # @version SketchUp 2025.0
+  def environment=(environment)
+  end
+
   # The {#get_drawingelement_visibility} method is used to get the visibility
   # of a drawing element on a particular page.
   #
@@ -126,6 +199,19 @@ class Sketchup::Page < Sketchup::Entity
   #   page = pages.add("My Page")
   #   result = page.get_drawingelement_visibility(constpoint)
   #
+  # @example
+  #   # SketchUp 2020.1 is required
+  #   def element_visible_in_page?(element, page)
+  #     case element
+  #     when Sketchup::ComponentInstance, Sketchup::Group
+  #       return unless page.use_hidden_objects?
+  #     else
+  #       return unless page.use_hidden_geometry?
+  #       return unless element.parent == Sketchup.active_model
+  #     end
+  #     page.get_drawingelement_visibility(element)
+  #   end
+  #
   # @param [Sketchup::Drawingelement] element
   #
   # @return [Boolean] - true if visible, false if not.
@@ -142,8 +228,8 @@ class Sketchup::Page < Sketchup::Entity
   #   page = pages.add "My Page"
   #   entities = page.hidden_entities
   #
-  # @return entities - an Entities object containing hidden
-  #   entities on the page.
+  # @return [Array<Sketchup::Drawingelement>] an array of drawing elements that are
+  #   *hidden* on the page.
   #
   # @version SketchUp 6.0
   def hidden_entities
@@ -248,7 +334,10 @@ class Sketchup::Page < Sketchup::Entity
   def name
   end
 
-  # The name= method sets the name for a page's tab.
+  # The {#name=} method sets the name for a page's tab. If the name is already used by another page,
+  # a unique name is created.
+  #
+  # @bug Prior to SketchUp 2026.0 this method did not make the name unique.
   #
   # @example
   #   model = Sketchup.active_model
@@ -268,13 +357,20 @@ class Sketchup::Page < Sketchup::Entity
   # The rendering_options method retrieves a RenderingOptions object for the
   # page.
   #
+  # Since SketchUp 2026.0, modifying rendering_options of a scene is an undoable operation.
+  #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
-  #   page = pages.add "My Page"
+  #   page = pages.add("My Page")
   #   renderingoptions = page.rendering_options
   #
-  # @return renderingoptions - a RenderingOptions object
+  # @note Most rendering options of a scene are also present in {Sketchup::Style} and are governed by
+  #   the selected style. Those options should not be changed from the scene.
+  #   The ones not related to {Sketchup::Style} like fog (+DisplayFog+,
+  #   +FogColor+) are safe to be changed from the scene.
+  #
+  # @return [Sketchup::RenderingOptions]
   #
   # @version SketchUp 6.0
   def rendering_options
@@ -331,7 +427,9 @@ class Sketchup::Page < Sketchup::Entity
   def set_visibility(arg1, arg2)
   end
 
-  # The shadow_info method retrieves the ShadowInfo object for the page.
+  # The {#shadow_info} method retrieves the ShadowInfo object for the page.
+  #
+  # Since SketchUp 2026.0, modifying shadow_info of a scene is an undoable operation.
   #
   # @example
   #   model = Sketchup.active_model
@@ -339,8 +437,11 @@ class Sketchup::Page < Sketchup::Entity
   #   page = pages.add "My Page"
   #   shadowinfo = page.shadow_info
   #
-  # @return shadowinfo - a ShadowInfo object if successful, nil if
-  #   the page does not save shadow information
+  # @note While certain shadow settings, such as those available in the Shadows panel, can be
+  #   controlled on a per-page basis, global settings like north
+  #   angle, latitude, and longitude are managed at the model level and are not page-specific.
+  #
+  # @return [Sketchup::ShadowInfo]
   #
   # @version SketchUp 6.0
   def shadow_info
@@ -410,6 +511,7 @@ class Sketchup::Page < Sketchup::Entity
   #   PAGE_USE_LAYER_VISIBILITY  # Visible Layers
   #   PAGE_USE_SECTION_PLANES    # Active Section Planes
   #   PAGE_USE_ALL               # All possible scene properties
+  #   PAGE_USE_ENVIRONMENT       # Environment settings
   #
   # @example
   #   model = Sketchup.active_model
@@ -503,6 +605,46 @@ class Sketchup::Page < Sketchup::Entity
   def use_camera?
   end
 
+  # The {#use_environment=} method is used to set if the {Sketchup::Environment}
+  # settings are used in the scene.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add('My Page')
+  #   page.use_environment?
+  #   # => true
+  #   page.use_environment = false
+  #   page.use_environment?
+  #   # => false
+  #
+  # @param [Boolean] use_environment
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2025.0
+  def use_environment=(use_environment)
+  end
+
+  # The {#use_environment?} method is used to determine if the {Sketchup::Environment}
+  # settings are used in the scene.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add('My Page')
+  #   page.use_environment?
+  #   # => true
+  #   page.use_environment = false
+  #   page.use_environment?
+  #   # => false
+  #
+  # @return [Boolean]
+  #
+  # @version SketchUp 2025.0
+  def use_environment?
+  end
+
   # The use_hidden= method sets the page's hidden property.
   #
   # @deprecated The functionality is replaced by {use_hidden_geometry=}

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2024 Trimble Inc.
+# Copyright:: Copyright 2026 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # The Pages class contains methods for manipulating a collection of Pages
@@ -17,16 +17,6 @@ class Sketchup::Pages < Sketchup::Entity
 
   include Enumerable
 
-  # Constants
-
-  ImageEmbedded = nil # Stub value.
-  ImageEmbeddedAndLinked = nil # Stub value.
-  ImageLinked = nil # Stub value.
-
-  UnitsNormalizedX = nil # Stub value.
-  UnitsNormalizedY = nil # Stub value.
-  UnitsPixels = nil # Stub value.
-
   # Class Methods
 
   # The {.add_frame_change_observer} method is used to add a new frame change
@@ -82,11 +72,6 @@ class Sketchup::Pages < Sketchup::Entity
   #   status = pages.add "Page 1"
   #   status = pages.add "Page 2"
   #   page = pages["Page 2"]
-  #   if (page)
-  #     UI.messagebox page
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @param index_or_name
   #   The index or the string name of the specific page.
@@ -103,6 +88,8 @@ class Sketchup::Pages < Sketchup::Entity
   # new Pages. If a name is given, then a new Page with that name is
   # added.
   #
+  # If the name is already used by another page, a unique name is created.
+  #
   # If the flags parameter is given, it controls which properties are saved with
   # the Page. See the {Page#update} method for a description of the flags that
   # can be set.
@@ -110,16 +97,13 @@ class Sketchup::Pages < Sketchup::Entity
   # If index is given, it specifies the position in the page list that the new
   # page is added.  Otherwise the new page is added to the end.
   #
+  # @bug Prior to SketchUp 2026.0 this method didn't make the name unique.
+  #
   # @example
   #   model = Sketchup.active_model
   #   pages = model.pages
   #   status = pages.add "Page 1"
   #   status = pages.add "Page 2"
-  #   if (status)
-  #     UI.messagebox status
-  #   else
-  #     UI.messagebox "Failure"
-  #   end
   #
   # @param [String] name
   #   The name of the specific page.
@@ -270,6 +254,31 @@ class Sketchup::Pages < Sketchup::Entity
   def remove_observer(observer)
   end
 
+  # The {#reorder} method is used to reorder an existing {Sketchup::Page} object inside collection.
+  #
+  # +new_index+ specifies the new position of the page. It should be a value
+  # between +0+ and the max index of the {Sketchup::Pages} collection.
+  # Negative indices can be used to specify an index from the end of the list.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   pages.reorder(model.pages[0], 2)
+  #
+  # @param [Sketchup::Page] page
+  #   The page to be reordered.
+  #
+  # @param [Integer] new_index
+  #   Index of where to replace the page.
+  #
+  # @raise [IndexError] if the given +new_index+ is out of range.
+  #
+  # @return nil
+  #
+  # @version SketchUp 2025.0
+  def reorder(page, new_index)
+  end
+
   # The selected_page method is used to retrieve the currently selected page.
   #
   # @example
@@ -358,4 +367,22 @@ class Sketchup::Pages < Sketchup::Entity
   def slideshow_time
   end
 
+  # The {#unique_name} method is used to generate a unique name for the page based on a base_name
+  # string. For example, a base name of "Joe" might return "Joe 2" if "Joe" already exists.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   pages = model.pages
+  #   page = pages.add('Joe')
+  #   page.unique_name('Joe')
+  #
+  # @param [String] base_name
+  #   The base name to use for the unique name.
+  #
+  # @return [String] The unique name.
+  #
+  # @version SketchUp 2026.0
+  def unique_name(base_name)
+  end
+
 end

data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.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 pages events.