sketchup-api-stubs 0.6.1 → 0.7.4

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 (149) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +2 -0
  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 -401
  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 -523
  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 -569
  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 -455
  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 -359
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +349 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -123
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -86
  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 -563
  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 -547
  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 -554
  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 -1097
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +125 -125
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +544 -537
  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 -262
  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 -1483
  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 -282
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +770 -650
  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 -356
  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 -995
  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 -303
  140. data/lib/sketchup-api-stubs/stubs/array.rb +741 -741
  141. data/lib/sketchup-api-stubs/stubs/geom.rb +348 -233
  142. data/lib/sketchup-api-stubs/stubs/languagehandler.rb +92 -92
  143. data/lib/sketchup-api-stubs/stubs/length.rb +278 -262
  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 -660
  149. metadata +2 -16
@@ -1,416 +1,416 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The Material class represents a texture or color that can be applied to
5
- # Drawingelements. It is most often applied to Faces.
6
- #
7
- # You can pass any object that can be used as a material to a method that
8
- # requires a material. Objects include actual materials, color, and classes
9
- # that can be converted to a color.
10
- #
11
- # The following are valid (assuming the existence of a Material mat1.)
12
- #
13
- # @example
14
- # face.material = mat1
15
- # face.material = "red"
16
- # face.material = 0xff0000
17
- #
18
- # @version SketchUp 6.0
19
- class Sketchup::Material < Sketchup::Entity
20
-
21
- # Includes
22
-
23
- include Comparable
24
-
25
- # Constants
26
-
27
- COLORIZE_SHIFT = nil # Stub value.
28
- COLORIZE_TINT = nil # Stub value.
29
-
30
- MATERIAL_COLORIZED_TEXTURED = nil # Stub value.
31
- MATERIAL_SOLID = nil # Stub value.
32
- MATERIAL_TEXTURED = nil # Stub value.
33
-
34
- OWNER_IMAGE = nil # Stub value.
35
- OWNER_LAYER = nil # Stub value.
36
- OWNER_MANAGER = nil # Stub value.
37
-
38
- # Instance Methods
39
-
40
- # The <=> method is used to compare two materials based on name. The number
41
- # returned relates to the "string distance" between the names.
42
- #
43
- # @example
44
- # model = Sketchup.active_model
45
- # materials = model.materials
46
- # m1 = materials.add('Joe')
47
- # m2 = materials.add('Fred')
48
- # p m1 <=> m2
49
- #
50
- # @param [Sketchup::Material] material2
51
- # A Material object.
52
- #
53
- # @return [Integer] 0 if they are equal, positive number if
54
- # material1 > material2, negative if material1 < material2
55
- #
56
- # @version SketchUp 6.0
57
- def <=>(material2)
58
- end
59
-
60
- # The == method is used to test if two materials are the same.
61
- #
62
- # @example
63
- # model = Sketchup.active_model
64
- # materials = model.materials
65
- # m1 = materials.add('Joe')
66
- # m2 = materials.add('Fred')
67
- # if (m1 == m2)
68
- # UI.messagebox('The Materials are equal.')
69
- # else
70
- # UI.messagebox('The Materials are not equal.')
71
- # end
72
- #
73
- # @param [Sketchup::Material] material2
74
- # A Material object.
75
- #
76
- # @return [Boolean] true if the materials are the same, false if
77
- # they are different
78
- #
79
- # @version SketchUp 6.0
80
- def ==(material2)
81
- end
82
-
83
- # The alpha method is used to get the opacity of the material.
84
- #
85
- # The value will be between 0.0 and 1.0. A value of 0.0 means that the material is
86
- # completely transparent. A value of 1.0 means that the Material is completely
87
- # opaque.
88
- #
89
- # @example
90
- # alpha_value = Sketchup.active_model.materials[0].alpha
91
- #
92
- # @return [Float] a number between 0 and 1
93
- #
94
- # @version SketchUp 6.0
95
- def alpha
96
- end
97
-
98
- # The alpha= method is used to set the opacity of the material.
99
- #
100
- # The value must be between 0.0 and 1.0. A value of 0.0 means that the material is
101
- # completely transparent. A value of 1.0 means that the Material is completely
102
- # opaque.
103
- #
104
- # @example
105
- # model = Sketchup.active_model
106
- # materials = model.materials
107
- # material = materials.add('Joe')
108
- # material.alpha = 0.5
109
- #
110
- # @param [Float] alpha
111
- # An opacity value.
112
- #
113
- # @return [Float] the newly set opacity value
114
- #
115
- # @version SketchUp 6.0
116
- def alpha=(alpha)
117
- end
118
-
119
- # The color method is used to retrieve the color of the material.
120
- #
121
- # If it uses a Texture, this will return the average color.
122
- #
123
- # @example
124
- # model = Sketchup.active_model
125
- # materials = model.materials
126
- # material = materials.add('Joe')
127
- # material.color = 'red'
128
- # color = material.color
129
- #
130
- # @return [Sketchup::Color] a Color object
131
- #
132
- # @version SketchUp 6.0
133
- def color
134
- end
135
-
136
- # The color= method is used to set the color of the material.
137
- #
138
- # If the Material has a texture, then this turns it into a colorized
139
- # texture.
140
- #
141
- # To reset the color of a Material with a texture, set the color
142
- # to nil.
143
- #
144
- # @example
145
- # model = Sketchup.active_model
146
- # materials = model.materials
147
- # material = materials.add('Joe')
148
- # material.color = 'red'
149
- #
150
- # @param [Sketchup::Color, String, nil] color
151
- # A Color object.
152
- #
153
- # @return [Sketchup::Color, String, nil] the newly set Color object
154
- #
155
- # @version SketchUp 6.0
156
- def color=(color)
157
- end
158
-
159
- # The colorize_deltas method retrieves the HLS delta for colorized materials.
160
- #
161
- # @example
162
- # material = Sketchup.active_model.materials[0]
163
- # h, l, s = material.colorize_deltas
164
- #
165
- # @return [Array(Float, Float, Float)] An array of floats representing the HLS delta.
166
- #
167
- # @version SketchUp 2015
168
- def colorize_deltas
169
- end
170
-
171
- # The colorize_type method retrieves the type of colorization of the material.
172
- # This value is only relevant when the materialType is set to 2
173
- # (colorized textured).
174
- # Types include:
175
- #
176
- # - 0 = shift (Sketchup::Material::COLORIZE_SHIFT),
177
- # - 1 = tint (Sketchup::Material::COLORIZE_TINT),
178
- #
179
- # @example
180
- # material = Sketchup.active_model.materials[0]
181
- # type = material.colorize_type
182
- #
183
- # @return [Integer] the colorize type for the Material object.
184
- #
185
- # @version SketchUp 2015
186
- def colorize_type
187
- end
188
-
189
- # The colorize_type method set the type of colorization of the material.
190
- # This value is only relevant when the materialType is set to 2
191
- # (colorized textured).
192
- # Types include:
193
- #
194
- # - 0 = shift (Sketchup::Material::COLORIZE_SHIFT),
195
- # - 1 = tint (Sketchup::Material::COLORIZE_TINT),
196
- #
197
- # @example
198
- # material = Sketchup.active_model.materials[0]
199
- # material.colorize_type = Sketchup::Material::COLORIZE_TINT
200
- #
201
- # @param [Integer] type
202
- # the new colorize type for the Material object.
203
- #
204
- # @return [Integer] the colorize type for the Material object.
205
- #
206
- # @version SketchUp 2015
207
- def colorize_type=(type)
208
- end
209
-
210
- # The display_name method retrieves the name that is displayed within SketchUp
211
- # for the material.
212
- #
213
- # This should be used when presenting the name in the UI, but the returned name
214
- # cannot be used as a key in model.materials.
215
- #
216
- # @example
217
- # model = Sketchup.active_model
218
- # materials = model.materials
219
- # material = materials.add('[Joe]')
220
- # # Use .name for the internal name of a material
221
- # puts material.name # Outputs "[Joe]"
222
- # # Use .display_name for presenting the material name
223
- # # to the UI like SketchUp does.
224
- # puts material.display_name # Outputs "Joe"
225
- #
226
- # @return [String] the display name for the material
227
- #
228
- # @version SketchUp 6.0
229
- def display_name
230
- end
231
-
232
- # The materialType method retrieves the type of the material. Types include:
233
- #
234
- # - 0 = solid (Sketchup::Material::MATERIAL_SOLID),
235
- # - 1 = textured (Sketchup::Material::MATERIAL_TEXTURED),
236
- # - 2 = colorized textured (Sketchup::Material::MATERIAL_COLORIZED_TEXTURED).
237
- #
238
- # The constants where added in SketchUp 2015.
239
- #
240
- # @example
241
- # material = Sketchup.active_model.materials[0]
242
- # type = material.materialType
243
- #
244
- # @return [Integer] the material type for the Material object. See
245
- # summary for details.
246
- #
247
- # @version SketchUp 6.0
248
- def materialType
249
- end
250
-
251
- # The name method retrieves the name of the material. This is the
252
- # internal name of the object which should be used for retrieving
253
- # the material from the model's material list.
254
- #
255
- # Use .display_name to display the name in the UI.
256
- #
257
- # @example
258
- # model = Sketchup.active_model
259
- # materials = model.materials
260
- # material = materials.add('[Joe]')
261
- # # Use .name for the internal name of a material
262
- # puts material.name # Outputs "[Joe]"
263
- # # Use .display_name for presenting the material name
264
- # # to the UI like SketchUp does.
265
- # puts material.display_name # Outputs "Joe"
266
- #
267
- # @return [String] the name of the Material object
268
- #
269
- # @version SketchUp 6.0
270
- def name
271
- end
272
-
273
- # The {#name=} method sets the name of the material.
274
- #
275
- # @example Safely change name without raising errors
276
- # materials = Sketchup.active_model.materials
277
- # material = materials.add("Joe")
278
- # material.name = materials.unique_name('Jeff')
279
- #
280
- # @note Since SketchUp 2018 this method will raise an `ArgumentError` if the
281
- # name is not unique.
282
- #
283
- # @note SketchUp 2018 would raise an error if you named material the name it
284
- # already had.
285
- #
286
- # @param [String] str
287
- # the new material name
288
- #
289
- # @raise [ArgumentError] if the name is not unique to the model.
290
- # (Added in SU2018)
291
- #
292
- # @return [String] the newly set material name.
293
- #
294
- # @version SketchUp 8.0 M1
295
- def name=(str)
296
- end
297
-
298
- # The {#owner_type} method is used to determine if the material is owned
299
- # by a {Sketchup::Materials}.
300
- #
301
- # Returned value is one of:
302
- # * +Sketchup::Material::OWNER_MANAGER+
303
- # * +Sketchup::Material::OWNER_IMAGE+
304
- # * +Sketchup::Material::OWNER_LAYER+
305
- #
306
- # @return [Integer]
307
- #
308
- # @version SketchUp 2019.2
309
- def owner_type
310
- end
311
-
312
- # The {#save_as} method is used to write a material to a SKM file.
313
- #
314
- # You must remember to append ".skm" to the filename as this will not be done
315
- # automatically.
316
- #
317
- # @example
318
- # filename = File.join(ENV['HOME'], 'Desktop', 'su_test.skm')
319
- # materials = Sketchup.active_model.materials
320
- # material = materials.add("Hello World")
321
- # material.color = 'red'
322
- # material.save_as(filename)
323
- #
324
- # @param [String] filename
325
- # the path to the SKM file to load.
326
- #
327
- # @return [Boolean] `true` if successful
328
- #
329
- # @version SketchUp 2017
330
- def save_as(filename)
331
- end
332
-
333
- # The texture method retrieves the texture of the material.
334
- #
335
- # @example
336
- # model = Sketchup.active_model
337
- # materials = model.materials
338
- # material = materials.add('Joe')
339
- # material.texture = "C:/Materials/Carpet.jpg"
340
- # texture = material.texture
341
- #
342
- # @return [Sketchup::Texture, nil] the Texture object within the Material.
343
- # Returns nil if the Material does not have a texture.
344
- #
345
- # @version SketchUp 6.0
346
- def texture
347
- end
348
-
349
- # The texture= method sets the texture for the material.
350
- #
351
- # Setting the texture to +nil+ will turn it into a solid color
352
- #
353
- # @example
354
- # model = Sketchup.active_model
355
- # materials = model.materials
356
- # material = materials.add('Joe')
357
- # material.texture = "C:/Materials/Carpet.jpg"
358
- #
359
- # @overload texture=(filename)
360
- #
361
- # @param filename [String] The file path to the texture the material should use.
362
- # @return [String]
363
- #
364
- # @overload texture=(properties)
365
- #
366
- # @param properties [Array(String, Integer, Integer)] An array with the
367
- # texture filename and optionally the width and height in model units.
368
- # @return [Array(String, Integer, Integer)]
369
- #
370
- # @overload texture=(image_rep)
371
- #
372
- # @param [Sketchup::ImageRep] image_rep The pixel data representing the
373
- # texture. (Added in SketchUp 2018)
374
- # @return [Sketchup::ImageRep]
375
- #
376
- # @version SketchUp 6.0
377
- def texture=(arg)
378
- end
379
-
380
- # The use_alpha? method tells if the material uses transparency.
381
- #
382
- # Note that this is not affected by the alpha value of the color object. Only
383
- # the .alpha value and transparent texture will make this method return true.
384
- #
385
- # @example
386
- # material = Sketchup.active_model.materials[0]
387
- # is_alpha = material.use_alpha?
388
- #
389
- # @return [Boolean]
390
- #
391
- # @version SketchUp 6.0
392
- def use_alpha?
393
- end
394
-
395
- # The write_thumbnail method writes a bitmap thumbnail to the given file name.
396
- #
397
- # @example
398
- # model = Sketchup.active_model
399
- # model.materials.each { |material|
400
- # thumbnail_file = "C:/tmp/materials/#{material.display_name}.png"
401
- # material.write_thumbnail(thumbnail_file, 128)
402
- # }
403
- #
404
- # @param [String] filename
405
- # The file name for the thumbnail.
406
- #
407
- # @param [Integer] resolution
408
- # The resolution of the thumbnail.
409
- #
410
- # @return [Boolean] true if successful, false if unsuccessful.
411
- #
412
- # @version SketchUp 8.0 M1
413
- def write_thumbnail(filename, resolution)
414
- end
415
-
416
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The Material class represents a texture or color that can be applied to
5
+ # Drawingelements. It is most often applied to Faces.
6
+ #
7
+ # You can pass any object that can be used as a material to a method that
8
+ # requires a material. Objects include actual materials, color, and classes
9
+ # that can be converted to a color.
10
+ #
11
+ # The following are valid (assuming the existence of a Material mat1.)
12
+ #
13
+ # @example
14
+ # face.material = mat1
15
+ # face.material = "red"
16
+ # face.material = 0xff0000
17
+ #
18
+ # @version SketchUp 6.0
19
+ class Sketchup::Material < Sketchup::Entity
20
+
21
+ # Includes
22
+
23
+ include Comparable
24
+
25
+ # Constants
26
+
27
+ COLORIZE_SHIFT = nil # Stub value.
28
+ COLORIZE_TINT = nil # Stub value.
29
+
30
+ MATERIAL_COLORIZED_TEXTURED = nil # Stub value.
31
+ MATERIAL_SOLID = nil # Stub value.
32
+ MATERIAL_TEXTURED = nil # Stub value.
33
+
34
+ OWNER_IMAGE = nil # Stub value.
35
+ OWNER_LAYER = nil # Stub value.
36
+ OWNER_MANAGER = nil # Stub value.
37
+
38
+ # Instance Methods
39
+
40
+ # The <=> method is used to compare two materials based on name. The number
41
+ # returned relates to the "string distance" between the names.
42
+ #
43
+ # @example
44
+ # model = Sketchup.active_model
45
+ # materials = model.materials
46
+ # m1 = materials.add('Joe')
47
+ # m2 = materials.add('Fred')
48
+ # p m1 <=> m2
49
+ #
50
+ # @param [Sketchup::Material] material2
51
+ # A Material object.
52
+ #
53
+ # @return [Integer] 0 if they are equal, positive number if
54
+ # material1 > material2, negative if material1 < material2
55
+ #
56
+ # @version SketchUp 6.0
57
+ def <=>(material2)
58
+ end
59
+
60
+ # The == method is used to test if two materials are the same.
61
+ #
62
+ # @example
63
+ # model = Sketchup.active_model
64
+ # materials = model.materials
65
+ # m1 = materials.add('Joe')
66
+ # m2 = materials.add('Fred')
67
+ # if (m1 == m2)
68
+ # UI.messagebox('The Materials are equal.')
69
+ # else
70
+ # UI.messagebox('The Materials are not equal.')
71
+ # end
72
+ #
73
+ # @param [Sketchup::Material] material2
74
+ # A Material object.
75
+ #
76
+ # @return [Boolean] true if the materials are the same, false if
77
+ # they are different
78
+ #
79
+ # @version SketchUp 6.0
80
+ def ==(material2)
81
+ end
82
+
83
+ # The alpha method is used to get the opacity of the material.
84
+ #
85
+ # The value will be between 0.0 and 1.0. A value of 0.0 means that the material is
86
+ # completely transparent. A value of 1.0 means that the Material is completely
87
+ # opaque.
88
+ #
89
+ # @example
90
+ # alpha_value = Sketchup.active_model.materials[0].alpha
91
+ #
92
+ # @return [Float] a number between 0 and 1
93
+ #
94
+ # @version SketchUp 6.0
95
+ def alpha
96
+ end
97
+
98
+ # The alpha= method is used to set the opacity of the material.
99
+ #
100
+ # The value must be between 0.0 and 1.0. A value of 0.0 means that the material is
101
+ # completely transparent. A value of 1.0 means that the Material is completely
102
+ # opaque.
103
+ #
104
+ # @example
105
+ # model = Sketchup.active_model
106
+ # materials = model.materials
107
+ # material = materials.add('Joe')
108
+ # material.alpha = 0.5
109
+ #
110
+ # @param [Float] alpha
111
+ # An opacity value.
112
+ #
113
+ # @return [Float] the newly set opacity value
114
+ #
115
+ # @version SketchUp 6.0
116
+ def alpha=(alpha)
117
+ end
118
+
119
+ # The color method is used to retrieve the color of the material.
120
+ #
121
+ # If it uses a Texture, this will return the average color.
122
+ #
123
+ # @example
124
+ # model = Sketchup.active_model
125
+ # materials = model.materials
126
+ # material = materials.add('Joe')
127
+ # material.color = 'red'
128
+ # color = material.color
129
+ #
130
+ # @return [Sketchup::Color] a Color object
131
+ #
132
+ # @version SketchUp 6.0
133
+ def color
134
+ end
135
+
136
+ # The color= method is used to set the color of the material.
137
+ #
138
+ # If the Material has a texture, then this turns it into a colorized
139
+ # texture.
140
+ #
141
+ # To reset the color of a Material with a texture, set the color
142
+ # to nil.
143
+ #
144
+ # @example
145
+ # model = Sketchup.active_model
146
+ # materials = model.materials
147
+ # material = materials.add('Joe')
148
+ # material.color = 'red'
149
+ #
150
+ # @param [Sketchup::Color, String, nil] color
151
+ # A Color object.
152
+ #
153
+ # @return [Sketchup::Color, String, nil] the newly set Color object
154
+ #
155
+ # @version SketchUp 6.0
156
+ def color=(color)
157
+ end
158
+
159
+ # The colorize_deltas method retrieves the HLS delta for colorized materials.
160
+ #
161
+ # @example
162
+ # material = Sketchup.active_model.materials[0]
163
+ # h, l, s = material.colorize_deltas
164
+ #
165
+ # @return [Array(Float, Float, Float)] An array of floats representing the HLS delta.
166
+ #
167
+ # @version SketchUp 2015
168
+ def colorize_deltas
169
+ end
170
+
171
+ # The colorize_type method retrieves the type of colorization of the material.
172
+ # This value is only relevant when the materialType is set to 2
173
+ # (colorized textured).
174
+ # Types include:
175
+ #
176
+ # - 0 = shift (Sketchup::Material::COLORIZE_SHIFT),
177
+ # - 1 = tint (Sketchup::Material::COLORIZE_TINT),
178
+ #
179
+ # @example
180
+ # material = Sketchup.active_model.materials[0]
181
+ # type = material.colorize_type
182
+ #
183
+ # @return [Integer] the colorize type for the Material object.
184
+ #
185
+ # @version SketchUp 2015
186
+ def colorize_type
187
+ end
188
+
189
+ # The colorize_type method set the type of colorization of the material.
190
+ # This value is only relevant when the materialType is set to 2
191
+ # (colorized textured).
192
+ # Types include:
193
+ #
194
+ # - 0 = shift (Sketchup::Material::COLORIZE_SHIFT),
195
+ # - 1 = tint (Sketchup::Material::COLORIZE_TINT),
196
+ #
197
+ # @example
198
+ # material = Sketchup.active_model.materials[0]
199
+ # material.colorize_type = Sketchup::Material::COLORIZE_TINT
200
+ #
201
+ # @param [Integer] type
202
+ # the new colorize type for the Material object.
203
+ #
204
+ # @return [Integer] the colorize type for the Material object.
205
+ #
206
+ # @version SketchUp 2015
207
+ def colorize_type=(type)
208
+ end
209
+
210
+ # The display_name method retrieves the name that is displayed within SketchUp
211
+ # for the material.
212
+ #
213
+ # This should be used when presenting the name in the UI, but the returned name
214
+ # cannot be used as a key in model.materials.
215
+ #
216
+ # @example
217
+ # model = Sketchup.active_model
218
+ # materials = model.materials
219
+ # material = materials.add('[Joe]')
220
+ # # Use .name for the internal name of a material
221
+ # puts material.name # Outputs "[Joe]"
222
+ # # Use .display_name for presenting the material name
223
+ # # to the UI like SketchUp does.
224
+ # puts material.display_name # Outputs "Joe"
225
+ #
226
+ # @return [String] the display name for the material
227
+ #
228
+ # @version SketchUp 6.0
229
+ def display_name
230
+ end
231
+
232
+ # The materialType method retrieves the type of the material. Types include:
233
+ #
234
+ # - 0 = solid (Sketchup::Material::MATERIAL_SOLID),
235
+ # - 1 = textured (Sketchup::Material::MATERIAL_TEXTURED),
236
+ # - 2 = colorized textured (Sketchup::Material::MATERIAL_COLORIZED_TEXTURED).
237
+ #
238
+ # The constants where added in SketchUp 2015.
239
+ #
240
+ # @example
241
+ # material = Sketchup.active_model.materials[0]
242
+ # type = material.materialType
243
+ #
244
+ # @return [Integer] the material type for the Material object. See
245
+ # summary for details.
246
+ #
247
+ # @version SketchUp 6.0
248
+ def materialType
249
+ end
250
+
251
+ # The name method retrieves the name of the material. This is the
252
+ # internal name of the object which should be used for retrieving
253
+ # the material from the model's material list.
254
+ #
255
+ # Use .display_name to display the name in the UI.
256
+ #
257
+ # @example
258
+ # model = Sketchup.active_model
259
+ # materials = model.materials
260
+ # material = materials.add('[Joe]')
261
+ # # Use .name for the internal name of a material
262
+ # puts material.name # Outputs "[Joe]"
263
+ # # Use .display_name for presenting the material name
264
+ # # to the UI like SketchUp does.
265
+ # puts material.display_name # Outputs "Joe"
266
+ #
267
+ # @return [String] the name of the Material object
268
+ #
269
+ # @version SketchUp 6.0
270
+ def name
271
+ end
272
+
273
+ # The {#name=} method sets the name of the material.
274
+ #
275
+ # @example Safely change name without raising errors
276
+ # materials = Sketchup.active_model.materials
277
+ # material = materials.add("Joe")
278
+ # material.name = materials.unique_name('Jeff')
279
+ #
280
+ # @note Since SketchUp 2018 this method will raise an `ArgumentError` if the
281
+ # name is not unique.
282
+ #
283
+ # @note SketchUp 2018 would raise an error if you named material the name it
284
+ # already had.
285
+ #
286
+ # @param [String] str
287
+ # the new material name
288
+ #
289
+ # @raise [ArgumentError] if the name is not unique to the model.
290
+ # (Added in SU2018)
291
+ #
292
+ # @return [String] the newly set material name.
293
+ #
294
+ # @version SketchUp 8.0 M1
295
+ def name=(str)
296
+ end
297
+
298
+ # The {#owner_type} method is used to determine if the material is owned
299
+ # by a {Sketchup::Materials}.
300
+ #
301
+ # Returned value is one of:
302
+ # * +Sketchup::Material::OWNER_MANAGER+
303
+ # * +Sketchup::Material::OWNER_IMAGE+
304
+ # * +Sketchup::Material::OWNER_LAYER+
305
+ #
306
+ # @return [Integer]
307
+ #
308
+ # @version SketchUp 2019.2
309
+ def owner_type
310
+ end
311
+
312
+ # The {#save_as} method is used to write a material to a SKM file.
313
+ #
314
+ # You must remember to append ".skm" to the filename as this will not be done
315
+ # automatically.
316
+ #
317
+ # @example
318
+ # filename = File.join(ENV['HOME'], 'Desktop', 'su_test.skm')
319
+ # materials = Sketchup.active_model.materials
320
+ # material = materials.add("Hello World")
321
+ # material.color = 'red'
322
+ # material.save_as(filename)
323
+ #
324
+ # @param [String] filename
325
+ # the path to the SKM file to load.
326
+ #
327
+ # @return [Boolean] `true` if successful
328
+ #
329
+ # @version SketchUp 2017
330
+ def save_as(filename)
331
+ end
332
+
333
+ # The texture method retrieves the texture of the material.
334
+ #
335
+ # @example
336
+ # model = Sketchup.active_model
337
+ # materials = model.materials
338
+ # material = materials.add('Joe')
339
+ # material.texture = "C:/Materials/Carpet.jpg"
340
+ # texture = material.texture
341
+ #
342
+ # @return [Sketchup::Texture, nil] the Texture object within the Material.
343
+ # Returns nil if the Material does not have a texture.
344
+ #
345
+ # @version SketchUp 6.0
346
+ def texture
347
+ end
348
+
349
+ # The texture= method sets the texture for the material.
350
+ #
351
+ # Setting the texture to +nil+ will turn it into a solid color
352
+ #
353
+ # @example
354
+ # model = Sketchup.active_model
355
+ # materials = model.materials
356
+ # material = materials.add('Joe')
357
+ # material.texture = "C:/Materials/Carpet.jpg"
358
+ #
359
+ # @overload texture=(filename)
360
+ #
361
+ # @param filename [String] The file path to the texture the material should use.
362
+ # @return [String]
363
+ #
364
+ # @overload texture=(properties)
365
+ #
366
+ # @param properties [Array(String, Integer, Integer)] An array with the
367
+ # texture filename and optionally the width and height in model units.
368
+ # @return [Array(String, Integer, Integer)]
369
+ #
370
+ # @overload texture=(image_rep)
371
+ #
372
+ # @param [Sketchup::ImageRep] image_rep The pixel data representing the
373
+ # texture. (Added in SketchUp 2018)
374
+ # @return [Sketchup::ImageRep]
375
+ #
376
+ # @version SketchUp 6.0
377
+ def texture=(arg)
378
+ end
379
+
380
+ # The use_alpha? method tells if the material uses transparency.
381
+ #
382
+ # Note that this is not affected by the alpha value of the color object. Only
383
+ # the .alpha value and transparent texture will make this method return true.
384
+ #
385
+ # @example
386
+ # material = Sketchup.active_model.materials[0]
387
+ # is_alpha = material.use_alpha?
388
+ #
389
+ # @return [Boolean]
390
+ #
391
+ # @version SketchUp 6.0
392
+ def use_alpha?
393
+ end
394
+
395
+ # The write_thumbnail method writes a bitmap thumbnail to the given file name.
396
+ #
397
+ # @example
398
+ # model = Sketchup.active_model
399
+ # model.materials.each { |material|
400
+ # thumbnail_file = "C:/tmp/materials/#{material.display_name}.png"
401
+ # material.write_thumbnail(thumbnail_file, 128)
402
+ # }
403
+ #
404
+ # @param [String] filename
405
+ # The file name for the thumbnail.
406
+ #
407
+ # @param [Integer] resolution
408
+ # The resolution of the thumbnail.
409
+ #
410
+ # @return [Boolean] true if successful, false if unsuccessful.
411
+ #
412
+ # @version SketchUp 8.0 M1
413
+ def write_thumbnail(filename, resolution)
414
+ end
415
+
416
+ end