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.
Files changed (149) hide show
  1. checksums.yaml +5 -5
  2. data/.yardopts +9 -9
  3. data/lib/sketchup-api-stubs.rb +1 -1
  4. data/lib/sketchup-api-stubs/sketchup.rb +145 -145
  5. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +318 -318
  6. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  7. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  8. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  10. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  11. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +492 -492
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -478
  13. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  14. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  16. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +691 -691
  17. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +573 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +411 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +174 -186
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +514 -514
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +143 -155
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -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 +371 -371
  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 +220 -232
  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 +204 -216
  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/SketchUpModel.rb +694 -694
  43. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  44. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  45. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  48. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +140 -140
  49. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +157 -157
  50. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -281
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +328 -328
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +577 -577
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +281 -281
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +562 -562
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +194 -194
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +329 -329
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +72 -72
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +102 -102
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +312 -312
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +38 -38
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +390 -390
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +508 -508
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1119 -1119
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -544
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +59 -59
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -125
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +750 -750
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +697 -697
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +285 -285
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +409 -409
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +226 -226
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +190 -190
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +393 -393
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +82 -82
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +303 -303
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +285 -280
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +244 -231
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +136 -136
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -123
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +416 -416
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +311 -311
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +141 -141
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +95 -95
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1638 -1601
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +356 -356
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +132 -132
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -770
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +353 -353
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +76 -76
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +456 -456
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +44 -44
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +454 -454
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +257 -257
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +57 -57
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +211 -211
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +225 -225
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +829 -829
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +154 -154
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +61 -61
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1301 -1301
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +43 -43
  134. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +310 -310
  135. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +356 -356
  136. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +229 -229
  137. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  138. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +633 -633
  139. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  140. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  141. data/lib/sketchup-api-stubs/stubs/geom.rb +348 -348
  142. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  143. data/lib/sketchup-api-stubs/stubs/length.rb +278 -278
  144. data/lib/sketchup-api-stubs/stubs/numeric.rb +249 -249
  145. data/lib/sketchup-api-stubs/stubs/sketchup.rb +1310 -1310
  146. data/lib/sketchup-api-stubs/stubs/sketchupextension.rb +353 -353
  147. data/lib/sketchup-api-stubs/stubs/string.rb +24 -24
  148. data/lib/sketchup-api-stubs/stubs/ui.rb +667 -667
  149. metadata +3 -4
@@ -1,152 +1,152 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The AttributeDictionaries class is a collection of all of the
5
- # AttributeDictionary objects that are attached to a given Entity object.
6
- #
7
- # The Entity class is a popular parent class in SketchUp, meaning you can
8
- # attach AttributeDictionaries to almost anything, from geometric items
9
- # like edges and faces and components to more conceptual things like pages
10
- # or materials.
11
- #
12
- # You access this class not by performing an AttributeDictionaries.new but
13
- # by grabbing a handle from an existing entity.
14
- #
15
- # @example
16
- # # Grab the first entity from the model.
17
- # my_layer = Sketchup.active_model.entities[0]
18
- #
19
- # # Grab a handle to its attribute dictionaries.
20
- # attrdicts = my_layer.attribute_dictionaries
21
- #
22
- # @version SketchUp 6.0
23
- class Sketchup::AttributeDictionaries < Sketchup::Entity
24
-
25
- # Includes
26
-
27
- include Enumerable
28
-
29
- # Instance Methods
30
-
31
- # Get an AttributeDictionary by name. Returns nil if there is none with the
32
- # given name.
33
- #
34
- # @example
35
- # model = Sketchup.active_model
36
- # attrdicts = model.attribute_dictionaries
37
- # # Iterates through all dictionaries and prints to screen.
38
- # dict = attrdicts['my_dictionary']
39
- # if dict
40
- # UI.messagebox("Found: " + dict.to_s)
41
- # else
42
- # UI.messagebox("No dictionary found.")
43
- # end
44
- #
45
- # @param [String] key
46
- # The name of the attribute dictionary.
47
- #
48
- # @return [Sketchup::AttributeDictionary] the dictionary
49
- #
50
- # @version SketchUp 6.0
51
- def [](key)
52
- end
53
-
54
- # The count method is inherited from the Enumerable mix-in module.
55
- #
56
- # @example
57
- # model = Sketchup.active_model
58
- # model.set_attribute('Example', 'Hello', 'World')
59
- # dictionaries = model.attribute_dictionaries
60
- # number = dictionaries.count
61
- #
62
- # @return [Integer]
63
- #
64
- # @see #length
65
- #
66
- # @version SketchUp 2014
67
- def count
68
- end
69
-
70
- # The delete method destroys a given AttributeDictionary. This
71
- # AttributeDictionary can be passed directly or identified by its
72
- # string name.
73
- #
74
- # In SketchUp 2018, special attribute dictionaries have been added. The name of
75
- # these dictionaries are "SU_InstanceSet" and "SU_DefinitionSet". The
76
- # dictionaries cannot be deleted via ruby and an ArgumentError will be raised.
77
- # The key/value pairs in the dictionary can be deleted safely.
78
- #
79
- # object
80
- #
81
- # @example
82
- # model = Sketchup.active_model
83
- # attrdicts = model.attribute_dictionaries
84
- # # Deletes a dictionary called 'my_dictionary'
85
- # attrdicts.delete 'my_dictionary'
86
- #
87
- # @param [String, Sketchup::AttributeDictionary] key_or_dict
88
- # The name of the attribute dictionary to delete, or
89
- # the dictionary object itself.
90
- #
91
- # @raise ArgumentError if an advanced attribute dictionary is being deleted.
92
- #
93
- # @return [Sketchup::AttributeDictionaries] the modified AttributeDictionaries
94
- #
95
- # @version SketchUp 6.0
96
- def delete(key_or_dict)
97
- end
98
-
99
- # The each method is used to iterate through all of the attributes
100
- # dictionaries.
101
- #
102
- # Throws an exception if there are no keys.
103
- #
104
- # @example
105
- # model = Sketchup.active_model
106
- # attrdicts = model.attribute_dictionaries
107
- # # Iterates through all dictionaries and prints to screen.
108
- # attrdicts.each { | dict | UI.messagebox dict }
109
- #
110
- # @return nil
111
- #
112
- # @version SketchUp 6.0
113
- #
114
- # @yield [dict] Each AttributeDictionary as it is found.
115
- def each
116
- end
117
-
118
- # The {#length} method returns the number of attribute dictionary objects in
119
- # the collection.
120
- #
121
- # @example
122
- # model = Sketchup.active_model
123
- # model.set_attribute('Example', 'Hello', 'World')
124
- # dictionaries = model.attribute_dictionaries
125
- # number = dictionaries.length
126
- #
127
- # @return [Integer] the number of attribute dictionary objects in the
128
- # collection.
129
- #
130
- # @see #size
131
- #
132
- # @version SketchUp 2014
133
- def length
134
- end
135
-
136
- # The {#size} method is an alias of {#length}.
137
- #
138
- # @example
139
- # model = Sketchup.active_model
140
- # model.set_attribute('Example', 'Hello', 'World')
141
- # dictionaries = model.attribute_dictionaries
142
- # number = dictionaries.size
143
- #
144
- # @return [Integer]
145
- #
146
- # @see #length
147
- #
148
- # @version SketchUp 2014
149
- def size
150
- end
151
-
152
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The AttributeDictionaries class is a collection of all of the
5
+ # AttributeDictionary objects that are attached to a given Entity object.
6
+ #
7
+ # The Entity class is a popular parent class in SketchUp, meaning you can
8
+ # attach AttributeDictionaries to almost anything, from geometric items
9
+ # like edges and faces and components to more conceptual things like pages
10
+ # or materials.
11
+ #
12
+ # You access this class not by performing an AttributeDictionaries.new but
13
+ # by grabbing a handle from an existing entity.
14
+ #
15
+ # @example
16
+ # # Grab the first entity from the model.
17
+ # my_layer = Sketchup.active_model.entities[0]
18
+ #
19
+ # # Grab a handle to its attribute dictionaries.
20
+ # attrdicts = my_layer.attribute_dictionaries
21
+ #
22
+ # @version SketchUp 6.0
23
+ class Sketchup::AttributeDictionaries < Sketchup::Entity
24
+
25
+ # Includes
26
+
27
+ include Enumerable
28
+
29
+ # Instance Methods
30
+
31
+ # Get an AttributeDictionary by name. Returns nil if there is none with the
32
+ # given name.
33
+ #
34
+ # @example
35
+ # model = Sketchup.active_model
36
+ # attrdicts = model.attribute_dictionaries
37
+ # # Iterates through all dictionaries and prints to screen.
38
+ # dict = attrdicts['my_dictionary']
39
+ # if dict
40
+ # UI.messagebox("Found: " + dict.to_s)
41
+ # else
42
+ # UI.messagebox("No dictionary found.")
43
+ # end
44
+ #
45
+ # @param [String] key
46
+ # The name of the attribute dictionary.
47
+ #
48
+ # @return [Sketchup::AttributeDictionary] the dictionary
49
+ #
50
+ # @version SketchUp 6.0
51
+ def [](key)
52
+ end
53
+
54
+ # The count method is inherited from the Enumerable mix-in module.
55
+ #
56
+ # @example
57
+ # model = Sketchup.active_model
58
+ # model.set_attribute('Example', 'Hello', 'World')
59
+ # dictionaries = model.attribute_dictionaries
60
+ # number = dictionaries.count
61
+ #
62
+ # @return [Integer]
63
+ #
64
+ # @see #length
65
+ #
66
+ # @version SketchUp 2014
67
+ def count
68
+ end
69
+
70
+ # The delete method destroys a given AttributeDictionary. This
71
+ # AttributeDictionary can be passed directly or identified by its
72
+ # string name.
73
+ #
74
+ # In SketchUp 2018, special attribute dictionaries have been added. The name of
75
+ # these dictionaries are "SU_InstanceSet" and "SU_DefinitionSet". The
76
+ # dictionaries cannot be deleted via ruby and an ArgumentError will be raised.
77
+ # The key/value pairs in the dictionary can be deleted safely.
78
+ #
79
+ # object
80
+ #
81
+ # @example
82
+ # model = Sketchup.active_model
83
+ # attrdicts = model.attribute_dictionaries
84
+ # # Deletes a dictionary called 'my_dictionary'
85
+ # attrdicts.delete 'my_dictionary'
86
+ #
87
+ # @param [String, Sketchup::AttributeDictionary] key_or_dict
88
+ # The name of the attribute dictionary to delete, or
89
+ # the dictionary object itself.
90
+ #
91
+ # @raise ArgumentError if an advanced attribute dictionary is being deleted.
92
+ #
93
+ # @return [Sketchup::AttributeDictionaries] the modified AttributeDictionaries
94
+ #
95
+ # @version SketchUp 6.0
96
+ def delete(key_or_dict)
97
+ end
98
+
99
+ # The each method is used to iterate through all of the attributes
100
+ # dictionaries.
101
+ #
102
+ # Throws an exception if there are no keys.
103
+ #
104
+ # @example
105
+ # model = Sketchup.active_model
106
+ # attrdicts = model.attribute_dictionaries
107
+ # # Iterates through all dictionaries and prints to screen.
108
+ # attrdicts.each { | dict | UI.messagebox dict }
109
+ #
110
+ # @return nil
111
+ #
112
+ # @version SketchUp 6.0
113
+ #
114
+ # @yield [dict] Each AttributeDictionary as it is found.
115
+ def each
116
+ end
117
+
118
+ # The {#length} method returns the number of attribute dictionary objects in
119
+ # the collection.
120
+ #
121
+ # @example
122
+ # model = Sketchup.active_model
123
+ # model.set_attribute('Example', 'Hello', 'World')
124
+ # dictionaries = model.attribute_dictionaries
125
+ # number = dictionaries.length
126
+ #
127
+ # @return [Integer] the number of attribute dictionary objects in the
128
+ # collection.
129
+ #
130
+ # @see #size
131
+ #
132
+ # @version SketchUp 2014
133
+ def length
134
+ end
135
+
136
+ # The {#size} method is an alias of {#length}.
137
+ #
138
+ # @example
139
+ # model = Sketchup.active_model
140
+ # model.set_attribute('Example', 'Hello', 'World')
141
+ # dictionaries = model.attribute_dictionaries
142
+ # number = dictionaries.size
143
+ #
144
+ # @return [Integer]
145
+ #
146
+ # @see #length
147
+ #
148
+ # @version SketchUp 2014
149
+ def size
150
+ end
151
+
152
+ end
@@ -1,281 +1,281 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The AttributeDictionary class allows you to attach arbitrary collections of
5
- # attributes to a SketchUp entity. The attributes are defined by key/value
6
- # pairs where the keys are strings. An Entity or Model object can have any
7
- # number of AttributeDictionary objects (see the AttributeDictionaries class).
8
- #
9
- # The Entity class is a popular parent class in SketchUp, meaning you can
10
- # attach attribute dictionaries to almost anything, from geometric items
11
- # like edges and faces and components to more conceptual things like pages
12
- # or materials.
13
- #
14
- # @version SketchUp 6.0
15
- class Sketchup::AttributeDictionary < Sketchup::Entity
16
-
17
- # Includes
18
-
19
- include Enumerable
20
-
21
- # Instance Methods
22
-
23
- # The [] method is used to retrieve the attribute with a given key.
24
- #
25
- # @example
26
- # model = Sketchup.active_model
27
- # value = model.set_attribute "testdictionary", "test", 115
28
- # attrdicts = model.attribute_dictionaries
29
- # attrdict = attrdicts["testdictionary"]
30
- #
31
- # # value will contain 115
32
- # value = attrdict["test"]
33
- #
34
- # @param [String] key
35
- # The name of the attribute.
36
- #
37
- # @return [Object, nil] the attribute stored under your key, or
38
- # nil if not found
39
- #
40
- # @version SketchUp 6.0
41
- def [](key)
42
- end
43
-
44
- # The set value ([]=) method is used to set the value of an attribute with a
45
- # given key.
46
- #
47
- # Creates a new attribute for the given key if needed.
48
- #
49
- # @example
50
- # model = Sketchup.active_model
51
- # value = model.set_attribute "testdictionary", "test", 110
52
- # attrdicts = model.attribute_dictionaries
53
- # attrdict = attrdicts["testdictionary"]
54
- # value = attrdict["test2"] = 120
55
- # if (value)
56
- # UI.messagebox value
57
- # end
58
- #
59
- # @param [String] key
60
- # The valid key.
61
- #
62
- # @param [Boolean, Fixnum, Float, Length, nil, String, Time, Array, Geom::Point3d, Geom::Vector3d] value
63
- # The value to be set.
64
- #
65
- # @return [Object, nil] the value that was set if successful, or false
66
- # if unsuccessful.
67
- #
68
- # @version SketchUp 6.0
69
- def []=(key, value)
70
- end
71
-
72
- # The count method is inherited from the Enumerable mix-in module.
73
- #
74
- # @example
75
- # model = Sketchup.active_model
76
- # model.set_attribute('Example', 'Hello', 'World')
77
- # dictionary = model.attribute_dictionary('Example')
78
- # number = dictionary.count
79
- #
80
- # @return [Integer]
81
- #
82
- # @version SketchUp 2014
83
- def count
84
- end
85
-
86
- # The delete_key method is used to delete an attribute with a given key.
87
- #
88
- # @example
89
- # create_if_nil = true
90
- # model = Sketchup.active_model
91
- # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
92
- # attrdict["attr_one"] = "one"
93
- # attrdict["attr_two"] = "two"
94
- #
95
- # # Delete a key/value pair and get the deleted value.
96
- # attrdict = model.attribute_dictionaries['test_dict']
97
- # value = attrdict.delete_key("attr_one")
98
- #
99
- # @param [String] key
100
- # The key to be deleted.
101
- #
102
- # @return [Object, nil] the value of the key
103
- #
104
- # @version SketchUp 6.0
105
- def delete_key(key)
106
- end
107
-
108
- # The {#each} method iterate through all of the attributes.
109
- #
110
- # @example
111
- # create_if_nil = true
112
- # model = Sketchup.active_model
113
- # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
114
- # attrdict["attr_one"] = "one"
115
- # attrdict["attr_two"] = "two"
116
- #
117
- # # Iterates through all attributes and prints the key to the screen.
118
- # attrdict = model.attribute_dictionaries['test_dict']
119
- # attrdict.each { | key, value |
120
- # puts "#{key} = #{value}"
121
- # }
122
- #
123
- # @see #each_pair
124
- #
125
- # @version SketchUp 6.0
126
- #
127
- # @yield [key, value]
128
- #
129
- # @yieldparam [String] key
130
- # The key of each attribute as it is found.
131
- #
132
- # @yieldparam [Object] value
133
- # The value of each attribute as it is found.
134
- def each
135
- end
136
-
137
- # The {#each_key} method is used to iterate through all of the attribute keys.
138
- #
139
- # @example
140
- # create_if_nil = true
141
- # model = Sketchup.active_model
142
- # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
143
- # attrdict["attr_one"] = "one"
144
- # attrdict["attr_two"] = "two"
145
- #
146
- # # iterates through all attributes and prints the key to the screen
147
- # attrdict = model.attribute_dictionaries['test_dict']
148
- # attrdict.each_key { |key| puts key }
149
- #
150
- # @return [nil]
151
- #
152
- # @version SketchUp 6.0
153
- #
154
- # @yieldparam [String] key
155
- # The key of each attribute as it is found.
156
- def each_key
157
- end
158
-
159
- # The {#each_pair} method is an alias for {#each}.
160
- #
161
- # @example
162
- # create_if_nil = true
163
- # model = Sketchup.active_model
164
- # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
165
- # attrdict["attr_one"] = "one"
166
- # attrdict["attr_two"] = "two"
167
- #
168
- # # iterates through all attributes and prints the key to the screen
169
- # attrdict = model.attribute_dictionaries['test_dict']
170
- # attrdict.each_pair { | key, value |
171
- # puts "#{key} = #{value}"
172
- # }
173
- #
174
- # @see #each
175
- #
176
- # @version SketchUp 6.0
177
- #
178
- # @yield [key, value]
179
- #
180
- # @yieldparam [String] key
181
- # The key of each attribute as it is found.
182
- #
183
- # @yieldparam [Object] value
184
- # The value of each attribute as it is found.
185
- def each_pair
186
- end
187
-
188
- # The keys method is used to retrieve an array with all of the attribute keys.
189
- #
190
- # @example
191
- # create_if_nil = true
192
- # model = Sketchup.active_model
193
- # attrdict = model.attribute_dictionary "test_dict", create_if_nil
194
- # attrdict["attr_one"] = "one"
195
- # attrdict["attr_two"] = "two"
196
- #
197
- # # Gets an array of keys
198
- # attrdict = model.attribute_dictionaries['test_dict']
199
- # keys = attrdict.keys
200
- #
201
- # @return [Array<String>] an array of keys within the attribute dictionary
202
- # if successful
203
- #
204
- # @version SketchUp 6.0
205
- def keys
206
- end
207
-
208
- # The {#length} method is used to retrieve the size (number of elements) of an
209
- # attribute dictionary.
210
- #
211
- # @example
212
- # model = Sketchup.active_model
213
- # model.set_attribute('Example', 'Hello', 'World')
214
- # dictionary = model.attribute_dictionary('Example')
215
- # number = dictionary.length
216
- #
217
- # @return [Integer]
218
- #
219
- # @see #size
220
- #
221
- # @version SketchUp 6.0
222
- def length
223
- end
224
-
225
- # The name method is used to retrieve the name of an attribute dictionary.
226
- #
227
- # @example
228
- # create_if_nil = true
229
- # model = Sketchup.active_model
230
- # attrdict = model.attribute_dictionary "test_dict", create_if_nil
231
- # attrdict["attr_one"] = "one"
232
- # attrdict["attr_two"] = "two"
233
- #
234
- # # Show the name.
235
- # UI.messagebox attrdict.name
236
- #
237
- # @return [String] the name of the attribute dictionary if
238
- # successful
239
- #
240
- # @version SketchUp 6.0
241
- def name
242
- end
243
-
244
- # The {#size} method is an alias of {#length}.
245
- #
246
- # @example
247
- # model = Sketchup.active_model
248
- # model.set_attribute('Example', 'Hello', 'World')
249
- # dictionary = model.attribute_dictionary('Example')
250
- # number = dictionary.size
251
- #
252
- # @return [Integer]
253
- #
254
- # @see #length
255
- #
256
- # @version SketchUp 6.0
257
- def size
258
- end
259
-
260
- # The values method is used to retrieve an array with all of the attribute
261
- # values.
262
- #
263
- # @example
264
- # create_if_nil = true
265
- # model = Sketchup.active_model
266
- # attrdict = model.attribute_dictionary "test_dict", create_if_nil
267
- # attrdict["attr_one"] = "one"
268
- # attrdict["attr_two"] = "two"
269
- #
270
- # # Gets an array of values
271
- # attrdict = model.attribute_dictionaries['test_dict']
272
- # values = attrdict.values
273
- #
274
- # @return [Array<Object>] an array of values within the attribute dictionary
275
- # if successful
276
- #
277
- # @version SketchUp 6.0
278
- def values
279
- end
280
-
281
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The AttributeDictionary class allows you to attach arbitrary collections of
5
+ # attributes to a SketchUp entity. The attributes are defined by key/value
6
+ # pairs where the keys are strings. An Entity or Model object can have any
7
+ # number of AttributeDictionary objects (see the AttributeDictionaries class).
8
+ #
9
+ # The Entity class is a popular parent class in SketchUp, meaning you can
10
+ # attach attribute dictionaries to almost anything, from geometric items
11
+ # like edges and faces and components to more conceptual things like pages
12
+ # or materials.
13
+ #
14
+ # @version SketchUp 6.0
15
+ class Sketchup::AttributeDictionary < Sketchup::Entity
16
+
17
+ # Includes
18
+
19
+ include Enumerable
20
+
21
+ # Instance Methods
22
+
23
+ # The [] method is used to retrieve the attribute with a given key.
24
+ #
25
+ # @example
26
+ # model = Sketchup.active_model
27
+ # value = model.set_attribute "testdictionary", "test", 115
28
+ # attrdicts = model.attribute_dictionaries
29
+ # attrdict = attrdicts["testdictionary"]
30
+ #
31
+ # # value will contain 115
32
+ # value = attrdict["test"]
33
+ #
34
+ # @param [String] key
35
+ # The name of the attribute.
36
+ #
37
+ # @return [Object, nil] the attribute stored under your key, or
38
+ # nil if not found
39
+ #
40
+ # @version SketchUp 6.0
41
+ def [](key)
42
+ end
43
+
44
+ # The set value ([]=) method is used to set the value of an attribute with a
45
+ # given key.
46
+ #
47
+ # Creates a new attribute for the given key if needed.
48
+ #
49
+ # @example
50
+ # model = Sketchup.active_model
51
+ # value = model.set_attribute "testdictionary", "test", 110
52
+ # attrdicts = model.attribute_dictionaries
53
+ # attrdict = attrdicts["testdictionary"]
54
+ # value = attrdict["test2"] = 120
55
+ # if (value)
56
+ # UI.messagebox value
57
+ # end
58
+ #
59
+ # @param [String] key
60
+ # The valid key.
61
+ #
62
+ # @param [Boolean, Fixnum, Float, Length, nil, String, Time, Array, Geom::Point3d, Geom::Vector3d] value
63
+ # The value to be set.
64
+ #
65
+ # @return [Object, nil] the value that was set if successful, or false
66
+ # if unsuccessful.
67
+ #
68
+ # @version SketchUp 6.0
69
+ def []=(key, value)
70
+ end
71
+
72
+ # The count method is inherited from the Enumerable mix-in module.
73
+ #
74
+ # @example
75
+ # model = Sketchup.active_model
76
+ # model.set_attribute('Example', 'Hello', 'World')
77
+ # dictionary = model.attribute_dictionary('Example')
78
+ # number = dictionary.count
79
+ #
80
+ # @return [Integer]
81
+ #
82
+ # @version SketchUp 2014
83
+ def count
84
+ end
85
+
86
+ # The delete_key method is used to delete an attribute with a given key.
87
+ #
88
+ # @example
89
+ # create_if_nil = true
90
+ # model = Sketchup.active_model
91
+ # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
92
+ # attrdict["attr_one"] = "one"
93
+ # attrdict["attr_two"] = "two"
94
+ #
95
+ # # Delete a key/value pair and get the deleted value.
96
+ # attrdict = model.attribute_dictionaries['test_dict']
97
+ # value = attrdict.delete_key("attr_one")
98
+ #
99
+ # @param [String] key
100
+ # The key to be deleted.
101
+ #
102
+ # @return [Object, nil] the value of the key
103
+ #
104
+ # @version SketchUp 6.0
105
+ def delete_key(key)
106
+ end
107
+
108
+ # The {#each} method iterate through all of the attributes.
109
+ #
110
+ # @example
111
+ # create_if_nil = true
112
+ # model = Sketchup.active_model
113
+ # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
114
+ # attrdict["attr_one"] = "one"
115
+ # attrdict["attr_two"] = "two"
116
+ #
117
+ # # Iterates through all attributes and prints the key to the screen.
118
+ # attrdict = model.attribute_dictionaries['test_dict']
119
+ # attrdict.each { | key, value |
120
+ # puts "#{key} = #{value}"
121
+ # }
122
+ #
123
+ # @see #each_pair
124
+ #
125
+ # @version SketchUp 6.0
126
+ #
127
+ # @yield [key, value]
128
+ #
129
+ # @yieldparam [String] key
130
+ # The key of each attribute as it is found.
131
+ #
132
+ # @yieldparam [Object] value
133
+ # The value of each attribute as it is found.
134
+ def each
135
+ end
136
+
137
+ # The {#each_key} method is used to iterate through all of the attribute keys.
138
+ #
139
+ # @example
140
+ # create_if_nil = true
141
+ # model = Sketchup.active_model
142
+ # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
143
+ # attrdict["attr_one"] = "one"
144
+ # attrdict["attr_two"] = "two"
145
+ #
146
+ # # iterates through all attributes and prints the key to the screen
147
+ # attrdict = model.attribute_dictionaries['test_dict']
148
+ # attrdict.each_key { |key| puts key }
149
+ #
150
+ # @return [nil]
151
+ #
152
+ # @version SketchUp 6.0
153
+ #
154
+ # @yieldparam [String] key
155
+ # The key of each attribute as it is found.
156
+ def each_key
157
+ end
158
+
159
+ # The {#each_pair} method is an alias for {#each}.
160
+ #
161
+ # @example
162
+ # create_if_nil = true
163
+ # model = Sketchup.active_model
164
+ # attrdict = model.attribute_dictionary("test_dict", create_if_nil)
165
+ # attrdict["attr_one"] = "one"
166
+ # attrdict["attr_two"] = "two"
167
+ #
168
+ # # iterates through all attributes and prints the key to the screen
169
+ # attrdict = model.attribute_dictionaries['test_dict']
170
+ # attrdict.each_pair { | key, value |
171
+ # puts "#{key} = #{value}"
172
+ # }
173
+ #
174
+ # @see #each
175
+ #
176
+ # @version SketchUp 6.0
177
+ #
178
+ # @yield [key, value]
179
+ #
180
+ # @yieldparam [String] key
181
+ # The key of each attribute as it is found.
182
+ #
183
+ # @yieldparam [Object] value
184
+ # The value of each attribute as it is found.
185
+ def each_pair
186
+ end
187
+
188
+ # The keys method is used to retrieve an array with all of the attribute keys.
189
+ #
190
+ # @example
191
+ # create_if_nil = true
192
+ # model = Sketchup.active_model
193
+ # attrdict = model.attribute_dictionary "test_dict", create_if_nil
194
+ # attrdict["attr_one"] = "one"
195
+ # attrdict["attr_two"] = "two"
196
+ #
197
+ # # Gets an array of keys
198
+ # attrdict = model.attribute_dictionaries['test_dict']
199
+ # keys = attrdict.keys
200
+ #
201
+ # @return [Array<String>] an array of keys within the attribute dictionary
202
+ # if successful
203
+ #
204
+ # @version SketchUp 6.0
205
+ def keys
206
+ end
207
+
208
+ # The {#length} method is used to retrieve the size (number of elements) of an
209
+ # attribute dictionary.
210
+ #
211
+ # @example
212
+ # model = Sketchup.active_model
213
+ # model.set_attribute('Example', 'Hello', 'World')
214
+ # dictionary = model.attribute_dictionary('Example')
215
+ # number = dictionary.length
216
+ #
217
+ # @return [Integer]
218
+ #
219
+ # @see #size
220
+ #
221
+ # @version SketchUp 6.0
222
+ def length
223
+ end
224
+
225
+ # The name method is used to retrieve the name of an attribute dictionary.
226
+ #
227
+ # @example
228
+ # create_if_nil = true
229
+ # model = Sketchup.active_model
230
+ # attrdict = model.attribute_dictionary "test_dict", create_if_nil
231
+ # attrdict["attr_one"] = "one"
232
+ # attrdict["attr_two"] = "two"
233
+ #
234
+ # # Show the name.
235
+ # UI.messagebox attrdict.name
236
+ #
237
+ # @return [String] the name of the attribute dictionary if
238
+ # successful
239
+ #
240
+ # @version SketchUp 6.0
241
+ def name
242
+ end
243
+
244
+ # The {#size} method is an alias of {#length}.
245
+ #
246
+ # @example
247
+ # model = Sketchup.active_model
248
+ # model.set_attribute('Example', 'Hello', 'World')
249
+ # dictionary = model.attribute_dictionary('Example')
250
+ # number = dictionary.size
251
+ #
252
+ # @return [Integer]
253
+ #
254
+ # @see #length
255
+ #
256
+ # @version SketchUp 6.0
257
+ def size
258
+ end
259
+
260
+ # The values method is used to retrieve an array with all of the attribute
261
+ # values.
262
+ #
263
+ # @example
264
+ # create_if_nil = true
265
+ # model = Sketchup.active_model
266
+ # attrdict = model.attribute_dictionary "test_dict", create_if_nil
267
+ # attrdict["attr_one"] = "one"
268
+ # attrdict["attr_two"] = "two"
269
+ #
270
+ # # Gets an array of values
271
+ # attrdict = model.attribute_dictionaries['test_dict']
272
+ # values = attrdict.values
273
+ #
274
+ # @return [Array<Object>] an array of values within the attribute dictionary
275
+ # if successful
276
+ #
277
+ # @version SketchUp 6.0
278
+ def values
279
+ end
280
+
281
+ end