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,257 +1,255 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# The ShadowInfo class contains method to extract the shadow
|
5
|
-
# model. The majority of the shadow information returned
|
6
|
-
# Info > Location and Model Info > Shadows dialogs inside
|
7
|
-
#
|
8
|
-
#
|
9
|
-
#
|
10
|
-
#
|
11
|
-
# - +
|
12
|
-
#
|
13
|
-
# - +
|
14
|
-
# - +
|
15
|
-
# - +
|
16
|
-
# - +
|
17
|
-
# - +
|
18
|
-
# - +
|
19
|
-
# - +
|
20
|
-
# - +
|
21
|
-
# - +
|
22
|
-
# - +
|
23
|
-
# - +
|
24
|
-
# - +
|
25
|
-
# - +
|
26
|
-
# - +
|
27
|
-
# - +
|
28
|
-
# - +
|
29
|
-
# - +
|
30
|
-
# - +
|
31
|
-
# - +
|
32
|
-
# - +
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
#
|
51
|
-
|
52
|
-
#
|
53
|
-
#
|
54
|
-
#
|
55
|
-
#
|
56
|
-
#
|
57
|
-
# @
|
58
|
-
#
|
59
|
-
# @
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
65
|
-
#
|
66
|
-
#
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
# @
|
72
|
-
|
73
|
-
|
74
|
-
|
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
|
-
# value = shadowinfo["City"]
|
100
|
-
# UI.messagebox value
|
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
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
# @
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
# @
|
154
|
-
#
|
155
|
-
# @
|
156
|
-
#
|
157
|
-
# @
|
158
|
-
#
|
159
|
-
# @yieldparam [String] key
|
160
|
-
#
|
161
|
-
# @yieldparam [Object] value
|
162
|
-
def each
|
163
|
-
end
|
164
|
-
|
165
|
-
# The each_key method iterates through all of the shadow information keys.
|
166
|
-
#
|
167
|
-
# @example
|
168
|
-
# shadowinfo.each_key { |key| puts key }
|
169
|
-
#
|
170
|
-
# @return [nil]
|
171
|
-
#
|
172
|
-
# @version SketchUp 6.0
|
173
|
-
#
|
174
|
-
# @
|
175
|
-
def each_key
|
176
|
-
end
|
177
|
-
|
178
|
-
# The {#each_pair} method is an alias for {#each}.
|
179
|
-
#
|
180
|
-
# @example
|
181
|
-
# model = Sketchup.active_model
|
182
|
-
# shadow_info = model.shadow_info
|
183
|
-
# shadow_info.each_pair { |key, value|
|
184
|
-
# puts "#{key} : #{value}"
|
185
|
-
# }
|
186
|
-
#
|
187
|
-
# @return [nil]
|
188
|
-
#
|
189
|
-
# @see #each
|
190
|
-
#
|
191
|
-
# @version SketchUp 6.0
|
192
|
-
#
|
193
|
-
# @
|
194
|
-
#
|
195
|
-
# @yieldparam [
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
|
201
|
-
#
|
202
|
-
#
|
203
|
-
#
|
204
|
-
#
|
205
|
-
#
|
206
|
-
#
|
207
|
-
# @
|
208
|
-
|
209
|
-
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
#
|
214
|
-
#
|
215
|
-
#
|
216
|
-
#
|
217
|
-
#
|
218
|
-
#
|
219
|
-
#
|
220
|
-
# @
|
221
|
-
#
|
222
|
-
# @
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
#
|
229
|
-
#
|
230
|
-
#
|
231
|
-
#
|
232
|
-
#
|
233
|
-
#
|
234
|
-
#
|
235
|
-
#
|
236
|
-
#
|
237
|
-
# @
|
238
|
-
|
239
|
-
|
240
|
-
|
241
|
-
|
242
|
-
|
243
|
-
#
|
244
|
-
#
|
245
|
-
#
|
246
|
-
#
|
247
|
-
#
|
248
|
-
#
|
249
|
-
# @
|
250
|
-
#
|
251
|
-
# @
|
252
|
-
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# The {Sketchup::ShadowInfo} class contains method to extract the shadow
|
5
|
+
# information for a model. The majority of the shadow information returned
|
6
|
+
# exists in the Model Info > Location and Model Info > Shadows dialogs inside
|
7
|
+
# SketchUp.
|
8
|
+
#
|
9
|
+
# The following shadow information keys are maintained in SketchUp:
|
10
|
+
#
|
11
|
+
# - +City+ (in Model Info > Geo-location > Set Manual Location...) Note that
|
12
|
+
# 'City' is called 'Location' in the UI
|
13
|
+
# - +Country+ (in Model Info > Geo-location > Set Manual Location...)
|
14
|
+
# - +Dark+ (in Window > Shadows)
|
15
|
+
# - +DayOfYear+
|
16
|
+
# - +DaylightSavings+
|
17
|
+
# - +DisplayNorth+
|
18
|
+
# - +DisplayOnAllFaces+ (in Window > Shadows)
|
19
|
+
# - +DisplayOnGroundPlane+ (in Window > Shadows)
|
20
|
+
# - +DisplayShadows+ (in Window > Shadows)
|
21
|
+
# - +EdgesCastShadows+ (in Window > Shadows)
|
22
|
+
# - +Latitude+ (in Model Info > Geo-location > Set Manual Location...)
|
23
|
+
# - +Light+ (in Window > Shadows)
|
24
|
+
# - +Longitude+ (in Model Info > Geo-location > Set Manual Location...)
|
25
|
+
# - +NorthAngle+
|
26
|
+
# - +ShadowTime+ (in Window > Shadows)
|
27
|
+
# - +ShadowTime_time_t+ (ShadowTime in Epoch time)
|
28
|
+
# - +SunDirection+ (Generated based on ShadowTime)
|
29
|
+
# - +SunRise+ (Generated based on ShadowTime)
|
30
|
+
# - +SunRise_time_t+ (SunRise in Epoch time)
|
31
|
+
# - +SunSet+ (Generated based on ShadowTime)
|
32
|
+
# - +SunSet_time_t+ (SunSet in Epoch time)
|
33
|
+
# - +TZOffset+ (in Window > Shadows)
|
34
|
+
# - +UseSunForAllShading+ (in Window > Shadows)
|
35
|
+
#
|
36
|
+
# You access the {Sketchup::ShadowInfo} object by calling {Sketchup::Model#shadow_info}:
|
37
|
+
#
|
38
|
+
# @example
|
39
|
+
# model = Sketchup.active_model
|
40
|
+
# shadowinfo = model.shadow_info
|
41
|
+
# puts "My city is: #{shadowinfo["City"]}"
|
42
|
+
#
|
43
|
+
# @version SketchUp 6.0
|
44
|
+
class Sketchup::ShadowInfo < Sketchup::Entity
|
45
|
+
|
46
|
+
# Includes
|
47
|
+
|
48
|
+
include Enumerable
|
49
|
+
|
50
|
+
# Class Methods
|
51
|
+
|
52
|
+
# The {#each_key} method iterates through all of the shadow information keys.
|
53
|
+
#
|
54
|
+
# @example
|
55
|
+
# shadowinfo.each_key { |key| puts key }
|
56
|
+
#
|
57
|
+
# @return [nil]
|
58
|
+
#
|
59
|
+
# @version SketchUp 6.0
|
60
|
+
#
|
61
|
+
# @yieldparam [String] key
|
62
|
+
def self.each_key
|
63
|
+
end
|
64
|
+
|
65
|
+
# The keys method is a class method that returns an array with all of the
|
66
|
+
# attribute keys
|
67
|
+
#
|
68
|
+
# @example
|
69
|
+
# keys = Sketchup::ShadowInfo.keys
|
70
|
+
#
|
71
|
+
# @return [Array<String>] an array of keys
|
72
|
+
#
|
73
|
+
# @version SketchUp 6.0
|
74
|
+
def self.keys
|
75
|
+
end
|
76
|
+
|
77
|
+
# Instance Methods
|
78
|
+
|
79
|
+
# The [] method retrieves a value from the array of keys
|
80
|
+
#
|
81
|
+
# @example
|
82
|
+
# value = shadowinfo["key"]
|
83
|
+
#
|
84
|
+
# @param [String] key
|
85
|
+
# The key of the shadowinfo value to retrieve.
|
86
|
+
#
|
87
|
+
# @return [Object, nil] the value that is retrieved.
|
88
|
+
#
|
89
|
+
# @version SketchUp 6.0
|
90
|
+
def [](key)
|
91
|
+
end
|
92
|
+
|
93
|
+
# The set value []= method is used to set the value in the array of shadow
|
94
|
+
# info options.
|
95
|
+
#
|
96
|
+
# @example
|
97
|
+
# model = Sketchup.active_model
|
98
|
+
# shadowinfo = model.shadow_info
|
99
|
+
# value = shadowinfo["City"]
|
100
|
+
# UI.messagebox value
|
101
|
+
# value = shadowinfo["City"]="Denver, CO"
|
102
|
+
# UI.messagebox value
|
103
|
+
#
|
104
|
+
# @param [String] key
|
105
|
+
# The key of the shadowinfo value to set.
|
106
|
+
#
|
107
|
+
# @param [Object] value
|
108
|
+
# The value to be set.
|
109
|
+
#
|
110
|
+
# @return [Object] the value that was set if successful, or false
|
111
|
+
# if unsuccessful.
|
112
|
+
#
|
113
|
+
# @version SketchUp 6.0
|
114
|
+
def []=(key, value)
|
115
|
+
end
|
116
|
+
|
117
|
+
# The add_observer method is used to add an observer to the current object.
|
118
|
+
#
|
119
|
+
# @example
|
120
|
+
# status = object.add_observer observer
|
121
|
+
#
|
122
|
+
# @param [Object] observer
|
123
|
+
# An observer.
|
124
|
+
#
|
125
|
+
# @return [Boolean] true if successful, false if unsuccessful.
|
126
|
+
#
|
127
|
+
# @version SketchUp 6.0
|
128
|
+
def add_observer(observer)
|
129
|
+
end
|
130
|
+
|
131
|
+
# The count method is inherited from the Enumerable mix-in module.
|
132
|
+
#
|
133
|
+
# @example
|
134
|
+
# shadow_info = Sketchup.active_model.shadow_info
|
135
|
+
# number = shadow_info.count
|
136
|
+
#
|
137
|
+
# @return [Integer]
|
138
|
+
#
|
139
|
+
# @version SketchUp 2014
|
140
|
+
def count
|
141
|
+
end
|
142
|
+
|
143
|
+
# The {#each} method iterates through all of the shadow information key/value
|
144
|
+
# pairs.
|
145
|
+
#
|
146
|
+
# @example
|
147
|
+
# model = Sketchup.active_model
|
148
|
+
# shadow_info = model.shadow_info
|
149
|
+
# shadow_info.each { |key, value|
|
150
|
+
# puts "#{key} : #{value}"
|
151
|
+
# }
|
152
|
+
#
|
153
|
+
# @return [nil]
|
154
|
+
#
|
155
|
+
# @see #each_pair
|
156
|
+
#
|
157
|
+
# @version SketchUp 6.0
|
158
|
+
#
|
159
|
+
# @yieldparam [String] key
|
160
|
+
#
|
161
|
+
# @yieldparam [Object] value
|
162
|
+
def each
|
163
|
+
end
|
164
|
+
|
165
|
+
# The {#each_key} method iterates through all of the shadow information keys.
|
166
|
+
#
|
167
|
+
# @example
|
168
|
+
# shadowinfo.each_key { |key| puts key }
|
169
|
+
#
|
170
|
+
# @return [nil]
|
171
|
+
#
|
172
|
+
# @version SketchUp 6.0
|
173
|
+
#
|
174
|
+
# @yieldparam [String] key
|
175
|
+
def each_key
|
176
|
+
end
|
177
|
+
|
178
|
+
# The {#each_pair} method is an alias for {#each}.
|
179
|
+
#
|
180
|
+
# @example
|
181
|
+
# model = Sketchup.active_model
|
182
|
+
# shadow_info = model.shadow_info
|
183
|
+
# shadow_info.each_pair { |key, value|
|
184
|
+
# puts "#{key} : #{value}"
|
185
|
+
# }
|
186
|
+
#
|
187
|
+
# @return [nil]
|
188
|
+
#
|
189
|
+
# @see #each
|
190
|
+
#
|
191
|
+
# @version SketchUp 6.0
|
192
|
+
#
|
193
|
+
# @yieldparam [String] key
|
194
|
+
#
|
195
|
+
# @yieldparam [Object] value
|
196
|
+
def each_pair
|
197
|
+
end
|
198
|
+
|
199
|
+
# The keys method is a class method that returns an array with all of the
|
200
|
+
# attribute keys
|
201
|
+
#
|
202
|
+
# @example
|
203
|
+
# keys = Sketchup::ShadowInfo.keys
|
204
|
+
#
|
205
|
+
# @return [Array<String>] an array of keys
|
206
|
+
#
|
207
|
+
# @version SketchUp 6.0
|
208
|
+
def keys
|
209
|
+
end
|
210
|
+
|
211
|
+
# The {#length} method returns the number of options in the shadow options
|
212
|
+
# collection
|
213
|
+
#
|
214
|
+
# @example
|
215
|
+
# shadow_info = Sketchup.active_model.shadow_info
|
216
|
+
# number = shadow_info.length
|
217
|
+
#
|
218
|
+
# @return [Integer]
|
219
|
+
#
|
220
|
+
# @see #size
|
221
|
+
#
|
222
|
+
# @version SketchUp 2014
|
223
|
+
def length
|
224
|
+
end
|
225
|
+
|
226
|
+
# The remove_observer method is used to remove an observer from the current
|
227
|
+
# object.
|
228
|
+
#
|
229
|
+
# @example
|
230
|
+
# status = object.remove_observer observer
|
231
|
+
#
|
232
|
+
# @param [Object] observer
|
233
|
+
# An observer.
|
234
|
+
#
|
235
|
+
# @return [Boolean] true if successful, false if unsuccessful.
|
236
|
+
#
|
237
|
+
# @version SketchUp 6.0
|
238
|
+
def remove_observer(observer)
|
239
|
+
end
|
240
|
+
|
241
|
+
# The {#size} method is an alias for {#length}.
|
242
|
+
#
|
243
|
+
# @example
|
244
|
+
# shadow_info = Sketchup.active_model.shadow_info
|
245
|
+
# number = shadow_info.size
|
246
|
+
#
|
247
|
+
# @return [Integer]
|
248
|
+
#
|
249
|
+
# @see #length
|
250
|
+
#
|
251
|
+
# @version SketchUp 2014
|
252
|
+
def size
|
253
|
+
end
|
254
|
+
|
255
|
+
end
|
@@ -1,59 +1,59 @@
|
|
1
|
-
# Copyright:: Copyright
|
2
|
-
# License:: The MIT License (MIT)
|
3
|
-
|
4
|
-
# This observer interface is implemented to react to changes to the shadow
|
5
|
-
# settings.
|
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
|
-
# {Sketchup::ShadowInfo} object.
|
10
|
-
#
|
11
|
-
# @example
|
12
|
-
# # This is an example of an observer that watches the selection for
|
13
|
-
# # changes.
|
14
|
-
# class MyShadowInfoObserver < Sketchup::ShadowInfoObserver
|
15
|
-
# def onShadowInfoChanged(shadow_info, type)
|
16
|
-
# puts "onShadowInfoChanged: #{type}"
|
17
|
-
# end
|
18
|
-
# end
|
19
|
-
#
|
20
|
-
# # Attach the observer.
|
21
|
-
# Sketchup.active_model.shadow_info.add_observer(MyShadowInfoObserver.new)
|
22
|
-
#
|
23
|
-
# @version SketchUp 6.0
|
24
|
-
class Sketchup::ShadowInfoObserver
|
25
|
-
|
26
|
-
# Instance Methods
|
27
|
-
|
28
|
-
# The {#onShadowInfoChanged} method is invoked whenever the user alters a
|
29
|
-
# setting inside the Shadows and Model Info dialogs. The type parameter
|
30
|
-
# contains a number identifying which option was altered. Here are the types to
|
31
|
-
# expect:
|
32
|
-
#
|
33
|
-
# - 0 = Time/Date sliders
|
34
|
-
# - 1 = Display Shadows checkbox
|
35
|
-
# - 2 = Light/Dark sliders
|
36
|
-
# - 3 = Geographic Location (in Model Info > Location)
|
37
|
-
# - 4 = Solar Orientation (in Model Info > Location)
|
38
|
-
# - 7 = Use Sun for Shading checkbox
|
39
|
-
# - 8 = Display from Edges checkbox
|
40
|
-
# - 9 = Display on Ground checkbox
|
41
|
-
# - 10 = Display on Faces checkbox
|
42
|
-
#
|
43
|
-
# @example
|
44
|
-
# def onShadowInfoChanged(shadow_info, type)
|
45
|
-
# puts "onShadowInfoChanged: #{type}"
|
46
|
-
# end
|
47
|
-
#
|
48
|
-
# @param [Sketchup::ShadowInfo] shadow_info
|
49
|
-
#
|
50
|
-
# @param [Integer] type
|
51
|
-
# A number identifying which setting was changed.
|
52
|
-
#
|
53
|
-
# @return [nil]
|
54
|
-
#
|
55
|
-
# @version SketchUp 6.0
|
56
|
-
def onShadowInfoChanged(shadow_info, type)
|
57
|
-
end
|
58
|
-
|
59
|
-
end
|
1
|
+
# Copyright:: Copyright 2023 Trimble Inc.
|
2
|
+
# License:: The MIT License (MIT)
|
3
|
+
|
4
|
+
# This observer interface is implemented to react to changes to the shadow
|
5
|
+
# settings.
|
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
|
+
# {Sketchup::ShadowInfo} object.
|
10
|
+
#
|
11
|
+
# @example
|
12
|
+
# # This is an example of an observer that watches the selection for
|
13
|
+
# # changes.
|
14
|
+
# class MyShadowInfoObserver < Sketchup::ShadowInfoObserver
|
15
|
+
# def onShadowInfoChanged(shadow_info, type)
|
16
|
+
# puts "onShadowInfoChanged: #{type}"
|
17
|
+
# end
|
18
|
+
# end
|
19
|
+
#
|
20
|
+
# # Attach the observer.
|
21
|
+
# Sketchup.active_model.shadow_info.add_observer(MyShadowInfoObserver.new)
|
22
|
+
#
|
23
|
+
# @version SketchUp 6.0
|
24
|
+
class Sketchup::ShadowInfoObserver
|
25
|
+
|
26
|
+
# Instance Methods
|
27
|
+
|
28
|
+
# The {#onShadowInfoChanged} method is invoked whenever the user alters a
|
29
|
+
# setting inside the Shadows and Model Info dialogs. The type parameter
|
30
|
+
# contains a number identifying which option was altered. Here are the types to
|
31
|
+
# expect:
|
32
|
+
#
|
33
|
+
# - 0 = Time/Date sliders
|
34
|
+
# - 1 = Display Shadows checkbox
|
35
|
+
# - 2 = Light/Dark sliders
|
36
|
+
# - 3 = Geographic Location (in Model Info > Location)
|
37
|
+
# - 4 = Solar Orientation (in Model Info > Location)
|
38
|
+
# - 7 = Use Sun for Shading checkbox
|
39
|
+
# - 8 = Display from Edges checkbox
|
40
|
+
# - 9 = Display on Ground checkbox
|
41
|
+
# - 10 = Display on Faces checkbox
|
42
|
+
#
|
43
|
+
# @example
|
44
|
+
# def onShadowInfoChanged(shadow_info, type)
|
45
|
+
# puts "onShadowInfoChanged: #{type}"
|
46
|
+
# end
|
47
|
+
#
|
48
|
+
# @param [Sketchup::ShadowInfo] shadow_info
|
49
|
+
#
|
50
|
+
# @param [Integer] type
|
51
|
+
# A number identifying which setting was changed.
|
52
|
+
#
|
53
|
+
# @return [nil]
|
54
|
+
#
|
55
|
+
# @version SketchUp 6.0
|
56
|
+
def onShadowInfoChanged(shadow_info, type)
|
57
|
+
end
|
58
|
+
|
59
|
+
end
|