sketchup-api-stubs 0.7.10 → 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 (159) 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 +1 -1
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +2 -2
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +25 -15
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +17 -32
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +1 -1
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +62 -39
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +136 -104
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +56 -30
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +76 -52
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +35 -31
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +8 -16
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +135 -110
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +207 -222
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +6 -6
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +1 -1
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +1 -1
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +11 -7
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +1 -1
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +1 -1
  22. data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb +234 -0
  23. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +124 -10
  24. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +1 -1
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +1 -1
  26. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +112 -4
  27. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +1 -1
  28. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +1 -1
  29. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +4 -4
  30. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +1 -1
  31. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +1 -1
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +1 -1
  33. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +1 -1
  34. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +1 -1
  35. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +56 -9
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +1 -1
  37. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +1 -1
  38. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +100 -1
  39. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +13 -14
  40. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +1 -1
  41. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +5 -3
  42. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +1 -1
  43. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +1 -1
  44. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +1 -1
  45. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +47 -1
  46. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +1 -1
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +1 -1
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +1 -1
  49. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +1 -1
  50. data/lib/sketchup-api-stubs/stubs/Layout.rb +1 -1
  51. data/lib/sketchup-api-stubs/stubs/Length.rb +9 -1
  52. data/lib/sketchup-api-stubs/stubs/Numeric.rb +1 -1
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +65 -13
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +1 -1
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +1 -1
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +2 -7
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +16 -3
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +13 -13
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +8 -14
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +10 -15
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +1 -1
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +2 -2
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +1 -1
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +28 -14
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +15 -8
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +1 -1
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +7 -12
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +1 -1
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +1 -1
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +4 -10
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +1 -1
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +1 -1
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +17 -15
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +17 -17
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +1 -1
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +3 -3
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +11 -14
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +2 -2
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +10 -10
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +59 -19
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +1 -1
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +1 -1
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +3 -3
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +1 -1
  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 +3 -6
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +94 -25
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +2 -2
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +16 -26
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +24 -17
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +11 -9
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +1 -1
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +4 -67
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +2 -2
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +2 -2
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +34 -8
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +1 -1
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +4 -3
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +14 -8
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +3 -45
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +1 -19
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +1 -9
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +1 -1
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +10 -3
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +1 -1
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +1 -1
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb +70 -0
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +1 -1
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +831 -130
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +35 -22
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +1 -1
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +1 -1
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +146 -88
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +20 -5
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +14 -11
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +1 -1
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +1 -1
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +17 -44
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +1 -13
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +158 -16
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +48 -21
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +1 -1
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +61 -40
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +1 -1
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +13 -1
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +1 -1
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +1 -1
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +84 -91
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +1 -1
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +1 -2
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +9 -5
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +1 -1
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +1 -1
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb +125 -0
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +20 -1
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +59 -13
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +29 -8
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +13 -31
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +9 -9
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +229 -139
  143. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +1 -1
  144. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +1 -1
  145. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +1 -1
  146. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +23 -22
  147. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +336 -99
  148. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +34 -8
  149. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +71 -36
  150. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +11 -11
  151. data/lib/sketchup-api-stubs/stubs/String.rb +1 -1
  152. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +21 -9
  153. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +80 -5
  154. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +14 -3
  155. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +20 -3
  156. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +9 -6
  157. data/lib/sketchup-api-stubs/stubs/UI.rb +77 -14
  158. data/lib/sketchup-api-stubs/stubs/_top_level.rb +7 -7
  159. metadata +10 -24
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # An Image object represents a raster image placed in the Model.
@@ -97,11 +97,6 @@ class Sketchup::Image < Sketchup::Drawingelement
97
97
  # entities = model.active_entities
98
98
  # image = entities.add_image path, pt, 300
99
99
  # height = image.height
100
- # if (height)
101
- # UI.messagebox height
102
- # else
103
- # UI.messagebox "Failure"
104
- # end
105
100
  #
106
101
  # @return height - the height of the model if successful
107
102
  #
@@ -121,11 +116,6 @@ class Sketchup::Image < Sketchup::Drawingelement
121
116
  # image = entities.add_image path, pt, 300
122
117
  # UI.messagebox "Before adjustment"
123
118
  # height = image.height = 400
124
- # if (height)
125
- # UI.messagebox height
126
- # else
127
- # UI.messagebox "Failure"
128
- # end
129
119
  #
130
120
  # @param height
131
121
  # The height, in inches, to set the image.
@@ -166,11 +156,6 @@ class Sketchup::Image < Sketchup::Drawingelement
166
156
  # entities = model.active_entities
167
157
  # image = entities.add_image path, pt, 300
168
158
  # vector = image.normal
169
- # if (vector)
170
- # UI.messagebox vector
171
- # else
172
- # UI.messagebox "Failure"
173
- # end
174
159
  #
175
160
  # @return vector - a Vector3d object if successful
176
161
  #
@@ -188,11 +173,7 @@ class Sketchup::Image < Sketchup::Drawingelement
188
173
  # entities = model.active_entities
189
174
  # image = entities.add_image path, pt, 300
190
175
  # origin = image.origin
191
- # if (origin)
192
- # UI.messagebox origin
193
- # else
194
- # UI.messagebox "Failure"
195
- # end
176
+ # puts origin.inspect
196
177
  #
197
178
  # @return point - a Point3d object containing the origin location
198
179
  # if successful
@@ -201,7 +182,7 @@ class Sketchup::Image < Sketchup::Drawingelement
201
182
  def origin
202
183
  end
203
184
 
204
- # The origin= method is used to set the 3D point as the origin of the image.
185
+ # The {#origin=} method is used to set the 3D point as the origin of the image.
205
186
  #
206
187
  # @example
207
188
  # model = Sketchup.active_model
@@ -212,11 +193,7 @@ class Sketchup::Image < Sketchup::Drawingelement
212
193
  # image = entities.add_image path, pt, 300
213
194
  # UI.messagebox "Before Move"
214
195
  # origin = image.origin=pt2
215
- # if (origin)
216
- # UI.messagebox origin
217
- # else
218
- # UI.messagebox "Failure"
219
- # end
196
+ # puts origin.inspect
220
197
  #
221
198
  # @param point
222
199
  # A Point3d object with the new origin.
@@ -237,11 +214,6 @@ class Sketchup::Image < Sketchup::Drawingelement
237
214
  # entities = model.active_entities
238
215
  # image = entities.add_image path, pt, 300
239
216
  # path = image.path
240
- # if (path)
241
- # UI.messagebox path
242
- # else
243
- # UI.messagebox "Failure"
244
- # end
245
217
  #
246
218
  # @return path - the path for the image file if successful
247
219
  #
@@ -259,11 +231,6 @@ class Sketchup::Image < Sketchup::Drawingelement
259
231
  # entities = model.active_entities
260
232
  # image = entities.add_image path, pt, 300
261
233
  # pixelheight = image.pixelheight
262
- # if (pixelheight)
263
- # UI.messagebox pixelheight
264
- # else
265
- # UI.messagebox "Failure"
266
- # end
267
234
  #
268
235
  # @return height - the height of the image in pixels if
269
236
  # successful
@@ -282,11 +249,6 @@ class Sketchup::Image < Sketchup::Drawingelement
282
249
  # entities = model.active_entities
283
250
  # image = entities.add_image path, pt, 300
284
251
  # pixelwidth = image.pixelwidth
285
- # if (pixelwidth)
286
- # UI.messagebox pixelwidth
287
- # else
288
- # UI.messagebox "Failure"
289
- # end
290
252
  #
291
253
  # @return width - the width of the image in pixels if successful
292
254
  #
@@ -304,11 +266,6 @@ class Sketchup::Image < Sketchup::Drawingelement
304
266
  # image = entities.add_image path, pt, 300
305
267
  # UI.messagebox "Before Resize"
306
268
  # size = image.size= 500,500
307
- # if (size)
308
- # UI.messagebox size
309
- # else
310
- # UI.messagebox "Failure"
311
- # end
312
269
  #
313
270
  # @param width
314
271
  # The width of the image.
@@ -335,11 +292,6 @@ class Sketchup::Image < Sketchup::Drawingelement
335
292
  # image = entities.add_image path, pt, 300
336
293
  # UI.messagebox "Before Move"
337
294
  # image = image.transform! t
338
- # if (image)
339
- # UI.messagebox image
340
- # else
341
- # UI.messagebox "Failure"
342
- # end
343
295
  #
344
296
  # @param transform
345
297
  # A Transformation object.
@@ -404,11 +356,6 @@ class Sketchup::Image < Sketchup::Drawingelement
404
356
  # entities = model.active_entities
405
357
  # image = entities.add_image path, pt, 300
406
358
  # width = image.width
407
- # if (width)
408
- # UI.messagebox width
409
- # else
410
- # UI.messagebox "Failure"
411
- # end
412
359
  #
413
360
  # @return width - the width of the image if successful
414
361
  #
@@ -428,11 +375,6 @@ class Sketchup::Image < Sketchup::Drawingelement
428
375
  # image = entities.add_image path, pt, 300
429
376
  # UI.messagebox "Before adjustment"
430
377
  # width = image.width=400
431
- # if (width)
432
- # UI.messagebox width
433
- # else
434
- # UI.messagebox "Failure"
435
- # end
436
378
  #
437
379
  # @param width
438
380
  # The width, in inches, to set the image.
@@ -453,11 +395,6 @@ class Sketchup::Image < Sketchup::Drawingelement
453
395
  # entities = model.active_entities
454
396
  # image = entities.add_image path, pt, 300
455
397
  # zrotation = image.zrotation
456
- # if (zrotation)
457
- # UI.messagebox zrotation
458
- # else
459
- # UI.messagebox "Failure"
460
- # end
461
398
  #
462
399
  # @return vector - a Vector3d object if successful
463
400
  #
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # References an image representation object.
@@ -203,7 +203,7 @@ class Sketchup::ImageRep
203
203
  #
204
204
  # @note The encoding of the pixel_data {String} parameter should be ASCII-8BIT.
205
205
  # Any other encoding could corrupt the binary data. Using
206
- # `Array#pack("C*")` gives correct encoding.
206
+ # +Array#pack("C*")+ gives correct encoding.
207
207
  #
208
208
  # @param [Integer] width
209
209
  # The width of the pixel data. Must be greater than 0.
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Importer interface lets you build your own importers for SketchUp. To
@@ -52,7 +52,7 @@
52
52
  # # to import. This is where you do the real work of opening and
53
53
  # # processing the file.
54
54
  # def load_file(file_path, status)
55
- # UI.messagebox(file_path)
55
+ # # This where you do your import logic.
56
56
  #
57
57
  # return Sketchup::Importer::ImportSuccess
58
58
  # end
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The {Sketchup::InputPoint} class is used to pick 3d points and/or entities
@@ -271,30 +271,56 @@ class Sketchup::InputPoint
271
271
  #
272
272
  # @example
273
273
  # view = Sketchup.active_model.active_view
274
- # x = 100
275
- # y = 100
274
+ # x = 100 # Screen coordinate
275
+ # y = 200 # Screen coordinate
276
276
  # inputpoint = view.inputpoint(x, y)
277
- # inputpoint2 = Sketchup::InputPoint.new(Geom::Point3d.new(100, 200, 300))
277
+ # inputpoint2 = Sketchup::InputPoint.new(Geom::Point3d.new(100, 250, 300))
278
278
  # inputpoint.pick(view, x, y)
279
279
  # inputpoint.pick(view, x, y, inputpoint2)
280
280
  #
281
281
  # @overload pick(view, x, y)
282
282
  #
283
+ # @note Signature for versions prior to SketchUp 2025.0
284
+ # @version SketchUp 6.0
285
+ # The first form just uses the screen position to compute the InputPoint. It
286
+ # is used when you don't want the InputPoint to be dependent on another
287
+ # InputPoint.
288
+ # @param [Sketchup::View] view
289
+ # @param [Integer] x Screen coordinate in physical pixels.
290
+ # @param [Integer] y Screen coordinate in physical pixels.
291
+ #
292
+ # @overload pick(view, x, y, inputpoint)
293
+ #
294
+ # @note Signature for versions prior to SketchUp 2025.0
295
+ # @version SketchUp 6.0
296
+ # The second form uses the screen position and another InputPoint. It will
297
+ # find additional inferences such as along one of the axis directions from the
298
+ # first point.
299
+ # @param [Sketchup::View] view
300
+ # @param [Integer] x Screen coordinate in physical pixels.
301
+ # @param [Integer] y Screen coordinate in physical pixels.
302
+ # @param [Sketchup::InputPoint] inputpoint
303
+ # A second input point used as a reference for the pick.
304
+ #
305
+ # @overload pick(view, x, y)
306
+ #
307
+ # @version SketchUp 2025.0
283
308
  # The first form just uses the screen position to compute the InputPoint. It
284
309
  # is used when you don't want the InputPoint to be dependent on another
285
310
  # InputPoint.
286
311
  # @param [Sketchup::View] view
287
- # @param [Integer] x
288
- # @param [Integer] y
312
+ # @param [Float] x Screen coordinate in logical pixels.
313
+ # @param [Float] y Screen coordinate in logical pixels.
289
314
  #
290
315
  # @overload pick(view, x, y, inputpoint)
291
316
  #
317
+ # @version SketchUp 2025.0
292
318
  # The second form uses the screen position and another InputPoint. It will
293
319
  # find additional inferences such as along one of the axis directions from the
294
320
  # first point.
295
321
  # @param [Sketchup::View] view
296
- # @param [Integer] x
297
- # @param [Integer] y
322
+ # @param [Float] x Screen coordinate in logical pixels.
323
+ # @param [Float] y Screen coordinate in logical pixels.
298
324
  # @param [Sketchup::InputPoint] inputpoint
299
325
  # A second input point used as a reference for the pick.
300
326
  #
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This observer interface is implemented to react to component instance
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The {Sketchup::InstancePath} class represent the instance path to a given
@@ -152,7 +152,8 @@ class Sketchup::InstancePath
152
152
  #
153
153
  # @raise [TypeError] if the instance path refer to deleted entities.
154
154
  #
155
- # @return [Sketchup::Entity]
155
+ # @return [Sketchup::Entity, nil] Nil if the last item of the instance path is a group or
156
+ # component, otherwise {Sketchup::Entity}.
156
157
  #
157
158
  # @version SketchUp 2017
158
159
  def leaf
@@ -212,7 +213,7 @@ class Sketchup::InstancePath
212
213
  #
213
214
  # @raise [TypeError] if the instance path refer to deleted entities.
214
215
  #
215
- # @return [Sketchup::Group, Sketchup::ComponentInstance, nil]
216
+ # @return [Sketchup::Group, Sketchup::ComponentInstance, Sketchup::Image, nil]
216
217
  #
217
218
  # @version SketchUp 2017
218
219
  def root
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Layer class contains methods modifying and extracting information for a
@@ -83,7 +83,7 @@ class Sketchup::Layer < Sketchup::Entity
83
83
  def color
84
84
  end
85
85
 
86
- # The {#color=} method is used to set the name of a layer.
86
+ # The {#color=} method is used to set the color of a layer.
87
87
  #
88
88
  # @example
89
89
  # model = Sketchup.active_model
@@ -98,6 +98,7 @@ class Sketchup::Layer < Sketchup::Entity
98
98
  end
99
99
 
100
100
  # The {#display_name} method is used to retrieve the display name of the layer.
101
+ # This is the name shown to the user in the Sketchup UI.
101
102
  #
102
103
  # @example
103
104
  # model = Sketchup.active_model
@@ -105,6 +106,10 @@ class Sketchup::Layer < Sketchup::Entity
105
106
  # new_layer = layers.add ("test layer")
106
107
  # name = new_layer.display_name
107
108
  #
109
+ # @note The display name and internal name of layers should share the same value except for the
110
+ # Layer0. From version 2020.0 onwards the display name of Layer0 is "Untagged" and it is
111
+ # localized.
112
+ #
108
113
  # @return [String]
109
114
  #
110
115
  # @see #name
@@ -115,8 +120,6 @@ class Sketchup::Layer < Sketchup::Entity
115
120
 
116
121
  # The {#folder} method is used to return the parent layer folder of a layer.
117
122
  #
118
- # @api TagFolder
119
- #
120
123
  # @example
121
124
  # model = Sketchup.active_model
122
125
  # layers = model.layers
@@ -137,8 +140,6 @@ class Sketchup::Layer < Sketchup::Entity
137
140
  # This will trigger +onParentFolderChanged+ in normal cases and
138
141
  # +onLayerChanged+ during undo/redo.
139
142
  #
140
- # @api TagFolder
141
- #
142
143
  # @example
143
144
  # model = Sketchup.active_model
144
145
  # layers = model.layers
@@ -180,7 +181,8 @@ class Sketchup::Layer < Sketchup::Entity
180
181
  def line_style=(line_style)
181
182
  end
182
183
 
183
- # The {#name} method is used to retrieve the name of the layer.
184
+ # The {#name} method return the internal name of the layer which is handled by the model.
185
+ # Its use is for scripting and internal references.
184
186
  #
185
187
  # @example
186
188
  # model = Sketchup.active_model
@@ -188,7 +190,11 @@ class Sketchup::Layer < Sketchup::Entity
188
190
  # new_layer = layers.add "test layer"
189
191
  # name = new_layer.name
190
192
  #
191
- # @return [String]
193
+ # @note The internal layer and display name of layers should share the same value except for the
194
+ # Layer0. From version 2020.0 onwards the display name of Layer0 is "Untagged" and it is
195
+ # localized.
196
+ #
197
+ # @return [String] representing the name of the layer
192
198
  #
193
199
  # @see #display_name
194
200
  #
@@ -1,10 +1,8 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # Allows layers to be organized in folders. Folders may have duplicate names.
5
5
  #
6
- # @api TagFolder
7
- #
8
6
  # @note As of SketchUp 2020 "Layers" were renamed to "Tags" in the UI.
9
7
  # The API retains the use of "Layer" for compatibility and is synonymous with
10
8
  # "Tag".
@@ -21,8 +19,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
21
19
  # The {#<=>} method is used to compare two layer folders based on their names.
22
20
  # This enables the Ruby +Array#sort+ method to sort SketchUp layer folders.
23
21
  #
24
- # @api TagFolder
25
- #
26
22
  # @example
27
23
  # model = Sketchup.active_model
28
24
  # layers = model.layers
@@ -45,13 +41,11 @@ class Sketchup::LayerFolder < Sketchup::Entity
45
41
 
46
42
  # The {#==} method is used to determine if two layer folders are the same.
47
43
  #
48
- # @api TagFolder
49
- #
50
44
  # @example
51
45
  # model = Sketchup.active_model
52
46
  # layers = model.layers
53
- # folder1 = layers.add('Folder1')
54
- # folder2 = layers.add('Folder2')
47
+ # folder1 = layers.add_folder('Folder1')
48
+ # folder2 = layers.add_folder('Folder2')
55
49
  # equal = folder1 == folder2
56
50
  #
57
51
  # @param [Object] other
@@ -64,8 +58,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
64
58
 
65
59
  # The {#add_folder} method adds or moves a layer folder.
66
60
  #
67
- # @api TagFolder
68
- #
69
61
  # @example
70
62
  # manager = Sketchup.active_model.layers
71
63
  # folder1 = manager.add_folder('Doors')
@@ -95,8 +87,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
95
87
 
96
88
  # The {#add_layer} method adds a layer to a folder.
97
89
  #
98
- # @api TagFolder
99
- #
100
90
  # @example
101
91
  # manager = Sketchup.active_model.layers
102
92
  # layer = manager.add_layer('Inner Doors')
@@ -119,8 +109,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
119
109
  # The {#count_folders} method retrieves the number of child folders in the
120
110
  # folder.
121
111
  #
122
- # @api TagFolder
123
- #
124
112
  # @example
125
113
  # layers = Sketchup.active_model.layers
126
114
  # folder1 = layers.add_folder('Hello')
@@ -135,8 +123,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
135
123
 
136
124
  # The {#count_layers} method retrieves the number of layers in the folder.
137
125
  #
138
- # @api TagFolder
139
- #
140
126
  # @example
141
127
  # layers = Sketchup.active_model.layers
142
128
  # layer = layers.add_layer('World')
@@ -159,8 +145,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
159
145
  # The {#each_folder} method is used to iterate through the folders that are
160
146
  # direct children to the folder.
161
147
  #
162
- # @api TagFolder
163
- #
164
148
  # @example
165
149
  # model = Sketchup.active_model
166
150
  # layers = model.layers
@@ -179,8 +163,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
179
163
  # The {#each_layer} method is used to iterate through the layers that are
180
164
  # direct children to the folder.
181
165
  #
182
- # @api TagFolder
183
- #
184
166
  # @example
185
167
  # model = Sketchup.active_model
186
168
  # layers = model.layers
@@ -201,8 +183,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
201
183
  # The {#folder} method is used to return the parent layer folder of a layer
202
184
  # folder.
203
185
  #
204
- # @api TagFolder
205
- #
206
186
  # @example
207
187
  # model = Sketchup.active_model
208
188
  # layers = model.layers
@@ -224,8 +204,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
224
204
  #
225
205
  # This will trigger +onLayerFolderRemoved+ followed by +onLayerFolderAdded+.
226
206
  #
227
- # @api TagFolder
228
- #
229
207
  # @example
230
208
  # model = Sketchup.active_model
231
209
  # layers = model.layers
@@ -244,8 +222,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
244
222
 
245
223
  # The {#folders} returns the direct child-folders of the folder.
246
224
  #
247
- # @api TagFolder
248
- #
249
225
  # @example
250
226
  # manager = Sketchup.active_model.layers
251
227
  # folder1 = manager.add_folder('Doors')
@@ -260,8 +236,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
260
236
 
261
237
  # The {#layers} method retrieves the child layers of a folder.
262
238
  #
263
- # @api TagFolder
264
- #
265
239
  # @example
266
240
  # manager = Sketchup.active_model.layers
267
241
  # folder = manager.add_folder('Hello')
@@ -278,8 +252,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
278
252
 
279
253
  # The {#name} method gets the name of the folder.
280
254
  #
281
- # @api TagFolder
282
- #
283
255
  # @example
284
256
  # manager = Sketchup.active_model.layers
285
257
  # folder = manager.add_folder('Doors')
@@ -294,8 +266,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
294
266
 
295
267
  # The {#name=} method sets the name of the folder.
296
268
  #
297
- # @api TagFolder
298
- #
299
269
  # @example
300
270
  # manager = Sketchup.active_model.layers
301
271
  # folder = manager.add_folder('Doors')
@@ -312,8 +282,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
312
282
  # The {#remove_folder} method removes the folder from the model. All children
313
283
  # are preserved, but move up one level.
314
284
  #
315
- # @api TagFolder
316
- #
317
285
  # @example
318
286
  # manager = Sketchup.active_model.layers
319
287
  # folder1 = manager.add_folder('Doors')
@@ -333,8 +301,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
333
301
  # The {#remove_layer} method removes a layer from a folder. The layer will be
334
302
  # parent to the layer manager.
335
303
  #
336
- # @api TagFolder
337
- #
338
304
  # @example
339
305
  # manager = Sketchup.active_model.layers
340
306
  # layer = manager.add_layer('Inner Doors')
@@ -353,8 +319,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
353
319
 
354
320
  # The {#visible=} method is used to set if the layer folder is visible.
355
321
  #
356
- # @api TagFolder
357
- #
358
322
  # @example
359
323
  # model = Sketchup.active_model
360
324
  # layers = model.layers
@@ -369,8 +333,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
369
333
 
370
334
  # The {#visible?} method is used to determine if the layer folder is visible.
371
335
  #
372
- # @api TagFolder
373
- #
374
336
  # @example
375
337
  # model = Sketchup.active_model
376
338
  # layers = model.layers
@@ -386,8 +348,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
386
348
  # The {#visible_on_new_pages=} method is used to set if the layer folder is by
387
349
  # default visible on new pages.
388
350
  #
389
- # @api TagFolder
390
- #
391
351
  # @example
392
352
  # model = Sketchup.active_model
393
353
  # layers = model.layers
@@ -405,8 +365,6 @@ class Sketchup::LayerFolder < Sketchup::Entity
405
365
  # The {#visible_on_new_pages?} method is used to determine if the layer folder
406
366
  # is by default visible on new pages.
407
367
  #
408
- # @api TagFolder
409
- #
410
368
  # @example
411
369
  # model = Sketchup.active_model
412
370
  # layers = model.layers
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Layers collection allows you to see and manage all of the layers in a
@@ -63,8 +63,6 @@ class Sketchup::Layers < Sketchup::Entity
63
63
 
64
64
  # The {#add_folder} method adds or moves a layer folder.
65
65
  #
66
- # @api TagFolder
67
- #
68
66
  # @example
69
67
  # manager = Sketchup.active_model.layers
70
68
  # folder = manager.add_folder('Doors')
@@ -143,8 +141,6 @@ class Sketchup::Layers < Sketchup::Entity
143
141
  # The {#count_folders} method counts the number of folders which are direct
144
142
  # children of the layer manager.
145
143
  #
146
- # @api TagFolder
147
- #
148
144
  # @example
149
145
  # manager = Sketchup.active_model.layers
150
146
  # folder = manager.add_folder('Doors')
@@ -158,8 +154,6 @@ class Sketchup::Layers < Sketchup::Entity
158
154
 
159
155
  # The {#count_layers} method retrieves the number of layers not in a folder.
160
156
  #
161
- # @api TagFolder
162
- #
163
157
  # @example
164
158
  # layers = Sketchup.active_model.layers
165
159
  # number = layers.count_layers
@@ -199,8 +193,6 @@ class Sketchup::Layers < Sketchup::Entity
199
193
  # The {#each_folder} method is used to iterate through the folders that are
200
194
  # direct children to the layer manager.
201
195
  #
202
- # @api TagFolder
203
- #
204
196
  # @example
205
197
  # manager = Sketchup.active_model.layers
206
198
  # folder = manager.add_folder('Doors')
@@ -220,8 +212,6 @@ class Sketchup::Layers < Sketchup::Entity
220
212
  # The {#each_layer} method is used to iterate through the layers that are not
221
213
  # inside a layer folder.
222
214
  #
223
- # @api TagFolder
224
- #
225
215
  # @example
226
216
  # model = Sketchup.active_model
227
217
  # layers = model.layers
@@ -238,8 +228,6 @@ class Sketchup::Layers < Sketchup::Entity
238
228
 
239
229
  # The {#folders} method returns the folders of the layer manager.
240
230
  #
241
- # @api TagFolder
242
- #
243
231
  # @example
244
232
  # manager = Sketchup.active_model.layers
245
233
  # manager.add_folder('Doors')
@@ -257,8 +245,6 @@ class Sketchup::Layers < Sketchup::Entity
257
245
 
258
246
  # The {#layers} method retrieves the layers not in a folder.
259
247
  #
260
- # @api TagFolder
261
- #
262
248
  # @example
263
249
  # manager = Sketchup.active_model.layers
264
250
  # layers = manager.layers
@@ -301,8 +287,6 @@ class Sketchup::Layers < Sketchup::Entity
301
287
  # The {#purge_unused_folders} method is used to remove all layer folder with
302
288
  # no children.
303
289
  #
304
- # @api TagFolder
305
- #
306
290
  # @example
307
291
  # manager = Sketchup.active_model.layers
308
292
  # folder = manager.add_folder('Doors')
@@ -353,8 +337,6 @@ class Sketchup::Layers < Sketchup::Entity
353
337
  # The {#remove_folder} method removes the folder from the model. All children are
354
338
  # preserved, but moved up one level.
355
339
  #
356
- # @api TagFolder
357
- #
358
340
  # @example
359
341
  # manager = Sketchup.active_model.layers
360
342
  # folder = manager.add_folder('Doors')
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # This observer interface is implemented to react to layers events.
@@ -92,8 +92,6 @@ class Sketchup::LayersObserver
92
92
  # The {#onLayerFolderAdded} method is called when a layer folder is added
93
93
  # to a model.
94
94
  #
95
- # @api TagFolder
96
- #
97
95
  # @example
98
96
  # class MyLayersObserver < Sketchup::LayersObserver
99
97
  # def onLayerFolderAdded(layers, layer_folder)
@@ -118,8 +116,6 @@ class Sketchup::LayersObserver
118
116
  # The {#onLayerFolderChanged} method is called when a layer folder changes
119
117
  # one of its properties.
120
118
  #
121
- # @api TagFolder
122
- #
123
119
  # @example
124
120
  # class MyLayersObserver < Sketchup::LayersObserver
125
121
  # def onLayerFolderChanged(layers, layer_folder)
@@ -146,8 +142,6 @@ class Sketchup::LayersObserver
146
142
  # The {#onLayerFolderRemoved} method is called when a layer folder is removed
147
143
  # from a model.
148
144
  #
149
- # @api TagFolder
150
- #
151
145
  # @example
152
146
  # class MyLayersObserver < Sketchup::LayersObserver
153
147
  # def onLayerFolderRemoved(layers, layer_folder)
@@ -196,8 +190,6 @@ class Sketchup::LayersObserver
196
190
  # The {#onParentFolderChanged} method is called when a layer changes parent
197
191
  # folder.
198
192
  #
199
- # @api TagFolder
200
- #
201
193
  # @example
202
194
  # class MyLayersObserver < Sketchup::LayersObserver
203
195
  # def onParentFolderChanged(layers, layer)
@@ -1,4 +1,4 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
4
  # The Sketchup::Licensing::ExtensionLicense class is used to store extension