sketchup-api-stubs 0.7.9 → 0.7.11

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

@@ -1,40 +1,40 @@
-# Copyright:: Copyright 2023 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The {Sketchup::Skp} module is used to read metadata from external SketchUp
-# files without loading the whole file.
-#
-# @version SketchUp 2021.0
-module Sketchup::Skp
-
-  # Class Methods
-
-  # The {.read_guid} method is used to read the GUID, globally unique identifier,
-  # for an external model.
-  #
-  # In SketchUp, GUIDs are used to test if {Sketchup::ComponentDefinition}s and
-  # {Sketchup::Model}s match (a component being an embedded model).
-  # When you insert a component to a model, its GUID is compared to existing
-  # component definitions in that model, and if there is a match the existing
-  # component definition is re-used rather than a duplicate being added.
-  # When a component definition is modified or a model is saved, their GUIDs are
-  # renewed.
-  #
-  # @example
-  #   model = Sketchup.active_model
-  #   definitions = model.definitions
-  #   definition = definitions.find { |definition| !definition.internal? }
-  #   # true if component matches its external file.
-  #   definition.guid == Sketchup::Skp.read_guid(definition.path)
-  #
-  # @param [String] filepath
-  #
-  # @raise [ArgumentError] if the file is missing or is not a SketchUp model.
-  #
-  # @return [String]
-  #
-  # @version SketchUp 2021.0
-  def self.read_guid(filepath)
-  end
-
-end
+# Copyright:: Copyright 2026 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The {Sketchup::Skp} module is used to read metadata from external SketchUp
+# files without loading the whole file.
+#
+# @version SketchUp 2021.0
+module Sketchup::Skp
+
+  # Class Methods
+
+  # The {.read_guid} method is used to read the GUID, globally unique identifier,
+  # for an external model.
+  #
+  # In SketchUp, GUIDs are used to test if {Sketchup::ComponentDefinition}s and
+  # {Sketchup::Model}s match (a component being an embedded model).
+  # When you insert a component to a model, its GUID is compared to existing
+  # component definitions in that model, and if there is a match the existing
+  # component definition is re-used rather than a duplicate being added.
+  # When a component definition is modified or a model is saved, their GUIDs are
+  # renewed.
+  #
+  # @example
+  #   model = Sketchup.active_model
+  #   definitions = model.definitions
+  #   definition = definitions.find { |definition| !definition.internal? }
+  #   # true if component matches its external file.
+  #   definition.guid == Sketchup::Skp.read_guid(definition.path)
+  #
+  # @param [String] filepath
+  #
+  # @raise [ArgumentError] if the file is missing or is not a SketchUp model.
+  #
+  # @return [String]
+  #
+  # @version SketchUp 2021.0
+  def self.read_guid(filepath)
+  end
+
+end

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,69 +1,88 @@
-# Copyright:: Copyright 2023 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.
-#
-# @example
-#   styles = Sketchup.active_model.styles
-#   puts "Your first style is named #{styles.first.name}"
-#
-# @version SketchUp 6.0
-class Sketchup::Style < Sketchup::Entity
-
-  # Instance Methods
-
-  # The {#description} method gets the description for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   puts "Your first style description is: #{style.description}"
-  #
-  # @return [String] description
-  #
-  # @version SketchUp 6.0
-  def description
-  end
-
-  # The {#description=} method sets the description for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   style.description = "My new style description."
-  #
-  # @param [String] description
-  #
-  # @version SketchUp 6.0
-  def description=(description)
-  end
-
-  # The {#name} method gets the name for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   name = style.name
-  #
-  # @return [String]
-  #
-  # @version SketchUp 6.0
-  def name
-  end
-
-  # The {#name=} method sets the name for a {Sketchup::Style}.
-  #
-  # @example
-  #   styles = Sketchup.active_model.styles
-  #   style = styles.first
-  #   style.name = 'My Very Own Style'
-  #
-  # @param [String] name
-  #
-  # @version SketchUp 6.0
-  def name=(name)
-  end
-
-end
+# 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}"
+#
+# @version SketchUp 6.0
+class Sketchup::Style < Sketchup::Entity
+
+  # Instance Methods
+
+  # The {#description} method gets the description for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   puts "Your first style description is: #{style.description}"
+  #
+  # @return [String] description
+  #
+  # @version SketchUp 6.0
+  def description
+  end
+
+  # The {#description=} method sets the description for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   style.description = "My new style description."
+  #
+  # @param [String] description
+  #
+  # @version SketchUp 6.0
+  def description=(description)
+  end
+
+  # The {#name} method gets the name for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   name = style.name
+  #
+  # @return [String]
+  #
+  # @version SketchUp 6.0
+  def name
+  end
+
+  # The {#name=} method sets the name for a {Sketchup::Style}.
+  #
+  # @example
+  #   styles = Sketchup.active_model.styles
+  #   style = styles.first
+  #   style.name = 'My Very Own Style'
+  #
+  # @param [String] name
+  #
+  # @version SketchUp 6.0
+  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