sketchup-api-stubs 0.7.7 → 0.7.8

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

@@ -1,4 +1,4 @@
-# Copyright:: Copyright 2021 Trimble Inc.
+# Copyright:: Copyright 2022 Trimble Inc.
 # License:: The MIT License (MIT)
 
 # References an angular dimension entity. An {Layout::AngularDimension} is
@@ -34,14 +34,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#angle} method returns the {Layout::AngularDimension}'s angle. The angle
   # is represented in radians.
   #
+  # inner_angle) angle = dim.angle
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   angle = dim.angle
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Numeric]
   #
@@ -52,14 +53,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#arc_center_point} method returns the paper space location for the
   # dimension arc center point.
   #
+  # inner_angle) center = dim.arc_center_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   center = dim.arc_center_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d]
   #
@@ -72,14 +74,15 @@ class Layout::AngularDimension < Layout::Entity
   # change. When +false+, the text will display the length measurement and wil
   # update automatically.
   #
+  # inner_angle) dim.custom_text = true
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   dim.custom_text = true
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Boolean] uses_custom_text
   #
@@ -97,15 +100,15 @@ class Layout::AngularDimension < Layout::Entity
   # doesn't change. When +false+, the text will display the length measurement
   # and will update automatically.
   #
+  # inner_angle) # returns false uses_custom_text = dim.custom_text?
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   # returns false
-  #   uses_custom_text = dim.custom_text?
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Boolean]
   #
@@ -116,14 +119,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#end_connection_point} method returns the paper space location for the
   # second connection.
   #
+  # inner_angle) end_connection = dim.end_connection_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   end_connection = dim.end_connection_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d]
   #
@@ -134,14 +138,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#end_connection_point=} method sets the paper space location for the
   # second connection.
   #
+  # inner_angle) dim.end_connection_point = Geom::Point2d.new(6, 6)
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   dim.end_connection_point = Geom::Point2d.new(6, 6)
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Geom::Point2d] end_point
   #
@@ -157,14 +162,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#end_extent_point} method returns the paper space location for the
   # end of the dimension line.
   #
+  # inner_angle) end_ext_point = dim.end_extent_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   end_ext_point = dim.end_extent_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d] end_extent
   #
@@ -175,15 +181,16 @@ class Layout::AngularDimension < Layout::Entity
   # The {#end_extent_point=} method sets the paper space location for the
   # end of the dimension line.
   #
+  # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_extent_point = Geom::Point2d.new(6,
+  # 6)
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   end_ext_point = Geom::Point2d.new(5, 6)
-  #   dim.end_extent_point = Geom::Point2d.new(6, 6)
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Geom::Point2d] end_extent
   #
@@ -200,15 +207,15 @@ class Layout::AngularDimension < Layout::Entity
   # second connection point to the start of the second extension line. The
   # connection and extent points will not move.
   #
+  # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_offset_length = 0.5
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   end_ext_point = Geom::Point2d.new(5, 6)
-  #   dim.end_offset_length = 0.5
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Numeric] offset_length
   #
@@ -225,14 +232,15 @@ class Layout::AngularDimension < Layout::Entity
   # end of the first extension line. The first extension line runs from this
   # offset point to the end extent point.
   #
+  # inner_angle) end_offset = dim.end_offset_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   end_offset = dim.end_offset_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d] end_offset
   #
@@ -246,14 +254,15 @@ class Layout::AngularDimension < Layout::Entity
   # from four to six {Layout::Entity}s: start extension line, end extension line,
   # one or two dimension lines, dimension text, and optionally the leader line.
   #
+  # inner_angle) entites = dim.entities
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   entites = dim.entities
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Layout::Entities]
   #
@@ -264,13 +273,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#initialize} method creates a new disconnected
   # {Layout::AngularDimension}.
   #
+  # inner_angle)
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Geom::Point2d] start_point
   #   Where the {Layout::AngularDimension}
@@ -307,14 +318,15 @@ class Layout::AngularDimension < Layout::Entity
   # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
   # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
   #
+  # inner_angle) type = dim.leader_line_type
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   type = dim.leader_line_type
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Integer]
   #
@@ -331,14 +343,15 @@ class Layout::AngularDimension < Layout::Entity
   # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
   # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
   #
+  # inner_angle) dim.leader_line_type = Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   dim.leader_line_type = Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Integer] type
   #   The leader line type
@@ -357,14 +370,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#radius} method returns the {Layout::AngularDimension}'s radius. This is
   # the distance from the arc center point to the dimension line.
   #
+  # inner_angle) radius = dim.radius
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   radius = dim.radius
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Numeric]
   #
@@ -375,14 +389,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#radius=} method sets the the {Layout::AngularDimension}'s radius. This
   # is the distance from the arc center point to the dimension line.
   #
+  # inner_angle) dim.radius = 2.0
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   dim.radius = 2.0
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Numeric] radius
   #
@@ -400,14 +415,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#start_connection_point} method returns the paper space location for the
   # first connection.
   #
+  # inner_angle) start_connection = dim.start_connection_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   start_connection = dim.start_connection_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d]
   #
@@ -418,14 +434,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#start_connection_point=} method sets the paper space location for the
   # first connection.
   #
+  # inner_angle) dim.start_connection_point = Geom::Point2d.new(2, 2)
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   dim.start_connection_point = Geom::Point2d.new(2, 2)
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Geom::Point2d] start_point
   #
@@ -441,14 +458,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#start_extent_point} method returns the paper space location for the
   # start of the dimension line.
   #
+  # inner_angle) start_ext_point = dim.start_extent_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   start_ext_point = dim.start_extent_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d] start_extent
   #
@@ -459,15 +477,16 @@ class Layout::AngularDimension < Layout::Entity
   # The {#start_extent_point=} method sets the paper space location for the
   # start of the dimension line.
   #
+  # inner_angle) start_ext_point = Geom::Point2d.new(2, 3) dim.start_extent_point =
+  # Geom::Point2d.new(2, 2)
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   start_ext_point = Geom::Point2d.new(2, 3)
-  #   dim.start_extent_point = Geom::Point2d.new(2, 2)
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Geom::Point2d] start_extent
   #
@@ -484,15 +503,15 @@ class Layout::AngularDimension < Layout::Entity
   # first connection point to the start of the first extension line. The
   # connection and extent points will not move.
   #
+  # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.start_offset_length = 0.5
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   end_ext_point = Geom::Point2d.new(5, 6)
-  #   dim.start_offset_length = 0.5
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Numeric] offset_length
   #
@@ -509,14 +528,15 @@ class Layout::AngularDimension < Layout::Entity
   # start of the first extension line. The first extension line runs from this
   # offset point to the start extent point.
   #
+  # inner_angle) start_offset = dim.start_offset_point
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   start_offset = dim.start_offset_point
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @return [Geom::Point2d] start_offset
   #
@@ -527,14 +547,15 @@ class Layout::AngularDimension < Layout::Entity
   # The {#text} method returns a copy of the {Layout::AngularDimension}'s
   # {Layout::FormattedText}.
   #
+  # inner_angle) text = dim.text
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   text = dim.text
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @note With the addition of auto-text in dimensions for LayOut 2019.2, the
   #   copy of the dimension text incorrectly provided the plain text when
@@ -549,15 +570,16 @@ class Layout::AngularDimension < Layout::Entity
   # The {#text=} method sets the {Layout::AngularDimension}'s
   # {Layout::FormattedText}.
   #
+  # inner_angle) anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT dim.text =
+  # Layout::FormattedText.new("Hello LayOut", start_point, anchor_type)
+  #
   # @example
   #   start_point = Geom::Point2d.new(1, 1)
   #   end_point = Geom::Point2d.new(5, 5)
   #   start_extent = Geom::Point2d.new(1, 2)
   #   end_extent = Geom::Point2d.new(5, 6)
   #   inner_angle = true
-  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent, inner_angle)
-  #   anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
-  #   dim.text = Layout::FormattedText.new("Hello LayOut", start_point, anchor_type)
+  #   dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
   #
   # @param [Layout::FormattedText] formatted_text
   #