sketchup-api-stubs 0.7.11 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +6 -0
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +4 -0
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +35 -11
  5. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +1 -1
  6. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +9 -5
  7. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +5 -0
  8. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +10 -0
  9. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +5 -2
  10. data/lib/sketchup-api-stubs/stubs/Geom.rb +2 -0
  11. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +4 -4
  12. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +53 -51
  13. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +2 -1
  14. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +1 -1
  15. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +6 -8
  16. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +50 -0
  17. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +8 -10
  18. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +1 -1
  19. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +8 -10
  20. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +6 -9
  21. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1 -1
  22. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +17 -0
  23. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +109 -21
  24. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +17 -11
  25. data/lib/sketchup-api-stubs/stubs/Sketchup/CRSLocation.rb +402 -0
  26. data/lib/sketchup-api-stubs/stubs/Sketchup/CRSMapUnit.rb +83 -0
  27. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +220 -8
  28. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +85 -16
  29. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +11 -9
  30. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +5 -1
  31. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +6 -6
  32. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +19 -11
  33. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +8 -9
  34. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +181 -33
  35. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +0 -5
  36. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +8 -1
  37. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +0 -5
  38. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +14 -12
  39. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +100 -19
  40. data/lib/sketchup-api-stubs/stubs/Sketchup/HatchPattern.rb +277 -0
  41. data/lib/sketchup-api-stubs/stubs/Sketchup/HatchPatternData.rb +245 -0
  42. data/lib/sketchup-api-stubs/stubs/Sketchup/HatchPatterns.rb +155 -0
  43. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +2 -2
  44. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +144 -0
  45. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +6 -0
  46. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +13 -1
  47. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +2 -4
  48. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +66 -3
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +4 -4
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +112 -25
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +130 -4
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +0 -1
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +95 -83
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +11 -11
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/Procedure.rb +452 -0
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +29 -3
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +30 -0
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +15 -13
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +16 -0
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +74 -0
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +49 -8
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +25 -12
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +78 -22
  64. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +55 -4
  65. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +73 -59
  66. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +119 -164
  67. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +50 -9
  68. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +4 -1
  69. data/lib/sketchup-api-stubs/stubs/UI.rb +15 -8
  70. data/lib/sketchup-api-stubs/stubs/_top_level.rb +8 -0
  71. metadata +9 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: ce48bf908bfd9e91aae631e26262a1c873fb9bfe1f69398f324eca2fbed29997
4
- data.tar.gz: 99704ab5d21b6eeaf4b90bd149ea79f30a4ad83180b964b396cacd9c0430cd75
3
+ metadata.gz: 2a1f59db6d7daa411dba70d960a0a4f90875d20270149d146ccbaea2e76599b2
4
+ data.tar.gz: 2b6d835637499f4a750550a98aeea1e733eef8b70626abce5689e7257927ea5f
5
5
  SHA512:
6
- metadata.gz: e4355b2185598fe0b3b164a0e1df5d2c74d0ad9cf2c9ada54eed6d30a16bac04fde6cfe0905396e78d1b51be51c2c13d387d8d25f26611406f4eeb263326c367
7
- data.tar.gz: 1b23aa71bbe0cf30b6d39ce68a851a2ce1baaac29ab75b0119ba0d9aec451553cdc53db886fbe92647baac6660e0202ac6760806f9121a0b04b18f07c251085a
6
+ metadata.gz: afa64cbb9405db40aadaa3f02b7f90ad9deff2f9d1f647db56b4e970f39037752341b27902f9ce6d99bbaed266570954f46217c9e3c1b617b73d928f407a3fd0
7
+ data.tar.gz: 99884e34791050bd696767e83798d6bfca17e0583fdb8dfb9e0e007430674ca3e1f242b2c9005a079b05eb85cf710cef2e408a1f6b63a359aee6914c33966424
@@ -60,6 +60,8 @@ require 'sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb'
60
60
  require 'sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb'
61
61
  require 'sketchup-api-stubs/stubs/Sketchup/Axes.rb'
62
62
  require 'sketchup-api-stubs/stubs/Sketchup/Behavior.rb'
63
+ require 'sketchup-api-stubs/stubs/Sketchup/CRSLocation.rb'
64
+ require 'sketchup-api-stubs/stubs/Sketchup/CRSMapUnit.rb'
63
65
  require 'sketchup-api-stubs/stubs/Sketchup/Camera.rb'
64
66
  require 'sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb'
65
67
  require 'sketchup-api-stubs/stubs/Sketchup/Classifications.rb'
@@ -90,6 +92,9 @@ require 'sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb'
90
92
  require 'sketchup-api-stubs/stubs/Sketchup/Face.rb'
91
93
  require 'sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb'
92
94
  require 'sketchup-api-stubs/stubs/Sketchup/Group.rb'
95
+ require 'sketchup-api-stubs/stubs/Sketchup/HatchPattern.rb'
96
+ require 'sketchup-api-stubs/stubs/Sketchup/HatchPatternData.rb'
97
+ require 'sketchup-api-stubs/stubs/Sketchup/HatchPatterns.rb'
93
98
  require 'sketchup-api-stubs/stubs/Sketchup/Http.rb'
94
99
  require 'sketchup-api-stubs/stubs/Sketchup/Http/Request.rb'
95
100
  require 'sketchup-api-stubs/stubs/Sketchup/Http/Response.rb'
@@ -124,6 +129,7 @@ require 'sketchup-api-stubs/stubs/Sketchup/Page.rb'
124
129
  require 'sketchup-api-stubs/stubs/Sketchup/Pages.rb'
125
130
  require 'sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb'
126
131
  require 'sketchup-api-stubs/stubs/Sketchup/PickHelper.rb'
132
+ require 'sketchup-api-stubs/stubs/Sketchup/Procedure.rb'
127
133
  require 'sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb'
128
134
  require 'sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb'
129
135
  require 'sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb'
@@ -28,6 +28,10 @@
28
28
  # transformation = Geom::Transformation.new(array)
29
29
  # entities.transform_entities(transformation, construction_point)
30
30
  #
31
+ # @note When a translational {Geom::Transformation} is expected, a
32
+ # 3-element Array [dx, dy, dz] may be passed and will be interpreted as
33
+ # a translation vector. See {Geom::Transformation}.
34
+ #
31
35
  # @version SketchUp 6.0
32
36
  class Array
33
37
 
@@ -31,6 +31,17 @@
31
31
  # @version SketchUp 6.0
32
32
  class Geom::BoundingBox
33
33
 
34
+ # Constants
35
+
36
+ CORNER_LEFT_BACK_BOTTOM = nil # Stub value.
37
+ CORNER_LEFT_BACK_TOP = nil # Stub value.
38
+ CORNER_LEFT_FRONT_BOTTOM = nil # Stub value.
39
+ CORNER_LEFT_FRONT_TOP = nil # Stub value.
40
+ CORNER_RIGHT_BACK_BOTTOM = nil # Stub value.
41
+ CORNER_RIGHT_BACK_TOP = nil # Stub value.
42
+ CORNER_RIGHT_FRONT_BOTTOM = nil # Stub value.
43
+ CORNER_RIGHT_FRONT_TOP = nil # Stub value.
44
+
34
45
  # Instance Methods
35
46
 
36
47
  # The add method is used to add a point, vertex, or other bounding boxes to the
@@ -120,23 +131,32 @@ class Geom::BoundingBox
120
131
  def contains?(point_or_bb)
121
132
  end
122
133
 
123
- # The corner method is used to retrieve a point object at a specified corner
134
+ # The {#corner} method is used to retrieve a point object at a specified corner
124
135
  # of the bounding box.
125
136
  #
126
137
  # There are 8 corners to a bounding box, identified by the numbers 0 through 7.
127
138
  # Points are returned in the currently set units (inches, by default). These
128
139
  # are which index refers to which corner:
140
+ # - 0: {CORNER_LEFT_FRONT_BOTTOM}
141
+ # - 1: {CORNER_RIGHT_FRONT_BOTTOM}
142
+ # - 2: {CORNER_LEFT_BACK_BOTTOM}
143
+ # - 3: {CORNER_RIGHT_BACK_BOTTOM}
144
+ # - 4: {CORNER_LEFT_FRONT_TOP}
145
+ # - 5: {CORNER_RIGHT_FRONT_TOP}
146
+ # - 6: {CORNER_LEFT_BACK_TOP}
147
+ # - 7: {CORNER_RIGHT_BACK_TOP}
148
+ #
149
+ # @example New preferred style using constants
150
+ # # From SketchUp 2026.2 onwards:
151
+ # boundingbox = Geom::BoundingBox.new
152
+ # boundingbox.add([100, 200, -400], [200, 400, 100])
153
+ # # This will return Point3d(100, 200, -400).
154
+ # boundingbox.corner(Geom::BoundingBox::CORNER_LEFT_FRONT_BOTTOM)
155
+ # # This will return Point3d(100, 400, 100).
156
+ # boundingbox.corner(Geom::BoundingBox::CORNER_LEFT_BACK_TOP)
129
157
  #
130
- # - 0 = [0, 0, 0] (left front bottom)
131
- # - 1 = [1, 0, 0] (right front bottom)
132
- # - 2 = [0, 1, 0] (left back bottom)
133
- # - 3 = [1, 1, 0] (right back bottom)
134
- # - 4 = [0, 0, 1] (left front top)
135
- # - 5 = [1, 0, 1] (right front top)
136
- # - 6 = [0, 1, 1] (left back top)
137
- # - 7 = [1, 1, 1] (right back top)
138
- #
139
- # @example
158
+ # @example Old style using magic numbers
159
+ # # For SketchUp 2026.1 and older: (Works with newer versions too)
140
160
  # boundingbox = Geom::BoundingBox.new
141
161
  # boundingbox.add([100, 200, -400], [200, 400, 100])
142
162
  # # This will return Point3d(100, 200, -400).
@@ -223,6 +243,10 @@ class Geom::BoundingBox
223
243
  # @example
224
244
  # boundingbox = Geom::BoundingBox.new
225
245
  #
246
+ # @note An empty bounding box will return undefined non-zero values
247
+ # from methods like {#min}, {#max}, {#corner}, and
248
+ # {#center}. Always check {#empty?} or {#valid?} before relying on the returned values.
249
+ #
226
250
  # @return [Geom::BoundingBox] a BoundingBox object if successful
227
251
  #
228
252
  # @version SketchUp 6.0
@@ -4,7 +4,7 @@
4
4
  # The {Geom::Point2d} class allows you to work with a point in 2D space.
5
5
  # {Geom::Point2d} is a series of values representing x and y coordinates.
6
6
  #
7
- # The values are specified as +[x, y]+. For example [1, 1].
7
+ # The values are specified as +[x, y]+. For example +[1, 1]+.
8
8
  # To create a point call +Geom::Point2d.new+, where the creation method
9
9
  # can take a variety of arguments:
10
10
  #
@@ -5,15 +5,15 @@
5
5
  # The point is basically just a series of values representing x, y and z
6
6
  # coordinates.
7
7
  #
8
- # The values are specified as [x,y,z]. For example [100,200,300].
9
- # To create a point call Geom::Point3d.new, where the creation method
8
+ # The values are specified as +[x, y, z]+. For example +[100, 200, 300]+.
9
+ # To create a point call +Geom::Point3d.new+, where the creation method
10
10
  # can take a variety of arguments:
11
11
  #
12
12
  # In addition to the methods below, there are a series of geometry
13
- # related methods that are on the Array class, since Point3d objects
14
- # can also be represented as a 3-element Array. These Array-level methods are
13
+ # related methods that are on the {Array} class, since {Geom::Point3d} objects
14
+ # can also be represented as a 3-element {Array}. These {Array}-level methods are
15
15
  # for operations such as determining if a point is on a line, on a plane, etc.
16
- # See the Array class for details.
16
+ # See the {Array} class for details.
17
17
  #
18
18
  # @example
19
19
  # # No arguments, creates a point at the origin [0, 0, 0]
@@ -26,6 +26,10 @@
26
26
  # # values to a variable as an array:
27
27
  # point3 = [100, 200, 300]
28
28
  #
29
+ # @note Compatibility: Many API methods that accept a {Geom::Point3d} also
30
+ # accept a 3-element {Array} of {Numeric} values +[x, y, z]+. Arrays are
31
+ # implicitly converted where appropriate. See {Array} and {Geom::Vector3d}.
32
+ #
29
33
  # @version SketchUp 6.0
30
34
  class Geom::Point3d
31
35
 
@@ -11,6 +11,11 @@
11
11
  # transformations in 3 dimensions which is covered extensively on
12
12
  # the internet.
13
13
  #
14
+ # @note Translation convenience: In contexts expecting a pure translation,
15
+ # you can pass a {Geom::Point3d}, {Geom::Vector3d}, or a 3-element
16
+ # Array [dx, dy, dz] and it will be converted to a translation
17
+ # {Geom::Transformation}. For full matrices, pass a 16-element Array.
18
+ #
14
19
  # @version SketchUp 6.0
15
20
  class Geom::Transformation
16
21
 
@@ -1,6 +1,16 @@
1
1
  # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
+ # {Geom::Transformation2d} represents 2D affine transforms used by LayOut.
5
+ # The internal representation is a 2x3 matrix +[m11, m12, m21, m22, tx, ty]+.
6
+ # Use {.translation}, {.rotation}, and {.scaling} to construct common transforms,
7
+ # or pass a 6-element Array to {.new} or {#set!} for a custom matrix.
8
+ #
9
+ # @see Geom::Point2d
10
+ #
11
+ # @see Geom::Vector2d
12
+ #
13
+ # @see IDENTITY_2D
4
14
  #
5
15
  # @version LayOut 2018
6
16
  class Geom::Transformation2d
@@ -6,6 +6,10 @@
6
6
  #
7
7
  # There are numerous tutorials on 3D vectors available on the internet.
8
8
  #
9
+ # @note Compatibility: Many API methods that accept a Geom::Vector3d also
10
+ # accept a 3-element {Array} of {Numeric} values +[x, y, z]+. Arrays are implicitly
11
+ # converted where appropriate. See Array and Geom::Point3d.
12
+ #
9
13
  # @version SketchUp 6.0
10
14
  class Geom::Vector3d
11
15
 
@@ -215,13 +219,12 @@ class Geom::Vector3d
215
219
  #
216
220
  # Returns an Array of three vectors [xaxis, yaxis, zaxis]
217
221
  #
218
- # Vector3d objects
219
- #
220
222
  # @example
221
223
  # vector = Geom::Vector3d.new(1, 0, 0)
222
224
  # array = vector.axes
223
225
  #
224
226
  # @return [Array(Geom::Vector3d, Geom::Vector3d, Geom::Vector3d)] an Array object containing three
227
+ # Vector3d objects
225
228
  #
226
229
  # @version SketchUp 6.0
227
230
  def axes
@@ -10,12 +10,14 @@
10
10
  #
11
11
  # A line can be represented as either an Array of a point and a
12
12
  # vector, or as an Array of two points.
13
+ #
13
14
  # line1 = [Geom::Point3d.new(0, 0, 0), Geom::Vector3d.new(0, 0, 1)]
14
15
  # line2 = [Geom::Point3d.new(0, 0, 0), Geom::Point3d.new(0, 0, 100)]
15
16
  #
16
17
  # A plane can be represented as either an Array
17
18
  # of a point and a vector, or as an Array of 4 numbers that give the
18
19
  # coefficients of a plane equation.
20
+ #
19
21
  # plane1 = [Geom::Point3d.new(0, 0, 0), Geom::Vector3d.new(0, 0, 1)]
20
22
  # plane2 = [0, 0, 1, 0]
21
23
  #
@@ -8,9 +8,6 @@
8
8
  # language folder and encoded in UTF-8. The strings file should include
9
9
  # "key"="value" string pairs in the following format:
10
10
  #
11
- # language code gocorp_swiveldriver/Resources/fr/swiveldriver.strings
12
- # gocorp_swiveldriver/Resources/es/swiveldriver.strings
13
- #
14
11
  # @example Example code that uses LanguageHandler:
15
12
  # # Create a global language handler object
16
13
  # swiveldriver_lang_handler = LanguageHandler.new('swiveldriver.strings')
@@ -26,7 +23,10 @@
26
23
  # gocorp_swiveldriver.rb <- creates the SketchupExtension instance
27
24
  # gocorp_swiveldriver/
28
25
  # gocorp_swiveldriver/Resources/
29
- # gocorp_swiveldriver/Resources/en/swiveldriver.strings <- OPTIONAL localization files by
26
+ # gocorp_swiveldriver/Resources/en/swiveldriver.strings <- OPTIONAL localization files
27
+ # by language code
28
+ # gocorp_swiveldriver/Resources/fr/swiveldriver.strings
29
+ # gocorp_swiveldriver/Resources/es/swiveldriver.strings
30
30
  #
31
31
  # @version SketchUp 2014
32
32
  class LanguageHandler
@@ -34,8 +34,6 @@ class Layout::AngularDimension < Layout::Entity
34
34
  # The {#angle} method returns the {Layout::AngularDimension}'s angle. The angle
35
35
  # is represented in radians.
36
36
  #
37
- # inner_angle) angle = dim.angle
38
- #
39
37
  # @example
40
38
  # start_point = Geom::Point2d.new(1, 1)
41
39
  # end_point = Geom::Point2d.new(5, 5)
@@ -43,6 +41,8 @@ class Layout::AngularDimension < Layout::Entity
43
41
  # end_extent = Geom::Point2d.new(5, 6)
44
42
  # inner_angle = true
45
43
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
44
+ # inner_angle)
45
+ # angle = dim.angle
46
46
  #
47
47
  # @return [Numeric]
48
48
  #
@@ -53,8 +53,6 @@ class Layout::AngularDimension < Layout::Entity
53
53
  # The {#arc_center_point} method returns the paper space location for the
54
54
  # dimension arc center point.
55
55
  #
56
- # inner_angle) center = dim.arc_center_point
57
- #
58
56
  # @example
59
57
  # start_point = Geom::Point2d.new(1, 1)
60
58
  # end_point = Geom::Point2d.new(5, 5)
@@ -62,6 +60,8 @@ class Layout::AngularDimension < Layout::Entity
62
60
  # end_extent = Geom::Point2d.new(5, 6)
63
61
  # inner_angle = true
64
62
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
63
+ # inner_angle)
64
+ # center = dim.arc_center_point
65
65
  #
66
66
  # @return [Geom::Point2d]
67
67
  #
@@ -74,8 +74,6 @@ class Layout::AngularDimension < Layout::Entity
74
74
  # change. When +false+, the text will display the length measurement and wil
75
75
  # update automatically.
76
76
  #
77
- # inner_angle) dim.custom_text = true
78
- #
79
77
  # @example
80
78
  # start_point = Geom::Point2d.new(1, 1)
81
79
  # end_point = Geom::Point2d.new(5, 5)
@@ -83,6 +81,8 @@ class Layout::AngularDimension < Layout::Entity
83
81
  # end_extent = Geom::Point2d.new(5, 6)
84
82
  # inner_angle = true
85
83
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
84
+ # inner_angle)
85
+ # dim.custom_text = true
86
86
  #
87
87
  # @param [Boolean] uses_custom_text
88
88
  #
@@ -100,8 +100,6 @@ class Layout::AngularDimension < Layout::Entity
100
100
  # doesn't change. When +false+, the text will display the length measurement
101
101
  # and will update automatically.
102
102
  #
103
- # inner_angle) # returns false uses_custom_text = dim.custom_text?
104
- #
105
103
  # @example
106
104
  # start_point = Geom::Point2d.new(1, 1)
107
105
  # end_point = Geom::Point2d.new(5, 5)
@@ -109,6 +107,9 @@ class Layout::AngularDimension < Layout::Entity
109
107
  # end_extent = Geom::Point2d.new(5, 6)
110
108
  # inner_angle = true
111
109
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
110
+ # inner_angle)
111
+ # # returns false
112
+ # uses_custom_text = dim.custom_text?
112
113
  #
113
114
  # @return [Boolean]
114
115
  #
@@ -119,8 +120,6 @@ class Layout::AngularDimension < Layout::Entity
119
120
  # The {#end_connection_point} method returns the paper space location for the
120
121
  # second connection.
121
122
  #
122
- # inner_angle) end_connection = dim.end_connection_point
123
- #
124
123
  # @example
125
124
  # start_point = Geom::Point2d.new(1, 1)
126
125
  # end_point = Geom::Point2d.new(5, 5)
@@ -128,6 +127,8 @@ class Layout::AngularDimension < Layout::Entity
128
127
  # end_extent = Geom::Point2d.new(5, 6)
129
128
  # inner_angle = true
130
129
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
130
+ # inner_angle)
131
+ # end_connection = dim.end_connection_point
131
132
  #
132
133
  # @return [Geom::Point2d]
133
134
  #
@@ -138,8 +139,6 @@ class Layout::AngularDimension < Layout::Entity
138
139
  # The {#end_connection_point=} method sets the paper space location for the
139
140
  # second connection.
140
141
  #
141
- # inner_angle) dim.end_connection_point = Geom::Point2d.new(6, 6)
142
- #
143
142
  # @example
144
143
  # start_point = Geom::Point2d.new(1, 1)
145
144
  # end_point = Geom::Point2d.new(5, 5)
@@ -147,6 +146,8 @@ class Layout::AngularDimension < Layout::Entity
147
146
  # end_extent = Geom::Point2d.new(5, 6)
148
147
  # inner_angle = true
149
148
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
149
+ # inner_angle)
150
+ # dim.end_connection_point = Geom::Point2d.new(6, 6)
150
151
  #
151
152
  # @param [Geom::Point2d] end_point
152
153
  #
@@ -162,8 +163,6 @@ class Layout::AngularDimension < Layout::Entity
162
163
  # The {#end_extent_point} method returns the paper space location for the
163
164
  # end of the dimension line.
164
165
  #
165
- # inner_angle) end_ext_point = dim.end_extent_point
166
- #
167
166
  # @example
168
167
  # start_point = Geom::Point2d.new(1, 1)
169
168
  # end_point = Geom::Point2d.new(5, 5)
@@ -171,6 +170,8 @@ class Layout::AngularDimension < Layout::Entity
171
170
  # end_extent = Geom::Point2d.new(5, 6)
172
171
  # inner_angle = true
173
172
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
173
+ # inner_angle)
174
+ # end_ext_point = dim.end_extent_point
174
175
  #
175
176
  # @return [Geom::Point2d] end_extent
176
177
  #
@@ -181,9 +182,6 @@ class Layout::AngularDimension < Layout::Entity
181
182
  # The {#end_extent_point=} method sets the paper space location for the
182
183
  # end of the dimension line.
183
184
  #
184
- # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_extent_point = Geom::Point2d.new(6,
185
- # 6)
186
- #
187
185
  # @example
188
186
  # start_point = Geom::Point2d.new(1, 1)
189
187
  # end_point = Geom::Point2d.new(5, 5)
@@ -191,6 +189,9 @@ class Layout::AngularDimension < Layout::Entity
191
189
  # end_extent = Geom::Point2d.new(5, 6)
192
190
  # inner_angle = true
193
191
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
192
+ # inner_angle)
193
+ # end_ext_point = Geom::Point2d.new(5, 6)
194
+ # dim.end_extent_point = Geom::Point2d.new(6, 6)
194
195
  #
195
196
  # @param [Geom::Point2d] end_extent
196
197
  #
@@ -207,8 +208,6 @@ class Layout::AngularDimension < Layout::Entity
207
208
  # second connection point to the start of the second extension line. The
208
209
  # connection and extent points will not move.
209
210
  #
210
- # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_offset_length = 0.5
211
- #
212
211
  # @example
213
212
  # start_point = Geom::Point2d.new(1, 1)
214
213
  # end_point = Geom::Point2d.new(5, 5)
@@ -216,6 +215,9 @@ class Layout::AngularDimension < Layout::Entity
216
215
  # end_extent = Geom::Point2d.new(5, 6)
217
216
  # inner_angle = true
218
217
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
218
+ # inner_angle)
219
+ # end_ext_point = Geom::Point2d.new(5, 6)
220
+ # dim.end_offset_length = 0.5
219
221
  #
220
222
  # @param [Numeric] offset_length
221
223
  #
@@ -232,8 +234,6 @@ class Layout::AngularDimension < Layout::Entity
232
234
  # end of the first extension line. The first extension line runs from this
233
235
  # offset point to the end extent point.
234
236
  #
235
- # inner_angle) end_offset = dim.end_offset_point
236
- #
237
237
  # @example
238
238
  # start_point = Geom::Point2d.new(1, 1)
239
239
  # end_point = Geom::Point2d.new(5, 5)
@@ -241,6 +241,8 @@ class Layout::AngularDimension < Layout::Entity
241
241
  # end_extent = Geom::Point2d.new(5, 6)
242
242
  # inner_angle = true
243
243
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
244
+ # inner_angle)
245
+ # end_offset = dim.end_offset_point
244
246
  #
245
247
  # @return [Geom::Point2d] end_offset
246
248
  #
@@ -254,8 +256,6 @@ class Layout::AngularDimension < Layout::Entity
254
256
  # from four to six {Layout::Entity}s: start extension line, end extension line,
255
257
  # one or two dimension lines, dimension text, and optionally the leader line.
256
258
  #
257
- # inner_angle) entites = dim.entities
258
- #
259
259
  # @example
260
260
  # start_point = Geom::Point2d.new(1, 1)
261
261
  # end_point = Geom::Point2d.new(5, 5)
@@ -263,6 +263,8 @@ class Layout::AngularDimension < Layout::Entity
263
263
  # end_extent = Geom::Point2d.new(5, 6)
264
264
  # inner_angle = true
265
265
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
266
+ # inner_angle)
267
+ # entites = dim.entities
266
268
  #
267
269
  # @return [Layout::Entities]
268
270
  #
@@ -273,8 +275,6 @@ class Layout::AngularDimension < Layout::Entity
273
275
  # The {#initialize} method creates a new disconnected
274
276
  # {Layout::AngularDimension}.
275
277
  #
276
- # inner_angle)
277
- #
278
278
  # @example
279
279
  # start_point = Geom::Point2d.new(1, 1)
280
280
  # end_point = Geom::Point2d.new(5, 5)
@@ -282,6 +282,7 @@ class Layout::AngularDimension < Layout::Entity
282
282
  # end_extent = Geom::Point2d.new(5, 6)
283
283
  # inner_angle = true
284
284
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
285
+ # inner_angle)
285
286
  #
286
287
  # @param [Geom::Point2d] start_point
287
288
  # Where the {Layout::AngularDimension}
@@ -318,8 +319,6 @@ class Layout::AngularDimension < Layout::Entity
318
319
  # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
319
320
  # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
320
321
  #
321
- # inner_angle) type = dim.leader_line_type
322
- #
323
322
  # @example
324
323
  # start_point = Geom::Point2d.new(1, 1)
325
324
  # end_point = Geom::Point2d.new(5, 5)
@@ -327,6 +326,8 @@ class Layout::AngularDimension < Layout::Entity
327
326
  # end_extent = Geom::Point2d.new(5, 6)
328
327
  # inner_angle = true
329
328
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
329
+ # inner_angle)
330
+ # type = dim.leader_line_type
330
331
  #
331
332
  # @return [Integer]
332
333
  #
@@ -343,8 +344,6 @@ class Layout::AngularDimension < Layout::Entity
343
344
  # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
344
345
  # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
345
346
  #
346
- # inner_angle) dim.leader_line_type = Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER
347
- #
348
347
  # @example
349
348
  # start_point = Geom::Point2d.new(1, 1)
350
349
  # end_point = Geom::Point2d.new(5, 5)
@@ -352,6 +351,8 @@ class Layout::AngularDimension < Layout::Entity
352
351
  # end_extent = Geom::Point2d.new(5, 6)
353
352
  # inner_angle = true
354
353
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
354
+ # inner_angle)
355
+ # dim.leader_line_type = Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER
355
356
  #
356
357
  # @param [Integer] type
357
358
  # The leader line type
@@ -370,8 +371,6 @@ class Layout::AngularDimension < Layout::Entity
370
371
  # The {#radius} method returns the {Layout::AngularDimension}'s radius. This is
371
372
  # the distance from the arc center point to the dimension line.
372
373
  #
373
- # inner_angle) radius = dim.radius
374
- #
375
374
  # @example
376
375
  # start_point = Geom::Point2d.new(1, 1)
377
376
  # end_point = Geom::Point2d.new(5, 5)
@@ -379,6 +378,8 @@ class Layout::AngularDimension < Layout::Entity
379
378
  # end_extent = Geom::Point2d.new(5, 6)
380
379
  # inner_angle = true
381
380
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
381
+ # inner_angle)
382
+ # radius = dim.radius
382
383
  #
383
384
  # @return [Numeric]
384
385
  #
@@ -389,8 +390,6 @@ class Layout::AngularDimension < Layout::Entity
389
390
  # The {#radius=} method sets the the {Layout::AngularDimension}'s radius. This
390
391
  # is the distance from the arc center point to the dimension line.
391
392
  #
392
- # inner_angle) dim.radius = 2.0
393
- #
394
393
  # @example
395
394
  # start_point = Geom::Point2d.new(1, 1)
396
395
  # end_point = Geom::Point2d.new(5, 5)
@@ -398,6 +397,8 @@ class Layout::AngularDimension < Layout::Entity
398
397
  # end_extent = Geom::Point2d.new(5, 6)
399
398
  # inner_angle = true
400
399
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
400
+ # inner_angle)
401
+ # dim.radius = 2.0
401
402
  #
402
403
  # @param [Numeric] radius
403
404
  #
@@ -415,8 +416,6 @@ class Layout::AngularDimension < Layout::Entity
415
416
  # The {#start_connection_point} method returns the paper space location for the
416
417
  # first connection.
417
418
  #
418
- # inner_angle) start_connection = dim.start_connection_point
419
- #
420
419
  # @example
421
420
  # start_point = Geom::Point2d.new(1, 1)
422
421
  # end_point = Geom::Point2d.new(5, 5)
@@ -424,6 +423,8 @@ class Layout::AngularDimension < Layout::Entity
424
423
  # end_extent = Geom::Point2d.new(5, 6)
425
424
  # inner_angle = true
426
425
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
426
+ # inner_angle)
427
+ # start_connection = dim.start_connection_point
427
428
  #
428
429
  # @return [Geom::Point2d]
429
430
  #
@@ -434,8 +435,6 @@ class Layout::AngularDimension < Layout::Entity
434
435
  # The {#start_connection_point=} method sets the paper space location for the
435
436
  # first connection.
436
437
  #
437
- # inner_angle) dim.start_connection_point = Geom::Point2d.new(2, 2)
438
- #
439
438
  # @example
440
439
  # start_point = Geom::Point2d.new(1, 1)
441
440
  # end_point = Geom::Point2d.new(5, 5)
@@ -443,6 +442,8 @@ class Layout::AngularDimension < Layout::Entity
443
442
  # end_extent = Geom::Point2d.new(5, 6)
444
443
  # inner_angle = true
445
444
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
445
+ # inner_angle)
446
+ # dim.start_connection_point = Geom::Point2d.new(2, 2)
446
447
  #
447
448
  # @param [Geom::Point2d] start_point
448
449
  #
@@ -458,8 +459,6 @@ class Layout::AngularDimension < Layout::Entity
458
459
  # The {#start_extent_point} method returns the paper space location for the
459
460
  # start of the dimension line.
460
461
  #
461
- # inner_angle) start_ext_point = dim.start_extent_point
462
- #
463
462
  # @example
464
463
  # start_point = Geom::Point2d.new(1, 1)
465
464
  # end_point = Geom::Point2d.new(5, 5)
@@ -467,6 +466,8 @@ class Layout::AngularDimension < Layout::Entity
467
466
  # end_extent = Geom::Point2d.new(5, 6)
468
467
  # inner_angle = true
469
468
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
469
+ # inner_angle)
470
+ # start_ext_point = dim.start_extent_point
470
471
  #
471
472
  # @return [Geom::Point2d] start_extent
472
473
  #
@@ -477,9 +478,6 @@ class Layout::AngularDimension < Layout::Entity
477
478
  # The {#start_extent_point=} method sets the paper space location for the
478
479
  # start of the dimension line.
479
480
  #
480
- # inner_angle) start_ext_point = Geom::Point2d.new(2, 3) dim.start_extent_point =
481
- # Geom::Point2d.new(2, 2)
482
- #
483
481
  # @example
484
482
  # start_point = Geom::Point2d.new(1, 1)
485
483
  # end_point = Geom::Point2d.new(5, 5)
@@ -487,6 +485,9 @@ class Layout::AngularDimension < Layout::Entity
487
485
  # end_extent = Geom::Point2d.new(5, 6)
488
486
  # inner_angle = true
489
487
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
488
+ # inner_angle)
489
+ # start_ext_point = Geom::Point2d.new(2, 3)
490
+ # dim.start_extent_point = Geom::Point2d.new(2, 2)
490
491
  #
491
492
  # @param [Geom::Point2d] start_extent
492
493
  #
@@ -503,8 +504,6 @@ class Layout::AngularDimension < Layout::Entity
503
504
  # first connection point to the start of the first extension line. The
504
505
  # connection and extent points will not move.
505
506
  #
506
- # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.start_offset_length = 0.5
507
- #
508
507
  # @example
509
508
  # start_point = Geom::Point2d.new(1, 1)
510
509
  # end_point = Geom::Point2d.new(5, 5)
@@ -512,6 +511,9 @@ class Layout::AngularDimension < Layout::Entity
512
511
  # end_extent = Geom::Point2d.new(5, 6)
513
512
  # inner_angle = true
514
513
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
514
+ # inner_angle)
515
+ # end_ext_point = Geom::Point2d.new(5, 6)
516
+ # dim.start_offset_length = 0.5
515
517
  #
516
518
  # @param [Numeric] offset_length
517
519
  #
@@ -528,8 +530,6 @@ class Layout::AngularDimension < Layout::Entity
528
530
  # start of the first extension line. The first extension line runs from this
529
531
  # offset point to the start extent point.
530
532
  #
531
- # inner_angle) start_offset = dim.start_offset_point
532
- #
533
533
  # @example
534
534
  # start_point = Geom::Point2d.new(1, 1)
535
535
  # end_point = Geom::Point2d.new(5, 5)
@@ -537,6 +537,8 @@ class Layout::AngularDimension < Layout::Entity
537
537
  # end_extent = Geom::Point2d.new(5, 6)
538
538
  # inner_angle = true
539
539
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
540
+ # inner_angle)
541
+ # start_offset = dim.start_offset_point
540
542
  #
541
543
  # @return [Geom::Point2d] start_offset
542
544
  #
@@ -547,8 +549,6 @@ class Layout::AngularDimension < Layout::Entity
547
549
  # The {#text} method returns a copy of the {Layout::AngularDimension}'s
548
550
  # {Layout::FormattedText}.
549
551
  #
550
- # inner_angle) text = dim.text
551
- #
552
552
  # @example
553
553
  # start_point = Geom::Point2d.new(1, 1)
554
554
  # end_point = Geom::Point2d.new(5, 5)
@@ -556,6 +556,8 @@ class Layout::AngularDimension < Layout::Entity
556
556
  # end_extent = Geom::Point2d.new(5, 6)
557
557
  # inner_angle = true
558
558
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
559
+ # inner_angle)
560
+ # text = dim.text
559
561
  #
560
562
  # @note With the addition of auto-text in dimensions for LayOut 2019.2, the
561
563
  # copy of the dimension text incorrectly provided the plain text when
@@ -570,9 +572,6 @@ class Layout::AngularDimension < Layout::Entity
570
572
  # The {#text=} method sets the {Layout::AngularDimension}'s
571
573
  # {Layout::FormattedText}.
572
574
  #
573
- # inner_angle) anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT dim.text =
574
- # Layout::FormattedText.new("Hello LayOut", start_point, anchor_type)
575
- #
576
575
  # @example
577
576
  # start_point = Geom::Point2d.new(1, 1)
578
577
  # end_point = Geom::Point2d.new(5, 5)
@@ -580,6 +579,9 @@ class Layout::AngularDimension < Layout::Entity
580
579
  # end_extent = Geom::Point2d.new(5, 6)
581
580
  # inner_angle = true
582
581
  # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
582
+ # inner_angle)
583
+ # anchor_type = Layout::FormattedText::ANCHOR_TYPE_TOP_LEFT
584
+ # dim.text = Layout::FormattedText.new("Hello LayOut", start_point, anchor_type)
583
585
  #
584
586
  # @param [Layout::FormattedText] formatted_text
585
587
  #