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::ComponentInstance} class is used to represent component
@@ -109,12 +109,8 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
109
109
  #
110
110
  # @example
111
111
  # # Assuming 'instance' is a ComponentInstance object
112
- # array = instance.explode
113
- # if array
114
- # UI.messagebox "Exploded the component instance"
115
- # else
116
- # UI.messagebox "Failure"
117
- # end
112
+ # instance = Sketchup.active_model.active_entities.grep(Sketchup::ComponentInstance).first
113
+ # entities = instance.explode
118
114
  #
119
115
  # @return [Array<Sketchup::Entity>, false] An array of entity objects if successful, +false+ if
120
116
  # unsuccessful
@@ -519,13 +515,19 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
519
515
  # new_transformation = Geom::Transformation.new([100,0,0])
520
516
  # componentinstance.transformation = new_transformation
521
517
  #
518
+ # @note As of SketchUp 2026, this will raise an error if the
519
+ # {Geom::Transformation} is not invertible. Prior to 2026 this would silently set the
520
+ # transformation possibly causing rendering or editing problems.
521
+ #
522
522
  # @param [Geom::Transformation] transformation
523
523
  #
524
+ # @raise ArgumentError if the {Geom::Transformation} is not invertible (as of Sketchup 2026)
525
+ #
524
526
  # @version SketchUp 6.0
525
527
  def transformation=(transformation)
526
528
  end
527
529
 
528
- # The trim method is used to compute the (non-destructive) boolean difference
530
+ # The {#trim} method is used to compute the (non-destructive) boolean difference
529
531
  # of the two instances representing manifold solid volumes (this - arg). If
530
532
  # the specified objects (this and arg) do not represent manifold volumes, this
531
533
  # method fails.
@@ -536,6 +538,11 @@ class Sketchup::ComponentInstance < Sketchup::Drawingelement
536
538
  # instance2 = entities[1]
537
539
  # result = instance1.trim(instance2)
538
540
  #
541
+ # @note Trimming object instance2 using instance1 results in a new trimmed version of instance2.
542
+ # If the trim is successful the original instance2 is erased and a newly trimmed
543
+ # version is created. This new version, derived from the trimming operation,
544
+ # will possess a new GUID and will be returned.
545
+ #
539
546
  # @note This method is not available in SketchUp Make.
540
547
  #
541
548
  # @param [Sketchup::ComponentInstance] 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 Console class is used by SketchUp to direct $stdout and $stderr to 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 ConstructionLine class contains methods for modifying construction
@@ -20,11 +20,6 @@ class Sketchup::ConstructionLine < Sketchup::Drawingelement
20
20
  # point2 = Geom::Point3d.new(20,20,20)
21
21
  # constline = entities.add_cline(point1, point2)
22
22
  # vector = constline.direction
23
- # if (vector)
24
- # UI.messagebox(vector)
25
- # else
26
- # UI.messagebox("Failure")
27
- # end
28
23
  #
29
24
  # @return vector - a Vector3d object if successful
30
25
  #
@@ -83,12 +78,12 @@ class Sketchup::ConstructionLine < Sketchup::Drawingelement
83
78
  # @example
84
79
  # model = Sketchup.active_model
85
80
  # entities = model.active_entities
86
- # point1 = Geom::Point3d.new(0,0,0)
87
- # point2 = Geom::Point3d.new(20,20,20)
88
- # point3 = Geom::Point3d.new(10,10,10)
81
+ # point1 = Geom::Point3d.new(0, 0, 0)
82
+ # point2 = Geom::Point3d.new(20, 20, 20)
83
+ # point3 = Geom::Point3d.new(10, 10, 10)
89
84
  # constline = entities.add_cline(point1, point2)
90
- # UI.messagebox(constline.end)
91
- # # Will display point2
85
+ # constline.end = point3
86
+ # # Will shorten the line to [10, 10, 10]
92
87
  #
93
88
  # @overload end=(point)
94
89
  #
@@ -225,7 +220,7 @@ class Sketchup::ConstructionLine < Sketchup::Drawingelement
225
220
  # constline = entities.add_cline(point1, point2)
226
221
  # puts constline.stipple
227
222
  #
228
- # @return [String]
223
+ # @return [Integer]
229
224
  #
230
225
  # @version SketchUp 6.0
231
226
  def stipple
@@ -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
  # A construction point represents a point in the model that can be used to aid
@@ -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 Curve class is used by SketchUp to unite a series of Edge objects into
@@ -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
  # A DefinitionList object holds a list of all of the ComponentDefinition
@@ -145,7 +145,7 @@ class Sketchup::DefinitionList < Sketchup::Entity
145
145
  # be skipped as the indices change. Instead copy the current collection to an
146
146
  # array using +to_a+ and then use +each+ on the array, when removing content.
147
147
  #
148
- # @return [nil]
148
+ # @return [Sketchup::ComponentDefinition]
149
149
  #
150
150
  # @version SketchUp 6.0
151
151
  #
@@ -233,7 +233,7 @@ class Sketchup::DefinitionList < Sketchup::Entity
233
233
  # @param [String] path
234
234
  # The path where the component definition file is located.
235
235
  #
236
- # @overload load(path, allow_newer: true)
236
+ # @overload load(path, allow_newer: false)
237
237
  #
238
238
  # Starting with SketchUp 2021.0 SketchUp attempts to load newer SketchUp
239
239
  # models. If a newer model is loaded some information might have been skipped
@@ -268,13 +268,7 @@ class Sketchup::DefinitionList < Sketchup::Entity
268
268
  #
269
269
  # This method throws an exception if an url string is not
270
270
  # given, or an error occurs during retrieval from URL and a
271
- # +load_handler+ was not given. Optional second parameter +load_handler+ can be
272
- # used to pass in a Ruby object that responds to the following methods:
273
- #
274
- # - +cancelled?+
275
- # - +onPercentChange(percent)+
276
- # - +onSuccess()+
277
- # - +onFailure(message_string)+
271
+ # {Sketchup::LoadHandler load_handler} was not given.
278
272
  #
279
273
  # @bug Calling this method from an {UI::HtmlDialog}'s action callback on macOS will cause the
280
274
  # SketchUp application to become unresponsive or crash. To work around this, defer the call
@@ -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 definition
@@ -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 events on a definitions
@@ -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 Dimension class provides base functionality for classes DimensionLinear
@@ -38,13 +38,14 @@ class Sketchup::Dimension < Sketchup::Drawingelement
38
38
  def add_observer(observer)
39
39
  end
40
40
 
41
- # The arrow_type method retrieves the current arrow type of the dimension.
42
- # Valid arrow types are class constants:
43
- # - +Dimension::ARROW_NONE,+
44
- # - +Dimension::ARROW_SLASH+
45
- # - +Dimension::ARROW_DOT+
46
- # - +Dimension::ARROW_CLOSED+
47
- # - +Dimension::ARROW_OPEN+
41
+ # The {#arrow_type} method retrieves the current arrow type of the dimension.
42
+ #
43
+ # Valid arrow types are:
44
+ # - {Sketchup::Dimension::ARROW_NONE}
45
+ # - {Sketchup::Dimension::ARROW_SLASH}
46
+ # - {Sketchup::Dimension::ARROW_DOT}
47
+ # - {Sketchup::Dimension::ARROW_CLOSED}
48
+ # - {Sketchup::Dimension::ARROW_OPEN}
48
49
  #
49
50
  # @example
50
51
  # type = dim.arrow_type
@@ -58,13 +59,14 @@ class Sketchup::Dimension < Sketchup::Drawingelement
58
59
  def arrow_type
59
60
  end
60
61
 
61
- # The arrow_type= method sets the arrow type of the dimension.
62
- # Valid arrow types are class constants:
63
- # - +Dimension::ARROW_NONE,+
64
- # - +Dimension::ARROW_SLASH+
65
- # - +Dimension::ARROW_DOT+
66
- # - +Dimension::ARROW_CLOSED+
67
- # - +Dimension::ARROW_OPEN+
62
+ # The {#arrow_type=} method sets the arrow type of the dimension.
63
+ #
64
+ # Valid arrow types are:
65
+ # - {Sketchup::Dimension::ARROW_NONE}
66
+ # - {Sketchup::Dimension::ARROW_SLASH}
67
+ # - {Sketchup::Dimension::ARROW_DOT}
68
+ # - {Sketchup::Dimension::ARROW_CLOSED}
69
+ # - {Sketchup::Dimension::ARROW_OPEN}
68
70
  #
69
71
  # @example
70
72
  # dim.arrow_type = Sketchup::Dimension::ARROW_CLOSED
@@ -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 DimensionLinear class represents linear dimensions.
@@ -18,12 +18,12 @@ class Sketchup::DimensionLinear < Sketchup::Dimension
18
18
 
19
19
  # Instance Methods
20
20
 
21
- # The aligned_text_position method returns the text position for dimensions
21
+ # The {#aligned_text_position} method returns the text position for dimensions
22
22
  # with aligned text (i.e. has_aligned_text? returns true).
23
23
  # Valid values are class constants:
24
- # - DimensionLinear::ALIGNED_TEXT_ABOVE
25
- # - DimensionLinear::ALIGNED_TEXT_CENTER
26
- # - DimensionLinear::ALIGNED_TEXT_OUTSIDE
24
+ # - {Sketchup::DimensionLinear::ALIGNED_TEXT_ABOVE}
25
+ # - {Sketchup::DimensionLinear::ALIGNED_TEXT_CENTER}
26
+ # - {Sketchup::DimensionLinear::ALIGNED_TEXT_OUTSIDE}
27
27
  #
28
28
  # @example
29
29
  # pos = dim.aligned_text_position
@@ -41,12 +41,12 @@ class Sketchup::DimensionLinear < Sketchup::Dimension
41
41
  def aligned_text_position
42
42
  end
43
43
 
44
- # The aligned_text_position= method is used to set the text position for
44
+ # The {#aligned_text_position=} method is used to set the text position for
45
45
  # dimensions with aligned text (i.e. has_aligned_text? returns true).
46
46
  # Valid values are class constants:
47
- # - DimensionLinear::ALIGNED_TEXT_ABOVE
48
- # - DimensionLinear::ALIGNED_TEXT_CENTER
49
- # - DimensionLinear::ALIGNED_TEXT_OUTSIDE
47
+ # - {Sketchup::DimensionLinear::ALIGNED_TEXT_ABOVE}
48
+ # - {Sketchup::DimensionLinear::ALIGNED_TEXT_CENTER}
49
+ # - {Sketchup::DimensionLinear::ALIGNED_TEXT_OUTSIDE}
50
50
  #
51
51
  # @example
52
52
  # dim.aligned_text_position = Sketchup::DimensionLinear::ALIGNED_TEXT_CENTER
@@ -263,11 +263,11 @@ class Sketchup::DimensionLinear < Sketchup::Dimension
263
263
  def start_attached_to=(path)
264
264
  end
265
265
 
266
- # The text_position method returns the position of the text along the dimension
266
+ # The {#text_position} method returns the position of the text along the dimension
267
267
  # line. Valid values are class constants:
268
- # - DimensionLinear::TEXT_OUTSIDE_START
269
- # - DimensionLinear::TEXT_CENTERED
270
- # - DimensionLinear::TEXT_OUTSIDE_END
268
+ # - {Sketchup::DimensionLinear::TEXT_OUTSIDE_START}
269
+ # - {Sketchup::DimensionLinear::TEXT_CENTERED}
270
+ # - {Sketchup::DimensionLinear::TEXT_OUTSIDE_END}
271
271
  #
272
272
  # @example
273
273
  # pos = dim.text_position
@@ -285,11 +285,11 @@ class Sketchup::DimensionLinear < Sketchup::Dimension
285
285
  def text_position
286
286
  end
287
287
 
288
- # The text_position= method is used to set the position of the text along the
288
+ # The {#text_position=} method is used to set the position of the text along the
289
289
  # dimension line. Valid values are class constants:
290
- # - DimensionLinear::TEXT_OUTSIDE_START
291
- # - DimensionLinear::TEXT_CENTERED
292
- # - DimensionLinear::TEXT_OUTSIDE_END
290
+ # - {Sketchup::DimensionLinear::TEXT_OUTSIDE_START}
291
+ # - {Sketchup::DimensionLinear::TEXT_CENTERED}
292
+ # - {Sketchup::DimensionLinear::TEXT_OUTSIDE_END}
293
293
  #
294
294
  # @example
295
295
  # dim.text_position = Sketchup::DimensionLinear::TEXT_CENTERED
@@ -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 changes in dimension text.
@@ -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 DimensionRadial class represents radius and diameter dimensions on
@@ -37,7 +37,7 @@ class Sketchup::DimensionRadial < Sketchup::Dimension
37
37
  def arc_curve=(arc_curve)
38
38
  end
39
39
 
40
- # The leader_break_point method returns the break point on the leader where the
40
+ # The {#leader_break_point} method returns the break point on the leader where the
41
41
  # dimension text is attached.
42
42
  #
43
43
  # @example
@@ -50,7 +50,7 @@ class Sketchup::DimensionRadial < Sketchup::Dimension
50
50
  def leader_break_point
51
51
  end
52
52
 
53
- # The leader_break_point= method is used to set the break point on the leader
53
+ # The {#leader_break_point=} method is used to set the break point on the leader
54
54
  # where the dimension text is attached.
55
55
  #
56
56
  # @example
@@ -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
  # Drawingelement is a base class for an item in the model that can be
@@ -60,7 +60,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
60
60
  #
61
61
  # # Make the face not cast shadows.
62
62
  # status = face.casts_shadows = false
63
- # UI.messagebox status.to_s
64
63
  #
65
64
  # @param [Boolean] casts
66
65
  # true if you want the Drawingelement object to cast
@@ -89,7 +88,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
89
88
  # # Add the face to the entities in the model
90
89
  # face = entities.add_face pts
91
90
  # status = face.casts_shadows?
92
- # UI.messagebox status.to_s
93
91
  #
94
92
  # @return [Boolean]
95
93
  #
@@ -176,7 +174,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
176
174
  # # Add the face to the entities in the model
177
175
  # face = entities.add_face pts
178
176
  # status = face.hidden?
179
- # UI.messagebox "hidden? " + status.to_s
180
177
  #
181
178
  # @return [Boolean]
182
179
  #
@@ -281,8 +278,8 @@ class Sketchup::Drawingelement < Sketchup::Entity
281
278
  # # Returns nil if not successful, path if successful.
282
279
  # # Should return a texture object.
283
280
  # m.texture = "c:\\My Textures\\Carpet.jpg"
284
- # rescue
285
- # UI.messagebox $!.message
281
+ # rescue => exception
282
+ # puts exception.message
286
283
  # end
287
284
  # # You will see the material applied when you reverse the box's faces
288
285
  # material = face.material = m
@@ -315,7 +312,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
315
312
  #
316
313
  # # Make the face not receive shadows.
317
314
  # status = face.receives_shadows = false
318
- # UI.messagebox status.to_s
319
315
  #
320
316
  # @param [Boolean] receive
321
317
  # true if you want the Drawingelement object to
@@ -343,7 +339,6 @@ class Sketchup::Drawingelement < Sketchup::Entity
343
339
  # # Add the face to the entities in the model
344
340
  # face = entities.add_face pts
345
341
  # status = face.receives_shadows?
346
- # UI.messagebox status.to_s
347
342
  #
348
343
  # @return [Boolean]
349
344
  #
@@ -351,7 +346,7 @@ class Sketchup::Drawingelement < Sketchup::Entity
351
346
  def receives_shadows?
352
347
  end
353
348
 
354
- # The visible= method is used to set the visible status for an element. This
349
+ # The {#visible=} method is used to set the visible status for an element. This
355
350
  # method performs an opposite function to the hidden= method.
356
351
  #
357
352
  # @example
@@ -370,16 +365,16 @@ class Sketchup::Drawingelement < Sketchup::Entity
370
365
  # status = face.visible = false
371
366
  #
372
367
  # @param [Boolean] visibility
373
- # true if you want to hide the element, false if not
374
- #
375
- # @return [Boolean] true if the element has been hidden, false if
376
- # the element has not been hidden.
368
+ # true if you want to make the element visible, false if not
377
369
  #
378
370
  # @version SketchUp 6.0
379
371
  def visible=(visibility)
380
372
  end
381
373
 
382
- # The visible? method is used to get the visible status for an element.
374
+ # The {#visible?} method checks if a Drawingelement object is not explicitly hidden (i.e. its
375
+ # hidden property is false). However, this method's return value alone does not guarantee that the
376
+ # element is visible in the model view. Its tag or parent elements can also be hidden. Some element
377
+ # types can also be hidden by rendering options (Styles).
383
378
  #
384
379
  # @example
385
380
  # depth = 100
@@ -399,6 +394,8 @@ class Sketchup::Drawingelement < Sketchup::Entity
399
394
  #
400
395
  # @return [Boolean]
401
396
  #
397
+ # @see Sketchup::Model#drawing_element_visible?
398
+ #
402
399
  # @version SketchUp 6.0
403
400
  def visible?
404
401
  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 Edge class contains methods modifying and extracting information for
@@ -324,7 +324,7 @@ class Sketchup::Edge < Sketchup::Drawingelement
324
324
  def soft?
325
325
  end
326
326
 
327
- # The split method is used to to split an edge into two or more distinct
327
+ # The {#split} method is used to split an edge into two or more distinct
328
328
  # edges. If a Point3d is given, it must be a point that is on the Edge.
329
329
  #
330
330
  # If a Float is given, it is a number between 0 and 1 that gives 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 EdgeUse class defines how an Edge is used in the definition of a Face.
@@ -23,7 +23,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
23
23
  # edgeuse = edgeuses[0]
24
24
  # edge = edgeuse.edge
25
25
  #
26
- # @return edge - an Edge object used by this edge use
26
+ # @return [Sketchup::Edge] an Edge object used by this edge use
27
27
  #
28
28
  # @version SketchUp 6.0
29
29
  def edge
@@ -45,7 +45,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
45
45
  # edgeuse = edgeuses[0]
46
46
  # vector3d = edgeuse.end_vertex_normal
47
47
  #
48
- # @return vector3d - a vector3d object if successful.
48
+ # @return [Geom::Vector3d] a vector3d object if successful.
49
49
  #
50
50
  # @version SketchUp 6.0
51
51
  def end_vertex_normal
@@ -66,7 +66,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
66
66
  # edgeuse = edgeuses[0]
67
67
  # face = edgeuse.face
68
68
  #
69
- # @return face - a Face object used by this edge use
69
+ # @return [Sketchup::Face] a Face object used by this edge use
70
70
  #
71
71
  # @version SketchUp 6.0
72
72
  def face
@@ -87,7 +87,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
87
87
  # edgeuse = edgeuses[0]
88
88
  # loop = edgeuse.loop
89
89
  #
90
- # @return loop - a Loop object that contains this edge use.
90
+ # @return [Sketchup::Loop] a Loop object that contains this edge use.
91
91
  #
92
92
  # @version SketchUp 6.0
93
93
  def loop
@@ -108,7 +108,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
108
108
  # edgeuse = edgeuses[0]
109
109
  # next_edgeuse = edgeuse.next
110
110
  #
111
- # @return edgeuse - the next EdgeUse object in a loop
111
+ # @return [Sketchup::EdgeUse] the next EdgeUse object in a loop
112
112
  #
113
113
  # @version SketchUp 6.0
114
114
  def next
@@ -136,7 +136,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
136
136
  # edgeuse = edgeuses[1]
137
137
  # partners = edgeuse.partners
138
138
  #
139
- # @return array - an array of partner Edge Use objects.
139
+ # @return [Array<Sketchup::EdgeUse>] an array of partner Edge Use objects.
140
140
  #
141
141
  # @version SketchUp 6.0
142
142
  def partners
@@ -157,7 +157,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
157
157
  # edgeuse = edgeuses[0]
158
158
  # previous_edgeuse = edgeuse.previous
159
159
  #
160
- # @return edgeuse - the previous Edge Use object in the loop
160
+ # @return [Sketchup::EdgeUse] the previous Edge Use object in the loop
161
161
  #
162
162
  # @version SketchUp 6.0
163
163
  def previous
@@ -180,7 +180,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
180
180
  # edgeuse = edgeuses[0]
181
181
  # reversed = edgeuse.reversed?
182
182
  #
183
- # @return [Boolean] boolean - true if reversed, false if not reversed.
183
+ # @return [Boolean] true if reversed, false if not reversed.
184
184
  #
185
185
  # @version SketchUp 6.0
186
186
  def reversed?
@@ -202,7 +202,7 @@ class Sketchup::EdgeUse < Sketchup::Entity
202
202
  # edgeuse = edgeuses[0]
203
203
  # vector3d = edgeuse.start_vertex_normal
204
204
  #
205
- # @return vector3d - a vector3d object if successful.
205
+ # @return [Geom::Vector3d] a vector3d object if successful.
206
206
  #
207
207
  # @version SketchUp 6.0
208
208
  def start_vertex_normal
@@ -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::Entities} class is a collection of Entity objects, either in a
@@ -520,8 +520,7 @@ class Sketchup::Entities
520
520
  def add_faces_from_mesh(polygon_mesh, smooth_flags = Geom::PolygonMesh::AUTO_SOFTEN|Geom::PolygonMesh::SMOOTH_SOFT_EDGES, f_material = nil, b_material = nil)
521
521
  end
522
522
 
523
- # The add_group method is used to create an empty group or a group with
524
- # entities.
523
+ # The {#add_group} method is used to create a new group.
525
524
  #
526
525
  # @example
527
526
  # model = Sketchup.active_model
@@ -582,8 +581,8 @@ class Sketchup::Entities
582
581
  def add_image(path, point, width, height = 0.0)
583
582
  end
584
583
 
585
- # The add_instance method adds a component instance to the collection of
586
- # entities.
584
+ # The {#add_instance} method adds a group or component instance to the collection of
585
+ # entities using an existent definition.
587
586
  #
588
587
  # @example
589
588
  # model = Sketchup.active_model
@@ -694,7 +693,9 @@ class Sketchup::Entities
694
693
  def add_observer(observer)
695
694
  end
696
695
 
697
- # The add_section_plane method adds a section plane object to the entities.
696
+ # Adds a section plane object to the entities.
697
+ #
698
+ # Refer to the {Geom} module for information on how planes are represented.
698
699
  #
699
700
  # @example
700
701
  # # Create a section plane
@@ -705,16 +706,53 @@ class Sketchup::Entities
705
706
  # # Make sure section planes are visible
706
707
  # model.rendering_options['DisplaySectionPlanes'] = true
707
708
  #
708
- # @param plane
709
- # the geometric plane where the SectionPlane object is to
710
- # be created. Refer to the Geom module for information on
711
- # how planes are represented.
709
+ # @overload add_section_plane(point, vector)
710
+ #
711
+ # @param [Geom::Point3d] point
712
+ # @param [Geom::Vector3d] vector
713
+ #
714
+ # @overload add_section_plane(plane)
712
715
  #
713
- # @return [Sketchup::SectionPlane, nil] the created SectionPlane object if
714
- # successful, nil on failure.
716
+ # @param [Array(Geom::Point3d), Geom::Vector3d]] plane
717
+ #
718
+ # @overload add_section_plane(plane)
719
+ #
720
+ # @param [Array(Integer, Integer, Integer, Integer)] plane
721
+ # Plane coefficents.
722
+ #
723
+ # @return [Sketchup::SectionPlane, nil]
715
724
  #
716
725
  # @version SketchUp 2014
717
- def add_section_plane(plane)
726
+ def add_section_plane(*args)
727
+ end
728
+
729
+ # The {#add_snap} method is used to create a new {Sketchup::Snap}.
730
+ #
731
+ # @example
732
+ # entities = Sketchup.active_model.entities
733
+ # snap = entities.add_snap(ORIGIN, X_AXIS)
734
+ #
735
+ # @overload add_snap(position, direction)
736
+ #
737
+ # With a position and a direction vector provided, but no up vector, SketchUp tries
738
+ # to keep the Snap upright.
739
+ # @param [Geom::Point3d] position
740
+ # @param [Geom::Vector3d] direction
741
+ #
742
+ # @overload add_snap(position, direction, up)
743
+ #
744
+ # @param [Geom::Point3d] position
745
+ # @param [Geom::Vector3d] direction
746
+ # @param [Geom::Vector3d] up
747
+ #
748
+ # @raise ArgumentError if +direction+ and +up+ are parallel.
749
+ #
750
+ # @return [Sketchup::Snap]
751
+ #
752
+ # @see Sketchup::Snap
753
+ #
754
+ # @version SketchUp 2025.0
755
+ def add_snap(*args)
718
756
  end
719
757
 
720
758
  # The {#add_text} method adds a note or label text entity to the entities.
@@ -825,9 +863,9 @@ class Sketchup::Entities
825
863
  # }
826
864
  #
827
865
  # @note While using {Sketchup::Entities#build} it is important to not
828
- # add or remove vertices by other means of the builder. Also don't modify the
829
- # position of the vertices in the {Sketchup::Entities} container geometry is
830
- # added to. Doing so can break the vertex-cache that de-duplicates the vertices.
866
+ # add or remove vertices by other means than the builder. Also don't modify the
867
+ # position of the vertices in the {Sketchup::Entities} collection. Doing so can break the
868
+ # vertex-cache that de-duplicates the vertices.
831
869
  #
832
870
  # @return [nil]
833
871
  #
@@ -1001,8 +1039,10 @@ class Sketchup::Entities
1001
1039
  def fill_from_mesh(polygon_mesh, weld_vertices = true, smooth_flags = Geom::PolygonMesh::AUTO_SOFTEN|Geom::PolygonMesh::SMOOTH_SOFT_EDGES, f_material = nil, b_material = nil)
1002
1040
  end
1003
1041
 
1004
- # The intersect_with method is used to intersect an entities, component
1005
- # instance, or group object with a entities object.
1042
+ # The {#intersect_with} method is used to intersect a Sketchup::Entities, Sketchup::Component,
1043
+ # or Sketchup::Group object with a entities object.
1044
+ #
1045
+ # empty if no intersection(s) were found.
1006
1046
  #
1007
1047
  # @example
1008
1048
  # model = Sketchup.active_model
@@ -1048,7 +1088,7 @@ class Sketchup::Entities
1048
1088
  # @param [Sketchup::Entity, Array<Sketchup::Entity>] entities2
1049
1089
  # A single entity, or an array of entities.
1050
1090
  #
1051
- # @return [nil]
1091
+ # @return [Array<Sketchup::Edge>] The intersecting edges created. This array may be
1052
1092
  #
1053
1093
  # @version SketchUp 6.0
1054
1094
  def intersect_with(recurse, transform1, entities1, transform2, hidden, entities2)
@@ -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::EntitiesBuilder} is an interface to generate bulk geometry
@@ -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 {Sketchup::Entities}