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.
- checksums.yaml +4 -4
- data/lib/sketchup-api-stubs/sketchup.rb +151 -147
- data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
- data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
- data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
- data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
- data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
- data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +509 -509
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -478
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
- data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
- data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
- data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -351
- data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -179
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -515
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
- data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
- data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
- data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
- data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
- data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
- data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
- data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
- data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
- data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
- data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
- data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
- data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
- data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -0
- data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
- data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
- data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
- data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
- data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
- data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -594
- data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
- data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -425
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1126
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -917
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -405
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -327
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1654
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -478
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
- data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
- data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +255 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -835
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -71
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1307
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
- data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1377 -1353
- data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
- data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -317
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -478
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
- data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -672
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
- data/lib/sketchup-api-stubs.rb +1 -1
- metadata +20 -16
@@ -1,60 +1,60 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This observer interface is implemented to react to entity 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 entity of
|
8
|
-
# interests.
|
9
|
-
#
|
10
|
-
# @example
|
11
|
-
# class MyEntityObserver < Sketchup::EntityObserver
|
12
|
-
# def onEraseEntity(entity)
|
13
|
-
# puts "onEraseEntity: #{entity}"
|
14
|
-
# end
|
15
|
-
# end
|
16
|
-
#
|
17
|
-
# # Attach the observer. (Assumes there is an entity in the model.)
|
18
|
-
# Sketchup.active_model.entities[0].add_observer(MyEntityObserver.new)
|
19
|
-
#
|
20
|
-
# @note The methods of this observer fire in such a way that making changes
|
21
|
-
# to the model while inside of them is dangerous. If you experience sudden
|
22
|
-
# crashes, it could be because of this observer. A potential workaround is to
|
23
|
-
# use a {Sketchup::ToolsObserver} to watch what the user is doing instead.
|
24
|
-
#
|
25
|
-
# @version SketchUp 6.0
|
26
|
-
class Sketchup::EntityObserver
|
27
|
-
|
28
|
-
# Instance Methods
|
29
|
-
|
30
|
-
# The {#onChangeEntity} method is invoked when your entity is modified.
|
31
|
-
#
|
32
|
-
# @example
|
33
|
-
# def onChangeEntity(entity)
|
34
|
-
# puts "onChangeEntity: #{entity}"
|
35
|
-
# end
|
36
|
-
#
|
37
|
-
# @param [Sketchup::Entity] entity
|
38
|
-
#
|
39
|
-
# @return [nil]
|
40
|
-
#
|
41
|
-
# @version SketchUp 6.0
|
42
|
-
def onChangeEntity(entity)
|
43
|
-
end
|
44
|
-
|
45
|
-
# The {#onEraseEntity} method is invoked when your entity is erased.
|
46
|
-
#
|
47
|
-
# @example
|
48
|
-
# def onEraseEntity(entity)
|
49
|
-
# puts "onEraseEntity: #{entity}"
|
50
|
-
# end
|
51
|
-
#
|
52
|
-
# @param [Sketchup::Entity] entity
|
53
|
-
#
|
54
|
-
# @return [nil]
|
55
|
-
#
|
56
|
-
# @version SketchUp 6.0
|
57
|
-
def onEraseEntity(entity)
|
58
|
-
end
|
59
|
-
|
60
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to entity 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 entity of
|
8
|
+
# interests.
|
9
|
+
#
|
10
|
+
# @example
|
11
|
+
# class MyEntityObserver < Sketchup::EntityObserver
|
12
|
+
# def onEraseEntity(entity)
|
13
|
+
# puts "onEraseEntity: #{entity}"
|
14
|
+
# end
|
15
|
+
# end
|
16
|
+
#
|
17
|
+
# # Attach the observer. (Assumes there is an entity in the model.)
|
18
|
+
# Sketchup.active_model.entities[0].add_observer(MyEntityObserver.new)
|
19
|
+
#
|
20
|
+
# @note The methods of this observer fire in such a way that making changes
|
21
|
+
# to the model while inside of them is dangerous. If you experience sudden
|
22
|
+
# crashes, it could be because of this observer. A potential workaround is to
|
23
|
+
# use a {Sketchup::ToolsObserver} to watch what the user is doing instead.
|
24
|
+
#
|
25
|
+
# @version SketchUp 6.0
|
26
|
+
class Sketchup::EntityObserver
|
27
|
+
|
28
|
+
# Instance Methods
|
29
|
+
|
30
|
+
# The {#onChangeEntity} method is invoked when your entity is modified.
|
31
|
+
#
|
32
|
+
# @example
|
33
|
+
# def onChangeEntity(entity)
|
34
|
+
# puts "onChangeEntity: #{entity}"
|
35
|
+
# end
|
36
|
+
#
|
37
|
+
# @param [Sketchup::Entity] entity
|
38
|
+
#
|
39
|
+
# @return [nil]
|
40
|
+
#
|
41
|
+
# @version SketchUp 6.0
|
42
|
+
def onChangeEntity(entity)
|
43
|
+
end
|
44
|
+
|
45
|
+
# The {#onEraseEntity} method is invoked when your entity is erased.
|
46
|
+
#
|
47
|
+
# @example
|
48
|
+
# def onEraseEntity(entity)
|
49
|
+
# puts "onEraseEntity: #{entity}"
|
50
|
+
# end
|
51
|
+
#
|
52
|
+
# @param [Sketchup::Entity] entity
|
53
|
+
#
|
54
|
+
# @return [nil]
|
55
|
+
#
|
56
|
+
# @version SketchUp 6.0
|
57
|
+
def onEraseEntity(entity)
|
58
|
+
end
|
59
|
+
|
60
|
+
end
|
@@ -1,126 +1,125 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The ExtensionsManager class provides a way of accessing the
|
5
|
-
# SketchupExtensions that have been registered via the
|
6
|
-
# Sketchup.register_extension method.
|
7
|
-
#
|
8
|
-
# There is only one ExtensionsManager available. You access it via the
|
9
|
-
# Sketchup.extensions method.
|
10
|
-
#
|
11
|
-
# @version SketchUp 8.0 M2
|
12
|
-
class Sketchup::ExtensionsManager
|
13
|
-
|
14
|
-
# Includes
|
15
|
-
|
16
|
-
include Enumerable
|
17
|
-
|
18
|
-
# Instance Methods
|
19
|
-
|
20
|
-
# The [] method is used to get an extension by name, index or ID.
|
21
|
-
#
|
22
|
-
# @example
|
23
|
-
# manager = Sketchup.extensions
|
24
|
-
# extension = manager[1]
|
25
|
-
# if (extension)
|
26
|
-
# puts extension.name
|
27
|
-
# else
|
28
|
-
# puts "No Extensions installed"
|
29
|
-
# end
|
30
|
-
#
|
31
|
-
# # You can also get extensions by name.
|
32
|
-
# solarnorth = manager['Solar North Toolbar']
|
33
|
-
#
|
34
|
-
# # You can also get extensions by ID.
|
35
|
-
# my_extension = manager['2475A758-6503-46D5-AC5E-16AEA0A3162A']
|
36
|
-
#
|
37
|
-
# @note Index starts at 1.
|
38
|
-
#
|
39
|
-
# @param [Integer, String] index_or_name
|
40
|
-
# The index, name or ID of the SketchupExtension object.
|
41
|
-
#
|
42
|
-
# @return [SketchupExtension, nil]
|
43
|
-
#
|
44
|
-
# @version SketchUp 8.0 M2
|
45
|
-
def [](index_or_name)
|
46
|
-
end
|
47
|
-
|
48
|
-
#
|
49
|
-
# @example
|
50
|
-
# manager = Sketchup.extensions
|
51
|
-
# number = manager.count
|
52
|
-
#
|
53
|
-
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
54
|
-
# +
|
55
|
-
# for {#length}.
|
56
|
-
#
|
57
|
-
# @return [Integer]
|
58
|
-
#
|
59
|
-
# @see #length
|
60
|
-
#
|
61
|
-
# @version SketchUp 8.0 M2
|
62
|
-
def count
|
63
|
-
end
|
64
|
-
|
65
|
-
# The each method is used to iterate through extensions.
|
66
|
-
#
|
67
|
-
# @example
|
68
|
-
# manager = Sketchup.extensions
|
69
|
-
# # Retrieves each extension
|
70
|
-
# manager.each { |extension| puts extension.name }
|
71
|
-
#
|
72
|
-
# @return nil
|
73
|
-
#
|
74
|
-
# @version SketchUp 8.0 M2
|
75
|
-
#
|
76
|
-
# @
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
|
126
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The ExtensionsManager class provides a way of accessing the
|
5
|
+
# SketchupExtensions that have been registered via the
|
6
|
+
# Sketchup.register_extension method.
|
7
|
+
#
|
8
|
+
# There is only one ExtensionsManager available. You access it via the
|
9
|
+
# Sketchup.extensions method.
|
10
|
+
#
|
11
|
+
# @version SketchUp 8.0 M2
|
12
|
+
class Sketchup::ExtensionsManager
|
13
|
+
|
14
|
+
# Includes
|
15
|
+
|
16
|
+
include Enumerable
|
17
|
+
|
18
|
+
# Instance Methods
|
19
|
+
|
20
|
+
# The [] method is used to get an extension by name, index or ID.
|
21
|
+
#
|
22
|
+
# @example
|
23
|
+
# manager = Sketchup.extensions
|
24
|
+
# extension = manager[1]
|
25
|
+
# if (extension)
|
26
|
+
# puts extension.name
|
27
|
+
# else
|
28
|
+
# puts "No Extensions installed"
|
29
|
+
# end
|
30
|
+
#
|
31
|
+
# # You can also get extensions by name.
|
32
|
+
# solarnorth = manager['Solar North Toolbar']
|
33
|
+
#
|
34
|
+
# # You can also get extensions by ID.
|
35
|
+
# my_extension = manager['2475A758-6503-46D5-AC5E-16AEA0A3162A']
|
36
|
+
#
|
37
|
+
# @note Index starts at 1.
|
38
|
+
#
|
39
|
+
# @param [Integer, String] index_or_name
|
40
|
+
# The index, name or ID of the SketchupExtension object.
|
41
|
+
#
|
42
|
+
# @return [SketchupExtension, nil]
|
43
|
+
#
|
44
|
+
# @version SketchUp 8.0 M2
|
45
|
+
def [](index_or_name)
|
46
|
+
end
|
47
|
+
|
48
|
+
#
|
49
|
+
# @example
|
50
|
+
# manager = Sketchup.extensions
|
51
|
+
# number = manager.count
|
52
|
+
#
|
53
|
+
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
54
|
+
# +Enumerable+ mix-in module. Prior to that the {#count} method is an alias
|
55
|
+
# for {#length}.
|
56
|
+
#
|
57
|
+
# @return [Integer]
|
58
|
+
#
|
59
|
+
# @see #length
|
60
|
+
#
|
61
|
+
# @version SketchUp 8.0 M2
|
62
|
+
def count
|
63
|
+
end
|
64
|
+
|
65
|
+
# The {#each} method is used to iterate through extensions.
|
66
|
+
#
|
67
|
+
# @example
|
68
|
+
# manager = Sketchup.extensions
|
69
|
+
# # Retrieves each extension
|
70
|
+
# manager.each { |extension| puts extension.name }
|
71
|
+
#
|
72
|
+
# @return [nil]
|
73
|
+
#
|
74
|
+
# @version SketchUp 8.0 M2
|
75
|
+
#
|
76
|
+
# @yieldparam [SketchupExtension] extension
|
77
|
+
def each
|
78
|
+
end
|
79
|
+
|
80
|
+
# The keys method is used to get a list of keys in the ExtensionsManager,
|
81
|
+
# which are the same as the names of the extensions.
|
82
|
+
#
|
83
|
+
# @example
|
84
|
+
# manager = Sketchup.extensions
|
85
|
+
# keys = manager.keys
|
86
|
+
# for key in keys
|
87
|
+
# UI.messagebox('The next extension is named: ' + key)
|
88
|
+
# end
|
89
|
+
#
|
90
|
+
# @return keys - Array of string keys
|
91
|
+
#
|
92
|
+
# @version SketchUp 8.0 M2
|
93
|
+
def keys
|
94
|
+
end
|
95
|
+
|
96
|
+
# The {#length} method returns the number of {SketchupExtension} objects inside
|
97
|
+
# this ExtensionsManager.
|
98
|
+
#
|
99
|
+
# @example
|
100
|
+
# manager = Sketchup.extensions
|
101
|
+
# number = manager.length
|
102
|
+
#
|
103
|
+
# @return [Integer]
|
104
|
+
#
|
105
|
+
# @see #size
|
106
|
+
#
|
107
|
+
# @version SketchUp 8.0 M2
|
108
|
+
def length
|
109
|
+
end
|
110
|
+
|
111
|
+
# The {#size} method is an alias of {#length}.
|
112
|
+
#
|
113
|
+
# @example
|
114
|
+
# manager = Sketchup.extensions
|
115
|
+
# number = manager.size
|
116
|
+
#
|
117
|
+
# @return [Integer]
|
118
|
+
#
|
119
|
+
# @see #length
|
120
|
+
#
|
121
|
+
# @version SketchUp 8.0 M2
|
122
|
+
def size
|
123
|
+
end
|
124
|
+
|
125
|
+
end
|