sketchup-api-stubs 0.7.4 → 0.7.5

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

@@ -1,174 +1,179 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# The AutoTextDefinitions class is a container class for all
-# {Layout::AutoTextDefinition}s in a {Layout::Document}.
-#
-# @example
-#   # Grab a handle to an existing LayOut document's auto text definitions.
-#   doc = Layout::Document.open("C:/path/to/document.layout")
-#   auto_texts = doc.auto_text_definitions
-#
-#   # From here, we can add auto text definitions to or remove them from the
-#   # document.
-#   auto_texts.add("PageNum", Layout::AutoTextDefinition::TYPE_PAGE_NUM)
-#   auto_texts.remove("PageNum")
-#
-# @version LayOut 2018
-class Layout::AutoTextDefinitions
-
-  # Includes
-
-  include Enumerable
-
-  # Instance Methods
-
-  # The {#[]} method returns a value from the array of
-  # {Layout::AutoTextDefinition}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   auto_texts = doc.auto_text_definitions
-  #   auto_text = auto_texts[2]
-  #
-  # @overload [](index)
-  #
-  #   @param [Integer] index The index of the {Layout::AutoTextDefinition} to
-  #     return
-  #   @return [Layout::AutoTextDefinition]
-  #
-  # @overload [](name)
-  #
-  #   @param [String] name The name of the {Layout::AutoTextDefinition} to
-  #     return
-  #   @return [Layout::AutoTextDefinition]
-  #
-  # @raise [IndexError] if index is out of range
-  #
-  # @version LayOut 2018
-  def [](index)
-  end
-
-  # The {#add} method adds an {Layout::AutoTextDefinition} to the
-  # {Layout::Document}.
-  #
-  # The type can be one of the following values:
-  # [+Layout::AutoTextDefinition::TYPE_FILE+]
-  # [+Layout::AutoTextDefinition::TYPE_PAGE_NAME+]
-  # [+Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+]
-  # [+Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_CURRENT+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   doc.auto_text_definitions.add("current date",
-  #      Layout::AutoTextDefinition::TYPE_DATE_CURRENT);
-  #
-  # @param [String] name
-  #
-  # @param [Integer] type
-  #
-  # @raise [ArgumentError] if type is not a valid auto text type, or is mandatory.
-  #
-  # @return [Layout::AutoTextDefinition]
-  #
-  # @version LayOut 2018
-  def add(name, type)
-  end
-
-  # The {#each} method iterates through all of the {Layout::AutoTextDefinition}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   auto_texts = doc.auto_text_definitions
-  #   auto_texts.each { |auto_text|
-  #     puts auto_text.name
-  #   }
-  #
-  # @version LayOut 2018
-  #
-  # @yieldparam [Layout::AutoTextDefinition] auto_text
-  def each
-  end
-
-  # The {#index} method returns the index of the {Layout::AutoTextDefinition},
-  # or +nil+ if it doesn't exist in the {Layout::Document}.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   auto_texts = doc.auto_text_definitions
-  #   index = auto_texts.index(definitions.first) # Returns 0
-  #
-  # @overload index(auto_text)
-  #
-  #   @param [Layout::AutoTextDefinition] auto_text
-  #   @return [Integer, nil]
-  #
-  # @overload index(name)
-  #
-  #   @param [String] name The name of the {Layout::AutoTextDefinition} to get
-  #     the index of
-  #   @return [Integer, nil]
-  #
-  # @version LayOut 2018
-  def index(auto_text)
-  end
-
-  # The {#length} method returns the number of {Layout::AutoTextDefinition}s.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   auto_texts = doc.auto_text_definitions
-  #   num_auto_texts = auto_texts.length
-  #
-  # @return [Integer]
-  #
-  # @version LayOut 2018
-  def length
-  end
-  alias_method :size, :length
-
-  # The {#remove} method removes an {Layout::AutoTextDefinition} from the
-  # {Layout::Document}.
-  #
-  # The {Layout::AutoTextDefinition} must be one of the following types:
-  # [+Layout::AutoTextDefinition::TYPE_FILE+]
-  # [+Layout::AutoTextDefinition::TYPE_PAGE_NAME+]
-  # [+Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+]
-  # [+Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_CURRENT+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
-  # [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   auto_texts = doc.auto_text_definitions
-  #   auto_texts.remove(auto_texts[10], true)
-  #
-  # @overload remove(definition, convert_tags_to_text = true)
-  #
-  #   @param [Layout::AutoTextDefinition] definition
-  #   @param [Boolean] convert_tags_to_text
-  #
-  # @overload remove(name, convert_tags_to_text = true)
-  #
-  #   @param [String] name The name of the {Layout::AutoTextDefinition} to remove
-  #   @param [Boolean] convert_tags_to_text
-  #
-  # @overload remove(index, convert_tags_to_text = true)
-  #
-  #   @param [Integer] index The index of the {Layout::AutoTextDefinition} to
-  #     remove
-  #   @param [Boolean] convert_tags_to_text
-  #
-  # @raise [ArgumentError] if the definition that is being removed is mandatory
-  #
-  # @version LayOut 2018
-  def remove(*args)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# The AutoTextDefinitions class is a container class for all
+# {Layout::AutoTextDefinition}s in a {Layout::Document}.
+#
+# @example
+#   # Grab a handle to an existing LayOut document's auto text definitions.
+#   doc = Layout::Document.open("C:/path/to/document.layout")
+#   auto_texts = doc.auto_text_definitions
+#
+#   # From here, we can add auto text definitions to or remove them from the
+#   # document.
+#   auto_texts.add("PageNum", Layout::AutoTextDefinition::TYPE_PAGE_NUM)
+#   auto_texts.remove("PageNum")
+#
+# @version LayOut 2018
+class Layout::AutoTextDefinitions
+
+  # Includes
+
+  include Enumerable
+
+  # Instance Methods
+
+  # The {#[]} method returns a value from the array of
+  # {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   auto_texts = doc.auto_text_definitions
+  #   auto_text = auto_texts[2]
+  #
+  # @overload [](index)
+  #
+  #   @param [Integer] index The index of the {Layout::AutoTextDefinition} to
+  #     return
+  #   @return [Layout::AutoTextDefinition]
+  #
+  # @overload [](name)
+  #
+  #   @param [String] name The name of the {Layout::AutoTextDefinition} to
+  #     return
+  #   @return [Layout::AutoTextDefinition]
+  #
+  # @raise [IndexError] if index is out of range
+  #
+  # @version LayOut 2018
+  def [](index)
+  end
+
+  # The {#add} method adds an {Layout::AutoTextDefinition} to the
+  # {Layout::Document}.
+  #
+  # The type can be one of the following values:
+  # [+Layout::AutoTextDefinition::TYPE_FILE+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_NAME+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+]
+  # [+Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_CURRENT+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   doc.auto_text_definitions.add("current date",
+  #      Layout::AutoTextDefinition::TYPE_DATE_CURRENT);
+  #
+  # @param [String] name
+  #
+  # @param [Integer] type
+  #
+  # @raise [ArgumentError] if type is not a valid auto text type, or is mandatory.
+  #
+  # @return [Layout::AutoTextDefinition]
+  #
+  # @version LayOut 2018
+  def add(name, type)
+  end
+
+  # The {#each} method iterates through all of the {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   auto_texts = doc.auto_text_definitions
+  #   auto_texts.each { |auto_text|
+  #     puts auto_text.name
+  #   }
+  #
+  # @note Don't remove content from this collection while iterating over it with
+  #   {#each}. This would change the size of the collection and cause elements to
+  #   be skipped as the indices change. Instead copy the current collection to an
+  #   array using +to_a+ and then use +each+ on the array, when removing content.
+  #
+  # @version LayOut 2018
+  #
+  # @yieldparam [Layout::AutoTextDefinition] auto_text
+  def each
+  end
+
+  # The {#index} method returns the index of the {Layout::AutoTextDefinition},
+  # or +nil+ if it doesn't exist in the {Layout::Document}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   auto_texts = doc.auto_text_definitions
+  #   index = auto_texts.index(definitions.first) # Returns 0
+  #
+  # @overload index(auto_text)
+  #
+  #   @param [Layout::AutoTextDefinition] auto_text
+  #   @return [Integer, nil]
+  #
+  # @overload index(name)
+  #
+  #   @param [String] name The name of the {Layout::AutoTextDefinition} to get
+  #     the index of
+  #   @return [Integer, nil]
+  #
+  # @version LayOut 2018
+  def index(auto_text)
+  end
+
+  # The {#length} method returns the number of {Layout::AutoTextDefinition}s.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   auto_texts = doc.auto_text_definitions
+  #   num_auto_texts = auto_texts.length
+  #
+  # @return [Integer]
+  #
+  # @version LayOut 2018
+  def length
+  end
+  alias_method :size, :length
+
+  # The {#remove} method removes an {Layout::AutoTextDefinition} from the
+  # {Layout::Document}.
+  #
+  # The {Layout::AutoTextDefinition} must be one of the following types:
+  # [+Layout::AutoTextDefinition::TYPE_FILE+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_NAME+]
+  # [+Layout::AutoTextDefinition::TYPE_PAGE_NUMBER+]
+  # [+Layout::AutoTextDefinition::TYPE_CUSTOM_TEXT+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_CURRENT+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_CREATED+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_MODIFIED+]
+  # [+Layout::AutoTextDefinition::TYPE_DATE_PUBLISHED+]
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   auto_texts = doc.auto_text_definitions
+  #   auto_texts.remove(auto_texts[10], true)
+  #
+  # @overload remove(definition, convert_tags_to_text = true)
+  #
+  #   @param [Layout::AutoTextDefinition] definition
+  #   @param [Boolean] convert_tags_to_text
+  #
+  # @overload remove(name, convert_tags_to_text = true)
+  #
+  #   @param [String] name The name of the {Layout::AutoTextDefinition} to remove
+  #   @param [Boolean] convert_tags_to_text
+  #
+  # @overload remove(index, convert_tags_to_text = true)
+  #
+  #   @param [Integer] index The index of the {Layout::AutoTextDefinition} to
+  #     remove
+  #   @param [Boolean] convert_tags_to_text
+  #
+  # @raise [ArgumentError] if the definition that is being removed is mandatory
+  #
+  # @version LayOut 2018
+  def remove(*args)
+  end
+
+end

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

@@ -1,70 +1,70 @@
-# Copyright:: Copyright 2020 Trimble Inc.
-# License:: The MIT License (MIT)
-
-# This is the interface to a LayOut Connection Point. A
-# {Layout::ConnectionPoint} defines a target point to which a {Layout::Label}
-# or {Layout::LinearDimension} can connect.
-#
-# @example
-#   doc = Layout::Document.open("C:/path/to/document.layout")
-#   entity = doc.pages.first.entities.first
-#   point = [2, 2]
-#   # Create a Connection Point to LayOut Entity in the document
-#   cp = Layout::ConnectionPoint.new(entity, point)
-#   # If the entity is a [Layout::SketchUpModel], then we can use a 3D point
-#   # in model space along with the PID of the entity in the model to make a
-#   # deep connection.
-#   point3D = [100, 200, 300]
-#   pid = "1345"
-#   cp2 = Layout::ConnectionPoint.new(entity, point3D, pid)
-#   # This point can then be used to connect a label or linear dimension to
-#   # the entity.
-#   leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
-#   target_point = Geom::Point2d.new(1, 1)
-#   bounds = Geom::Bounds2d.new(2, 1, 1, 1)
-#   label = Layout::Label.new(text, leader_type, target_point, bounds)
-#   label.connect(cp)
-#
-# @version LayOut 2018
-class Layout::ConnectionPoint
-
-  # Instance Methods
-
-  # The {#initialize} method creates a new {Layout::ConnectionPoint}.
-  #
-  # @example
-  #   doc = Layout::Document.open("C:/path/to/document.layout")
-  #   entity = doc.pages.first.entities.first
-  #   point = [2, 2]
-  #   # Create a Connection Point to LayOut Entity in the document
-  #   cp = Layout::ConnectionPoint.new(entity, point)
-  #
-  # @overload initialize(entity, point, aperture = 0.0001)
-  #
-  #   @param [Layout::Entity] entity
-  #   @param [Geom::Point2d] point The position on the entity to connect to.
-  #   @param [Numeric] aperture The search radius to find the entity provided. If
-  #     no aperture value is provided, a default value of 0.0001 will be used.
-  #     The value provided must be greater than zero.
-  #   @return [Layout::ConnectionPoint]
-  #
-  #   @raise [ArgumentError] if point passed in is not within the bounds of entity
-  #   @raise [ArgumentError] if aperture is not greater than zero
-  #   @raise [ArgumentError] if entity is not in a document
-  #
-  # @overload initialize(model, point3d, pid = nil)
-  #
-  #   @param [Layout::SketchUpModel] model
-  #   @param [Geom::Point3d] point3d The 3D point in model space to connect to.
-  #   @param [String, nil] pid The persistent ID of the entity to connect to in
-  #     the model, if any.
-  #   @return [Layout::ConnectionPoint]
-  #
-  #   @raise [ArgumentError] if entity is not in a document
-  #   @raise [ArgumentError] if the provided pid does not exist in the model
-  #
-  # @version LayOut 2018
-  def initialize(*args)
-  end
-
-end
+# Copyright:: Copyright 2020 Trimble Inc.
+# License:: The MIT License (MIT)
+
+# This is the interface to a LayOut Connection Point. A
+# {Layout::ConnectionPoint} defines a target point to which a {Layout::Label}
+# or {Layout::LinearDimension} can connect.
+#
+# @example
+#   doc = Layout::Document.open("C:/path/to/document.layout")
+#   entity = doc.pages.first.entities.first
+#   point = [2, 2]
+#   # Create a Connection Point to LayOut Entity in the document
+#   cp = Layout::ConnectionPoint.new(entity, point)
+#   # If the entity is a [Layout::SketchUpModel], then we can use a 3D point
+#   # in model space along with the PID of the entity in the model to make a
+#   # deep connection.
+#   point3D = [100, 200, 300]
+#   pid = "1345"
+#   cp2 = Layout::ConnectionPoint.new(entity, point3D, pid)
+#   # This point can then be used to connect a label or linear dimension to
+#   # the entity.
+#   leader_type = Layout::Label::LEADER_LINE_TYPE_BEZIER
+#   target_point = Geom::Point2d.new(1, 1)
+#   bounds = Geom::Bounds2d.new(2, 1, 1, 1)
+#   label = Layout::Label.new(text, leader_type, target_point, bounds)
+#   label.connect(cp)
+#
+# @version LayOut 2018
+class Layout::ConnectionPoint
+
+  # Instance Methods
+
+  # The {#initialize} method creates a new {Layout::ConnectionPoint}.
+  #
+  # @example
+  #   doc = Layout::Document.open("C:/path/to/document.layout")
+  #   entity = doc.pages.first.entities.first
+  #   point = [2, 2]
+  #   # Create a Connection Point to LayOut Entity in the document
+  #   cp = Layout::ConnectionPoint.new(entity, point)
+  #
+  # @overload initialize(entity, point, aperture = 0.0001)
+  #
+  #   @param [Layout::Entity] entity
+  #   @param [Geom::Point2d] point The position on the entity to connect to.
+  #   @param [Numeric] aperture The search radius to find the entity provided. If
+  #     no aperture value is provided, a default value of 0.0001 will be used.
+  #     The value provided must be greater than zero.
+  #   @return [Layout::ConnectionPoint]
+  #
+  #   @raise [ArgumentError] if point passed in is not within the bounds of entity
+  #   @raise [ArgumentError] if aperture is not greater than zero
+  #   @raise [ArgumentError] if entity is not in a document
+  #
+  # @overload initialize(model, point3d, pid = nil)
+  #
+  #   @param [Layout::SketchUpModel] model
+  #   @param [Geom::Point3d] point3d The 3D point in model space to connect to.
+  #   @param [String, nil] pid The persistent ID of the entity to connect to in
+  #     the model, if any.
+  #   @return [Layout::ConnectionPoint]
+  #
+  #   @raise [ArgumentError] if entity is not in a document
+  #   @raise [ArgumentError] if the provided pid does not exist in the model
+  #
+  # @version LayOut 2018
+  def initialize(*args)
+  end
+
+end