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
  # The {Sketchup::PickHelper} class is used to pick entities that reside under
@@ -137,28 +137,33 @@ class Sketchup::PickHelper
137
137
  def depth_at(index)
138
138
  end
139
139
 
140
- # The do_pick method is used to perform the initial pick. This method is
140
+ # The {#do_pick} method is used to perform the initial pick. This method is
141
141
  # generally called before any other methods in the PickHelper class.
142
142
  #
143
- # Returns the number of entities picked. The x and y values are the screen
144
- # coordinates of the point at which would want to do a pick.
145
- #
146
143
  # @example
147
- # ph = view.pick_helpernum = ph.do_pick(x, y)
144
+ # ph = view.pick_helper
145
+ # num = ph.do_pick(x, y)
146
+ # entity = ph.best_picked
148
147
  #
149
- # @param x
150
- # X screen coordinate for the pick.
148
+ # @overload do_pick(x, y, aperture = 0)
151
149
  #
152
- # @param y
153
- # Y screen coordinate for the pick.
150
+ # @note Signature for versions prior to SketchUp 2025.0
151
+ # @version SketchUp 6.0
152
+ # @param [Integer] x Screen coordinate in physical pixels.
153
+ # @param [Integer] y Screen coordinate in physical pixels.
154
+ # @param [Integer] aperture The size of the aperture in physical pixels.
155
+ # @return [Integer] Number of entities picked.
154
156
  #
155
- # @param aperture
156
- # The size of the pick-aperture.
157
+ # @overload do_pick(x, y, aperture = 0.0)
157
158
  #
158
- # @return Integer - The number of Entity objects picked
159
+ # @version SketchUp 2025.0
160
+ # @param [Float] x Screen coordinate in logical pixels.
161
+ # @param [Float] y Screen coordinate in logical pixels.
162
+ # @param [Float] aperture The size of the aperture in logical pixels.
163
+ # @return [Integer] Number of entities picked.
159
164
  #
160
165
  # @version SketchUp 6.0
161
- def do_pick(x, y, aperture = 0)
166
+ def do_pick(*args)
162
167
  end
163
168
 
164
169
  # The element_at method is used to retrieve a specific entity in the list of
@@ -190,8 +195,6 @@ class Sketchup::PickHelper
190
195
  # You do not normally need to call this method, but you can use this if you
191
196
  # want to call {#test_point} or {#pick_segment} on a lot of points.
192
197
  #
193
- # If the optional aperture is given, it is given in pixels.
194
- #
195
198
  # @example
196
199
  # ph = view.pick_helper
197
200
  # ph.init(x, y, 5)
@@ -200,19 +203,27 @@ class Sketchup::PickHelper
200
203
  # ph.test_point(point)
201
204
  # }
202
205
  #
203
- # @param [Integer] x
204
- # X screen coordinate for the pick.
206
+ # @overload init(x, y, aperture = 0)
207
+ #
208
+ # @note Signature for versions prior to SketchUp 2025.0
209
+ # @version SketchUp 6.0
210
+ # @param [Integer] x Screen coordinate in physical pixels.
211
+ # @param [Integer] y Screen coordinate in physical pixels.
212
+ # @param [Integer] aperture The size of the aperture in physical pixels.
213
+ # This is the width and height of the square picking aperture.
205
214
  #
206
- # @param [Integer] y
207
- # Y screen coordinate for the pick.
215
+ # @overload init(x, y, aperture = 0.0)
208
216
  #
209
- # @param [Integer] aperture
210
- # aperture in pixels.
217
+ # @version SketchUp 2025.0
218
+ # @param [Integer] x Screen coordinate in logical pixels.
219
+ # @param [Integer] y Screen coordinate in logical pixels.
220
+ # @param [Integer] aperture The size of the aperture in logical pixels.
221
+ # This is the width and height of the square picking aperture.
211
222
  #
212
223
  # @return [Sketchup::PickHelper]
213
224
  #
214
225
  # @version SketchUp 6.0
215
- def init(x, y, aperture = 0)
226
+ def init(*args)
216
227
  end
217
228
 
218
229
  # The leaf_at method retrieves the deepest thing in a pick path.
@@ -305,7 +316,7 @@ class Sketchup::PickHelper
305
316
  #
306
317
  # @param [Array<Geom::Point3d>] points A series of points in the polyline as
307
318
  # a list of parameters or an array containing Point3d
308
- # objects.
319
+ # objects. Model coordinates.
309
320
  # @param [Integer] x screen mouse position in pixels.
310
321
  # @param [Integer] y (required if x given) screen mouse position
311
322
  # in pixels.
@@ -343,13 +354,17 @@ class Sketchup::PickHelper
343
354
  # ph.do_pick(x, y)
344
355
  # entity = ph.picked_element
345
356
  #
346
- # @param index
357
+ # @overload picked_element()
358
+ #
347
359
  #
348
- # @return element - a drawing element that is not an edge or face
349
- # if successful
360
+ # @overload picked_element(index)
361
+ #
362
+ # @param [Integer] index
363
+ #
364
+ # @return [Sketchup::Drawingelement, nil] a drawing element that is not an edge or face
350
365
  #
351
366
  # @version SketchUp 6.0
352
- def picked_element(index)
367
+ def picked_element(*args)
353
368
  end
354
369
 
355
370
  # The picked_face method is used to retrieve the best face picked.
@@ -387,17 +402,19 @@ class Sketchup::PickHelper
387
402
  # This is more efficient if you want to test a lot of points using the same
388
403
  # screen point. But you *must* have called the {#init} method first for this
389
404
  # to work.
390
- # @param [Geom::Point3d] point
405
+ # @param [Geom::Point3d] point Model coordinate.
391
406
  #
392
407
  # @overload test_point(point, x, y, aperture = 0)
393
408
  #
394
- # @param [Geom::Point3d] point
395
- # @param [Integer] x
396
- # @param [Integer] y
397
- # @param [Integer] aperture
409
+ # @param [Geom::Point3d] point Model coordinate.
410
+ # @param [Integer] x X screen coordinate for the pick.
411
+ # @param [Integer] y Y screen coordinate for the pick.
412
+ # @param [Integer] aperture aperture in pixels.
398
413
  #
399
414
  # @return [Boolean]
400
415
  #
416
+ # @see #init
417
+ #
401
418
  # @version SketchUp 6.0
402
419
  def test_point(*args)
403
420
  end
@@ -453,25 +470,29 @@ class Sketchup::PickHelper
453
470
  # Used to pick a set of entities from a model based on a screen coordinate
454
471
  # rectangular area defined by two points. The pick criteria can be for
455
472
  # completely-contained or partially-contained entities, similar to how
456
- # the Selection tool works. The z value of the points passed in are ignored.
473
+ # the Selection tool works. The +z+ value of the points passed in are ignored.
457
474
  #
458
475
  # @example
459
476
  # ph = Sketchup.active_model.active_view.pick_helper
460
477
  # start_point = Geom::Point3d.new(100, 100, 0)
461
478
  # end_point = Geom::Point3d.new(500, 500, 0)
462
479
  # num_picked = ph.window_pick(start_point, end_point, Sketchup::PickHelper::PICK_CROSSING)
480
+ # picked_entities = ph.all_picked
481
+ #
482
+ # @note Prior to SketchUp 2025.0 this method expected physical screen coordinates.
483
+ # As of SketchUp 2025.0 they are expected to be logical screen coordinates.
463
484
  #
464
- # @param start_point
485
+ # @param [Geom::Point3d] start_point
465
486
  # First screen coordinate point.
466
487
  #
467
- # @param end_point
488
+ # @param [Geom::Point3d] end_point
468
489
  # Second screen coordinate point.
469
490
  #
470
- # @param pick_type
471
- # PICK_INSIDE to select entities completely contained or
472
- # PICK_CROSSING to select entities partially contained.
491
+ # @param [Integer] pick_type
492
+ # {PICK_INSIDE} to select entities completely contained or
493
+ # {PICK_CROSSING} to select entities partially contained.
473
494
  #
474
- # @return The number of Entity objects picked
495
+ # @return [Integer] The number of {Sketchup::Drawingelement} objects picked.
475
496
  #
476
497
  # @version SketchUp 2016
477
498
  def window_pick(start_point, end_point, pick_type)
@@ -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::RegionalSettings} module contains methods getting information about the
@@ -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 RenderingOptions class contains method to extract the rendering
@@ -25,6 +25,9 @@
25
25
  # - +EdgeColorMode+
26
26
  # - +EdgeDisplayMode+
27
27
  # - +EdgeType+
28
+ # - Accepted values (Integer):
29
+ # - 0: Standard edges
30
+ # - 1: Sketchy edges
28
31
  # - +ExtendLines+
29
32
  # - +FaceBackColor+
30
33
  # - +FaceFrontColor+
@@ -90,6 +93,10 @@
90
93
  # - +AmbientOcclusionDistance+
91
94
  # - +AmbientOcclusionIntensity+
92
95
  #
96
+ # Added in SketchUp 2026.0:
97
+ # - +AmbientOcclusionColor+
98
+ # - +AmbientOcclusionMultiplier+
99
+ #
93
100
  # @version SketchUp 6.0
94
101
  class Sketchup::RenderingOptions < Sketchup::Entity
95
102
 
@@ -105,9 +112,12 @@ class Sketchup::RenderingOptions < Sketchup::Entity
105
112
  ROPDrawHiddenObjects = nil # Stub value.
106
113
  ROPEditComponent = nil # Stub value.
107
114
  ROPSectionDisplayTurnedOff = nil # Stub value.
115
+ ROPSetAOColor = nil # Stub value.
116
+ ROPSetAOColorEnabled = nil # Stub value.
108
117
  ROPSetAODistance = nil # Stub value.
109
118
  ROPSetAOEnabled = nil # Stub value.
110
119
  ROPSetAOIntensity = nil # Stub value.
120
+ ROPSetAOMultiplier = nil # Stub value.
111
121
  ROPSetBackgroundColor = nil # Stub value.
112
122
  ROPSetConstructionColor = nil # Stub value.
113
123
  ROPSetDepthQueEdges = nil # Stub value.
@@ -138,6 +148,7 @@ class Sketchup::RenderingOptions < Sketchup::Entity
138
148
  ROPSetGroundColor = nil # Stub value.
139
149
  ROPSetGroundTransparency = nil # Stub value.
140
150
  ROPSetHideConstructionGeometry = nil # Stub value.
151
+ ROPSetHideSpaces = nil # Stub value.
141
152
  ROPSetHighlightColor = nil # Stub value.
142
153
  ROPSetHorizonColor = nil # Stub value.
143
154
  ROPSetJitterEdges = nil # Stub value.
@@ -148,6 +159,7 @@ class Sketchup::RenderingOptions < Sketchup::Entity
148
159
  ROPSetLockedColor = nil # Stub value.
149
160
  ROPSetMaterialTransparency = nil # Stub value.
150
161
  ROPSetModelTransparency = nil # Stub value.
162
+ ROPSetModelingGrid = nil # Stub value.
151
163
  ROPSetPhotomatchBackgroundOpacity = nil # Stub value.
152
164
  ROPSetPhotomatchDrawBackground = nil # Stub value.
153
165
  ROPSetPhotomatchDrawOverlay = nil # Stub value.
@@ -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 rendering options events.
@@ -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 SectionPlane class represents a section plane in a SketchUp model. Note
@@ -1,11 +1,11 @@
1
- # Copyright:: Copyright 2024 Trimble Inc.
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
2
  # License:: The MIT License (MIT)
3
3
 
4
- # A set of the currently selected entities. Use the Model.selection method
5
- # to get a Selection object. Note that the order of entities
4
+ # A set of the currently selected drawing elements. Use the Model.selection method
5
+ # to get a Selection object. Note that the order of drawing elements
6
6
  # (<code>selection[0]</code>, <code>selection[1]</code> and so on) in the set
7
7
  # is in no particular order and should not be assumed to be in the same order
8
- # as the user selected the entities.
8
+ # as the user selected the drawing elements.
9
9
  #
10
10
  # @example
11
11
  # # Get a handle to the selection set.
@@ -21,8 +21,8 @@ class Sketchup::Selection
21
21
 
22
22
  # Instance Methods
23
23
 
24
- # The {#[]} method is used to retrieve an {Sketchup::Entity} from the selection
25
- # by index. Index 0 is the first entity in the selection.
24
+ # The {#[]} method is used to retrieve a {Sketchup::Drawingelement} from the selection
25
+ # by index. Index 0 is the first Drawingelement in the selection.
26
26
  #
27
27
  # This method is not very efficient. If you need to look at every entity in
28
28
  # the selection, consider using {#each} instead of using this method
@@ -36,9 +36,9 @@ class Sketchup::Selection
36
36
  # p selection[0]
37
37
  #
38
38
  # @param [Integer] index
39
- # The index of the Entity object to retrieve.
39
+ # The index of the Drawingelement object to retrieve.
40
40
  #
41
- # @return [Sketchup::Entity, nil]
41
+ # @return [Sketchup::Drawingelement, nil]
42
42
  #
43
43
  # @see #at
44
44
  #
@@ -46,36 +46,32 @@ class Sketchup::Selection
46
46
  def [](index)
47
47
  end
48
48
 
49
- # The add method is used to add entities to the selection. Entities that are
49
+ # The {#add} method is used to add Drawingelement to the selection. Drawingelements that are
50
50
  # added to the Selection are visually indicated by the selection bounding box.
51
51
  #
52
- # You can pass it individual Entities or an Array of Entities:
53
- # Note that the add, remove, and toggle methods are all aliases for one
54
- # another. So if you call remove on an entity that is not selected, it will
55
- # be toggled to be selected, not removed! Be cautious when writing your code to
56
- # not make the assumption about the currently selected state of a given entity.
52
+ # You can pass it individual Drawingelements or an Array of Drawingelements.
57
53
  #
58
54
  # @example
59
- # # Add by listing the entities...
55
+ # # Add by listing the Drawingelements...
60
56
  # ss.add(e1, e2, e3)
61
57
  #
62
- # # ...or add by passing an Array of entities.
58
+ # # ...or add by passing an Array of Drawingelements.
63
59
  # ss.add([e1, e2, e3])
64
60
  #
65
61
  # @example
66
- # entities = model.active_entities
67
- # entity = entities[0]
68
- # status = selection.add entity
62
+ # model = Sketchup.active_model
63
+ # edge = model.active_entities.add_line([0, 0, 0], [9, 9, 9])
64
+ # model.selection.add(edge)
69
65
  #
70
- # @overload add(entities)
66
+ # @overload add(drawing_elements)
71
67
  #
72
- # @param [Array<Sketchup::Entity>] entities
68
+ # @param [Array<Sketchup::Drawingelement>] drawing_elements
73
69
  #
74
- # @overload add(*entities)
70
+ # @overload add(*drawing_elements)
75
71
  #
76
- # @param [Array<Sketchup::Entity>] entities
72
+ # @param [Array<Sketchup::Drawingelement>] drawing_elements
77
73
  #
78
- # @return [Integer] the number of Entity objects added
74
+ # @return [Integer] the number of Drawingelement objects added
79
75
  #
80
76
  # @version SketchUp 6.0
81
77
  def add(*args)
@@ -106,9 +102,9 @@ class Sketchup::Selection
106
102
  # p selection.at(0)
107
103
  #
108
104
  # @param [Integer] index
109
- # The index of the Entity object to retrieve.
105
+ # The index of the Drawingelement object to retrieve.
110
106
  #
111
- # @return [Sketchup::Entity, nil]
107
+ # @return [Sketchup::Drawingelement, nil]
112
108
  #
113
109
  # @see #[]
114
110
  #
@@ -130,7 +126,7 @@ class Sketchup::Selection
130
126
  def clear
131
127
  end
132
128
 
133
- # The {contains?} method is and alias of {#include?}.
129
+ # The {#contains?} method is and alias of {#include?}.
134
130
  #
135
131
  # @example
136
132
  # model = Sketchup.active_model
@@ -139,14 +135,14 @@ class Sketchup::Selection
139
135
  # selection.add(entity)
140
136
  # p selection.contains?(entity)
141
137
  #
142
- # @param [Sketchup::Entity] entity
138
+ # @param [Sketchup::Drawingelement] drawing_element
143
139
  #
144
140
  # @return [Boolean]
145
141
  #
146
142
  # @see #include?
147
143
  #
148
144
  # @version SketchUp 6.0
149
- def contains?(entity)
145
+ def contains?(drawing_element)
150
146
  end
151
147
 
152
148
  #
@@ -166,13 +162,13 @@ class Sketchup::Selection
166
162
  def count
167
163
  end
168
164
 
169
- # The {#each} method is used to iterate through all of the selected entities.
165
+ # The {#each} method is used to iterate through all of the selected Drawingelements.
170
166
  #
171
- # If you want to do something with all of the selected Entities, this is more
167
+ # If you want to do something with all of the selected Drawingelements, this is more
172
168
  # efficient than using {#[]}.
173
169
  #
174
170
  # @example
175
- # selection.each { |entity| puts entity }
171
+ # selection.each { |drawing_element| puts drawing_element }
176
172
  #
177
173
  # @note Don't remove content from this collection while iterating over it with
178
174
  # {#each}. This would change the size of the collection and cause elemnts to
@@ -183,15 +179,15 @@ class Sketchup::Selection
183
179
  #
184
180
  # @version SketchUp 6.0
185
181
  #
186
- # @yieldparam [Sketchup::Entity] entity
182
+ # @yieldparam [Sketchup::Drawingelement] drawing_element
187
183
  def each
188
184
  end
189
185
 
190
- # The empty? method is used to determine if there are entities in the
186
+ # The {#empty?} method is used to determine if there are drawing elements in the
191
187
  # selection.
192
188
  #
193
189
  # @example
194
- # status = selection.add entity
190
+ # status = selection.add drawing_element
195
191
  # status = selection.empty
196
192
  #
197
193
  # @return [Boolean]
@@ -200,23 +196,23 @@ class Sketchup::Selection
200
196
  def empty?
201
197
  end
202
198
 
203
- # The first method is used to retrieve the first selected entity
199
+ # The {#first} method is used to retrieve the first selected Drawingelement
204
200
  #
205
201
  # Returns nil if nothing is selected. This method is useful when you know that
206
- # only a single entity is selected, or you are only interested in the first
207
- # selected entity.
202
+ # only a single Drawingelement is selected, or you are only interested in the first
203
+ # selected Drawingelement.
208
204
  #
209
205
  # @example
210
- # status = selection.add entity
211
- # entity = selection.first
206
+ # status = selection.add drawing_element
207
+ # drawing_element = selection.first
212
208
  #
213
- # @return [Sketchup::Entity] the first selected Entity object if successful
209
+ # @return [Sketchup::Drawingelement] the first selected Drawingelement object if successful
214
210
  #
215
211
  # @version SketchUp 6.0
216
212
  def first
217
213
  end
218
214
 
219
- # The {include?} method is used to determine if a given {Sketchup::Entity} is
215
+ # The {#include?} method is used to determine if a given {Sketchup::Drawingelement} is
220
216
  # in the selection.
221
217
  #
222
218
  # @example
@@ -226,14 +222,14 @@ class Sketchup::Selection
226
222
  # selection.add(entity)
227
223
  # p selection.include?(entity)
228
224
  #
229
- # @param [Sketchup::Entity] entity
225
+ # @param [Sketchup::Drawingelement] drawing_element
230
226
  #
231
227
  # @return [Boolean]
232
228
  #
233
229
  # @see #contains?
234
230
  #
235
231
  # @version SketchUp 6.0
236
- def include?(entity)
232
+ def include?(drawing_element)
237
233
  end
238
234
 
239
235
  # The {#invert} method is used to invert the selection.
@@ -257,11 +253,11 @@ class Sketchup::Selection
257
253
  def invert
258
254
  end
259
255
 
260
- # The is_curve? method is used to determine if the selection contains all
256
+ # The {#is_curve?} method is used to determine if the selection contains all
261
257
  # edges that belong to a single curve.
262
258
  #
263
259
  # @example
264
- # selection.add entity
260
+ # selection.add drawing_element
265
261
  # status = selection.is_curve?
266
262
  #
267
263
  # @return [Boolean]
@@ -270,11 +266,11 @@ class Sketchup::Selection
270
266
  def is_curve?
271
267
  end
272
268
 
273
- # The is_surface? method is used to determine if the selection contains only
269
+ # The {#is_surface?} method is used to determine if the selection contains only
274
270
  # all of the faces that are part of a single curved surface.
275
271
  #
276
272
  # @example
277
- # selection.add entity
273
+ # selection.add drawing_element
278
274
  # status = selection.is_surface
279
275
  #
280
276
  # @return [Boolean]
@@ -283,7 +279,7 @@ class Sketchup::Selection
283
279
  def is_surface?
284
280
  end
285
281
 
286
- # The {#length} method is used to retrieve the number of selected entities.
282
+ # The {#length} method is used to retrieve the number of selected drawing elements.
287
283
  #
288
284
  # @example
289
285
  # selection = Sketchup.active_model.selection
@@ -299,7 +295,7 @@ class Sketchup::Selection
299
295
  def length
300
296
  end
301
297
 
302
- # The model method retrieves the model for the selection.
298
+ # The {#model} method retrieves the model for the selection.
303
299
  #
304
300
  # @example
305
301
  # model = selection.model
@@ -325,35 +321,33 @@ class Sketchup::Selection
325
321
  def nitems
326
322
  end
327
323
 
328
- # The remove method is used to remove entities from the selection.
329
- #
330
- # You can pass it individual Entities or an Array of Entities:
331
- # Note that the add, remove, and toggle methods are all aliases for one
332
- # another. So if you call remove on an entity that is not selected, it will
333
- # be toggled to be selected, not removed! Be cautious when writing your code to
334
- # not make the assumption about the currently selected state of a given entity.
324
+ # The {#remove} method is used to remove Drawingelements from the selection.
325
+ # You can pass it individual Drawingelements or an Array of Drawingelements.
335
326
  #
336
327
  # @example
337
- # # Remove by listing the entities...
328
+ # # Remove by listing the Drawingelements...
338
329
  # ss.remove(e1, e2, e3)
339
330
  #
340
- # # ...or remove by passing an Array of entities.
331
+ # # ...or remove by passing an Array of Drawingelements.
341
332
  # ss.remove([e1, e2, e3])
342
333
  #
343
334
  # @example
344
- # entities = model.active_entities
345
- # entity = entities[0]
346
- # status = selection.add entity
335
+ # model = Sketchup.active_model
336
+ # face = model.active_entities.add_line([0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0])
337
+ # edges = face.all_connected
338
+ # model.selection.add(edges)
347
339
  #
348
- # @overload remove(entities)
340
+ # model.selection.remove(edges.first)
349
341
  #
350
- # @param [Array<Sketchup::Entity>] entities
342
+ # @overload remove(drawing_elements)
351
343
  #
352
- # @overload remove(*entities)
344
+ # @param [Array<Sketchup::Drawingelement>] drawing_elements
353
345
  #
354
- # @param [Array<Sketchup::Entity>] entities
346
+ # @overload remove(*drawing_elements)
355
347
  #
356
- # @return [Integer] the number of Entity objects removed
348
+ # @param [Array<Sketchup::Drawingelement>] drawing_elements
349
+ #
350
+ # @return [Integer] the number of Drawingelement objects removed
357
351
  #
358
352
  # @version SketchUp 6.0
359
353
  def remove(*args)
@@ -375,25 +369,25 @@ class Sketchup::Selection
375
369
  def remove_observer(observer)
376
370
  end
377
371
 
378
- # The shift method is used to remove the first entity from the selection and
372
+ # The {#shift} method is used to remove the first Drawingelement from the selection and
379
373
  # returns it.
380
374
  #
381
375
  # @example
382
- # status = selection.add entity
376
+ # status = selection.add drawing_element
383
377
  # UI.messagebox "Ready to remove item from selection set"
384
- # entity = selection.shift
378
+ # drawing_element = selection.shift
385
379
  #
386
- # @return [Sketchup::Entity] the first Entity object in the selection set
380
+ # @return [Sketchup::Drawingelement] the first Drawingelement object in the selection set
387
381
  # if successful
388
382
  #
389
383
  # @version SketchUp 6.0
390
384
  def shift
391
385
  end
392
386
 
393
- # The single_object? method is used to determine if the selection contains a
387
+ # The {#single_object?} method is used to determine if the selection contains a
394
388
  # single object.
395
389
  #
396
- # It can either be a single Entity or a group of Entities for which is_curve?
390
+ # It can either be a single DrawingElement or a group of DrawingElements for which is_curve?
397
391
  # or is_surface? will return true.
398
392
  #
399
393
  # @example
@@ -419,37 +413,36 @@ class Sketchup::Selection
419
413
  def size
420
414
  end
421
415
 
422
- # The toggle method is used to change whether an entity is part of the
423
- # selection. Entities that are not already selected
424
- # are added. Entities that are already selected are removed.
416
+ # The {#toggle} method is used to change whether a Drawingelement is part of the
417
+ # selection. Drawingelements that are not already selected
418
+ # are added. Drawingelements that are already selected are removed.
425
419
  #
426
- # You can pass it individual Entities or an Array of Entities:
427
- # Note that the add, remove, and toggle methods are all aliases for one
428
- # another. So if you call remove on an entity that is not selected, it will
429
- # be toggled to be selected, not removed! Be cautious when writing your code to
430
- # not make the assumption about the currently selected state of a given entity.
420
+ # You can pass it individual Drawingelements or an Array of Drawingelements.
431
421
  #
432
422
  # @example
433
- # # Toggle by listing the entities...
423
+ # # Toggle by listing the Drawingelements...
434
424
  # ss.toggle(e1, e2, e3)
435
425
  #
436
- # # ...or toggle by passing an Array of entities.
426
+ # # ...or toggle by passing an Array of Drawingelements.
437
427
  # ss.toggle([e1, e2, e3])
438
428
  #
439
429
  # @example
440
- # entities = model.active_entities
441
- # entity = entities[0]
442
- # status = selection.add entity
430
+ # model = Sketchup.active_model
431
+ # face = model.active_entities.add_line([0, 0, 0], [9, 0, 0], [9, 9, 0], [0, 9, 0])
432
+ # edges = face.all_connected
433
+ # model.selection.add(edges)
434
+ #
435
+ # model.selection.toggle(edges.first)
443
436
  #
444
- # @overload toggle(entities)
437
+ # @overload toggle(drawings_elements)
445
438
  #
446
- # @param [Array<Sketchup::Entity>] entities
439
+ # @param [Array<Sketchup::Drawingelement>] drawing_elements
447
440
  #
448
- # @overload toggle(*entities)
441
+ # @overload toggle(*drawing_elements)
449
442
  #
450
- # @param [Array<Sketchup::Entity>] entities
443
+ # @param [Array<Sketchup::Drawingelement>] drawing_elements
451
444
  #
452
- # @return [Integer] the number of Entity objects changed
445
+ # @return [Integer] the number of Drawingelement objects changed
453
446
  #
454
447
  # @version SketchUp 6.0
455
448
  def toggle(*args)
@@ -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 selection events.
@@ -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 set class represents a collection of unique objects. This class is useful
@@ -201,7 +201,6 @@ class Sketchup::Set
201
201
  # set.insert('Hello')
202
202
  # set.insert('World')
203
203
  # my_array = set.to_a
204
- # UI.messagebox my_array
205
204
  #
206
205
  # @return array - The Array of the entities in the Set.
207
206
  #