sketchup-api-stubs 0.7.4 → 0.7.8

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 (151) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +148 -145
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -318
  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 +523 -492
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +478 -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 -348
  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 +698 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -174
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +516 -514
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -143
  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 -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 +225 -220
  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 -204
  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 +692 -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/Layout.rb +25 -25
  49. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  50. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  51. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -140
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +152 -152
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +286 -281
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -328
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -577
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +122 -122
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -281
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +619 -562
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -593
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -194
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +426 -329
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -72
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -102
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -312
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -38
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +396 -390
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +502 -508
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1205 -1119
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +272 -0
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -125
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -544
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -59
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +126 -125
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -750
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +104 -104
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -697
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +292 -285
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -409
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -226
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -190
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +407 -393
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -82
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -303
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -285
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -0
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -244
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -136
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +112 -112
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -416
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +318 -311
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -141
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -95
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1651 -1638
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -356
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +131 -132
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +284 -284
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -770
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +363 -353
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -76
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +477 -456
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +364 -364
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -44
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +459 -454
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +260 -257
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -57
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -0
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -211
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -225
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +837 -829
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -154
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -61
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1317 -1301
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -43
  140. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1360 -1310
  141. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  142. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  143. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -310
  144. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +496 -356
  145. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -229
  146. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +240 -240
  147. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  148. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -667
  149. data/lib/sketchup-api-stubs/stubs/_top_level.rb +311 -311
  150. data/lib/sketchup-api-stubs.rb +1 -1
  151. metadata +15 -12
@@ -1,390 +1,396 @@
1
- # Copyright:: Copyright 2020 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # Drawingelement is a base class for an item in the model that can be
5
- # displayed. These items include edges, construction points, construction
6
- # lines, and images. Arc curves and arcs are not included because they are not
7
- # drawing elements by themselves, but are a composition of edges.
8
- #
9
- # @version SketchUp 6.0
10
- class Sketchup::Drawingelement < Sketchup::Entity
11
-
12
- # Instance Methods
13
-
14
- # The bounds method is used to retrieve the BoundingBox for an drawing
15
- # element.
16
- #
17
- # @example
18
- # depth = 100
19
- # width = 100
20
- # model = Sketchup.active_model
21
- # entities = model.active_entities
22
- # pts = []
23
- # pts[0] = [0, 0, 0]
24
- # pts[1] = [width, 0, 0]
25
- # pts[2] = [width, depth, 0]
26
- # pts[3] = [0, depth, 0]
27
- # # Add the face to the entities in the model
28
- # face = entities.add_face pts
29
- # # Remember, anything that can be displayed, such as a face, is also
30
- # # a Drawingelement. So I can call bounds on a face because Face
31
- # # is a sub-class of Drawingelement.
32
- # boundingbox = face.bounds
33
- #
34
- # @return [Geom::BoundingBox] A BoundingBox object if successful
35
- #
36
- # @version SketchUp 6.0
37
- def bounds
38
- end
39
-
40
- # The casts_shadows= method is used to set the Drawingelement to cast shadows.
41
- #
42
- # @example
43
- # depth = 100
44
- # width = 100
45
- # model = Sketchup.active_model
46
- # entities = model.active_entities
47
- # pts = []
48
- # pts[0] = [0, 0, 100]
49
- # pts[1] = [width, 0, 100]
50
- # pts[2] = [width, depth, 100]
51
- # pts[3] = [0, depth, 100]
52
- # # Add the face to the entities in the model.
53
- # face = entities.add_face pts
54
- #
55
- # # Make the face not cast shadows.
56
- # status = face.casts_shadows = false
57
- # UI.messagebox status.to_s
58
- #
59
- # @param [Boolean] casts
60
- # true if you want the Drawingelement object to cast
61
- # shadows, false if you do not want the Drawingelement
62
- # object to cast shadows.
63
- #
64
- # @return [Boolean] true if successful, false if unsuccessful.
65
- #
66
- # @version SketchUp 6.0
67
- def casts_shadows=(casts)
68
- end
69
-
70
- # The casts_shadows? method is used to determine if the Drawingelement is
71
- # casting shadows.
72
- #
73
- # @example
74
- # depth = 100
75
- # width = 100
76
- # model = Sketchup.active_model
77
- # entities = model.active_entities
78
- # pts = []
79
- # pts[0] = [0, 0, 0]
80
- # pts[1] = [width, 0, 0]
81
- # pts[2] = [width, depth, 0]
82
- # pts[3] = [0, depth, 0]
83
- # # Add the face to the entities in the model
84
- # face = entities.add_face pts
85
- # status = face.casts_shadows?
86
- # UI.messagebox status.to_s
87
- #
88
- # @return [Boolean]
89
- #
90
- # @version SketchUp 6.0
91
- def casts_shadows?
92
- end
93
-
94
- # The erase! method is used to erase an element from the model.
95
- #
96
- # Erasing an Edge also erases all of the Face objects that use the Edge.
97
- #
98
- # @example
99
- # depth = 100
100
- # width = 100
101
- # model = Sketchup.active_model
102
- # entities = model.active_entities
103
- # pts = []
104
- # pts[0] = [0, 0, 0]
105
- # pts[1] = [width, 0, 0]
106
- # pts[2] = [width, depth, 0]
107
- # pts[3] = [0, depth, 0]
108
- # # Add the face to the entities in the model
109
- # face = entities.add_face pts
110
- # status = face.erase!
111
- #
112
- # @return [Boolean] true if successful, false if unsuccessful
113
- #
114
- # @version SketchUp 6.0
115
- def erase!
116
- end
117
-
118
- # The hidden= method is used to set the hidden status for an element.
119
- #
120
- # @example
121
- # depth = 100
122
- # width = 100
123
- # model = Sketchup.active_model
124
- # entities = model.active_entities
125
- # pts = []
126
- # pts[0] = [0, 0, 0]
127
- # pts[1] = [width, 0, 0]
128
- # pts[2] = [width, depth, 0]
129
- # pts[3] = [0, depth, 0]
130
- # # Add the face to the entities in the model
131
- # face = entities.add_face pts
132
- # UI.messagebox "Click OK to Hide the Box"
133
- # status = face.hidden = true
134
- #
135
- # @param [Boolean] hidden
136
- # true if you want to hide the element, false if you do
137
- # not want to hide the element.
138
- #
139
- # @return [Boolean] true if the element has been hidden, false if
140
- # the element has not been hidden.
141
- #
142
- # @version SketchUp 6.0
143
- def hidden=(hidden)
144
- end
145
-
146
- # The hidden? method is used to determine if the element is hidden.
147
- #
148
- # Hidden elements are still in the model, but they are not displayed.
149
- #
150
- # @example
151
- # depth = 100
152
- # width = 100
153
- # model = Sketchup.active_model
154
- # entities = model.active_entities
155
- # pts = []
156
- # pts[0] = [0, 0, 0]
157
- # pts[1] = [width, 0, 0]
158
- # pts[2] = [width, depth, 0]
159
- # pts[3] = [0, depth, 0]
160
- # # Add the face to the entities in the model
161
- # face = entities.add_face pts
162
- # status = face.hidden?
163
- # UI.messagebox "hidden? " + status.to_s
164
- #
165
- # @return [Boolean]
166
- #
167
- # @version SketchUp 6.0
168
- def hidden?
169
- end
170
-
171
- # The layer method is used to retrieve the Layer object of the drawing
172
- # element.
173
- #
174
- # @example
175
- # depth = 100
176
- # width = 100
177
- # model = Sketchup.active_model
178
- # entities = model.active_entities
179
- # pts = []
180
- # pts[0] = [0, 0, 0]
181
- # pts[1] = [width, 0, 0]
182
- # pts[2] = [width, depth, 0]
183
- # pts[3] = [0, depth, 0]
184
- # # Add the face to the entities in the model
185
- # face = entities.add_face pts
186
- # layer = face.layer
187
- #
188
- # @return [Sketchup::Layer] a layer object if successful
189
- #
190
- # @version SketchUp 6.0
191
- def layer
192
- end
193
-
194
- # The layer= method is used to set the layer for the drawing element.
195
- #
196
- # An exception is raised if you give a string that doesn't match any layer
197
- # name.
198
- #
199
- # @example
200
- # depth = 100
201
- # width = 100
202
- # model = Sketchup.active_model
203
- # entities = model.active_entities
204
- # pts = []
205
- # pts[0] = [0, 0, 0]
206
- # pts[1] = [width, 0, 0]
207
- # pts[2] = [width, depth, 0]
208
- # pts[3] = [0, depth, 0]
209
- # # Add the face to the entities in the model
210
- # face = entities.add_face pts
211
- # # Add a layer
212
- # layer = Sketchup.active_model.layers.add "joe"
213
- # # Put the face on the joe layer (instead of layer 0)
214
- # newlayer = face.layer = layer
215
- #
216
- # @param [Sketchup::Layer, String] layer
217
- # A layer or layer name.
218
- #
219
- # @return [Sketchup::Layer, String] the new Layer object if successful
220
- #
221
- # @version SketchUp 6.0
222
- def layer=(layer)
223
- end
224
-
225
- # The material method is used to retrieve the material for the drawing
226
- # element.
227
- #
228
- # @example
229
- # depth = 100
230
- # width = 100
231
- # model = Sketchup.active_model
232
- # entities = model.active_entities
233
- # pts = []
234
- # pts[0] = [0, 0, 0]
235
- # pts[1] = [width, 0, 0]
236
- # pts[2] = [width, depth, 0]
237
- # pts[3] = [0, depth, 0]
238
- # # Add the face to the entities in the model
239
- # face = entities.add_face pts
240
- # material = face.material
241
- #
242
- # @return [Sketchup::Material] the Material object if successful
243
- #
244
- # @version SketchUp 6.0
245
- def material
246
- end
247
-
248
- # The material= method is used to set the material for the drawing
249
- # element.
250
- #
251
- # @example
252
- # depth = 100
253
- # width = 100
254
- # model = Sketchup.active_model
255
- # entities = model.active_entities
256
- # pts = []
257
- # pts[0] = [0, 0, 0]
258
- # pts[1] = [width, 0, 0]
259
- # pts[2] = [width, depth, 0]
260
- # pts[3] = [0, depth, 0]
261
- # # Add the face to the entities in the model
262
- # face = entities.add_face pts
263
- # m = model.materials.add "Joe"
264
- # begin
265
- # # Returns nil if not successful, path if successful.
266
- # # Should return a texture object.
267
- # m.texture = "c:\\My Textures\\Carpet.jpg"
268
- # rescue
269
- # UI.messagebox $!.message
270
- # end
271
- # # You will see the material applied when you reverse the box's faces
272
- # material = face.material = m
273
- #
274
- # @param [Sketchup::Material, String, Sketchup::Color] material
275
- # A Material, name of a material, Color, or name of a
276
- # color.
277
- #
278
- # @return [Sketchup::Material, String, Sketchup::Color] the new Material object if successful
279
- #
280
- # @version SketchUp 6.0
281
- def material=(material)
282
- end
283
-
284
- # The receive_shadows= method is used to set the Drawingelement to receive
285
- # shadows.
286
- #
287
- # @example
288
- # depth = 100
289
- # width = 100
290
- # model = Sketchup.active_model
291
- # entities = model.active_entities
292
- # pts = []
293
- # pts[0] = [0, 0, 100]
294
- # pts[1] = [width, 0, 100]
295
- # pts[2] = [width, depth, 100]
296
- # pts[3] = [0, depth, 100]
297
- # # Add the face to the entities in the model.
298
- # face = entities.add_face pts
299
- #
300
- # # Make the face not receive shadows.
301
- # status = face.receives_shadows = false
302
- # UI.messagebox status.to_s
303
- #
304
- # @param [Boolean] receive
305
- # true if you want the Drawingelement object to
306
- # receive shadows, false if not.
307
- #
308
- # @return [Boolean] true if successful, false if unsuccessful.
309
- #
310
- # @version SketchUp 6.0
311
- def receives_shadows=(receive)
312
- end
313
-
314
- # The receive_shadows? method is used to determine if the Drawingelement is
315
- # receiving shadows.
316
- #
317
- # @example
318
- # depth = 100
319
- # width = 100
320
- # model = Sketchup.active_model
321
- # entities = model.active_entities
322
- # pts = []
323
- # pts[0] = [0, 0, 0]
324
- # pts[1] = [width, 0, 0]
325
- # pts[2] = [width, depth, 0]
326
- # pts[3] = [0, depth, 0]
327
- # # Add the face to the entities in the model
328
- # face = entities.add_face pts
329
- # status = face.receives_shadows?
330
- # UI.messagebox status.to_s
331
- #
332
- # @return [Boolean]
333
- #
334
- # @version SketchUp 6.0
335
- def receives_shadows?
336
- end
337
-
338
- # The visible= method is used to set the visible status for an element. This
339
- # method performs an opposite function to the hidden= method.
340
- #
341
- # @example
342
- # depth = 100
343
- # width = 100
344
- # model = Sketchup.active_model
345
- # entities = model.active_entities
346
- # pts = []
347
- # pts[0] = [0, 0, 0]
348
- # pts[1] = [width, 0, 0]
349
- # pts[2] = [width, depth, 0]
350
- # pts[3] = [0, depth, 0]
351
- # # Add the face to the entities in the model
352
- # face = entities.add_face pts
353
- # UI.messagebox "Click OK to Hide the Box"
354
- # status = face.visible = false
355
- #
356
- # @param [Boolean] visibility
357
- # true if you want to hide the element, false if not
358
- #
359
- # @return [Boolean] true if the element has been hidden, false if
360
- # the element has not been hidden.
361
- #
362
- # @version SketchUp 6.0
363
- def visible=(visibility)
364
- end
365
-
366
- # The visible? method is used to get the visible status for an element.
367
- #
368
- # @example
369
- # depth = 100
370
- # width = 100
371
- # model = Sketchup.active_model
372
- # entities = model.active_entities
373
- # pts = []
374
- # pts[0] = [0, 0, 0]
375
- # pts[1] = [width, 0, 0]
376
- # pts[2] = [width, depth, 0]
377
- # pts[3] = [0, depth, 0]
378
- # # Add the face to the entities in the model
379
- # face = entities.add_face pts
380
- # UI.messagebox "Click OK to Hide the Box"
381
- # face.visible = false
382
- # UI.messagebox "Is the face visible? " + face.visible?.to_s
383
- #
384
- # @return [Boolean]
385
- #
386
- # @version SketchUp 6.0
387
- def visible?
388
- end
389
-
390
- end
1
+ # Copyright:: Copyright 2022 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # Drawingelement is a base class for an item in the model that can be
5
+ # displayed. These items include edges, construction points, construction
6
+ # lines, and images. Arc curves and arcs are not included because they are not
7
+ # drawing elements by themselves, but are a composition of edges.
8
+ #
9
+ # @version SketchUp 6.0
10
+ class Sketchup::Drawingelement < Sketchup::Entity
11
+
12
+ # Instance Methods
13
+
14
+ # The {#bounds} method is used to retrieve the {Geom::BoundingBox} bounding a
15
+ # {Sketchup::Drawingelement}.
16
+ #
17
+ # For a {Sketchup::Edge}, {Sketchup::ComponentInstance} and most other
18
+ # {Sketchup::Drawingelement}s, the boundingbox follows the coordinate system
19
+ # the drawing element is placed in.
20
+ # For {Sketchup::ComponentDefinition}, the box bounds the contents of the
21
+ # component and follows the component's own internal coordinate system.
22
+ #
23
+ # @example
24
+ # depth = 100
25
+ # width = 100
26
+ # model = Sketchup.active_model
27
+ # entities = model.active_entities
28
+ # pts = []
29
+ # pts[0] = [0, 0, 0]
30
+ # pts[1] = [width, 0, 0]
31
+ # pts[2] = [width, depth, 0]
32
+ # pts[3] = [0, depth, 0]
33
+ # # Add the face to the entities in the model
34
+ # face = entities.add_face pts
35
+ # # Remember, anything that can be displayed, such as a face, is also
36
+ # # a Drawingelement. So I can call bounds on a face because Face
37
+ # # is a sub-class of Drawingelement.
38
+ # boundingbox = face.bounds
39
+ #
40
+ # @return [Geom::BoundingBox]
41
+ #
42
+ # @version SketchUp 6.0
43
+ def bounds
44
+ end
45
+
46
+ # The casts_shadows= method is used to set the Drawingelement to cast shadows.
47
+ #
48
+ # @example
49
+ # depth = 100
50
+ # width = 100
51
+ # model = Sketchup.active_model
52
+ # entities = model.active_entities
53
+ # pts = []
54
+ # pts[0] = [0, 0, 100]
55
+ # pts[1] = [width, 0, 100]
56
+ # pts[2] = [width, depth, 100]
57
+ # pts[3] = [0, depth, 100]
58
+ # # Add the face to the entities in the model.
59
+ # face = entities.add_face pts
60
+ #
61
+ # # Make the face not cast shadows.
62
+ # status = face.casts_shadows = false
63
+ # UI.messagebox status.to_s
64
+ #
65
+ # @param [Boolean] casts
66
+ # true if you want the Drawingelement object to cast
67
+ # shadows, false if you do not want the Drawingelement
68
+ # object to cast shadows.
69
+ #
70
+ # @return [Boolean] true if successful, false if unsuccessful.
71
+ #
72
+ # @version SketchUp 6.0
73
+ def casts_shadows=(casts)
74
+ end
75
+
76
+ # The casts_shadows? method is used to determine if the Drawingelement is
77
+ # casting shadows.
78
+ #
79
+ # @example
80
+ # depth = 100
81
+ # width = 100
82
+ # model = Sketchup.active_model
83
+ # entities = model.active_entities
84
+ # pts = []
85
+ # pts[0] = [0, 0, 0]
86
+ # pts[1] = [width, 0, 0]
87
+ # pts[2] = [width, depth, 0]
88
+ # pts[3] = [0, depth, 0]
89
+ # # Add the face to the entities in the model
90
+ # face = entities.add_face pts
91
+ # status = face.casts_shadows?
92
+ # UI.messagebox status.to_s
93
+ #
94
+ # @return [Boolean]
95
+ #
96
+ # @version SketchUp 6.0
97
+ def casts_shadows?
98
+ end
99
+
100
+ # The erase! method is used to erase an element from the model.
101
+ #
102
+ # Erasing an Edge also erases all of the Face objects that use the Edge.
103
+ #
104
+ # @example
105
+ # depth = 100
106
+ # width = 100
107
+ # model = Sketchup.active_model
108
+ # entities = model.active_entities
109
+ # pts = []
110
+ # pts[0] = [0, 0, 0]
111
+ # pts[1] = [width, 0, 0]
112
+ # pts[2] = [width, depth, 0]
113
+ # pts[3] = [0, depth, 0]
114
+ # # Add the face to the entities in the model
115
+ # face = entities.add_face pts
116
+ # status = face.erase!
117
+ #
118
+ # @return [Boolean] true if successful, false if unsuccessful
119
+ #
120
+ # @version SketchUp 6.0
121
+ def erase!
122
+ end
123
+
124
+ # The hidden= method is used to set the hidden status for an element.
125
+ #
126
+ # @example
127
+ # depth = 100
128
+ # width = 100
129
+ # model = Sketchup.active_model
130
+ # entities = model.active_entities
131
+ # pts = []
132
+ # pts[0] = [0, 0, 0]
133
+ # pts[1] = [width, 0, 0]
134
+ # pts[2] = [width, depth, 0]
135
+ # pts[3] = [0, depth, 0]
136
+ # # Add the face to the entities in the model
137
+ # face = entities.add_face pts
138
+ # UI.messagebox "Click OK to Hide the Box"
139
+ # status = face.hidden = true
140
+ #
141
+ # @param [Boolean] hidden
142
+ # true if you want to hide the element, false if you do
143
+ # not want to hide the element.
144
+ #
145
+ # @return [Boolean] true if the element has been hidden, false if
146
+ # the element has not been hidden.
147
+ #
148
+ # @version SketchUp 6.0
149
+ def hidden=(hidden)
150
+ end
151
+
152
+ # The hidden? method is used to determine if the element is hidden.
153
+ #
154
+ # Hidden elements are still in the model, but they are not displayed.
155
+ #
156
+ # @example
157
+ # depth = 100
158
+ # width = 100
159
+ # model = Sketchup.active_model
160
+ # entities = model.active_entities
161
+ # pts = []
162
+ # pts[0] = [0, 0, 0]
163
+ # pts[1] = [width, 0, 0]
164
+ # pts[2] = [width, depth, 0]
165
+ # pts[3] = [0, depth, 0]
166
+ # # Add the face to the entities in the model
167
+ # face = entities.add_face pts
168
+ # status = face.hidden?
169
+ # UI.messagebox "hidden? " + status.to_s
170
+ #
171
+ # @return [Boolean]
172
+ #
173
+ # @version SketchUp 6.0
174
+ def hidden?
175
+ end
176
+
177
+ # The layer method is used to retrieve the Layer object of the drawing
178
+ # element.
179
+ #
180
+ # @example
181
+ # depth = 100
182
+ # width = 100
183
+ # model = Sketchup.active_model
184
+ # entities = model.active_entities
185
+ # pts = []
186
+ # pts[0] = [0, 0, 0]
187
+ # pts[1] = [width, 0, 0]
188
+ # pts[2] = [width, depth, 0]
189
+ # pts[3] = [0, depth, 0]
190
+ # # Add the face to the entities in the model
191
+ # face = entities.add_face pts
192
+ # layer = face.layer
193
+ #
194
+ # @return [Sketchup::Layer] a layer object if successful
195
+ #
196
+ # @version SketchUp 6.0
197
+ def layer
198
+ end
199
+
200
+ # The layer= method is used to set the layer for the drawing element.
201
+ #
202
+ # An exception is raised if you give a string that doesn't match any layer
203
+ # name.
204
+ #
205
+ # @example
206
+ # depth = 100
207
+ # width = 100
208
+ # model = Sketchup.active_model
209
+ # entities = model.active_entities
210
+ # pts = []
211
+ # pts[0] = [0, 0, 0]
212
+ # pts[1] = [width, 0, 0]
213
+ # pts[2] = [width, depth, 0]
214
+ # pts[3] = [0, depth, 0]
215
+ # # Add the face to the entities in the model
216
+ # face = entities.add_face pts
217
+ # # Add a layer
218
+ # layer = Sketchup.active_model.layers.add "joe"
219
+ # # Put the face on the joe layer (instead of layer 0)
220
+ # newlayer = face.layer = layer
221
+ #
222
+ # @param [Sketchup::Layer, String] layer
223
+ # A layer or layer name.
224
+ #
225
+ # @return [Sketchup::Layer, String] the new Layer object if successful
226
+ #
227
+ # @version SketchUp 6.0
228
+ def layer=(layer)
229
+ end
230
+
231
+ # The material method is used to retrieve the material for the drawing
232
+ # element.
233
+ #
234
+ # @example
235
+ # depth = 100
236
+ # width = 100
237
+ # model = Sketchup.active_model
238
+ # entities = model.active_entities
239
+ # pts = []
240
+ # pts[0] = [0, 0, 0]
241
+ # pts[1] = [width, 0, 0]
242
+ # pts[2] = [width, depth, 0]
243
+ # pts[3] = [0, depth, 0]
244
+ # # Add the face to the entities in the model
245
+ # face = entities.add_face pts
246
+ # material = face.material
247
+ #
248
+ # @return [Sketchup::Material] the Material object if successful
249
+ #
250
+ # @version SketchUp 6.0
251
+ def material
252
+ end
253
+
254
+ # The material= method is used to set the material for the drawing
255
+ # element.
256
+ #
257
+ # @example
258
+ # depth = 100
259
+ # width = 100
260
+ # model = Sketchup.active_model
261
+ # entities = model.active_entities
262
+ # pts = []
263
+ # pts[0] = [0, 0, 0]
264
+ # pts[1] = [width, 0, 0]
265
+ # pts[2] = [width, depth, 0]
266
+ # pts[3] = [0, depth, 0]
267
+ # # Add the face to the entities in the model
268
+ # face = entities.add_face pts
269
+ # m = model.materials.add "Joe"
270
+ # begin
271
+ # # Returns nil if not successful, path if successful.
272
+ # # Should return a texture object.
273
+ # m.texture = "c:\\My Textures\\Carpet.jpg"
274
+ # rescue
275
+ # UI.messagebox $!.message
276
+ # end
277
+ # # You will see the material applied when you reverse the box's faces
278
+ # material = face.material = m
279
+ #
280
+ # @param [Sketchup::Material, String, Sketchup::Color] material
281
+ # A Material, name of a material, Color, or name of a
282
+ # color.
283
+ #
284
+ # @return [Sketchup::Material, String, Sketchup::Color] the new Material object if successful
285
+ #
286
+ # @version SketchUp 6.0
287
+ def material=(material)
288
+ end
289
+
290
+ # The receive_shadows= method is used to set the Drawingelement to receive
291
+ # shadows.
292
+ #
293
+ # @example
294
+ # depth = 100
295
+ # width = 100
296
+ # model = Sketchup.active_model
297
+ # entities = model.active_entities
298
+ # pts = []
299
+ # pts[0] = [0, 0, 100]
300
+ # pts[1] = [width, 0, 100]
301
+ # pts[2] = [width, depth, 100]
302
+ # pts[3] = [0, depth, 100]
303
+ # # Add the face to the entities in the model.
304
+ # face = entities.add_face pts
305
+ #
306
+ # # Make the face not receive shadows.
307
+ # status = face.receives_shadows = false
308
+ # UI.messagebox status.to_s
309
+ #
310
+ # @param [Boolean] receive
311
+ # true if you want the Drawingelement object to
312
+ # receive shadows, false if not.
313
+ #
314
+ # @return [Boolean] true if successful, false if unsuccessful.
315
+ #
316
+ # @version SketchUp 6.0
317
+ def receives_shadows=(receive)
318
+ end
319
+
320
+ # The receive_shadows? method is used to determine if the Drawingelement is
321
+ # receiving shadows.
322
+ #
323
+ # @example
324
+ # depth = 100
325
+ # width = 100
326
+ # model = Sketchup.active_model
327
+ # entities = model.active_entities
328
+ # pts = []
329
+ # pts[0] = [0, 0, 0]
330
+ # pts[1] = [width, 0, 0]
331
+ # pts[2] = [width, depth, 0]
332
+ # pts[3] = [0, depth, 0]
333
+ # # Add the face to the entities in the model
334
+ # face = entities.add_face pts
335
+ # status = face.receives_shadows?
336
+ # UI.messagebox status.to_s
337
+ #
338
+ # @return [Boolean]
339
+ #
340
+ # @version SketchUp 6.0
341
+ def receives_shadows?
342
+ end
343
+
344
+ # The visible= method is used to set the visible status for an element. This
345
+ # method performs an opposite function to the hidden= method.
346
+ #
347
+ # @example
348
+ # depth = 100
349
+ # width = 100
350
+ # model = Sketchup.active_model
351
+ # entities = model.active_entities
352
+ # pts = []
353
+ # pts[0] = [0, 0, 0]
354
+ # pts[1] = [width, 0, 0]
355
+ # pts[2] = [width, depth, 0]
356
+ # pts[3] = [0, depth, 0]
357
+ # # Add the face to the entities in the model
358
+ # face = entities.add_face pts
359
+ # UI.messagebox "Click OK to Hide the Box"
360
+ # status = face.visible = false
361
+ #
362
+ # @param [Boolean] visibility
363
+ # true if you want to hide the element, false if not
364
+ #
365
+ # @return [Boolean] true if the element has been hidden, false if
366
+ # the element has not been hidden.
367
+ #
368
+ # @version SketchUp 6.0
369
+ def visible=(visibility)
370
+ end
371
+
372
+ # The visible? method is used to get the visible status for an element.
373
+ #
374
+ # @example
375
+ # depth = 100
376
+ # width = 100
377
+ # model = Sketchup.active_model
378
+ # entities = model.active_entities
379
+ # pts = []
380
+ # pts[0] = [0, 0, 0]
381
+ # pts[1] = [width, 0, 0]
382
+ # pts[2] = [width, depth, 0]
383
+ # pts[3] = [0, depth, 0]
384
+ # # Add the face to the entities in the model
385
+ # face = entities.add_face pts
386
+ # UI.messagebox "Click OK to Hide the Box"
387
+ # face.visible = false
388
+ # UI.messagebox "Is the face visible? " + face.visible?.to_s
389
+ #
390
+ # @return [Boolean]
391
+ #
392
+ # @version SketchUp 6.0
393
+ def visible?
394
+ end
395
+
396
+ end