sketchup-api-stubs 0.7.7 → 0.7.9

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 (154) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +151 -147
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +509 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -478
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
  16. data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -351
  17. data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -179
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -515
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  42. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -0
  43. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
  44. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  45. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  49. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  50. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  51. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -577
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -594
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -425
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1126
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -0
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -917
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -405
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -327
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1654
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -478
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +255 -257
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -835
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -71
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1307
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
  143. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1377 -1353
  144. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  145. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  146. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -317
  147. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -478
  148. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
  149. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
  150. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  151. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -672
  152. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
  153. data/lib/sketchup-api-stubs.rb +1 -1
  154. metadata +20 -16
@@ -1,115 +1,115 @@
1
- # Copyright:: Copyright 2021 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This observer interface is implemented to react to selection events.
5
- #
6
- # @abstract To implement this observer, create a Ruby class of this type, override the
7
- # desired methods, and add an instance of the observer to the objects of
8
- # interests.
9
- #
10
- # @example
11
- # # This is an example of an observer that watches the selection for
12
- # # changes.
13
- # class MySelectionObserver < Sketchup::SelectionObserver
14
- # def onSelectionBulkChange(selection)
15
- # puts "onSelectionBulkChange: #{selection}"
16
- # end
17
- # end
18
- #
19
- # # Attach the observer.
20
- # Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
21
- #
22
- # @version SketchUp 6.0
23
- class Sketchup::SelectionObserver
24
-
25
- # Instance Methods
26
-
27
- #
28
- # @example
29
- # def onSelectionAdded(selection, entity)
30
- # puts "onSelectionAdded: #{entity}"
31
- # end
32
- #
33
- # @note This event might not trigger even if a single element is selected. For
34
- # instance the Selection tool will trigger {#onSelectionBulkChange} regardless.
35
- #
36
- # @param [Sketchup::Selection] selection
37
- #
38
- # @param [Sketchup::Entity] entity
39
- #
40
- # @return [nil]
41
- #
42
- # @see onSelectionBulkChange
43
- #
44
- # @version SketchUp 6.0
45
- def onSelectionAdded(selection, entity)
46
- end
47
-
48
- # The {#onSelectionBulkChange} method is called whenever items are added or
49
- # removed from the selection set.
50
- #
51
- # The {#onSelectionBulkChange} callback will not trigger if the selection
52
- # is cleared by clicking on empty model space. Use the {#onSelectionCleared}
53
- # method to catch this case.
54
- #
55
- # @example
56
- # def onSelectionBulkChange(selection)
57
- # puts "onSelectionBulkChange: #{selection}"
58
- # end
59
- #
60
- # @param [Sketchup::Selection] selection
61
- #
62
- # @return [nil]
63
- #
64
- # @version SketchUp 6.0
65
- def onSelectionBulkChange(selection)
66
- end
67
-
68
- # The {#onSelectionCleared} method is called when the selection is completely
69
- # emptied.
70
- #
71
- # @example
72
- # def onSelectionCleared(selection)
73
- # puts "onSelectionCleared: #{selection}"
74
- # end
75
- #
76
- # @param [Sketchup::Selection] selection
77
- #
78
- # @return [nil]
79
- #
80
- # @version SketchUp 6.0
81
- def onSelectionCleared(selection)
82
- end
83
-
84
- #
85
- # @bug Due to a bug in SketchUp this event doesn't trigger. Instead
86
- # +onSelectedRemoved+ is called.
87
- #
88
- # @example
89
- # class MySelectionObserver < Sketchup::SelectionObserver
90
- # def onSelectionRemoved(selection, entity)
91
- # puts "onSelectionRemoved: #{entity}"
92
- # end
93
- #
94
- # # Due to a SketchUp bug, this method is called by the wrong name.
95
- # alias_method :onSelectedRemoved, :onSelectionRemoved
96
- # end
97
- #
98
- # # Attach the observer.
99
- # Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
100
- #
101
- # @note This event might not trigger even if a single element is deselected.
102
- # For instance the Selection tool will trigger {#onSelectionBulkChange}
103
- # regardless.
104
- #
105
- # @param [Sketchup::Selection] selection
106
- #
107
- # @param [Sketchup::Entity] entity
108
- #
109
- # @return [nil]
110
- #
111
- # @version SketchUp 6.0
112
- def onSelectionRemoved(selection, entity)
113
- end
114
-
115
- end
1
+ # Copyright:: Copyright 2023 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This observer interface is implemented to react to selection events.
5
+ #
6
+ # @abstract To implement this observer, create a Ruby class of this type, override the
7
+ # desired methods, and add an instance of the observer to the objects of
8
+ # interests.
9
+ #
10
+ # @example
11
+ # # This is an example of an observer that watches the selection for
12
+ # # changes.
13
+ # class MySelectionObserver < Sketchup::SelectionObserver
14
+ # def onSelectionBulkChange(selection)
15
+ # puts "onSelectionBulkChange: #{selection}"
16
+ # end
17
+ # end
18
+ #
19
+ # # Attach the observer.
20
+ # Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
21
+ #
22
+ # @version SketchUp 6.0
23
+ class Sketchup::SelectionObserver
24
+
25
+ # Instance Methods
26
+
27
+ #
28
+ # @example
29
+ # def onSelectionAdded(selection, entity)
30
+ # puts "onSelectionAdded: #{entity}"
31
+ # end
32
+ #
33
+ # @note This event might not trigger even if a single element is selected. For
34
+ # instance the Selection tool will trigger {#onSelectionBulkChange} regardless.
35
+ #
36
+ # @param [Sketchup::Selection] selection
37
+ #
38
+ # @param [Sketchup::Entity] entity
39
+ #
40
+ # @return [nil]
41
+ #
42
+ # @see onSelectionBulkChange
43
+ #
44
+ # @version SketchUp 6.0
45
+ def onSelectionAdded(selection, entity)
46
+ end
47
+
48
+ # The {#onSelectionBulkChange} method is called whenever items are added or
49
+ # removed from the selection set.
50
+ #
51
+ # The {#onSelectionBulkChange} callback will not trigger if the selection
52
+ # is cleared by clicking on empty model space. Use the {#onSelectionCleared}
53
+ # method to catch this case.
54
+ #
55
+ # @example
56
+ # def onSelectionBulkChange(selection)
57
+ # puts "onSelectionBulkChange: #{selection}"
58
+ # end
59
+ #
60
+ # @param [Sketchup::Selection] selection
61
+ #
62
+ # @return [nil]
63
+ #
64
+ # @version SketchUp 6.0
65
+ def onSelectionBulkChange(selection)
66
+ end
67
+
68
+ # The {#onSelectionCleared} method is called when the selection is completely
69
+ # emptied.
70
+ #
71
+ # @example
72
+ # def onSelectionCleared(selection)
73
+ # puts "onSelectionCleared: #{selection}"
74
+ # end
75
+ #
76
+ # @param [Sketchup::Selection] selection
77
+ #
78
+ # @return [nil]
79
+ #
80
+ # @version SketchUp 6.0
81
+ def onSelectionCleared(selection)
82
+ end
83
+
84
+ #
85
+ # @bug Due to a bug in SketchUp this event doesn't trigger. Instead
86
+ # +onSelectedRemoved+ is called.
87
+ #
88
+ # @example
89
+ # class MySelectionObserver < Sketchup::SelectionObserver
90
+ # def onSelectionRemoved(selection, entity)
91
+ # puts "onSelectionRemoved: #{entity}"
92
+ # end
93
+ #
94
+ # # Due to a SketchUp bug, this method is called by the wrong name.
95
+ # alias_method :onSelectedRemoved, :onSelectionRemoved
96
+ # end
97
+ #
98
+ # # Attach the observer.
99
+ # Sketchup.active_model.selection.add_observer(MySelectionObserver.new)
100
+ #
101
+ # @note This event might not trigger even if a single element is deselected.
102
+ # For instance the Selection tool will trigger {#onSelectionBulkChange}
103
+ # regardless.
104
+ #
105
+ # @param [Sketchup::Selection] selection
106
+ #
107
+ # @param [Sketchup::Entity] entity
108
+ #
109
+ # @return [nil]
110
+ #
111
+ # @version SketchUp 6.0
112
+ def onSelectionRemoved(selection, entity)
113
+ end
114
+
115
+ end
@@ -1,212 +1,212 @@
1
- # Copyright:: Copyright 2021 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The set class represents a collection of unique objects. This class is useful
5
- # for keeping track of a group of related entities, kind of like a selection
6
- # set that stays around for as long as you need it to.
7
- #
8
- # To make a set of your own, create an empty one using Sketchup::Set.new, and
9
- # then add items to it.
10
- #
11
- # @deprecated In SketchUp 2014 this class was changed from +Set+
12
- # to +Sketchup::Set+ in order to avoid conflict with the Ruby Standard
13
- # Library. The +Sketchup::Set+ class is deprecated and new extensions should
14
- # make use of Ruby's +Set+ class unless they need backward compatibility.
15
- #
16
- # @example
17
- # set = Sketchup::Set.new
18
- # set.insert(1)
19
- # set.insert(2)
20
- #
21
- # @example Compatibility Shim
22
- # module Example
23
- #
24
- # # Shim for the Set class which was moved in SketchUp 2014
25
- # if defined?(Sketchup::Set)
26
- # # Warning! Do NOT do this in the global namespace!
27
- # Set = Sketchup::Set
28
- # end
29
- #
30
- # def self.test_set_shim
31
- # set = Set.new
32
- # set.insert('Hello')
33
- # set.insert('World')
34
- # puts set.to_a
35
- # end
36
- #
37
- # end
38
- #
39
- # @version SketchUp 6.0
40
- class Sketchup::Set
41
-
42
- # Instance Methods
43
-
44
- # The clear method is used to clear all objects out of the set.
45
- #
46
- # @example
47
- # set = Sketchup::Set.new
48
- # set.insert(1)
49
- # set.insert(2)
50
- # set.insert(3)
51
- # set.clear
52
- #
53
- # @return set - an empty Set object
54
- #
55
- # @version SketchUp 6.0
56
- def clear
57
- end
58
-
59
- # The {#contains?} method is an alias for {#include?}.
60
- #
61
- # @example
62
- # set = Sketchup::Set.new
63
- # set.insert(1)
64
- # set.insert(2)
65
- # set.insert(3)
66
- # p set.contains?(2)
67
- #
68
- # @param [Sketchup::Entity] entity
69
- #
70
- # @return [Boolean]
71
- #
72
- # @see #include?
73
- #
74
- # @version SketchUp 6.0
75
- def contains?(entity)
76
- end
77
-
78
- # The delete object is used to delete or remove an object from the set.
79
- #
80
- # @example
81
- # set = Sketchup::Set.new
82
- # set.insert(1)
83
- # set.insert(2)
84
- # set.delete(1)
85
- #
86
- # @param object
87
- # The object to be deleted.
88
- #
89
- # @return object - the object that was deleted.
90
- #
91
- # @version SketchUp 6.0
92
- def delete(object)
93
- end
94
-
95
- # The each method is used to iterate through all of the objects in the set.
96
- #
97
- # @example
98
- # set = Sketchup::Set.new
99
- # set.insert(1)
100
- # set.insert(2)
101
- # set.insert(3)
102
- # set.each { | item | puts item }
103
- #
104
- # @version SketchUp 6.0
105
- #
106
- # @yield [item]
107
- def each
108
- end
109
-
110
- # The empty? method is used to determine whether the set is empty.
111
- #
112
- # @example
113
- # set = Sketchup::Set.new
114
- # set.insert(1)
115
- # set.insert(2)
116
- # set.insert(3)
117
- # puts set.empty?
118
- #
119
- # @return [Boolean] status - true if the set is empty, false if it is not
120
- # empty.
121
- #
122
- # @version SketchUp 6.0
123
- def empty?
124
- end
125
-
126
- # The {#include?} method is used to determine if the set includes a particular
127
- # object.
128
- #
129
- # @example
130
- # set = Sketchup::Set.new
131
- # set.insert(1)
132
- # set.insert(2)
133
- # set.insert(3)
134
- # p set.include?(2)
135
- #
136
- # @param [Sketchup::Entity] entity
137
- #
138
- # @return [Boolean]
139
- #
140
- # @see #contains?
141
- #
142
- # @version SketchUp 6.0
143
- def include?(entity)
144
- end
145
-
146
- # The insert method is used to insert an object into the set.
147
- #
148
- # @example
149
- # set = Sketchup::Set.new
150
- # set.insert(1)
151
- # set.insert(2)
152
- # set.insert(3)
153
- #
154
- # @param object
155
- # The object to be inserted into the set.
156
- #
157
- # @return size - the number of objects in the set
158
- #
159
- # @version SketchUp 6.0
160
- def insert(object)
161
- end
162
-
163
- # The {#length} method is an alias for {#size}.
164
- #
165
- # @example
166
- # set = Sketchup::Set.new
167
- # set.insert(1)
168
- # set.insert(2)
169
- # set.insert(3)
170
- # puts set.length
171
- #
172
- # @return [Integer]
173
- #
174
- # @see #size
175
- #
176
- # @version SketchUp 6.0
177
- def length
178
- end
179
-
180
- # The {#size} method is used to determine the number of objects in the set.
181
- #
182
- # @example
183
- # set = Sketchup::Set.new
184
- # set.insert(1)
185
- # set.insert(2)
186
- # set.insert(3)
187
- # puts set.size
188
- #
189
- # @return [Integer]
190
- #
191
- # @see #length
192
- #
193
- # @version SketchUp 6.0
194
- def size
195
- end
196
-
197
- # The to_a method is used to get an Array of the entities in your Set.
198
- #
199
- # @example
200
- # set = Sketchup::Set.new
201
- # set.insert('Hello')
202
- # set.insert('World')
203
- # my_array = set.to_a
204
- # UI.messagebox my_array
205
- #
206
- # @return array - The Array of the entities in the Set.
207
- #
208
- # @version SketchUp 6.0
209
- def to_a
210
- end
211
-
212
- end
1
+ # Copyright:: Copyright 2023 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The set class represents a collection of unique objects. This class is useful
5
+ # for keeping track of a group of related entities, kind of like a selection
6
+ # set that stays around for as long as you need it to.
7
+ #
8
+ # To make a set of your own, create an empty one using Sketchup::Set.new, and
9
+ # then add items to it.
10
+ #
11
+ # @deprecated In SketchUp 2014 this class was changed from +Set+
12
+ # to +Sketchup::Set+ in order to avoid conflict with the Ruby Standard
13
+ # Library. The +Sketchup::Set+ class is deprecated and new extensions should
14
+ # make use of Ruby's +Set+ class unless they need backward compatibility.
15
+ #
16
+ # @example
17
+ # set = Sketchup::Set.new
18
+ # set.insert(1)
19
+ # set.insert(2)
20
+ #
21
+ # @example Compatibility Shim
22
+ # module Example
23
+ #
24
+ # # Shim for the Set class which was moved in SketchUp 2014
25
+ # if defined?(Sketchup::Set)
26
+ # # Warning! Do NOT do this in the global namespace!
27
+ # Set = Sketchup::Set
28
+ # end
29
+ #
30
+ # def self.test_set_shim
31
+ # set = Set.new
32
+ # set.insert('Hello')
33
+ # set.insert('World')
34
+ # puts set.to_a
35
+ # end
36
+ #
37
+ # end
38
+ #
39
+ # @version SketchUp 6.0
40
+ class Sketchup::Set
41
+
42
+ # Instance Methods
43
+
44
+ # The clear method is used to clear all objects out of the set.
45
+ #
46
+ # @example
47
+ # set = Sketchup::Set.new
48
+ # set.insert(1)
49
+ # set.insert(2)
50
+ # set.insert(3)
51
+ # set.clear
52
+ #
53
+ # @return set - an empty Set object
54
+ #
55
+ # @version SketchUp 6.0
56
+ def clear
57
+ end
58
+
59
+ # The {#contains?} method is an alias for {#include?}.
60
+ #
61
+ # @example
62
+ # set = Sketchup::Set.new
63
+ # set.insert(1)
64
+ # set.insert(2)
65
+ # set.insert(3)
66
+ # p set.contains?(2)
67
+ #
68
+ # @param [Sketchup::Entity] entity
69
+ #
70
+ # @return [Boolean]
71
+ #
72
+ # @see #include?
73
+ #
74
+ # @version SketchUp 6.0
75
+ def contains?(entity)
76
+ end
77
+
78
+ # The delete object is used to delete or remove an object from the set.
79
+ #
80
+ # @example
81
+ # set = Sketchup::Set.new
82
+ # set.insert(1)
83
+ # set.insert(2)
84
+ # set.delete(1)
85
+ #
86
+ # @param object
87
+ # The object to be deleted.
88
+ #
89
+ # @return object - the object that was deleted.
90
+ #
91
+ # @version SketchUp 6.0
92
+ def delete(object)
93
+ end
94
+
95
+ # The each method is used to iterate through all of the objects in the set.
96
+ #
97
+ # @example
98
+ # set = Sketchup::Set.new
99
+ # set.insert(1)
100
+ # set.insert(2)
101
+ # set.insert(3)
102
+ # set.each { | item | puts item }
103
+ #
104
+ # @version SketchUp 6.0
105
+ #
106
+ # @yield [item]
107
+ def each
108
+ end
109
+
110
+ # The empty? method is used to determine whether the set is empty.
111
+ #
112
+ # @example
113
+ # set = Sketchup::Set.new
114
+ # set.insert(1)
115
+ # set.insert(2)
116
+ # set.insert(3)
117
+ # puts set.empty?
118
+ #
119
+ # @return [Boolean] status - true if the set is empty, false if it is not
120
+ # empty.
121
+ #
122
+ # @version SketchUp 6.0
123
+ def empty?
124
+ end
125
+
126
+ # The {#include?} method is used to determine if the set includes a particular
127
+ # object.
128
+ #
129
+ # @example
130
+ # set = Sketchup::Set.new
131
+ # set.insert(1)
132
+ # set.insert(2)
133
+ # set.insert(3)
134
+ # p set.include?(2)
135
+ #
136
+ # @param [Sketchup::Entity] entity
137
+ #
138
+ # @return [Boolean]
139
+ #
140
+ # @see #contains?
141
+ #
142
+ # @version SketchUp 6.0
143
+ def include?(entity)
144
+ end
145
+
146
+ # The insert method is used to insert an object into the set.
147
+ #
148
+ # @example
149
+ # set = Sketchup::Set.new
150
+ # set.insert(1)
151
+ # set.insert(2)
152
+ # set.insert(3)
153
+ #
154
+ # @param object
155
+ # The object to be inserted into the set.
156
+ #
157
+ # @return size - the number of objects in the set
158
+ #
159
+ # @version SketchUp 6.0
160
+ def insert(object)
161
+ end
162
+
163
+ # The {#length} method is an alias for {#size}.
164
+ #
165
+ # @example
166
+ # set = Sketchup::Set.new
167
+ # set.insert(1)
168
+ # set.insert(2)
169
+ # set.insert(3)
170
+ # puts set.length
171
+ #
172
+ # @return [Integer]
173
+ #
174
+ # @see #size
175
+ #
176
+ # @version SketchUp 6.0
177
+ def length
178
+ end
179
+
180
+ # The {#size} method is used to determine the number of objects in the set.
181
+ #
182
+ # @example
183
+ # set = Sketchup::Set.new
184
+ # set.insert(1)
185
+ # set.insert(2)
186
+ # set.insert(3)
187
+ # puts set.size
188
+ #
189
+ # @return [Integer]
190
+ #
191
+ # @see #length
192
+ #
193
+ # @version SketchUp 6.0
194
+ def size
195
+ end
196
+
197
+ # The to_a method is used to get an Array of the entities in your Set.
198
+ #
199
+ # @example
200
+ # set = Sketchup::Set.new
201
+ # set.insert('Hello')
202
+ # set.insert('World')
203
+ # my_array = set.to_a
204
+ # UI.messagebox my_array
205
+ #
206
+ # @return array - The Array of the entities in the Set.
207
+ #
208
+ # @version SketchUp 6.0
209
+ def to_a
210
+ end
211
+
212
+ end