sketchup-api-stubs 0.7.9 → 0.7.11

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 (160) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +157 -151
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +182 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +111 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +423 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +693 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +535 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +500 -476
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +267 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +133 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +547 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +678 -693
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +751 -747
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb +234 -0
  23. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +683 -517
  24. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  26. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +464 -353
  27. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
  28. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  29. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  30. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  31. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  33. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  34. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
  35. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +614 -567
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  37. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  38. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +282 -183
  39. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +458 -387
  40. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
  41. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +346 -344
  42. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  43. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -82
  44. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +714 -692
  45. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1565 -1519
  46. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  49. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  50. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  51. data/lib/sketchup-api-stubs/stubs/Length.rb +286 -278
  52. data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +196 -144
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +226 -209
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +145 -150
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +294 -281
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +296 -302
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +473 -478
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -121
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +673 -659
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +600 -593
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +252 -257
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +443 -449
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +167 -165
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +403 -406
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -397
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1282 -1239
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -261
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +519 -545
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Environment.rb +406 -0
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Environments.rb +185 -0
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb +113 -0
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +122 -125
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +1006 -937
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -102
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +740 -750
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +289 -282
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +64 -62
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +405 -468
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +432 -406
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +307 -306
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +332 -326
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +380 -422
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +409 -427
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +241 -249
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +55 -48
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -114
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb +70 -0
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +1115 -414
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +330 -317
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1714 -1652
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +372 -357
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +133 -130
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -271
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +463 -490
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +104 -116
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +939 -797
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +388 -361
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +501 -478
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +385 -361
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +451 -458
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +211 -212
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +259 -255
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb +125 -0
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +88 -69
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +263 -217
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +283 -262
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +199 -217
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +924 -834
  143. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  144. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  145. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
  146. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +143 -142
  147. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1566 -1311
  148. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +71 -45
  149. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1429 -1377
  150. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +353 -353
  151. data/lib/sketchup-api-stubs/stubs/String.rb +24 -24
  152. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +399 -389
  153. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +580 -494
  154. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +280 -269
  155. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +258 -241
  156. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +636 -635
  157. data/lib/sketchup-api-stubs/stubs/UI.rb +791 -683
  158. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -303
  159. data/lib/sketchup-api-stubs.rb +1 -1
  160. metadata +10 -24
@@ -1,595 +1,595 @@
1
- # Copyright:: Copyright 2023 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # References an angular dimension entity. An {Layout::AngularDimension} is
5
- # composed of the following sub-entities:
6
- # - two 'extension lines' that extend from the {Layout::Entity} being
7
- # dimensioned.
8
- # - a 'dimension line' connecting the ends of the leaders. This may be
9
- # represented by one or two {Layout::Path}s depending on appearance.
10
- # - an optional 'leader line' that is used for small {Layout::AngularDimension}s.
11
- # - a 'dimension text' that displays the {Layout::AngularDimension}'s text.
12
- #
13
- # There are seven points that may be modified for an {Layout::AngularDimension}:
14
- # - two 'connection points' that define the start and end of the
15
- # {Layout::AngularDimension}.
16
- # - two 'extent points' that define the start and end of the dimension line and
17
- # are the ends of the two extension lines.
18
- # - two 'offset points' that define the starting points of the extension lines.
19
- # - one 'arc center point' that defines the center of the
20
- # {Layout::AngularDimension}, where the extension lines intersect.
21
- #
22
- # @version LayOut 2018
23
- class Layout::AngularDimension < Layout::Entity
24
-
25
- # Constants
26
-
27
- LEADER_LINE_TYPE_BEZIER = nil # Stub value.
28
- LEADER_LINE_TYPE_HIDDEN = nil # Stub value.
29
- LEADER_LINE_TYPE_SINGLE_SEGMENT = nil # Stub value.
30
- LEADER_LINE_TYPE_TWO_SEGMENT = nil # Stub value.
31
-
32
- # Instance Methods
33
-
34
- # The {#angle} method returns the {Layout::AngularDimension}'s angle. The angle
35
- # is represented in radians.
36
- #
37
- # inner_angle) angle = dim.angle
38
- #
39
- # @example
40
- # start_point = Geom::Point2d.new(1, 1)
41
- # end_point = Geom::Point2d.new(5, 5)
42
- # start_extent = Geom::Point2d.new(1, 2)
43
- # end_extent = Geom::Point2d.new(5, 6)
44
- # inner_angle = true
45
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
46
- #
47
- # @return [Numeric]
48
- #
49
- # @version LayOut 2018
50
- def angle
51
- end
52
-
53
- # The {#arc_center_point} method returns the paper space location for the
54
- # dimension arc center point.
55
- #
56
- # inner_angle) center = dim.arc_center_point
57
- #
58
- # @example
59
- # start_point = Geom::Point2d.new(1, 1)
60
- # end_point = Geom::Point2d.new(5, 5)
61
- # start_extent = Geom::Point2d.new(1, 2)
62
- # end_extent = Geom::Point2d.new(5, 6)
63
- # inner_angle = true
64
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
65
- #
66
- # @return [Geom::Point2d]
67
- #
68
- # @version LayOut 2018
69
- def arc_center_point
70
- end
71
-
72
- # The {#custom_text=} sets whether or not the {Layout::AngularDimension} uses
73
- # custom text. When +true+, the text will display a custom string that doesn't
74
- # change. When +false+, the text will display the length measurement and wil
75
- # update automatically.
76
- #
77
- # inner_angle) dim.custom_text = true
78
- #
79
- # @example
80
- # start_point = Geom::Point2d.new(1, 1)
81
- # end_point = Geom::Point2d.new(5, 5)
82
- # start_extent = Geom::Point2d.new(1, 2)
83
- # end_extent = Geom::Point2d.new(5, 6)
84
- # inner_angle = true
85
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
86
- #
87
- # @param [Boolean] uses_custom_text
88
- #
89
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
90
- # {Layout::Layer}
91
- #
92
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
93
- #
94
- # @version LayOut 2018
95
- def custom_text=(uses_custom_text)
96
- end
97
-
98
- # The {#custom_text?} method returns whether the {Layout::AngularDimension}
99
- # uses custom text. When +true+, the text will display a custom string that
100
- # doesn't change. When +false+, the text will display the length measurement
101
- # and will update automatically.
102
- #
103
- # inner_angle) # returns false uses_custom_text = dim.custom_text?
104
- #
105
- # @example
106
- # start_point = Geom::Point2d.new(1, 1)
107
- # end_point = Geom::Point2d.new(5, 5)
108
- # start_extent = Geom::Point2d.new(1, 2)
109
- # end_extent = Geom::Point2d.new(5, 6)
110
- # inner_angle = true
111
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
112
- #
113
- # @return [Boolean]
114
- #
115
- # @version LayOut 2018
116
- def custom_text?
117
- end
118
-
119
- # The {#end_connection_point} method returns the paper space location for the
120
- # second connection.
121
- #
122
- # inner_angle) end_connection = dim.end_connection_point
123
- #
124
- # @example
125
- # start_point = Geom::Point2d.new(1, 1)
126
- # end_point = Geom::Point2d.new(5, 5)
127
- # start_extent = Geom::Point2d.new(1, 2)
128
- # end_extent = Geom::Point2d.new(5, 6)
129
- # inner_angle = true
130
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
131
- #
132
- # @return [Geom::Point2d]
133
- #
134
- # @version LayOut 2018
135
- def end_connection_point
136
- end
137
-
138
- # The {#end_connection_point=} method sets the paper space location for the
139
- # second connection.
140
- #
141
- # inner_angle) dim.end_connection_point = Geom::Point2d.new(6, 6)
142
- #
143
- # @example
144
- # start_point = Geom::Point2d.new(1, 1)
145
- # end_point = Geom::Point2d.new(5, 5)
146
- # start_extent = Geom::Point2d.new(1, 2)
147
- # end_extent = Geom::Point2d.new(5, 6)
148
- # inner_angle = true
149
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
150
- #
151
- # @param [Geom::Point2d] end_point
152
- #
153
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
154
- # {Layout::Layer}
155
- #
156
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
157
- #
158
- # @version LayOut 2018
159
- def end_connection_point=(end_point)
160
- end
161
-
162
- # The {#end_extent_point} method returns the paper space location for the
163
- # end of the dimension line.
164
- #
165
- # inner_angle) end_ext_point = dim.end_extent_point
166
- #
167
- # @example
168
- # start_point = Geom::Point2d.new(1, 1)
169
- # end_point = Geom::Point2d.new(5, 5)
170
- # start_extent = Geom::Point2d.new(1, 2)
171
- # end_extent = Geom::Point2d.new(5, 6)
172
- # inner_angle = true
173
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
174
- #
175
- # @return [Geom::Point2d] end_extent
176
- #
177
- # @version LayOut 2018
178
- def end_extent_point
179
- end
180
-
181
- # The {#end_extent_point=} method sets the paper space location for the
182
- # end of the dimension line.
183
- #
184
- # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_extent_point = Geom::Point2d.new(6,
185
- # 6)
186
- #
187
- # @example
188
- # start_point = Geom::Point2d.new(1, 1)
189
- # end_point = Geom::Point2d.new(5, 5)
190
- # start_extent = Geom::Point2d.new(1, 2)
191
- # end_extent = Geom::Point2d.new(5, 6)
192
- # inner_angle = true
193
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
194
- #
195
- # @param [Geom::Point2d] end_extent
196
- #
197
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
198
- # {Layout::Layer}
199
- #
200
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
201
- #
202
- # @version LayOut 2018
203
- def end_extent_point=(end_extent)
204
- end
205
-
206
- # The {#end_offset_length=} method sets the length of the offset from the
207
- # second connection point to the start of the second extension line. The
208
- # connection and extent points will not move.
209
- #
210
- # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_offset_length = 0.5
211
- #
212
- # @example
213
- # start_point = Geom::Point2d.new(1, 1)
214
- # end_point = Geom::Point2d.new(5, 5)
215
- # start_extent = Geom::Point2d.new(1, 2)
216
- # end_extent = Geom::Point2d.new(5, 6)
217
- # inner_angle = true
218
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
219
- #
220
- # @param [Numeric] offset_length
221
- #
222
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
223
- # {Layout::Layer}
224
- #
225
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
226
- #
227
- # @version LayOut 2018
228
- def end_offset_length=(offset_length)
229
- end
230
-
231
- # The {#end_offset_point} method returns the paper space location for the
232
- # end of the first extension line. The first extension line runs from this
233
- # offset point to the end extent point.
234
- #
235
- # inner_angle) end_offset = dim.end_offset_point
236
- #
237
- # @example
238
- # start_point = Geom::Point2d.new(1, 1)
239
- # end_point = Geom::Point2d.new(5, 5)
240
- # start_extent = Geom::Point2d.new(1, 2)
241
- # end_extent = Geom::Point2d.new(5, 6)
242
- # inner_angle = true
243
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
244
- #
245
- # @return [Geom::Point2d] end_offset
246
- #
247
- # @version LayOut 2018
248
- def end_offset_point
249
- end
250
-
251
- # The {#entities} method returns the {Layout::Entities} that represent the
252
- # {Layout::AngularDimension} in its exploded form. Depending on the appearance
253
- # of the {Layout::AngularDimension} being exploded, this may return anywhere
254
- # from four to six {Layout::Entity}s: start extension line, end extension line,
255
- # one or two dimension lines, dimension text, and optionally the leader line.
256
- #
257
- # inner_angle) entites = dim.entities
258
- #
259
- # @example
260
- # start_point = Geom::Point2d.new(1, 1)
261
- # end_point = Geom::Point2d.new(5, 5)
262
- # start_extent = Geom::Point2d.new(1, 2)
263
- # end_extent = Geom::Point2d.new(5, 6)
264
- # inner_angle = true
265
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
266
- #
267
- # @return [Layout::Entities]
268
- #
269
- # @version LayOut 2018
270
- def entities
271
- end
272
-
273
- # The {#initialize} method creates a new disconnected
274
- # {Layout::AngularDimension}.
275
- #
276
- # inner_angle)
277
- #
278
- # @example
279
- # start_point = Geom::Point2d.new(1, 1)
280
- # end_point = Geom::Point2d.new(5, 5)
281
- # start_extent = Geom::Point2d.new(1, 2)
282
- # end_extent = Geom::Point2d.new(5, 6)
283
- # inner_angle = true
284
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
285
- #
286
- # @param [Geom::Point2d] start_point
287
- # Where the {Layout::AngularDimension}
288
- # should start
289
- #
290
- # @param [Geom::Point2d] end_point
291
- # Where the {Layout::AngularDimension} should
292
- # end
293
- #
294
- # @param [Geom::Point2d] start_extent_point
295
- # The extent point where the
296
- # dimension line should start
297
- #
298
- # @param [Geom::Point2d] end_extent_point
299
- # The extent point where the dimension
300
- # line should end
301
- #
302
- # @param [Boolean] inner_angle
303
- # Whether or not the {Layout::AngularDimension}
304
- # should measure the inner angle. If +false+, it will measure the outer angle.
305
- #
306
- # @return [Layout::AngularDimension]
307
- #
308
- # @version LayOut 2018
309
- def initialize(start_point, end_point, start_extent_point, end_extent_point, inner_angle)
310
- end
311
-
312
- # The {#leader_line_type} method returns the type of leader line the
313
- # {Layout::AngularDimension} is using.
314
- #
315
- # The leader line type can be one of the following:
316
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
317
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_TWO_SEGMENT+]
318
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
319
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
320
- #
321
- # inner_angle) type = dim.leader_line_type
322
- #
323
- # @example
324
- # start_point = Geom::Point2d.new(1, 1)
325
- # end_point = Geom::Point2d.new(5, 5)
326
- # start_extent = Geom::Point2d.new(1, 2)
327
- # end_extent = Geom::Point2d.new(5, 6)
328
- # inner_angle = true
329
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
330
- #
331
- # @return [Integer]
332
- #
333
- # @version LayOut 2018
334
- def leader_line_type
335
- end
336
-
337
- # The {#leader_line_type=} method sets the type of leader line the
338
- # {Layout::AngularDimension} is using.
339
- #
340
- # The leader line type can be one of the following:
341
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
342
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_TWO_SEGMENT+]
343
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
344
- # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
345
- #
346
- # inner_angle) dim.leader_line_type = Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER
347
- #
348
- # @example
349
- # start_point = Geom::Point2d.new(1, 1)
350
- # end_point = Geom::Point2d.new(5, 5)
351
- # start_extent = Geom::Point2d.new(1, 2)
352
- # end_extent = Geom::Point2d.new(5, 6)
353
- # inner_angle = true
354
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
355
- #
356
- # @param [Integer] type
357
- # The leader line type
358
- #
359
- # @raise [ArgumentError] if type is not a valid leader line type
360
- #
361
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
362
- # {Layout::Layer}
363
- #
364
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
365
- #
366
- # @version LayOut 2018
367
- def leader_line_type=(type)
368
- end
369
-
370
- # The {#radius} method returns the {Layout::AngularDimension}'s radius. This is
371
- # the distance from the arc center point to the dimension line.
372
- #
373
- # inner_angle) radius = dim.radius
374
- #
375
- # @example
376
- # start_point = Geom::Point2d.new(1, 1)
377
- # end_point = Geom::Point2d.new(5, 5)
378
- # start_extent = Geom::Point2d.new(1, 2)
379
- # end_extent = Geom::Point2d.new(5, 6)
380
- # inner_angle = true
381
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
382
- #
383
- # @return [Numeric]
384
- #
385
- # @version LayOut 2018
386
- def radius
387
- end
388
-
389
- # The {#radius=} method sets the the {Layout::AngularDimension}'s radius. This
390
- # is the distance from the arc center point to the dimension line.
391
- #
392
- # inner_angle) dim.radius = 2.0
393
- #
394
- # @example
395
- # start_point = Geom::Point2d.new(1, 1)
396
- # end_point = Geom::Point2d.new(5, 5)
397
- # start_extent = Geom::Point2d.new(1, 2)
398
- # end_extent = Geom::Point2d.new(5, 6)
399
- # inner_angle = true
400
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
401
- #
402
- # @param [Numeric] radius
403
- #
404
- # @raise [ArgumentError] is radius is negative
405
- #
406
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
407
- # {Layout::Layer}
408
- #
409
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
410
- #
411
- # @version LayOut 2018
412
- def radius=(radius)
413
- end
414
-
415
- # The {#start_connection_point} method returns the paper space location for the
416
- # first connection.
417
- #
418
- # inner_angle) start_connection = dim.start_connection_point
419
- #
420
- # @example
421
- # start_point = Geom::Point2d.new(1, 1)
422
- # end_point = Geom::Point2d.new(5, 5)
423
- # start_extent = Geom::Point2d.new(1, 2)
424
- # end_extent = Geom::Point2d.new(5, 6)
425
- # inner_angle = true
426
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
427
- #
428
- # @return [Geom::Point2d]
429
- #
430
- # @version LayOut 2018
431
- def start_connection_point
432
- end
433
-
434
- # The {#start_connection_point=} method sets the paper space location for the
435
- # first connection.
436
- #
437
- # inner_angle) dim.start_connection_point = Geom::Point2d.new(2, 2)
438
- #
439
- # @example
440
- # start_point = Geom::Point2d.new(1, 1)
441
- # end_point = Geom::Point2d.new(5, 5)
442
- # start_extent = Geom::Point2d.new(1, 2)
443
- # end_extent = Geom::Point2d.new(5, 6)
444
- # inner_angle = true
445
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
446
- #
447
- # @param [Geom::Point2d] start_point
448
- #
449
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
450
- # {Layout::Layer}
451
- #
452
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
453
- #
454
- # @version LayOut 2018
455
- def start_connection_point=(start_point)
456
- end
457
-
458
- # The {#start_extent_point} method returns the paper space location for the
459
- # start of the dimension line.
460
- #
461
- # inner_angle) start_ext_point = dim.start_extent_point
462
- #
463
- # @example
464
- # start_point = Geom::Point2d.new(1, 1)
465
- # end_point = Geom::Point2d.new(5, 5)
466
- # start_extent = Geom::Point2d.new(1, 2)
467
- # end_extent = Geom::Point2d.new(5, 6)
468
- # inner_angle = true
469
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
470
- #
471
- # @return [Geom::Point2d] start_extent
472
- #
473
- # @version LayOut 2018
474
- def start_extent_point
475
- end
476
-
477
- # The {#start_extent_point=} method sets the paper space location for the
478
- # start of the dimension line.
479
- #
480
- # inner_angle) start_ext_point = Geom::Point2d.new(2, 3) dim.start_extent_point =
481
- # Geom::Point2d.new(2, 2)
482
- #
483
- # @example
484
- # start_point = Geom::Point2d.new(1, 1)
485
- # end_point = Geom::Point2d.new(5, 5)
486
- # start_extent = Geom::Point2d.new(1, 2)
487
- # end_extent = Geom::Point2d.new(5, 6)
488
- # inner_angle = true
489
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
490
- #
491
- # @param [Geom::Point2d] start_extent
492
- #
493
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
494
- # {Layout::Layer}
495
- #
496
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
497
- #
498
- # @version LayOut 2018
499
- def start_extent_point=(start_extent)
500
- end
501
-
502
- # The {#start_offset_length=} method sets the length of the offset from the
503
- # first connection point to the start of the first extension line. The
504
- # connection and extent points will not move.
505
- #
506
- # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.start_offset_length = 0.5
507
- #
508
- # @example
509
- # start_point = Geom::Point2d.new(1, 1)
510
- # end_point = Geom::Point2d.new(5, 5)
511
- # start_extent = Geom::Point2d.new(1, 2)
512
- # end_extent = Geom::Point2d.new(5, 6)
513
- # inner_angle = true
514
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
515
- #
516
- # @param [Numeric] offset_length
517
- #
518
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
519
- # {Layout::Layer}
520
- #
521
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
522
- #
523
- # @version LayOut 2018
524
- def start_offset_length=(offset_length)
525
- end
526
-
527
- # The {#start_offset_point} method returns the paper space location for the
528
- # start of the first extension line. The first extension line runs from this
529
- # offset point to the start extent point.
530
- #
531
- # inner_angle) start_offset = dim.start_offset_point
532
- #
533
- # @example
534
- # start_point = Geom::Point2d.new(1, 1)
535
- # end_point = Geom::Point2d.new(5, 5)
536
- # start_extent = Geom::Point2d.new(1, 2)
537
- # end_extent = Geom::Point2d.new(5, 6)
538
- # inner_angle = true
539
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
540
- #
541
- # @return [Geom::Point2d] start_offset
542
- #
543
- # @version LayOut 2018
544
- def start_offset_point
545
- end
546
-
547
- # The {#text} method returns a copy of the {Layout::AngularDimension}'s
548
- # {Layout::FormattedText}.
549
- #
550
- # inner_angle) text = dim.text
551
- #
552
- # @example
553
- # start_point = Geom::Point2d.new(1, 1)
554
- # end_point = Geom::Point2d.new(5, 5)
555
- # start_extent = Geom::Point2d.new(1, 2)
556
- # end_extent = Geom::Point2d.new(5, 6)
557
- # inner_angle = true
558
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
559
- #
560
- # @note With the addition of auto-text in dimensions for LayOut 2019.2, the
561
- # copy of the dimension text incorrectly provided the plain text when
562
- # requesting the display text. This has been fixed for LayOut 2020.1.
563
- #
564
- # @return [Layout::FormattedText]
565
- #
566
- # @version LayOut 2018
567
- def text
568
- end
569
-
570
- # The {#text=} method sets the {Layout::AngularDimension}'s
571
- # {Layout::FormattedText}.
572
- #
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
- # @example
577
- # start_point = Geom::Point2d.new(1, 1)
578
- # end_point = Geom::Point2d.new(5, 5)
579
- # start_extent = Geom::Point2d.new(1, 2)
580
- # end_extent = Geom::Point2d.new(5, 6)
581
- # inner_angle = true
582
- # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
583
- #
584
- # @param [Layout::FormattedText] formatted_text
585
- #
586
- # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
587
- # {Layout::Layer}
588
- #
589
- # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
590
- #
591
- # @version LayOut 2018
592
- def text=(formatted_text)
593
- end
594
-
595
- end
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # References an angular dimension entity. An {Layout::AngularDimension} is
5
+ # composed of the following sub-entities:
6
+ # - two 'extension lines' that extend from the {Layout::Entity} being
7
+ # dimensioned.
8
+ # - a 'dimension line' connecting the ends of the leaders. This may be
9
+ # represented by one or two {Layout::Path}s depending on appearance.
10
+ # - an optional 'leader line' that is used for small {Layout::AngularDimension}s.
11
+ # - a 'dimension text' that displays the {Layout::AngularDimension}'s text.
12
+ #
13
+ # There are seven points that may be modified for an {Layout::AngularDimension}:
14
+ # - two 'connection points' that define the start and end of the
15
+ # {Layout::AngularDimension}.
16
+ # - two 'extent points' that define the start and end of the dimension line and
17
+ # are the ends of the two extension lines.
18
+ # - two 'offset points' that define the starting points of the extension lines.
19
+ # - one 'arc center point' that defines the center of the
20
+ # {Layout::AngularDimension}, where the extension lines intersect.
21
+ #
22
+ # @version LayOut 2018
23
+ class Layout::AngularDimension < Layout::Entity
24
+
25
+ # Constants
26
+
27
+ LEADER_LINE_TYPE_BEZIER = nil # Stub value.
28
+ LEADER_LINE_TYPE_HIDDEN = nil # Stub value.
29
+ LEADER_LINE_TYPE_SINGLE_SEGMENT = nil # Stub value.
30
+ LEADER_LINE_TYPE_TWO_SEGMENT = nil # Stub value.
31
+
32
+ # Instance Methods
33
+
34
+ # The {#angle} method returns the {Layout::AngularDimension}'s angle. The angle
35
+ # is represented in radians.
36
+ #
37
+ # inner_angle) angle = dim.angle
38
+ #
39
+ # @example
40
+ # start_point = Geom::Point2d.new(1, 1)
41
+ # end_point = Geom::Point2d.new(5, 5)
42
+ # start_extent = Geom::Point2d.new(1, 2)
43
+ # end_extent = Geom::Point2d.new(5, 6)
44
+ # inner_angle = true
45
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
46
+ #
47
+ # @return [Numeric]
48
+ #
49
+ # @version LayOut 2018
50
+ def angle
51
+ end
52
+
53
+ # The {#arc_center_point} method returns the paper space location for the
54
+ # dimension arc center point.
55
+ #
56
+ # inner_angle) center = dim.arc_center_point
57
+ #
58
+ # @example
59
+ # start_point = Geom::Point2d.new(1, 1)
60
+ # end_point = Geom::Point2d.new(5, 5)
61
+ # start_extent = Geom::Point2d.new(1, 2)
62
+ # end_extent = Geom::Point2d.new(5, 6)
63
+ # inner_angle = true
64
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
65
+ #
66
+ # @return [Geom::Point2d]
67
+ #
68
+ # @version LayOut 2018
69
+ def arc_center_point
70
+ end
71
+
72
+ # The {#custom_text=} sets whether or not the {Layout::AngularDimension} uses
73
+ # custom text. When +true+, the text will display a custom string that doesn't
74
+ # change. When +false+, the text will display the length measurement and wil
75
+ # update automatically.
76
+ #
77
+ # inner_angle) dim.custom_text = true
78
+ #
79
+ # @example
80
+ # start_point = Geom::Point2d.new(1, 1)
81
+ # end_point = Geom::Point2d.new(5, 5)
82
+ # start_extent = Geom::Point2d.new(1, 2)
83
+ # end_extent = Geom::Point2d.new(5, 6)
84
+ # inner_angle = true
85
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
86
+ #
87
+ # @param [Boolean] uses_custom_text
88
+ #
89
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
90
+ # {Layout::Layer}
91
+ #
92
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
93
+ #
94
+ # @version LayOut 2018
95
+ def custom_text=(uses_custom_text)
96
+ end
97
+
98
+ # The {#custom_text?} method returns whether the {Layout::AngularDimension}
99
+ # uses custom text. When +true+, the text will display a custom string that
100
+ # doesn't change. When +false+, the text will display the length measurement
101
+ # and will update automatically.
102
+ #
103
+ # inner_angle) # returns false uses_custom_text = dim.custom_text?
104
+ #
105
+ # @example
106
+ # start_point = Geom::Point2d.new(1, 1)
107
+ # end_point = Geom::Point2d.new(5, 5)
108
+ # start_extent = Geom::Point2d.new(1, 2)
109
+ # end_extent = Geom::Point2d.new(5, 6)
110
+ # inner_angle = true
111
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
112
+ #
113
+ # @return [Boolean]
114
+ #
115
+ # @version LayOut 2018
116
+ def custom_text?
117
+ end
118
+
119
+ # The {#end_connection_point} method returns the paper space location for the
120
+ # second connection.
121
+ #
122
+ # inner_angle) end_connection = dim.end_connection_point
123
+ #
124
+ # @example
125
+ # start_point = Geom::Point2d.new(1, 1)
126
+ # end_point = Geom::Point2d.new(5, 5)
127
+ # start_extent = Geom::Point2d.new(1, 2)
128
+ # end_extent = Geom::Point2d.new(5, 6)
129
+ # inner_angle = true
130
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
131
+ #
132
+ # @return [Geom::Point2d]
133
+ #
134
+ # @version LayOut 2018
135
+ def end_connection_point
136
+ end
137
+
138
+ # The {#end_connection_point=} method sets the paper space location for the
139
+ # second connection.
140
+ #
141
+ # inner_angle) dim.end_connection_point = Geom::Point2d.new(6, 6)
142
+ #
143
+ # @example
144
+ # start_point = Geom::Point2d.new(1, 1)
145
+ # end_point = Geom::Point2d.new(5, 5)
146
+ # start_extent = Geom::Point2d.new(1, 2)
147
+ # end_extent = Geom::Point2d.new(5, 6)
148
+ # inner_angle = true
149
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
150
+ #
151
+ # @param [Geom::Point2d] end_point
152
+ #
153
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
154
+ # {Layout::Layer}
155
+ #
156
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
157
+ #
158
+ # @version LayOut 2018
159
+ def end_connection_point=(end_point)
160
+ end
161
+
162
+ # The {#end_extent_point} method returns the paper space location for the
163
+ # end of the dimension line.
164
+ #
165
+ # inner_angle) end_ext_point = dim.end_extent_point
166
+ #
167
+ # @example
168
+ # start_point = Geom::Point2d.new(1, 1)
169
+ # end_point = Geom::Point2d.new(5, 5)
170
+ # start_extent = Geom::Point2d.new(1, 2)
171
+ # end_extent = Geom::Point2d.new(5, 6)
172
+ # inner_angle = true
173
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
174
+ #
175
+ # @return [Geom::Point2d] end_extent
176
+ #
177
+ # @version LayOut 2018
178
+ def end_extent_point
179
+ end
180
+
181
+ # The {#end_extent_point=} method sets the paper space location for the
182
+ # end of the dimension line.
183
+ #
184
+ # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_extent_point = Geom::Point2d.new(6,
185
+ # 6)
186
+ #
187
+ # @example
188
+ # start_point = Geom::Point2d.new(1, 1)
189
+ # end_point = Geom::Point2d.new(5, 5)
190
+ # start_extent = Geom::Point2d.new(1, 2)
191
+ # end_extent = Geom::Point2d.new(5, 6)
192
+ # inner_angle = true
193
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
194
+ #
195
+ # @param [Geom::Point2d] end_extent
196
+ #
197
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
198
+ # {Layout::Layer}
199
+ #
200
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
201
+ #
202
+ # @version LayOut 2018
203
+ def end_extent_point=(end_extent)
204
+ end
205
+
206
+ # The {#end_offset_length=} method sets the length of the offset from the
207
+ # second connection point to the start of the second extension line. The
208
+ # connection and extent points will not move.
209
+ #
210
+ # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.end_offset_length = 0.5
211
+ #
212
+ # @example
213
+ # start_point = Geom::Point2d.new(1, 1)
214
+ # end_point = Geom::Point2d.new(5, 5)
215
+ # start_extent = Geom::Point2d.new(1, 2)
216
+ # end_extent = Geom::Point2d.new(5, 6)
217
+ # inner_angle = true
218
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
219
+ #
220
+ # @param [Numeric] offset_length
221
+ #
222
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
223
+ # {Layout::Layer}
224
+ #
225
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
226
+ #
227
+ # @version LayOut 2018
228
+ def end_offset_length=(offset_length)
229
+ end
230
+
231
+ # The {#end_offset_point} method returns the paper space location for the
232
+ # end of the first extension line. The first extension line runs from this
233
+ # offset point to the end extent point.
234
+ #
235
+ # inner_angle) end_offset = dim.end_offset_point
236
+ #
237
+ # @example
238
+ # start_point = Geom::Point2d.new(1, 1)
239
+ # end_point = Geom::Point2d.new(5, 5)
240
+ # start_extent = Geom::Point2d.new(1, 2)
241
+ # end_extent = Geom::Point2d.new(5, 6)
242
+ # inner_angle = true
243
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
244
+ #
245
+ # @return [Geom::Point2d] end_offset
246
+ #
247
+ # @version LayOut 2018
248
+ def end_offset_point
249
+ end
250
+
251
+ # The {#entities} method returns the {Layout::Entities} that represent the
252
+ # {Layout::AngularDimension} in its exploded form. Depending on the appearance
253
+ # of the {Layout::AngularDimension} being exploded, this may return anywhere
254
+ # from four to six {Layout::Entity}s: start extension line, end extension line,
255
+ # one or two dimension lines, dimension text, and optionally the leader line.
256
+ #
257
+ # inner_angle) entites = dim.entities
258
+ #
259
+ # @example
260
+ # start_point = Geom::Point2d.new(1, 1)
261
+ # end_point = Geom::Point2d.new(5, 5)
262
+ # start_extent = Geom::Point2d.new(1, 2)
263
+ # end_extent = Geom::Point2d.new(5, 6)
264
+ # inner_angle = true
265
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
266
+ #
267
+ # @return [Layout::Entities]
268
+ #
269
+ # @version LayOut 2018
270
+ def entities
271
+ end
272
+
273
+ # The {#initialize} method creates a new disconnected
274
+ # {Layout::AngularDimension}.
275
+ #
276
+ # inner_angle)
277
+ #
278
+ # @example
279
+ # start_point = Geom::Point2d.new(1, 1)
280
+ # end_point = Geom::Point2d.new(5, 5)
281
+ # start_extent = Geom::Point2d.new(1, 2)
282
+ # end_extent = Geom::Point2d.new(5, 6)
283
+ # inner_angle = true
284
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
285
+ #
286
+ # @param [Geom::Point2d] start_point
287
+ # Where the {Layout::AngularDimension}
288
+ # should start
289
+ #
290
+ # @param [Geom::Point2d] end_point
291
+ # Where the {Layout::AngularDimension} should
292
+ # end
293
+ #
294
+ # @param [Geom::Point2d] start_extent_point
295
+ # The extent point where the
296
+ # dimension line should start
297
+ #
298
+ # @param [Geom::Point2d] end_extent_point
299
+ # The extent point where the dimension
300
+ # line should end
301
+ #
302
+ # @param [Boolean] inner_angle
303
+ # Whether or not the {Layout::AngularDimension}
304
+ # should measure the inner angle. If +false+, it will measure the outer angle.
305
+ #
306
+ # @return [Layout::AngularDimension]
307
+ #
308
+ # @version LayOut 2018
309
+ def initialize(start_point, end_point, start_extent_point, end_extent_point, inner_angle)
310
+ end
311
+
312
+ # The {#leader_line_type} method returns the type of leader line the
313
+ # {Layout::AngularDimension} is using.
314
+ #
315
+ # The leader line type can be one of the following:
316
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
317
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_TWO_SEGMENT+]
318
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
319
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
320
+ #
321
+ # inner_angle) type = dim.leader_line_type
322
+ #
323
+ # @example
324
+ # start_point = Geom::Point2d.new(1, 1)
325
+ # end_point = Geom::Point2d.new(5, 5)
326
+ # start_extent = Geom::Point2d.new(1, 2)
327
+ # end_extent = Geom::Point2d.new(5, 6)
328
+ # inner_angle = true
329
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
330
+ #
331
+ # @return [Integer]
332
+ #
333
+ # @version LayOut 2018
334
+ def leader_line_type
335
+ end
336
+
337
+ # The {#leader_line_type=} method sets the type of leader line the
338
+ # {Layout::AngularDimension} is using.
339
+ #
340
+ # The leader line type can be one of the following:
341
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_SINGLE_SEGMENT+]
342
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_TWO_SEGMENT+]
343
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER+]
344
+ # [+Layout::AngularDimension::LEADER_LINE_TYPE_HIDDEN+]
345
+ #
346
+ # inner_angle) dim.leader_line_type = Layout::AngularDimension::LEADER_LINE_TYPE_BEZIER
347
+ #
348
+ # @example
349
+ # start_point = Geom::Point2d.new(1, 1)
350
+ # end_point = Geom::Point2d.new(5, 5)
351
+ # start_extent = Geom::Point2d.new(1, 2)
352
+ # end_extent = Geom::Point2d.new(5, 6)
353
+ # inner_angle = true
354
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
355
+ #
356
+ # @param [Integer] type
357
+ # The leader line type
358
+ #
359
+ # @raise [ArgumentError] if type is not a valid leader line type
360
+ #
361
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
362
+ # {Layout::Layer}
363
+ #
364
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
365
+ #
366
+ # @version LayOut 2018
367
+ def leader_line_type=(type)
368
+ end
369
+
370
+ # The {#radius} method returns the {Layout::AngularDimension}'s radius. This is
371
+ # the distance from the arc center point to the dimension line.
372
+ #
373
+ # inner_angle) radius = dim.radius
374
+ #
375
+ # @example
376
+ # start_point = Geom::Point2d.new(1, 1)
377
+ # end_point = Geom::Point2d.new(5, 5)
378
+ # start_extent = Geom::Point2d.new(1, 2)
379
+ # end_extent = Geom::Point2d.new(5, 6)
380
+ # inner_angle = true
381
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
382
+ #
383
+ # @return [Numeric]
384
+ #
385
+ # @version LayOut 2018
386
+ def radius
387
+ end
388
+
389
+ # The {#radius=} method sets the the {Layout::AngularDimension}'s radius. This
390
+ # is the distance from the arc center point to the dimension line.
391
+ #
392
+ # inner_angle) dim.radius = 2.0
393
+ #
394
+ # @example
395
+ # start_point = Geom::Point2d.new(1, 1)
396
+ # end_point = Geom::Point2d.new(5, 5)
397
+ # start_extent = Geom::Point2d.new(1, 2)
398
+ # end_extent = Geom::Point2d.new(5, 6)
399
+ # inner_angle = true
400
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
401
+ #
402
+ # @param [Numeric] radius
403
+ #
404
+ # @raise [ArgumentError] is radius is negative
405
+ #
406
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
407
+ # {Layout::Layer}
408
+ #
409
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
410
+ #
411
+ # @version LayOut 2018
412
+ def radius=(radius)
413
+ end
414
+
415
+ # The {#start_connection_point} method returns the paper space location for the
416
+ # first connection.
417
+ #
418
+ # inner_angle) start_connection = dim.start_connection_point
419
+ #
420
+ # @example
421
+ # start_point = Geom::Point2d.new(1, 1)
422
+ # end_point = Geom::Point2d.new(5, 5)
423
+ # start_extent = Geom::Point2d.new(1, 2)
424
+ # end_extent = Geom::Point2d.new(5, 6)
425
+ # inner_angle = true
426
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
427
+ #
428
+ # @return [Geom::Point2d]
429
+ #
430
+ # @version LayOut 2018
431
+ def start_connection_point
432
+ end
433
+
434
+ # The {#start_connection_point=} method sets the paper space location for the
435
+ # first connection.
436
+ #
437
+ # inner_angle) dim.start_connection_point = Geom::Point2d.new(2, 2)
438
+ #
439
+ # @example
440
+ # start_point = Geom::Point2d.new(1, 1)
441
+ # end_point = Geom::Point2d.new(5, 5)
442
+ # start_extent = Geom::Point2d.new(1, 2)
443
+ # end_extent = Geom::Point2d.new(5, 6)
444
+ # inner_angle = true
445
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
446
+ #
447
+ # @param [Geom::Point2d] start_point
448
+ #
449
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
450
+ # {Layout::Layer}
451
+ #
452
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
453
+ #
454
+ # @version LayOut 2018
455
+ def start_connection_point=(start_point)
456
+ end
457
+
458
+ # The {#start_extent_point} method returns the paper space location for the
459
+ # start of the dimension line.
460
+ #
461
+ # inner_angle) start_ext_point = dim.start_extent_point
462
+ #
463
+ # @example
464
+ # start_point = Geom::Point2d.new(1, 1)
465
+ # end_point = Geom::Point2d.new(5, 5)
466
+ # start_extent = Geom::Point2d.new(1, 2)
467
+ # end_extent = Geom::Point2d.new(5, 6)
468
+ # inner_angle = true
469
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
470
+ #
471
+ # @return [Geom::Point2d] start_extent
472
+ #
473
+ # @version LayOut 2018
474
+ def start_extent_point
475
+ end
476
+
477
+ # The {#start_extent_point=} method sets the paper space location for the
478
+ # start of the dimension line.
479
+ #
480
+ # inner_angle) start_ext_point = Geom::Point2d.new(2, 3) dim.start_extent_point =
481
+ # Geom::Point2d.new(2, 2)
482
+ #
483
+ # @example
484
+ # start_point = Geom::Point2d.new(1, 1)
485
+ # end_point = Geom::Point2d.new(5, 5)
486
+ # start_extent = Geom::Point2d.new(1, 2)
487
+ # end_extent = Geom::Point2d.new(5, 6)
488
+ # inner_angle = true
489
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
490
+ #
491
+ # @param [Geom::Point2d] start_extent
492
+ #
493
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
494
+ # {Layout::Layer}
495
+ #
496
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
497
+ #
498
+ # @version LayOut 2018
499
+ def start_extent_point=(start_extent)
500
+ end
501
+
502
+ # The {#start_offset_length=} method sets the length of the offset from the
503
+ # first connection point to the start of the first extension line. The
504
+ # connection and extent points will not move.
505
+ #
506
+ # inner_angle) end_ext_point = Geom::Point2d.new(5, 6) dim.start_offset_length = 0.5
507
+ #
508
+ # @example
509
+ # start_point = Geom::Point2d.new(1, 1)
510
+ # end_point = Geom::Point2d.new(5, 5)
511
+ # start_extent = Geom::Point2d.new(1, 2)
512
+ # end_extent = Geom::Point2d.new(5, 6)
513
+ # inner_angle = true
514
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
515
+ #
516
+ # @param [Numeric] offset_length
517
+ #
518
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
519
+ # {Layout::Layer}
520
+ #
521
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
522
+ #
523
+ # @version LayOut 2018
524
+ def start_offset_length=(offset_length)
525
+ end
526
+
527
+ # The {#start_offset_point} method returns the paper space location for the
528
+ # start of the first extension line. The first extension line runs from this
529
+ # offset point to the start extent point.
530
+ #
531
+ # inner_angle) start_offset = dim.start_offset_point
532
+ #
533
+ # @example
534
+ # start_point = Geom::Point2d.new(1, 1)
535
+ # end_point = Geom::Point2d.new(5, 5)
536
+ # start_extent = Geom::Point2d.new(1, 2)
537
+ # end_extent = Geom::Point2d.new(5, 6)
538
+ # inner_angle = true
539
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
540
+ #
541
+ # @return [Geom::Point2d] start_offset
542
+ #
543
+ # @version LayOut 2018
544
+ def start_offset_point
545
+ end
546
+
547
+ # The {#text} method returns a copy of the {Layout::AngularDimension}'s
548
+ # {Layout::FormattedText}.
549
+ #
550
+ # inner_angle) text = dim.text
551
+ #
552
+ # @example
553
+ # start_point = Geom::Point2d.new(1, 1)
554
+ # end_point = Geom::Point2d.new(5, 5)
555
+ # start_extent = Geom::Point2d.new(1, 2)
556
+ # end_extent = Geom::Point2d.new(5, 6)
557
+ # inner_angle = true
558
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
559
+ #
560
+ # @note With the addition of auto-text in dimensions for LayOut 2019.2, the
561
+ # copy of the dimension text incorrectly provided the plain text when
562
+ # requesting the display text. This has been fixed for LayOut 2020.1.
563
+ #
564
+ # @return [Layout::FormattedText]
565
+ #
566
+ # @version LayOut 2018
567
+ def text
568
+ end
569
+
570
+ # The {#text=} method sets the {Layout::AngularDimension}'s
571
+ # {Layout::FormattedText}.
572
+ #
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
+ # @example
577
+ # start_point = Geom::Point2d.new(1, 1)
578
+ # end_point = Geom::Point2d.new(5, 5)
579
+ # start_extent = Geom::Point2d.new(1, 2)
580
+ # end_extent = Geom::Point2d.new(5, 6)
581
+ # inner_angle = true
582
+ # dim = Layout::AngularDimension.new(start_point, end_point, start_extent, end_extent,
583
+ #
584
+ # @param [Layout::FormattedText] formatted_text
585
+ #
586
+ # @raise [LockedLayerError] if the {Layout::AngularDimension} is on a locked
587
+ # {Layout::Layer}
588
+ #
589
+ # @raise [LockedEntityError] if the {Layout::AngularDimension} is locked
590
+ #
591
+ # @version LayOut 2018
592
+ def text=(formatted_text)
593
+ end
594
+
595
+ end