sketchup-api-stubs 0.7.7 → 0.7.9

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

@@ -1,48 +1,48 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The +Sketchup::Licensing+ module contains methods for
-# extensions purchased from Extension Warehouse to check their licensing status.
-#
-# It is advised to place these calls inside encrypted Ruby (.rbe) files. This
-# API is also exposed via the SketchUp C API. Extensions that already use
-# native code should prefer using the native API, which should be more secure
-# than their Ruby API counterparts.
-#
-# For more details, see:
-# {Licensing Example}[https://github.com/SketchUp/sketchup-ruby-api-tutorials/tree/master/examples/99_license]
-#
-# @version SketchUp 2015
-module Sketchup::Licensing
-
-  # Constants
-
-  EXPIRED = nil # Stub value.
-  LICENSED = nil # Stub value.
-  NOT_LICENSED = nil # Stub value.
-  TRIAL = nil # Stub value.
-  TRIAL_EXPIRED = nil # Stub value.
-
-  # Class Methods
-
-  # Acquires a license for a given extension.
-  #
-  # @example
-  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
-  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
-  #   if ext_lic.licensed?
-  #      puts "Extension is licensed."
-  #   end
-  #
-  # @param [String] extension_id
-  #   The Extension Warehouse UUID for the desired extension.
-  #
-  # @return [ExtensionLicense] An object representing
-  #   licensing state for the extension. Do not store this object, retrieve
-  #   it again when needed since licensing state may have changed.
-  #
-  # @version SketchUp 2015
-  def self.get_extension_license(extension_id)
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The +Sketchup::Licensing+ module contains methods for
+# extensions purchased from Extension Warehouse to check their licensing status.
+#
+# It is advised to place these calls inside encrypted Ruby (.rbe) files. This
+# API is also exposed via the SketchUp C API. Extensions that already use
+# native code should prefer using the native API, which should be more secure
+# than their Ruby API counterparts.
+#
+# For more details, see
+# {Licensing Example}[https://github.com/SketchUp/sketchup-ruby-api-tutorials/tree/main/examples/99_license]
+#
+# @version SketchUp 2015
+module Sketchup::Licensing
+
+  # Constants
+
+  EXPIRED = nil # Stub value.
+  LICENSED = nil # Stub value.
+  NOT_LICENSED = nil # Stub value.
+  TRIAL = nil # Stub value.
+  TRIAL_EXPIRED = nil # Stub value.
+
+  # Class Methods
+
+  # Acquires a license for a given extension.
+  #
+  # @example
+  #   ext_id = "4e215280-dd23-40c4-babb-b8a8dd29d5ee"
+  #   ext_lic = Sketchup::Licensing.get_extension_license(ext_id)
+  #   if ext_lic.licensed?
+  #      puts "Extension is licensed."
+  #   end
+  #
+  # @param [String] extension_id
+  #   The Extension Warehouse UUID for the desired extension.
+  #
+  # @return [Sketchup::Licensing::ExtensionLicense] An object representing
+  #   licensing state for the extension. Do not store this object, retrieve
+  #   it again when needed since licensing state may have changed.
+  #
+  # @version SketchUp 2015
+  def self.get_extension_license(extension_id)
+  end
+
+end

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

@@ -1,24 +1,24 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This provides a way for SketchUp to customize a line style and be set on a
-# layer.
-#
-# @version SketchUp 2019
-class Sketchup::LineStyle < Sketchup::Entity
-
-  # Instance Methods
-
-  # The {#name} method retrieves the name of the line style object.
-  #
-  # @example
-  #   line_style = Sketchup.active_model.line_styles["Solid Basic"]
-  #   line_style.name # returns "Solid Basic"
-  #
-  # @return [String] The name of the line style.
-  #
-  # @version SketchUp 2019
-  def name
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This provides a way for SketchUp to customize a line style and be set on a
+# layer.
+#
+# @version SketchUp 2019
+class Sketchup::LineStyle < Sketchup::Entity
+
+  # Instance Methods
+
+  # The {#name} method retrieves the name of the line style object.
+  #
+  # @example
+  #   line_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style.name # returns "Solid Basic"
+  #
+  # @return [String] The name of the line style.
+  #
+  # @version SketchUp 2019
+  def name
+  end
+
+end

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

@@ -1,112 +1,114 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# Provides access to the different line style objects in the model.
-#
-# @version SketchUp 2019
-class Sketchup::LineStyles < Sketchup::Entity
-
-  # Includes
-
-  include Enumerable
-
-  # Instance Methods
-
-  # The {#[]} method lets you retrieve a line style by name or index.
-  #
-  # The {#at} method is an alias of {#[]}.
-  #
-  # @example
-  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
-  #   line_style = Sketchup.active_model.line_styles[1]
-  #
-  # @overload [](name)
-  #
-  #   @param [String] name The name of the line style to retrieve.
-  #
-  # @overload [](index)
-  #
-  #   @param [Index] index The index of the line style to retrieve.
-  #
-  #   @raise [IndexError] If index is out of bounds.
-  #
-  # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
-  #   couldn't be retrived.
-  #
-  # @version SketchUp 2019
-  def [](arg)
-  end
-
-  # The {#[]} method lets you retrieve a line style by name or index.
-  #
-  # The {#at} method is an alias of {#[]}.
-  #
-  # @example
-  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
-  #   line_style = Sketchup.active_model.line_styles[1]
-  #
-  # @overload [](name)
-  #
-  #   @param [String] name The name of the line style to retrieve.
-  #
-  # @overload [](index)
-  #
-  #   @param [Index] index The index of the line style to retrieve.
-  #
-  #   @raise [IndexError] If index is out of bounds.
-  #
-  # @return [Sketchup::LineStyle, nil] The line style retrieved. Nil if the name
-  #   couldn't be retrived.
-  #
-  # @version SketchUp 2019
-  def at(arg)
-  end
-
-  # The {#each} method is used to iterate through all the line styles.
-  #
-  # @example
-  #   line_styles = Sketchup.active_model.line_styles
-  #   line_styles.each{ |line_style| p line_style.name }
-  #
-  # @return [nil]
-  #
-  # @version SketchUp 2019
-  def each
-  end
-
-  # The {#names} method return the support line styles as strings.
-  #
-  # @example
-  #   Sketchup.active_model.line_styles.names
-  #
-  # @return [Array<String>]
-  #
-  # @version SketchUp 2019
-  def names
-  end
-
-  # The {#size} method returns the number of line styles that SketchUp supports.
-  #
-  # @example
-  #   line_styles = Sketchup.active_model.line_styles
-  #   line_styles.size
-  #
-  # @return [Integer] The count of line styles.
-  #
-  # @version SketchUp 2019
-  def size
-  end
-  alias_method :length, :size
-
-  # The {#to_a} method returns an array of all the line styles.
-  #
-  # @example
-  #   line_styles = Sketchup.active_active_model.line_styles.to_a
-  #
-  # @return [Array] Containing all the line style objects.
-  #
-  # @version SketchUp 2019
-  def to_a
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# Provides access to the different line style objects in the model.
+#
+# @version SketchUp 2019
+class Sketchup::LineStyles < Sketchup::Entity
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method lets you retrieve a line style by name or index.
+  #
+  # The {#at} method is an alias of {#[]}.
+  #
+  # @example
+  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style = Sketchup.active_model.line_styles[1]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the line style to retrieve.
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index of the line style to retrieve.
+  #
+  #   @raise [IndexError] If index is out of bounds.
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved. +nil+ if the name
+  #   couldn't be retrieved.
+  #
+  # @version SketchUp 2019
+  def [](arg)
+  end
+
+  # The {#[]} method lets you retrieve a line style by name or index.
+  #
+  # The {#at} method is an alias of {#[]}.
+  #
+  # @example
+  #   solid_style = Sketchup.active_model.line_styles["Solid Basic"]
+  #   line_style = Sketchup.active_model.line_styles[1]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the line style to retrieve.
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index of the line style to retrieve.
+  #
+  #   @raise [IndexError] If index is out of bounds.
+  #
+  # @return [Sketchup::LineStyle, nil] The line style retrieved. +nil+ if the name
+  #   couldn't be retrieved.
+  #
+  # @version SketchUp 2019
+  def at(arg)
+  end
+
+  # The {#each} method is used to iterate through all the line styles.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.each{ |line_style| p line_style.name }
+  #
+  # @return [nil]
+  #
+  # @version SketchUp 2019
+  #
+  # @yieldparam [Sketchup::LineStyle] linestyle
+  def each
+  end
+
+  # The {#names} method return the support line styles as strings.
+  #
+  # @example
+  #   Sketchup.active_model.line_styles.names
+  #
+  # @return [Array<String>]
+  #
+  # @version SketchUp 2019
+  def names
+  end
+
+  # The {#size} method returns the number of line styles that SketchUp supports.
+  #
+  # @example
+  #   line_styles = Sketchup.active_model.line_styles
+  #   line_styles.size
+  #
+  # @return [Integer] The count of line styles.
+  #
+  # @version SketchUp 2019
+  def size
+  end
+  alias_method :length, :size
+
+  # The {#to_a} method returns an array of all the line styles.
+  #
+  # @example
+  #   line_styles = Sketchup.active_active_model.line_styles.to_a
+  #
+  # @return [Array] Containing all the line style objects.
+  #
+  # @version SketchUp 2019
+  def to_a
+  end
+
+end

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

@@ -1,137 +1,137 @@
-# Copyright:: Copyright 2021 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# Loop is a low level topology class that will not need to be used often. A
-# Loop is a chain of Edges that bound a Face.
-#
-# @version SketchUp 6.0
-class Sketchup::Loop < Sketchup::Entity
-
-  # Instance Methods
-
-  # Determine if the loop is convex.
-  #
-  # @example
-  #   entities = Sketchup.active_model.active_entities
-  #   points = []
-  #   points << Geom::Point3d.new(0, 0, 0)
-  #   points << Geom::Point3d.new(100, 0, 0)
-  #   points << Geom::Point3d.new(100, 200, 0)
-  #   points << Geom::Point3d.new(0, 200, 0)
-  #   face = entities.add_face(points)
-  #   loop = face.outer_loop
-  #   if loop.convex?
-  #     puts "Loop is convex."
-  #   else
-  #     puts "Loop is not convex."
-  #   end
-  #
-  # @return [Boolean] status - true if convex, false if not convex.
-  #
-  # @version SketchUp 6.0
-  def convex?
-  end
-
-  # Get an array of the edges that define the loop in an ordered sequence.
-  #
-  # @example
-  #   entities = Sketchup.active_model.active_entities
-  #   points = []
-  #   points << Geom::Point3d.new(0, 0, 0)
-  #   points << Geom::Point3d.new(100, 0, 0)
-  #   points << Geom::Point3d.new(100, 200, 0)
-  #   points << Geom::Point3d.new(0, 200, 0)
-  #   face = entities.add_face(points)
-  #   loop = face.outer_loop
-  #   edges = loop.edges
-  #
-  # @return edges - an array of Edge objects if successful.
-  #
-  # @version SketchUp 6.0
-  def edges
-  end
-
-  # Get an array of the EdgeUse objects that define this loop in an ordered
-  # sequence.
-  #
-  # @example
-  #   entities = Sketchup.active_model.active_entities
-  #   points = []
-  #   points << Geom::Point3d.new(0, 0, 0)
-  #   points << Geom::Point3d.new(100, 0, 0)
-  #   points << Geom::Point3d.new(100, 200, 0)
-  #   points << Geom::Point3d.new(0, 200, 0)
-  #   face = entities.add_face(points)
-  #   loop = face.outer_loop
-  #   edgeuses = loop.edgeuses
-  #
-  # @return edgeuses - an array of EdgeUse objects if successful.
-  #
-  # @version SketchUp 6.0
-  def edgeuses
-  end
-
-  # Get the Face object that is bounded by this loop.
-  #
-  # @example
-  #   entities = Sketchup.active_model.active_entities
-  #   points = []
-  #   points << Geom::Point3d.new(0, 0, 0)
-  #   points << Geom::Point3d.new(100, 0, 0)
-  #   points << Geom::Point3d.new(100, 200, 0)
-  #   points << Geom::Point3d.new(0, 200, 0)
-  #   face = entities.add_face(points)
-  #   loop = face.outer_loop
-  #   loop_face = loop.face
-  #
-  # @return face - a Face object if successful
-  #
-  # @version SketchUp 6.0
-  def face
-  end
-
-  # Determine if this is an outer loop. Each face has one outer loop, and will
-  # have one loop for each hole.
-  #
-  # @example
-  #   entities = Sketchup.active_model.active_entities
-  #   points = []
-  #   points << Geom::Point3d.new(0, 0, 0)
-  #   points << Geom::Point3d.new(100, 0, 0)
-  #   points << Geom::Point3d.new(100, 200, 0)
-  #   points << Geom::Point3d.new(0, 200, 0)
-  #   face = entities.add_face(points)
-  #   loop = face.outer_loop
-  #   if loop.outer?
-  #     puts "Loop is an outer loop."
-  #   else
-  #     puts "Loop is not an outer loop."
-  #   end
-  #
-  # @return [Boolean] status - true if the loop is an outer loop, false if it
-  #   is not an outer loop.
-  #
-  # @version SketchUp 6.0
-  def outer?
-  end
-
-  # Get an array of the vertices that define the loop in an ordered sequence.
-  #
-  # @example
-  #   entities = Sketchup.active_model.active_entities
-  #   points = []
-  #   points << Geom::Point3d.new(0, 0, 0)
-  #   points << Geom::Point3d.new(100, 0, 0)
-  #   points << Geom::Point3d.new(100, 200, 0)
-  #   points << Geom::Point3d.new(0, 200, 0)
-  #   face = entities.add_face(points)
-  #   loop = face.outer_loop
-  #   vertices = loop.vertices
-  #
-  # @return vertices - an array of Vertex objects if successful.
-  #
-  # @version SketchUp 6.0
-  def vertices
-  end
-
-end
+# Copyright:: Copyright 2023 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# Loop is a low level topology class that will not need to be used often. A
+# Loop is a chain of Edges that bound a Face.
+#
+# @version SketchUp 6.0
+class Sketchup::Loop < Sketchup::Entity
+
+  # Instance Methods
+
+  # Determine if the loop is convex.
+  #
+  # @example
+  #   entities = Sketchup.active_model.active_entities
+  #   points = []
+  #   points << Geom::Point3d.new(0, 0, 0)
+  #   points << Geom::Point3d.new(100, 0, 0)
+  #   points << Geom::Point3d.new(100, 200, 0)
+  #   points << Geom::Point3d.new(0, 200, 0)
+  #   face = entities.add_face(points)
+  #   loop = face.outer_loop
+  #   if loop.convex?
+  #     puts "Loop is convex."
+  #   else
+  #     puts "Loop is not convex."
+  #   end
+  #
+  # @return [Boolean] status - true if convex, false if not convex.
+  #
+  # @version SketchUp 6.0
+  def convex?
+  end
+
+  # Get an array of the edges that define the loop in an ordered sequence.
+  #
+  # @example
+  #   entities = Sketchup.active_model.active_entities
+  #   points = []
+  #   points << Geom::Point3d.new(0, 0, 0)
+  #   points << Geom::Point3d.new(100, 0, 0)
+  #   points << Geom::Point3d.new(100, 200, 0)
+  #   points << Geom::Point3d.new(0, 200, 0)
+  #   face = entities.add_face(points)
+  #   loop = face.outer_loop
+  #   edges = loop.edges
+  #
+  # @return edges - an array of Edge objects if successful.
+  #
+  # @version SketchUp 6.0
+  def edges
+  end
+
+  # Get an array of the EdgeUse objects that define this loop in an ordered
+  # sequence.
+  #
+  # @example
+  #   entities = Sketchup.active_model.active_entities
+  #   points = []
+  #   points << Geom::Point3d.new(0, 0, 0)
+  #   points << Geom::Point3d.new(100, 0, 0)
+  #   points << Geom::Point3d.new(100, 200, 0)
+  #   points << Geom::Point3d.new(0, 200, 0)
+  #   face = entities.add_face(points)
+  #   loop = face.outer_loop
+  #   edgeuses = loop.edgeuses
+  #
+  # @return edgeuses - an array of EdgeUse objects if successful.
+  #
+  # @version SketchUp 6.0
+  def edgeuses
+  end
+
+  # Get the Face object that is bounded by this loop.
+  #
+  # @example
+  #   entities = Sketchup.active_model.active_entities
+  #   points = []
+  #   points << Geom::Point3d.new(0, 0, 0)
+  #   points << Geom::Point3d.new(100, 0, 0)
+  #   points << Geom::Point3d.new(100, 200, 0)
+  #   points << Geom::Point3d.new(0, 200, 0)
+  #   face = entities.add_face(points)
+  #   loop = face.outer_loop
+  #   loop_face = loop.face
+  #
+  # @return face - a Face object if successful
+  #
+  # @version SketchUp 6.0
+  def face
+  end
+
+  # Determine if this is an outer loop. Each face has one outer loop, and will
+  # have one loop for each hole.
+  #
+  # @example
+  #   entities = Sketchup.active_model.active_entities
+  #   points = []
+  #   points << Geom::Point3d.new(0, 0, 0)
+  #   points << Geom::Point3d.new(100, 0, 0)
+  #   points << Geom::Point3d.new(100, 200, 0)
+  #   points << Geom::Point3d.new(0, 200, 0)
+  #   face = entities.add_face(points)
+  #   loop = face.outer_loop
+  #   if loop.outer?
+  #     puts "Loop is an outer loop."
+  #   else
+  #     puts "Loop is not an outer loop."
+  #   end
+  #
+  # @return [Boolean] status - true if the loop is an outer loop, false if it
+  #   is not an outer loop.
+  #
+  # @version SketchUp 6.0
+  def outer?
+  end
+
+  # Get an array of the vertices that define the loop in an ordered sequence.
+  #
+  # @example
+  #   entities = Sketchup.active_model.active_entities
+  #   points = []
+  #   points << Geom::Point3d.new(0, 0, 0)
+  #   points << Geom::Point3d.new(100, 0, 0)
+  #   points << Geom::Point3d.new(100, 200, 0)
+  #   points << Geom::Point3d.new(0, 200, 0)
+  #   face = entities.add_face(points)
+  #   loop = face.outer_loop
+  #   vertices = loop.vertices
+  #
+  # @return vertices - an array of Vertex objects if successful.
+  #
+  # @version SketchUp 6.0
+  def vertices
+  end
+
+end