sketchup-api-stubs 0.7.9 → 0.7.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (160) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +157 -151
  3. data/lib/sketchup-api-stubs/stubs/Array.rb +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +182 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +111 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +423 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +693 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +535 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +500 -476
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +267 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +133 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +547 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +678 -693
  16. data/lib/sketchup-api-stubs/stubs/Geom.rb +351 -351
  17. data/lib/sketchup-api-stubs/stubs/LanguageHandler.rb +93 -93
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -595
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +751 -747
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -183
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Dictionary.rb +234 -0
  23. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +683 -517
  24. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  26. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +464 -353
  27. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -354
  28. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  29. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  30. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  31. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
  32. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  33. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  34. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
  35. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +614 -567
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  37. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  38. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +282 -183
  39. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +458 -387
  40. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
  41. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +346 -344
  42. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  43. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -82
  44. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +714 -692
  45. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1565 -1519
  46. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  49. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  50. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  51. data/lib/sketchup-api-stubs/stubs/Length.rb +286 -278
  52. data/lib/sketchup-api-stubs/stubs/Numeric.rb +249 -249
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +196 -144
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -169
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +226 -209
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +145 -150
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +294 -281
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +296 -302
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +473 -478
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -121
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +673 -659
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +600 -593
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +252 -257
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +443 -449
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +167 -165
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +403 -406
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -397
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1282 -1239
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -261
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +519 -545
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Environment.rb +406 -0
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Environments.rb +185 -0
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/EnvironmentsObserver.rb +113 -0
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +122 -125
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +1006 -937
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -102
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +740 -750
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +289 -282
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +64 -62
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +405 -468
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +432 -406
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +307 -306
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +332 -326
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +380 -422
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +409 -427
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +241 -249
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +55 -48
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -114
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/LoadHandler.rb +70 -0
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +1115 -414
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +330 -317
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1714 -1652
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +372 -357
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +133 -130
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -271
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +463 -490
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +104 -116
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +939 -797
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +388 -361
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +501 -478
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +385 -361
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +451 -458
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +211 -212
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +259 -255
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Snap.rb +125 -0
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +88 -69
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +263 -217
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +283 -262
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +199 -217
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +924 -834
  143. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  144. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  145. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -75
  146. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +143 -142
  147. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1566 -1311
  148. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +71 -45
  149. data/lib/sketchup-api-stubs/stubs/Sketchup.rb +1429 -1377
  150. data/lib/sketchup-api-stubs/stubs/SketchupExtension.rb +353 -353
  151. data/lib/sketchup-api-stubs/stubs/String.rb +24 -24
  152. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +399 -389
  153. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +580 -494
  154. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +280 -269
  155. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +258 -241
  156. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +636 -635
  157. data/lib/sketchup-api-stubs/stubs/UI.rb +791 -683
  158. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -303
  159. data/lib/sketchup-api-stubs.rb +1 -1
  160. metadata +10 -24
@@ -1,74 +1,74 @@
1
- # Copyright:: Copyright 2023 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This observer interface is implemented to react to component definition
5
- # events.
6
- #
7
- # @abstract To implement this observer, create a Ruby class of this type,
8
- # override the desired methods, and add an instance of the observer to the
9
- # definitions of interests.
10
- #
11
- # @example
12
- # # This is an example of an observer that watches a specific definition
13
- # # for new component insertions.
14
- # class MyDefObserver < Sketchup::DefinitionObserver
15
- # def onComponentInstanceAdded(definition, instance)
16
- # puts "onComponentInstanceAdded(#{definition}, #{instance})"
17
- # end
18
- # end
19
- #
20
- # # Attach the observer
21
- # Sketchup.active_model.definitions[0].add_observer(MyDefObserver.new)
22
- #
23
- # @version SketchUp 6.0
24
- class Sketchup::DefinitionObserver < Sketchup::EntityObserver
25
-
26
- # Instance Methods
27
-
28
- # The {#onComponentInstanceAdded} method is called when a new component
29
- # instance is added to a model.
30
- #
31
- # @example
32
- # def onComponentInstanceAdded(definition, instance)
33
- # puts "onComponentInstanceAdded(#{definition}, #{instance})"
34
- # end
35
- #
36
- # @param [Sketchup::ComponentDefinition] definition
37
- # The definition of the
38
- # added instance
39
- #
40
- # @param [Sketchup::ComponentInstance] instance
41
- # The added instance
42
- #
43
- # @return [nil]
44
- #
45
- # @version SketchUp 6.0
46
- def onComponentInstanceAdded(definition, instance)
47
- end
48
-
49
- # The {#onComponentInstanceRemoved} method is called when a component
50
- # instance is removed from a model.
51
- #
52
- # @example
53
- # def onComponentInstanceRemoved(definition, instance)
54
- # puts "onComponentInstanceRemoved(#{definition}, #{instance})"
55
- # end
56
- #
57
- # @note Due to the underlying way that the SketchUp Move Tool is
58
- # implemented, this method is fired on a Move + Copy operation even
59
- # though no {Sketchup::ComponentInstance} is apparently removed.
60
- #
61
- # @param [Sketchup::ComponentDefinition] definition
62
- # The definition of the
63
- # instance removed
64
- #
65
- # @param [Sketchup::ComponentInstance] instance
66
- # The removed instance
67
- #
68
- # @return [nil]
69
- #
70
- # @version SketchUp 6.0
71
- def onComponentInstanceRemoved(definition, instance)
72
- end
73
-
74
- end
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This observer interface is implemented to react to component definition
5
+ # events.
6
+ #
7
+ # @abstract To implement this observer, create a Ruby class of this type,
8
+ # override the desired methods, and add an instance of the observer to the
9
+ # definitions of interests.
10
+ #
11
+ # @example
12
+ # # This is an example of an observer that watches a specific definition
13
+ # # for new component insertions.
14
+ # class MyDefObserver < Sketchup::DefinitionObserver
15
+ # def onComponentInstanceAdded(definition, instance)
16
+ # puts "onComponentInstanceAdded(#{definition}, #{instance})"
17
+ # end
18
+ # end
19
+ #
20
+ # # Attach the observer
21
+ # Sketchup.active_model.definitions[0].add_observer(MyDefObserver.new)
22
+ #
23
+ # @version SketchUp 6.0
24
+ class Sketchup::DefinitionObserver < Sketchup::EntityObserver
25
+
26
+ # Instance Methods
27
+
28
+ # The {#onComponentInstanceAdded} method is called when a new component
29
+ # instance is added to a model.
30
+ #
31
+ # @example
32
+ # def onComponentInstanceAdded(definition, instance)
33
+ # puts "onComponentInstanceAdded(#{definition}, #{instance})"
34
+ # end
35
+ #
36
+ # @param [Sketchup::ComponentDefinition] definition
37
+ # The definition of the
38
+ # added instance
39
+ #
40
+ # @param [Sketchup::ComponentInstance] instance
41
+ # The added instance
42
+ #
43
+ # @return [nil]
44
+ #
45
+ # @version SketchUp 6.0
46
+ def onComponentInstanceAdded(definition, instance)
47
+ end
48
+
49
+ # The {#onComponentInstanceRemoved} method is called when a component
50
+ # instance is removed from a model.
51
+ #
52
+ # @example
53
+ # def onComponentInstanceRemoved(definition, instance)
54
+ # puts "onComponentInstanceRemoved(#{definition}, #{instance})"
55
+ # end
56
+ #
57
+ # @note Due to the underlying way that the SketchUp Move Tool is
58
+ # implemented, this method is fired on a Move + Copy operation even
59
+ # though no {Sketchup::ComponentInstance} is apparently removed.
60
+ #
61
+ # @param [Sketchup::ComponentDefinition] definition
62
+ # The definition of the
63
+ # instance removed
64
+ #
65
+ # @param [Sketchup::ComponentInstance] instance
66
+ # The removed instance
67
+ #
68
+ # @return [nil]
69
+ #
70
+ # @version SketchUp 6.0
71
+ def onComponentInstanceRemoved(definition, instance)
72
+ end
73
+
74
+ end
@@ -1,104 +1,104 @@
1
- # Copyright:: Copyright 2023 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # This observer interface is implemented to react to events on a definitions
5
- # collection.
6
- #
7
- # @abstract To implement this observer, create a Ruby class of this type,
8
- # override the desired methods, and add an instance of the observer to the
9
- # collection of interest.
10
- #
11
- # @example
12
- # class MyDefinitionsObserver < Sketchup::DefinitionsObserver
13
- # def onComponentAdded(definitions, definition)
14
- # puts "onComponentAdded: #{definition.name}"
15
- # end
16
- # end
17
- #
18
- # Sketchup.active_model.definitions.add_observer(MyDefinitionsObserver.new)
19
- #
20
- # @version SketchUp 6.0
21
- class Sketchup::DefinitionsObserver
22
-
23
- # Instance Methods
24
-
25
- # The {#onComponentAdded} method is called whenever a definition is added to
26
- # the definitions collection.
27
- #
28
- # @example
29
- # def onComponentAdded(definitions, definition)
30
- # puts "onComponentAdded: #{definition}"
31
- # end
32
- #
33
- # @param [Sketchup::DefinitionList] definitions
34
- #
35
- # @param [Sketchup::ComponentDefinition] definition
36
- #
37
- # @return [nil]
38
- #
39
- # @version SketchUp 6.0
40
- def onComponentAdded(definitions, definition)
41
- end
42
-
43
- # The {#onComponentPropertiesChanged} method is called whenever a definition's
44
- # name or description are changed.
45
- #
46
- # This does not fire when "Glue To", "Cuts Opening", or "Face Camera" settings
47
- # are changed.
48
- #
49
- # @example
50
- # def onComponentPropertiesChanged(definitions, definition)
51
- # puts "onComponentPropertiesChanged: #{definition}"
52
- # end
53
- #
54
- # @param [Sketchup::DefinitionList] definitions
55
- #
56
- # @param [Sketchup::ComponentDefinition] definition
57
- #
58
- # @return [nil]
59
- #
60
- # @version SketchUp 6.0
61
- def onComponentPropertiesChanged(definitions, definition)
62
- end
63
-
64
- # The {#onComponentAdded} method is called whenever a definition is removed
65
- # from the definitions collection.
66
- #
67
- # @example
68
- # def onComponentRemoved(definitions, definition)
69
- # puts "onComponentRemoved: #{definition}"
70
- # end
71
- #
72
- # @note This methods fires twice for each Component/Group erased.
73
- #
74
- # @param [Sketchup::DefinitionList] definitions
75
- #
76
- # @param [Sketchup::ComponentDefinition] definition
77
- #
78
- # @return [nil]
79
- #
80
- # @version SketchUp 6.0
81
- def onComponentRemoved(definitions, definition)
82
- end
83
-
84
- # The {#onComponentTypeChanged} event is fired when a component is converted to
85
- # a group or vice versa. (In the underlying implementation, {Sketchup::Group}s
86
- # are just a special kind of definition that is allowed to only have a single
87
- # instance.)
88
- #
89
- # @example
90
- # def onComponentTypeChanged(definitions, definition)
91
- # puts "onComponentTypeChanged: #{definition}"
92
- # end
93
- #
94
- # @param [Sketchup::DefinitionList] definitions
95
- #
96
- # @param [Sketchup::ComponentDefinition] definition
97
- #
98
- # @return [nil]
99
- #
100
- # @version SketchUp 6.0
101
- def onComponentTypeChanged(definitions, definition)
102
- end
103
-
104
- end
1
+ # Copyright:: Copyright 2026 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # This observer interface is implemented to react to events on a definitions
5
+ # collection.
6
+ #
7
+ # @abstract To implement this observer, create a Ruby class of this type,
8
+ # override the desired methods, and add an instance of the observer to the
9
+ # collection of interest.
10
+ #
11
+ # @example
12
+ # class MyDefinitionsObserver < Sketchup::DefinitionsObserver
13
+ # def onComponentAdded(definitions, definition)
14
+ # puts "onComponentAdded: #{definition.name}"
15
+ # end
16
+ # end
17
+ #
18
+ # Sketchup.active_model.definitions.add_observer(MyDefinitionsObserver.new)
19
+ #
20
+ # @version SketchUp 6.0
21
+ class Sketchup::DefinitionsObserver
22
+
23
+ # Instance Methods
24
+
25
+ # The {#onComponentAdded} method is called whenever a definition is added to
26
+ # the definitions collection.
27
+ #
28
+ # @example
29
+ # def onComponentAdded(definitions, definition)
30
+ # puts "onComponentAdded: #{definition}"
31
+ # end
32
+ #
33
+ # @param [Sketchup::DefinitionList] definitions
34
+ #
35
+ # @param [Sketchup::ComponentDefinition] definition
36
+ #
37
+ # @return [nil]
38
+ #
39
+ # @version SketchUp 6.0
40
+ def onComponentAdded(definitions, definition)
41
+ end
42
+
43
+ # The {#onComponentPropertiesChanged} method is called whenever a definition's
44
+ # name or description are changed.
45
+ #
46
+ # This does not fire when "Glue To", "Cuts Opening", or "Face Camera" settings
47
+ # are changed.
48
+ #
49
+ # @example
50
+ # def onComponentPropertiesChanged(definitions, definition)
51
+ # puts "onComponentPropertiesChanged: #{definition}"
52
+ # end
53
+ #
54
+ # @param [Sketchup::DefinitionList] definitions
55
+ #
56
+ # @param [Sketchup::ComponentDefinition] definition
57
+ #
58
+ # @return [nil]
59
+ #
60
+ # @version SketchUp 6.0
61
+ def onComponentPropertiesChanged(definitions, definition)
62
+ end
63
+
64
+ # The {#onComponentAdded} method is called whenever a definition is removed
65
+ # from the definitions collection.
66
+ #
67
+ # @example
68
+ # def onComponentRemoved(definitions, definition)
69
+ # puts "onComponentRemoved: #{definition}"
70
+ # end
71
+ #
72
+ # @note This methods fires twice for each Component/Group erased.
73
+ #
74
+ # @param [Sketchup::DefinitionList] definitions
75
+ #
76
+ # @param [Sketchup::ComponentDefinition] definition
77
+ #
78
+ # @return [nil]
79
+ #
80
+ # @version SketchUp 6.0
81
+ def onComponentRemoved(definitions, definition)
82
+ end
83
+
84
+ # The {#onComponentTypeChanged} event is fired when a component is converted to
85
+ # a group or vice versa. (In the underlying implementation, {Sketchup::Group}s
86
+ # are just a special kind of definition that is allowed to only have a single
87
+ # instance.)
88
+ #
89
+ # @example
90
+ # def onComponentTypeChanged(definitions, definition)
91
+ # puts "onComponentTypeChanged: #{definition}"
92
+ # end
93
+ #
94
+ # @param [Sketchup::DefinitionList] definitions
95
+ #
96
+ # @param [Sketchup::ComponentDefinition] definition
97
+ #
98
+ # @return [nil]
99
+ #
100
+ # @version SketchUp 6.0
101
+ def onComponentTypeChanged(definitions, definition)
102
+ end
103
+
104
+ end