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.
Files changed (154) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +151 -147
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +509 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -478
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
  16. data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -351
  17. data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -179
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -515
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -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 +370 -370
  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 +225 -225
  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 +209 -209
  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/ReferenceEntity.rb +82 -0
  43. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
  44. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  45. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  49. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  50. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  51. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -577
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -594
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -425
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1126
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -0
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -917
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -405
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -327
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1654
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -478
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +255 -257
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -835
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -71
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1307
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
  143. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1377 -1353
  144. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  145. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  146. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -317
  147. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -478
  148. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
  149. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
  150. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  151. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -672
  152. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
  153. data/lib/sketchup-api-stubs.rb +1 -1
  154. metadata +20 -16
@@ -1,257 +1,255 @@
1
- # Copyright:: Copyright 2021 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The ShadowInfo class contains method to extract the shadow information for a
5
- # model. The majority of the shadow information returned exists in the Model
6
- # Info > Location and Model Info > Shadows dialogs inside SketchUp.
7
- #
8
- # The following shadow information keys are maintained in SketchUp:
9
- #
10
- # - +City+ (in Model Info > Geo-location > Set Manual Location...) Note that 'City' is called 'Location' in the UI
11
- # - +Country+ (in Model Info > Geo-location > Set Manual Location...)
12
- # - +Dark+ (in Window > Shadows)
13
- # - +DayOfYear+
14
- # - +DaylightSavings+
15
- # - +DisplayNorth+ (in View > Toolbars > Solar North) Note that 'Toolbar' is called 'Tool Palettes' on Mac
16
- # - +DisplayOnAllFaces+ (in Window > Shadows)
17
- # - +DisplayOnGroundPlane+ (in Window > Shadows)
18
- # - +DisplayShadows+ (in Window > Shadows)
19
- # - +EdgesCastShadows+ (in Window > Shadows)
20
- # - +Latitude+ (in Model Info > Geo-location > Set Manual Location...)
21
- # - +Light+ (in Window > Shadows)
22
- # - +Longitude+ (in Model Info > Geo-location > Set Manual Location...)
23
- # - +NorthAngle+ (in View > Toolbars > Solar North) Note that 'Toolbar' is called 'Tool Palettes' on Mac
24
- # - +ShadowTime+ (in Window > Shadows)
25
- # - +ShadowTime_time_t+ (ShadowTime in Epoch time)
26
- # - +SunDirection+ (Generated based on ShadowTime)
27
- # - +SunRise+ (Generated based on ShadowTime)
28
- # - +SunRise_time_t+ (SunRise in Epoch time)
29
- # - +SunSet+ (Generated based on ShadowTime)
30
- # - +SunSet_time_t+ (SunSet in Epoch time)
31
- # - +TZOffset+ (in Window > Shadows)
32
- # - +UseSunForAllShading+ (in Window > Shadows)
33
- #
34
- # You access the ShadowInfo object by calling Model.shadow_info:
35
- #
36
- # @example
37
- # model = Sketchup.active_model
38
- # shadowinfo = model.shadow_info
39
- # UI.messagebox("My city is: " + shadowinfo["City"].to_s)
40
- #
41
- # @version SketchUp 6.0
42
- class Sketchup::ShadowInfo < Sketchup::Entity
43
-
44
- # Includes
45
-
46
- include Enumerable
47
-
48
- # Class Methods
49
-
50
- # The each_key method iterates through all of the shadow information keys.
51
- #
52
- # @example
53
- # shadowinfo.each_key { |key| puts key }
54
- #
55
- # @return [nil]
56
- #
57
- # @version SketchUp 6.0
58
- #
59
- # @yield [key] Variable to hold each key as they are found.
60
- def self.each_key
61
- end
62
-
63
- # The keys method is a class method that returns an array with all of the
64
- # attribute keys
65
- #
66
- # @example
67
- # keys = Sketchup::ShadowInfo.keys
68
- #
69
- # @return [Array<String>] an array of keys
70
- #
71
- # @version SketchUp 6.0
72
- def self.keys
73
- end
74
-
75
- # Instance Methods
76
-
77
- # The [] method retrieves a value from the array of keys
78
- #
79
- # @example
80
- # value = shadowinfo["key"]
81
- #
82
- # @param [String] key
83
- # The key of the shadowinfo value to retrieve.
84
- #
85
- # @return [Object, nil] the value that is retrieved.
86
- #
87
- # @version SketchUp 6.0
88
- def [](key)
89
- end
90
-
91
- # The set value []= method is used to set the value in the array of shadow
92
- # info options.
93
- #
94
- # @example
95
- # model = Sketchup.active_model
96
- # shadowinfo = model.shadow_info
97
- # value = shadowinfo["City"]
98
- # UI.messagebox value
99
- # value = shadowinfo["City"]="Denver, CO"
100
- # UI.messagebox value
101
- #
102
- # @param [String] key
103
- # The key of the shadowinfo value to set.
104
- #
105
- # @param [Object] value
106
- # The value to be set.
107
- #
108
- # @return [Object] the value that was set if successful, or false
109
- # if unsuccessful.
110
- #
111
- # @version SketchUp 6.0
112
- def []=(key, value)
113
- end
114
-
115
- # The add_observer method is used to add an observer to the current object.
116
- #
117
- # @example
118
- # status = object.add_observer observer
119
- #
120
- # @param [Object] observer
121
- # An observer.
122
- #
123
- # @return [Boolean] true if successful, false if unsuccessful.
124
- #
125
- # @version SketchUp 6.0
126
- def add_observer(observer)
127
- end
128
-
129
- # The count method is inherited from the Enumerable mix-in module.
130
- #
131
- # @example
132
- # shadow_info = Sketchup.active_model.shadow_info
133
- # number = shadow_info.count
134
- #
135
- # @return [Integer]
136
- #
137
- # @version SketchUp 2014
138
- def count
139
- end
140
-
141
- # The {#each} method iterates through all of the shadow information key/value
142
- # pairs.
143
- #
144
- # @example
145
- # model = Sketchup.active_model
146
- # shadow_info = model.shadow_info
147
- # shadow_info.each { |key, value|
148
- # puts "#{key} : #{value}"
149
- # }
150
- #
151
- # @return [nil]
152
- #
153
- # @see #each_pair
154
- #
155
- # @version SketchUp 6.0
156
- #
157
- # @yield [key, value]
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
- # @yield [key] Variable to hold each key as they are found.
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
- # @yield [key, value]
194
- #
195
- # @yieldparam [String] key
196
- #
197
- # @yieldparam [Object] value
198
- def each_pair
199
- end
200
-
201
- # The keys method is a class method that returns an array with all of the
202
- # attribute keys
203
- #
204
- # @example
205
- # keys = Sketchup::ShadowInfo.keys
206
- #
207
- # @return [Array<String>] an array of keys
208
- #
209
- # @version SketchUp 6.0
210
- def keys
211
- end
212
-
213
- # The {#length} method returns the number of options in the shadow options
214
- # collection
215
- #
216
- # @example
217
- # shadow_info = Sketchup.active_model.shadow_info
218
- # number = shadow_info.length
219
- #
220
- # @return [Integer]
221
- #
222
- # @see #size
223
- #
224
- # @version SketchUp 2014
225
- def length
226
- end
227
-
228
- # The remove_observer method is used to remove an observer from the current
229
- # object.
230
- #
231
- # @example
232
- # status = object.remove_observer observer
233
- #
234
- # @param [Object] observer
235
- # An observer.
236
- #
237
- # @return [Boolean] true if successful, false if unsuccessful.
238
- #
239
- # @version SketchUp 6.0
240
- def remove_observer(observer)
241
- end
242
-
243
- # The {#size} method is an alias for {#length}.
244
- #
245
- # @example
246
- # shadow_info = Sketchup.active_model.shadow_info
247
- # number = shadow_info.size
248
- #
249
- # @return [Integer]
250
- #
251
- # @see #length
252
- #
253
- # @version SketchUp 2014
254
- def size
255
- end
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 2021 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
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