sketchup-api-stubs 0.7.3 → 0.7.4
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/.yardopts +9 -9
- data/lib/sketchup-api-stubs.rb +1 -1
- data/lib/sketchup-api-stubs/sketchup.rb +145 -145
- data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
- 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 +492 -492
- data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -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 +691 -691
- data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
- data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
- data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
- data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
- data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
- data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
- data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
- data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -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 +371 -371
- 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 +220 -232
- 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 +204 -216
- 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/SketchUpModel.rb +694 -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/Sketchup/Animation.rb +140 -140
- data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
- data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
- data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
- data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
- data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
- data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
- data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
- data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -562
- data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
- 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 +194 -194
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
- data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
- data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
- data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
- data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
- data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
- data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
- data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
- data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
- data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
- data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
- data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
- data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
- data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
- data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
- data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
- data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
- data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
- data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
- data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
- data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
- data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
- data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
- data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
- data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
- data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
- data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
- data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
- data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
- data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
- data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
- data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
- data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
- data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
- data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
- 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 +257 -257
- data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
- data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
- data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
- data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
- data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
- data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
- data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
- data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
- data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
- data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
- data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
- data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
- data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
- data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
- data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
- data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
- data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
- data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
- data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
- data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
- data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
- data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
- data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
- data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
- data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
- data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
- data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
- metadata +3 -4
@@ -1,329 +1,329 @@
|
|
1
|
-
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# A DefinitionList object holds a list of all of the ComponentDefinition
|
5
|
-
# objects in a model. This class contains methods for adding and retrieving
|
6
|
-
# definitions from the list.
|
7
|
-
#
|
8
|
-
# @version SketchUp 6.0
|
9
|
-
class Sketchup::DefinitionList < Sketchup::Entity
|
10
|
-
|
11
|
-
# Includes
|
12
|
-
|
13
|
-
include Enumerable
|
14
|
-
|
15
|
-
# Instance Methods
|
16
|
-
|
17
|
-
# The [] method is used to retrieve a component definition from the list. You
|
18
|
-
# can give an integer index in the range 0 to length, a string which
|
19
|
-
# represents the GUID (a unique internal identifier), or a string that is
|
20
|
-
# the name of the definition.
|
21
|
-
#
|
22
|
-
# @example
|
23
|
-
# path=Sketchup.find_support_file "Bed.skp",
|
24
|
-
# "Components/Components Sampler/"
|
25
|
-
# model = Sketchup.active_model
|
26
|
-
# definitions = model.definitions
|
27
|
-
# componentdefinition = definitions.load path
|
28
|
-
# component = definitions[0]
|
29
|
-
#
|
30
|
-
# @overload [](index)
|
31
|
-
#
|
32
|
-
# @param [Integer] index The index for a specific component definition.
|
33
|
-
# @return [Sketchup::ComponentDefinition, nil]
|
34
|
-
#
|
35
|
-
# @overload [](name)
|
36
|
-
#
|
37
|
-
# @param [String] name The unique GUID for the component definition.
|
38
|
-
# @return [Sketchup::ComponentDefinition, nil]
|
39
|
-
#
|
40
|
-
# @overload [](guid)
|
41
|
-
#
|
42
|
-
# @param [String] guid The name of an existing component definition.
|
43
|
-
# @return [Sketchup::ComponentDefinition, nil]
|
44
|
-
#
|
45
|
-
# @version SketchUp 6.0
|
46
|
-
def [](arg)
|
47
|
-
end
|
48
|
-
|
49
|
-
# The add method is used to add a new component definition to the definition
|
50
|
-
# list with the given name.
|
51
|
-
#
|
52
|
-
# @example
|
53
|
-
# model = Sketchup.active_model
|
54
|
-
# definitions = model.definitions
|
55
|
-
# componentdefinition = definitions.add "BedTraditional"
|
56
|
-
# component = definitions[0]
|
57
|
-
#
|
58
|
-
# @param [String] def_name
|
59
|
-
# The new component definition to add to the definition
|
60
|
-
# list.
|
61
|
-
#
|
62
|
-
# @return [Sketchup::ComponentDefinition] the ComponentDefinition object
|
63
|
-
# that was added (if successful)
|
64
|
-
#
|
65
|
-
# @version SketchUp 6.0
|
66
|
-
def add(def_name)
|
67
|
-
end
|
68
|
-
|
69
|
-
# The add_observer method is used to add an observer to the current object.
|
70
|
-
#
|
71
|
-
# @example
|
72
|
-
# definitions = Sketchup.active_model.definitions
|
73
|
-
# status = definitions.add_observer observer
|
74
|
-
#
|
75
|
-
# @param [Object] observer
|
76
|
-
# An observer.
|
77
|
-
#
|
78
|
-
# @return [Boolean] true if successful, false if unsuccessful.
|
79
|
-
#
|
80
|
-
# @version SketchUp 6.0
|
81
|
-
def add_observer(observer)
|
82
|
-
end
|
83
|
-
|
84
|
-
# The [] method is used to retrieve a component definition from the list. You
|
85
|
-
# can give an integer index in the range 0 to length, a string which
|
86
|
-
# represents the GUID (a unique internal identifier), or a string that is
|
87
|
-
# the name of the definition.
|
88
|
-
#
|
89
|
-
# @example
|
90
|
-
# path=Sketchup.find_support_file "Bed.skp",
|
91
|
-
# "Components/Components Sampler/"
|
92
|
-
# model = Sketchup.active_model
|
93
|
-
# definitions = model.definitions
|
94
|
-
# componentdefinition = definitions.load path
|
95
|
-
# component = definitions[0]
|
96
|
-
#
|
97
|
-
# @overload [](index)
|
98
|
-
#
|
99
|
-
# @param [Integer] index The index for a specific component definition.
|
100
|
-
# @return [Sketchup::ComponentDefinition, nil]
|
101
|
-
#
|
102
|
-
# @overload [](name)
|
103
|
-
#
|
104
|
-
# @param [String] name The unique GUID for the component definition.
|
105
|
-
# @return [Sketchup::ComponentDefinition, nil]
|
106
|
-
#
|
107
|
-
# @overload [](guid)
|
108
|
-
#
|
109
|
-
# @param [String] guid The name of an existing component definition.
|
110
|
-
# @return [Sketchup::ComponentDefinition, nil]
|
111
|
-
#
|
112
|
-
# @version SketchUp 6.0
|
113
|
-
def at(arg)
|
114
|
-
end
|
115
|
-
|
116
|
-
#
|
117
|
-
# @example
|
118
|
-
# model = Sketchup.active_model
|
119
|
-
# definitions = model.definitions
|
120
|
-
# number = definitions.count
|
121
|
-
#
|
122
|
-
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
123
|
-
# +Enumable+ mix-in module. Prior to that the {#count} method is an alias
|
124
|
-
# for {#length}.
|
125
|
-
#
|
126
|
-
# @return [Integer]
|
127
|
-
#
|
128
|
-
# @see #length
|
129
|
-
#
|
130
|
-
# @version SketchUp 6.0
|
131
|
-
def count
|
132
|
-
end
|
133
|
-
|
134
|
-
# The each method is used to iterate through all of the component definitions
|
135
|
-
# in the definition list.
|
136
|
-
#
|
137
|
-
# Throws an exception if there are no component definitions.
|
138
|
-
#
|
139
|
-
# @example
|
140
|
-
# model = Sketchup.active_model
|
141
|
-
# definitions = model.definitions
|
142
|
-
# definitions.add("BedTraditional")
|
143
|
-
# number = definitions.each { |definition| puts definition.name }
|
144
|
-
#
|
145
|
-
# @return [nil]
|
146
|
-
#
|
147
|
-
# @version SketchUp 6.0
|
148
|
-
#
|
149
|
-
# @yield [Sketchup::ComponentDefinition] definition
|
150
|
-
def each
|
151
|
-
end
|
152
|
-
|
153
|
-
# The {#length} method is used to retrieve number of component definitions in
|
154
|
-
# the list.
|
155
|
-
#
|
156
|
-
# @example
|
157
|
-
# model = Sketchup.active_model
|
158
|
-
# definitions = model.definitions
|
159
|
-
# number = definitions.length
|
160
|
-
#
|
161
|
-
# @return [Integer]
|
162
|
-
#
|
163
|
-
# @see #size
|
164
|
-
#
|
165
|
-
# @version SketchUp 6.0
|
166
|
-
def length
|
167
|
-
end
|
168
|
-
|
169
|
-
# The load method is used to load a component from a file.
|
170
|
-
#
|
171
|
-
# @example
|
172
|
-
# path=Sketchup.find_support_file "Bed.skp",
|
173
|
-
# "Components/Components Sampler/"
|
174
|
-
# model = Sketchup.active_model
|
175
|
-
# definitions = model.definitions
|
176
|
-
# componentdefinition = definitions.load path
|
177
|
-
#
|
178
|
-
# @param [String] path
|
179
|
-
# The path where the component definition file is located.
|
180
|
-
#
|
181
|
-
# @raise RuntimeError If filename is an invalid SketchUp model. Added in
|
182
|
-
# SketchUp 2019. Possible that prior versions of SketchUp will crash.
|
183
|
-
#
|
184
|
-
# @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
|
185
|
-
# object if successful
|
186
|
-
#
|
187
|
-
# @version SketchUp 6.0
|
188
|
-
def load(path)
|
189
|
-
end
|
190
|
-
|
191
|
-
# The load_from_url method loads a component from a location specified by
|
192
|
-
# string url. This method throws an exception if an url string is not
|
193
|
-
# given, or an error occurs during retrieval from url and a
|
194
|
-
# load_handler was not given. Optional second parameter load_handler can be
|
195
|
-
# used to pass in a ruby object that responds to the following methods:
|
196
|
-
#
|
197
|
-
# - cancelled?(a_boolean)
|
198
|
-
# - onPercentChange(a_float)
|
199
|
-
# - onSuccess()
|
200
|
-
# - onFailure(message_string)
|
201
|
-
#
|
202
|
-
# @example
|
203
|
-
# class LoadHandler
|
204
|
-
#
|
205
|
-
# attr :error
|
206
|
-
#
|
207
|
-
# def onPercentChange(percent)
|
208
|
-
# Sketchup::set_status_text("LOADING: #{percent}%")
|
209
|
-
# end
|
210
|
-
#
|
211
|
-
# def cancelled?
|
212
|
-
# # You could, for example, show a messagebox after X seconds asking if the
|
213
|
-
# # user wants to cancel the download. If this method returns true, then
|
214
|
-
# # the download cancels.
|
215
|
-
# return false
|
216
|
-
# end
|
217
|
-
#
|
218
|
-
# def onSuccess
|
219
|
-
# Sketchup::set_status_text('')
|
220
|
-
# end
|
221
|
-
#
|
222
|
-
# def onFailure(error_message)
|
223
|
-
# self.error = error_message
|
224
|
-
# Sketchup::set_status_text('')
|
225
|
-
# end
|
226
|
-
#
|
227
|
-
# end
|
228
|
-
#
|
229
|
-
# # Replace this with a real URL...
|
230
|
-
# url = 'http://www.sketchup.com/model.skp'
|
231
|
-
# model = Sketchup.active_model
|
232
|
-
# definition = model.definitions.load_from_url(url, load_handler)
|
233
|
-
#
|
234
|
-
# if definition.nil?
|
235
|
-
# puts "Error: #{load_handler.error}"
|
236
|
-
# end
|
237
|
-
#
|
238
|
-
# @param [String] url
|
239
|
-
# URL to load a .skp file from.
|
240
|
-
#
|
241
|
-
# @param [Object] load_handler
|
242
|
-
# Ruby object that has methods defined
|
243
|
-
# as described in the load_from_url details.
|
244
|
-
#
|
245
|
-
# @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
|
246
|
-
# object if successful
|
247
|
-
#
|
248
|
-
# @version SketchUp 7.0
|
249
|
-
def load_from_url(url, load_handler = nil)
|
250
|
-
end
|
251
|
-
|
252
|
-
# The purge_unused method is used to remove the unused component definitions.
|
253
|
-
#
|
254
|
-
# @example
|
255
|
-
# definitions = Sketchup.active_model.definitions
|
256
|
-
# definitions.purge_unused
|
257
|
-
#
|
258
|
-
# @return [Sketchup::DefinitionList]
|
259
|
-
#
|
260
|
-
# @version SketchUp 6.0
|
261
|
-
def purge_unused
|
262
|
-
end
|
263
|
-
|
264
|
-
# The {#remove} method is used to remove a component definition from the
|
265
|
-
# definition list with the given component definition. This will remove all
|
266
|
-
# instances of the definition.
|
267
|
-
#
|
268
|
-
# @example
|
269
|
-
# model = Sketchup.active_model
|
270
|
-
# definitions = model.definitions
|
271
|
-
# definition = definitions[0]
|
272
|
-
# definitions.remove(definition)
|
273
|
-
#
|
274
|
-
# @param [Sketchup::ComponentDefinition] definition
|
275
|
-
#
|
276
|
-
# @return [Boolean]
|
277
|
-
#
|
278
|
-
# @version SketchUp 2018
|
279
|
-
def remove(definition)
|
280
|
-
end
|
281
|
-
|
282
|
-
# The remove_observer method is used to remove an observer from the current
|
283
|
-
# object.
|
284
|
-
#
|
285
|
-
# @example
|
286
|
-
# definitions = Sketchup.active_model.definitions
|
287
|
-
# status = definitions.remove_observer observer
|
288
|
-
#
|
289
|
-
# @param [Object] observer
|
290
|
-
# An observer.
|
291
|
-
#
|
292
|
-
# @return [Boolean] true if successful, false if unsuccessful.
|
293
|
-
#
|
294
|
-
# @version SketchUp 6.0
|
295
|
-
def remove_observer(observer)
|
296
|
-
end
|
297
|
-
|
298
|
-
# The {#size} method is an alias for {#length}.
|
299
|
-
#
|
300
|
-
# @example
|
301
|
-
# model = Sketchup.active_model
|
302
|
-
# definitions = model.definitions
|
303
|
-
# number = definitions.size
|
304
|
-
#
|
305
|
-
# @return [Integer]
|
306
|
-
#
|
307
|
-
# @see #length
|
308
|
-
#
|
309
|
-
# @version SketchUp 2014
|
310
|
-
def size
|
311
|
-
end
|
312
|
-
|
313
|
-
# The unique_name is used to generate a unique name for a definition based on
|
314
|
-
# a base_name string. For example, a base_name of "Joe" might return "Joe #2"
|
315
|
-
#
|
316
|
-
# @example
|
317
|
-
# model = Sketchup.active_model
|
318
|
-
# definitions = model.definitions
|
319
|
-
# new_name = definitions.unique_name "My Base Name"
|
320
|
-
#
|
321
|
-
# @param [String] base_name
|
322
|
-
#
|
323
|
-
# @return [String] the unique name.
|
324
|
-
#
|
325
|
-
# @version SketchUp 6.0
|
326
|
-
def unique_name(base_name)
|
327
|
-
end
|
328
|
-
|
329
|
-
end
|
1
|
+
# Copyright:: Copyright 2020 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# A DefinitionList object holds a list of all of the ComponentDefinition
|
5
|
+
# objects in a model. This class contains methods for adding and retrieving
|
6
|
+
# definitions from the list.
|
7
|
+
#
|
8
|
+
# @version SketchUp 6.0
|
9
|
+
class Sketchup::DefinitionList < Sketchup::Entity
|
10
|
+
|
11
|
+
# Includes
|
12
|
+
|
13
|
+
include Enumerable
|
14
|
+
|
15
|
+
# Instance Methods
|
16
|
+
|
17
|
+
# The [] method is used to retrieve a component definition from the list. You
|
18
|
+
# can give an integer index in the range 0 to length, a string which
|
19
|
+
# represents the GUID (a unique internal identifier), or a string that is
|
20
|
+
# the name of the definition.
|
21
|
+
#
|
22
|
+
# @example
|
23
|
+
# path=Sketchup.find_support_file "Bed.skp",
|
24
|
+
# "Components/Components Sampler/"
|
25
|
+
# model = Sketchup.active_model
|
26
|
+
# definitions = model.definitions
|
27
|
+
# componentdefinition = definitions.load path
|
28
|
+
# component = definitions[0]
|
29
|
+
#
|
30
|
+
# @overload [](index)
|
31
|
+
#
|
32
|
+
# @param [Integer] index The index for a specific component definition.
|
33
|
+
# @return [Sketchup::ComponentDefinition, nil]
|
34
|
+
#
|
35
|
+
# @overload [](name)
|
36
|
+
#
|
37
|
+
# @param [String] name The unique GUID for the component definition.
|
38
|
+
# @return [Sketchup::ComponentDefinition, nil]
|
39
|
+
#
|
40
|
+
# @overload [](guid)
|
41
|
+
#
|
42
|
+
# @param [String] guid The name of an existing component definition.
|
43
|
+
# @return [Sketchup::ComponentDefinition, nil]
|
44
|
+
#
|
45
|
+
# @version SketchUp 6.0
|
46
|
+
def [](arg)
|
47
|
+
end
|
48
|
+
|
49
|
+
# The add method is used to add a new component definition to the definition
|
50
|
+
# list with the given name.
|
51
|
+
#
|
52
|
+
# @example
|
53
|
+
# model = Sketchup.active_model
|
54
|
+
# definitions = model.definitions
|
55
|
+
# componentdefinition = definitions.add "BedTraditional"
|
56
|
+
# component = definitions[0]
|
57
|
+
#
|
58
|
+
# @param [String] def_name
|
59
|
+
# The new component definition to add to the definition
|
60
|
+
# list.
|
61
|
+
#
|
62
|
+
# @return [Sketchup::ComponentDefinition] the ComponentDefinition object
|
63
|
+
# that was added (if successful)
|
64
|
+
#
|
65
|
+
# @version SketchUp 6.0
|
66
|
+
def add(def_name)
|
67
|
+
end
|
68
|
+
|
69
|
+
# The add_observer method is used to add an observer to the current object.
|
70
|
+
#
|
71
|
+
# @example
|
72
|
+
# definitions = Sketchup.active_model.definitions
|
73
|
+
# status = definitions.add_observer observer
|
74
|
+
#
|
75
|
+
# @param [Object] observer
|
76
|
+
# An observer.
|
77
|
+
#
|
78
|
+
# @return [Boolean] true if successful, false if unsuccessful.
|
79
|
+
#
|
80
|
+
# @version SketchUp 6.0
|
81
|
+
def add_observer(observer)
|
82
|
+
end
|
83
|
+
|
84
|
+
# The [] method is used to retrieve a component definition from the list. You
|
85
|
+
# can give an integer index in the range 0 to length, a string which
|
86
|
+
# represents the GUID (a unique internal identifier), or a string that is
|
87
|
+
# the name of the definition.
|
88
|
+
#
|
89
|
+
# @example
|
90
|
+
# path=Sketchup.find_support_file "Bed.skp",
|
91
|
+
# "Components/Components Sampler/"
|
92
|
+
# model = Sketchup.active_model
|
93
|
+
# definitions = model.definitions
|
94
|
+
# componentdefinition = definitions.load path
|
95
|
+
# component = definitions[0]
|
96
|
+
#
|
97
|
+
# @overload [](index)
|
98
|
+
#
|
99
|
+
# @param [Integer] index The index for a specific component definition.
|
100
|
+
# @return [Sketchup::ComponentDefinition, nil]
|
101
|
+
#
|
102
|
+
# @overload [](name)
|
103
|
+
#
|
104
|
+
# @param [String] name The unique GUID for the component definition.
|
105
|
+
# @return [Sketchup::ComponentDefinition, nil]
|
106
|
+
#
|
107
|
+
# @overload [](guid)
|
108
|
+
#
|
109
|
+
# @param [String] guid The name of an existing component definition.
|
110
|
+
# @return [Sketchup::ComponentDefinition, nil]
|
111
|
+
#
|
112
|
+
# @version SketchUp 6.0
|
113
|
+
def at(arg)
|
114
|
+
end
|
115
|
+
|
116
|
+
#
|
117
|
+
# @example
|
118
|
+
# model = Sketchup.active_model
|
119
|
+
# definitions = model.definitions
|
120
|
+
# number = definitions.count
|
121
|
+
#
|
122
|
+
# @note Since SketchUp 2014 the count method is inherited from Ruby's
|
123
|
+
# +Enumable+ mix-in module. Prior to that the {#count} method is an alias
|
124
|
+
# for {#length}.
|
125
|
+
#
|
126
|
+
# @return [Integer]
|
127
|
+
#
|
128
|
+
# @see #length
|
129
|
+
#
|
130
|
+
# @version SketchUp 6.0
|
131
|
+
def count
|
132
|
+
end
|
133
|
+
|
134
|
+
# The each method is used to iterate through all of the component definitions
|
135
|
+
# in the definition list.
|
136
|
+
#
|
137
|
+
# Throws an exception if there are no component definitions.
|
138
|
+
#
|
139
|
+
# @example
|
140
|
+
# model = Sketchup.active_model
|
141
|
+
# definitions = model.definitions
|
142
|
+
# definitions.add("BedTraditional")
|
143
|
+
# number = definitions.each { |definition| puts definition.name }
|
144
|
+
#
|
145
|
+
# @return [nil]
|
146
|
+
#
|
147
|
+
# @version SketchUp 6.0
|
148
|
+
#
|
149
|
+
# @yield [Sketchup::ComponentDefinition] definition
|
150
|
+
def each
|
151
|
+
end
|
152
|
+
|
153
|
+
# The {#length} method is used to retrieve number of component definitions in
|
154
|
+
# the list.
|
155
|
+
#
|
156
|
+
# @example
|
157
|
+
# model = Sketchup.active_model
|
158
|
+
# definitions = model.definitions
|
159
|
+
# number = definitions.length
|
160
|
+
#
|
161
|
+
# @return [Integer]
|
162
|
+
#
|
163
|
+
# @see #size
|
164
|
+
#
|
165
|
+
# @version SketchUp 6.0
|
166
|
+
def length
|
167
|
+
end
|
168
|
+
|
169
|
+
# The load method is used to load a component from a file.
|
170
|
+
#
|
171
|
+
# @example
|
172
|
+
# path=Sketchup.find_support_file "Bed.skp",
|
173
|
+
# "Components/Components Sampler/"
|
174
|
+
# model = Sketchup.active_model
|
175
|
+
# definitions = model.definitions
|
176
|
+
# componentdefinition = definitions.load path
|
177
|
+
#
|
178
|
+
# @param [String] path
|
179
|
+
# The path where the component definition file is located.
|
180
|
+
#
|
181
|
+
# @raise RuntimeError If filename is an invalid SketchUp model. Added in
|
182
|
+
# SketchUp 2019. Possible that prior versions of SketchUp will crash.
|
183
|
+
#
|
184
|
+
# @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
|
185
|
+
# object if successful
|
186
|
+
#
|
187
|
+
# @version SketchUp 6.0
|
188
|
+
def load(path)
|
189
|
+
end
|
190
|
+
|
191
|
+
# The load_from_url method loads a component from a location specified by
|
192
|
+
# string url. This method throws an exception if an url string is not
|
193
|
+
# given, or an error occurs during retrieval from url and a
|
194
|
+
# load_handler was not given. Optional second parameter load_handler can be
|
195
|
+
# used to pass in a ruby object that responds to the following methods:
|
196
|
+
#
|
197
|
+
# - cancelled?(a_boolean)
|
198
|
+
# - onPercentChange(a_float)
|
199
|
+
# - onSuccess()
|
200
|
+
# - onFailure(message_string)
|
201
|
+
#
|
202
|
+
# @example
|
203
|
+
# class LoadHandler
|
204
|
+
#
|
205
|
+
# attr :error
|
206
|
+
#
|
207
|
+
# def onPercentChange(percent)
|
208
|
+
# Sketchup::set_status_text("LOADING: #{percent}%")
|
209
|
+
# end
|
210
|
+
#
|
211
|
+
# def cancelled?
|
212
|
+
# # You could, for example, show a messagebox after X seconds asking if the
|
213
|
+
# # user wants to cancel the download. If this method returns true, then
|
214
|
+
# # the download cancels.
|
215
|
+
# return false
|
216
|
+
# end
|
217
|
+
#
|
218
|
+
# def onSuccess
|
219
|
+
# Sketchup::set_status_text('')
|
220
|
+
# end
|
221
|
+
#
|
222
|
+
# def onFailure(error_message)
|
223
|
+
# self.error = error_message
|
224
|
+
# Sketchup::set_status_text('')
|
225
|
+
# end
|
226
|
+
#
|
227
|
+
# end
|
228
|
+
#
|
229
|
+
# # Replace this with a real URL...
|
230
|
+
# url = 'http://www.sketchup.com/model.skp'
|
231
|
+
# model = Sketchup.active_model
|
232
|
+
# definition = model.definitions.load_from_url(url, load_handler)
|
233
|
+
#
|
234
|
+
# if definition.nil?
|
235
|
+
# puts "Error: #{load_handler.error}"
|
236
|
+
# end
|
237
|
+
#
|
238
|
+
# @param [String] url
|
239
|
+
# URL to load a .skp file from.
|
240
|
+
#
|
241
|
+
# @param [Object] load_handler
|
242
|
+
# Ruby object that has methods defined
|
243
|
+
# as described in the load_from_url details.
|
244
|
+
#
|
245
|
+
# @return [Sketchup::ComponentDefinition] the loaded ComponentDefinition
|
246
|
+
# object if successful
|
247
|
+
#
|
248
|
+
# @version SketchUp 7.0
|
249
|
+
def load_from_url(url, load_handler = nil)
|
250
|
+
end
|
251
|
+
|
252
|
+
# The purge_unused method is used to remove the unused component definitions.
|
253
|
+
#
|
254
|
+
# @example
|
255
|
+
# definitions = Sketchup.active_model.definitions
|
256
|
+
# definitions.purge_unused
|
257
|
+
#
|
258
|
+
# @return [Sketchup::DefinitionList]
|
259
|
+
#
|
260
|
+
# @version SketchUp 6.0
|
261
|
+
def purge_unused
|
262
|
+
end
|
263
|
+
|
264
|
+
# The {#remove} method is used to remove a component definition from the
|
265
|
+
# definition list with the given component definition. This will remove all
|
266
|
+
# instances of the definition.
|
267
|
+
#
|
268
|
+
# @example
|
269
|
+
# model = Sketchup.active_model
|
270
|
+
# definitions = model.definitions
|
271
|
+
# definition = definitions[0]
|
272
|
+
# definitions.remove(definition)
|
273
|
+
#
|
274
|
+
# @param [Sketchup::ComponentDefinition] definition
|
275
|
+
#
|
276
|
+
# @return [Boolean]
|
277
|
+
#
|
278
|
+
# @version SketchUp 2018
|
279
|
+
def remove(definition)
|
280
|
+
end
|
281
|
+
|
282
|
+
# The remove_observer method is used to remove an observer from the current
|
283
|
+
# object.
|
284
|
+
#
|
285
|
+
# @example
|
286
|
+
# definitions = Sketchup.active_model.definitions
|
287
|
+
# status = definitions.remove_observer observer
|
288
|
+
#
|
289
|
+
# @param [Object] observer
|
290
|
+
# An observer.
|
291
|
+
#
|
292
|
+
# @return [Boolean] true if successful, false if unsuccessful.
|
293
|
+
#
|
294
|
+
# @version SketchUp 6.0
|
295
|
+
def remove_observer(observer)
|
296
|
+
end
|
297
|
+
|
298
|
+
# The {#size} method is an alias for {#length}.
|
299
|
+
#
|
300
|
+
# @example
|
301
|
+
# model = Sketchup.active_model
|
302
|
+
# definitions = model.definitions
|
303
|
+
# number = definitions.size
|
304
|
+
#
|
305
|
+
# @return [Integer]
|
306
|
+
#
|
307
|
+
# @see #length
|
308
|
+
#
|
309
|
+
# @version SketchUp 2014
|
310
|
+
def size
|
311
|
+
end
|
312
|
+
|
313
|
+
# The unique_name is used to generate a unique name for a definition based on
|
314
|
+
# a base_name string. For example, a base_name of "Joe" might return "Joe #2"
|
315
|
+
#
|
316
|
+
# @example
|
317
|
+
# model = Sketchup.active_model
|
318
|
+
# definitions = model.definitions
|
319
|
+
# new_name = definitions.unique_name "My Base Name"
|
320
|
+
#
|
321
|
+
# @param [String] base_name
|
322
|
+
#
|
323
|
+
# @return [String] the unique name.
|
324
|
+
#
|
325
|
+
# @version SketchUp 6.0
|
326
|
+
def unique_name(base_name)
|
327
|
+
end
|
328
|
+
|
329
|
+
end
|