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,226 +1,226 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # References an image representation object.
5
- #
6
- # @version SketchUp 2018
7
- class Sketchup::ImageRep
8
-
9
- # Instance Methods
10
-
11
- # The {#bits_per_pixel} method gets the number of bits per pixel in the
12
- # image.
13
- #
14
- # @example
15
- # image_rep = Sketchup::ImageRep.new
16
- # image_rep.load_file("/path/to/image.jpg")
17
- # bpp = image_rep.bits_per_pixel
18
- #
19
- # @return [Integer]
20
- #
21
- # @version SketchUp 2018
22
- def bits_per_pixel
23
- end
24
-
25
- # The {#color_at_uv} method returns a color corresponding to the UV texture
26
- # coordinates
27
- #
28
- # @example
29
- # image_rep = Sketchup::ImageRep.new
30
- # image_rep.load_file("/path/to/image.jpg")
31
- # color = image_rep.color_at_uv(0.7, 0.5, false)
32
- #
33
- # @param [Float] u
34
- # The U texture coordinate.
35
- #
36
- # @param [Float] v
37
- # The V texture coordinate.
38
- #
39
- # @param [Boolean] bilinear
40
- # Use bilinear texture filtering. This
41
- # interpolates the colors instead of picking
42
- # the nearest neighbor.
43
- #
44
- # @return [Sketchup::Color, nil]
45
- #
46
- # @version SketchUp 2018
47
- def color_at_uv(u, v, bilinear = false)
48
- end
49
-
50
- # The {#colors} method returns an array of {Sketchup::Color} for each pixel in
51
- # the image.
52
- #
53
- # @example
54
- # image_rep = Sketchup::ImageRep.new
55
- # image_rep.load_file("/path/to/image.jpg")
56
- # colors = image_rep.colors
57
- #
58
- # @return [Array<Sketchup::Color>, nil]
59
- #
60
- # @version SketchUp 2018
61
- def colors
62
- end
63
-
64
- # The {#data} method gets the pixel data for an image in a string of bytes.
65
- #
66
- # @example
67
- # image_rep = Sketchup::ImageRep.new
68
- # image_rep.load_file("/path/to/image.jpg")
69
- # byte_string = image_rep.data
70
- # byte_string.each_byte { |byte| puts byte, ' ' }
71
- #
72
- # @return [String, nil]
73
- #
74
- # @version SketchUp 2018
75
- def data
76
- end
77
-
78
- # The {#height} method returns the height of an image.
79
- #
80
- # @example
81
- # image_rep = Sketchup::ImageRep.new
82
- # image_rep.load_file("/path/to/image.jpg")
83
- # image_rep.height
84
- #
85
- # @return [Integer]
86
- #
87
- # @version SketchUp 2018
88
- def height
89
- end
90
-
91
- # The {#initialize} method creates a new image object. The image object will
92
- # have no data if a path to the image is not provided.
93
- #
94
- # @example Default constructor
95
- # image_rep = Sketchup::ImageRep.new
96
- #
97
- # @example Construct from file
98
- # image_rep = Sketchup::ImageRep.new("/path/to/image.jpg")
99
- #
100
- # @overload initialize
101
- #
102
- #
103
- # @overload initialize(filepath)
104
- #
105
- # @param [String] filepath
106
- #
107
- # @raise [ArgumentError] if the file path or image is invalid.
108
- #
109
- # @return [Sketchup::ImageRep]
110
- #
111
- # @version SketchUp 2018
112
- def initialize(*args)
113
- end
114
-
115
- # The {#load_file} method loads image data from the specified file.
116
- #
117
- # @example
118
- # image_rep = Sketchup::ImageRep.new
119
- # image_rep.load_file("/path/to/image.jpg")
120
- #
121
- # @param [String] filepath
122
- #
123
- # @raise [ArgumentError] if the filepath or image is invalid.
124
- #
125
- # @version SketchUp 2018
126
- def load_file(filepath)
127
- end
128
-
129
- # The {#row_padding} method returns the size of the row padding of an image
130
- # in bytes.
131
- #
132
- # @example
133
- # image_rep = Sketchup::ImageRep.new
134
- # image_rep.load_file("/path/to/image.jpg")
135
- # image_rep.row_padding
136
- #
137
- # @return [Integer]
138
- #
139
- # @version SketchUp 2018
140
- def row_padding
141
- end
142
-
143
- # The {#save_file} method saves an image data object to an image file
144
- # specified by a path.
145
- #
146
- # @example
147
- # image_rep = Sketchup::ImageRep.new
148
- # image_rep.load_file("/path/to/image1.jpg")
149
- # # do stuff with the image representation
150
- # image_rep.save_file("/path/to/save/image2.jpg")
151
- #
152
- # @param [String] filepath
153
- #
154
- # @version SketchUp 2018
155
- def save_file(filepath)
156
- end
157
-
158
- # The {#set_data} method sets the pixel data of the {Sketchup::ImageRep}.
159
- #
160
- # @example Setting new data
161
- # image_rep = Sketchup::ImageRep.new
162
- # image_rep.load_file("/path/to/image.jpg")
163
- # new_image_rep = image_rep.set_data(800, 600, 24, 0, pixel_data)
164
- #
165
- # @note The encoding of the pixel_data {String} parameter should be ASCII-8BIT.
166
- # Any other encoding could corrupt the binary data.
167
- #
168
- # @param [Integer] width
169
- # The width of the pixel data. Must be greater than 0.
170
- #
171
- # @param [Integer] height
172
- # The height of the pixel data.
173
- # Must be greater than 0.
174
- #
175
- # @param [Integer] bits_per_pixel
176
- # The bits per pixel for the pixel data.
177
- # Must be either 8/24/32.
178
- #
179
- # @param [Integer] row_padding
180
- # The row padding for the pixel data which is
181
- # sized in bytes. Row padding is used to pad each row with zeros so that each
182
- # scanline on the pixel data will end on the data-type boundry.
183
- #
184
- # @param [String] pixel_data
185
- # The binary string containing the pixel data
186
- # representing the new image.
187
- #
188
- # @raise [ArgumentError] If width, height, bits_per_pixel or pixel_data are
189
- # invalid.
190
- #
191
- # @raise [TypeError] If width, height, bits_per_pixel or pixel_data are wrong
192
- # data types.
193
- #
194
- # @return [Sketchup::ImageRep]
195
- #
196
- # @version SketchUp 2018
197
- def set_data(width, height, bits_per_pixel, row_padding, pixel_data)
198
- end
199
-
200
- # The {#size} method gets the total size of the image data in bytes.
201
- #
202
- # @example
203
- # image_rep = Sketchup::ImageRep.new
204
- # image_rep.load_file("/path/to/image.jpg")
205
- # data_size = image_rep.size
206
- #
207
- # @return [Integer]
208
- #
209
- # @version SketchUp 2018
210
- def size
211
- end
212
-
213
- # The {#width} method returns the width of an image.
214
- #
215
- # @example
216
- # image_rep = Sketchup::ImageRep.new
217
- # image_rep.load_file("/path/to/image.jpg")
218
- # image_rep.width
219
- #
220
- # @return [Integer]
221
- #
222
- # @version SketchUp 2018
223
- def width
224
- end
225
-
226
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # References an image representation object.
5
+ #
6
+ # @version SketchUp 2018
7
+ class Sketchup::ImageRep
8
+
9
+ # Instance Methods
10
+
11
+ # The {#bits_per_pixel} method gets the number of bits per pixel in the
12
+ # image.
13
+ #
14
+ # @example
15
+ # image_rep = Sketchup::ImageRep.new
16
+ # image_rep.load_file("/path/to/image.jpg")
17
+ # bpp = image_rep.bits_per_pixel
18
+ #
19
+ # @return [Integer]
20
+ #
21
+ # @version SketchUp 2018
22
+ def bits_per_pixel
23
+ end
24
+
25
+ # The {#color_at_uv} method returns a color corresponding to the UV texture
26
+ # coordinates
27
+ #
28
+ # @example
29
+ # image_rep = Sketchup::ImageRep.new
30
+ # image_rep.load_file("/path/to/image.jpg")
31
+ # color = image_rep.color_at_uv(0.7, 0.5, false)
32
+ #
33
+ # @param [Float] u
34
+ # The U texture coordinate.
35
+ #
36
+ # @param [Float] v
37
+ # The V texture coordinate.
38
+ #
39
+ # @param [Boolean] bilinear
40
+ # Use bilinear texture filtering. This
41
+ # interpolates the colors instead of picking
42
+ # the nearest neighbor.
43
+ #
44
+ # @return [Sketchup::Color, nil]
45
+ #
46
+ # @version SketchUp 2018
47
+ def color_at_uv(u, v, bilinear = false)
48
+ end
49
+
50
+ # The {#colors} method returns an array of {Sketchup::Color} for each pixel in
51
+ # the image.
52
+ #
53
+ # @example
54
+ # image_rep = Sketchup::ImageRep.new
55
+ # image_rep.load_file("/path/to/image.jpg")
56
+ # colors = image_rep.colors
57
+ #
58
+ # @return [Array<Sketchup::Color>, nil]
59
+ #
60
+ # @version SketchUp 2018
61
+ def colors
62
+ end
63
+
64
+ # The {#data} method gets the pixel data for an image in a string of bytes.
65
+ #
66
+ # @example
67
+ # image_rep = Sketchup::ImageRep.new
68
+ # image_rep.load_file("/path/to/image.jpg")
69
+ # byte_string = image_rep.data
70
+ # byte_string.each_byte { |byte| puts byte, ' ' }
71
+ #
72
+ # @return [String, nil]
73
+ #
74
+ # @version SketchUp 2018
75
+ def data
76
+ end
77
+
78
+ # The {#height} method returns the height of an image.
79
+ #
80
+ # @example
81
+ # image_rep = Sketchup::ImageRep.new
82
+ # image_rep.load_file("/path/to/image.jpg")
83
+ # image_rep.height
84
+ #
85
+ # @return [Integer]
86
+ #
87
+ # @version SketchUp 2018
88
+ def height
89
+ end
90
+
91
+ # The {#initialize} method creates a new image object. The image object will
92
+ # have no data if a path to the image is not provided.
93
+ #
94
+ # @example Default constructor
95
+ # image_rep = Sketchup::ImageRep.new
96
+ #
97
+ # @example Construct from file
98
+ # image_rep = Sketchup::ImageRep.new("/path/to/image.jpg")
99
+ #
100
+ # @overload initialize
101
+ #
102
+ #
103
+ # @overload initialize(filepath)
104
+ #
105
+ # @param [String] filepath
106
+ #
107
+ # @raise [ArgumentError] if the file path or image is invalid.
108
+ #
109
+ # @return [Sketchup::ImageRep]
110
+ #
111
+ # @version SketchUp 2018
112
+ def initialize(*args)
113
+ end
114
+
115
+ # The {#load_file} method loads image data from the specified file.
116
+ #
117
+ # @example
118
+ # image_rep = Sketchup::ImageRep.new
119
+ # image_rep.load_file("/path/to/image.jpg")
120
+ #
121
+ # @param [String] filepath
122
+ #
123
+ # @raise [ArgumentError] if the filepath or image is invalid.
124
+ #
125
+ # @version SketchUp 2018
126
+ def load_file(filepath)
127
+ end
128
+
129
+ # The {#row_padding} method returns the size of the row padding of an image
130
+ # in bytes.
131
+ #
132
+ # @example
133
+ # image_rep = Sketchup::ImageRep.new
134
+ # image_rep.load_file("/path/to/image.jpg")
135
+ # image_rep.row_padding
136
+ #
137
+ # @return [Integer]
138
+ #
139
+ # @version SketchUp 2018
140
+ def row_padding
141
+ end
142
+
143
+ # The {#save_file} method saves an image data object to an image file
144
+ # specified by a path.
145
+ #
146
+ # @example
147
+ # image_rep = Sketchup::ImageRep.new
148
+ # image_rep.load_file("/path/to/image1.jpg")
149
+ # # do stuff with the image representation
150
+ # image_rep.save_file("/path/to/save/image2.jpg")
151
+ #
152
+ # @param [String] filepath
153
+ #
154
+ # @version SketchUp 2018
155
+ def save_file(filepath)
156
+ end
157
+
158
+ # The {#set_data} method sets the pixel data of the {Sketchup::ImageRep}.
159
+ #
160
+ # @example Setting new data
161
+ # image_rep = Sketchup::ImageRep.new
162
+ # image_rep.load_file("/path/to/image.jpg")
163
+ # new_image_rep = image_rep.set_data(800, 600, 24, 0, pixel_data)
164
+ #
165
+ # @note The encoding of the pixel_data {String} parameter should be ASCII-8BIT.
166
+ # Any other encoding could corrupt the binary data.
167
+ #
168
+ # @param [Integer] width
169
+ # The width of the pixel data. Must be greater than 0.
170
+ #
171
+ # @param [Integer] height
172
+ # The height of the pixel data.
173
+ # Must be greater than 0.
174
+ #
175
+ # @param [Integer] bits_per_pixel
176
+ # The bits per pixel for the pixel data.
177
+ # Must be either 8/24/32.
178
+ #
179
+ # @param [Integer] row_padding
180
+ # The row padding for the pixel data which is
181
+ # sized in bytes. Row padding is used to pad each row with zeros so that each
182
+ # scanline on the pixel data will end on the data-type boundry.
183
+ #
184
+ # @param [String] pixel_data
185
+ # The binary string containing the pixel data
186
+ # representing the new image.
187
+ #
188
+ # @raise [ArgumentError] If width, height, bits_per_pixel or pixel_data are
189
+ # invalid.
190
+ #
191
+ # @raise [TypeError] If width, height, bits_per_pixel or pixel_data are wrong
192
+ # data types.
193
+ #
194
+ # @return [Sketchup::ImageRep]
195
+ #
196
+ # @version SketchUp 2018
197
+ def set_data(width, height, bits_per_pixel, row_padding, pixel_data)
198
+ end
199
+
200
+ # The {#size} method gets the total size of the image data in bytes.
201
+ #
202
+ # @example
203
+ # image_rep = Sketchup::ImageRep.new
204
+ # image_rep.load_file("/path/to/image.jpg")
205
+ # data_size = image_rep.size
206
+ #
207
+ # @return [Integer]
208
+ #
209
+ # @version SketchUp 2018
210
+ def size
211
+ end
212
+
213
+ # The {#width} method returns the width of an image.
214
+ #
215
+ # @example
216
+ # image_rep = Sketchup::ImageRep.new
217
+ # image_rep.load_file("/path/to/image.jpg")
218
+ # image_rep.width
219
+ #
220
+ # @return [Integer]
221
+ #
222
+ # @version SketchUp 2018
223
+ def width
224
+ end
225
+
226
+ end
@@ -1,190 +1,190 @@
1
- # Copyright:: Copyright 2019 Trimble Inc.
2
- # License:: The MIT License (MIT)
3
-
4
- # The Importer interface lets you build your own importers for SketchUp. To
5
- # use this, you create a subclass of Importer and implement all of the
6
- # methods described below. This will make your importer appear in the list
7
- # that users see under File > Import, and you can use Ruby to do all of the
8
- # work of opening the file and creating whatever you need inside SketchUp.
9
- #
10
- # Here is an example of a complete script that imports a .txt file and
11
- # displays its contents in a messagebox.
12
- #
13
- # @example
14
- # class TextImporter < Sketchup::Importer
15
- #
16
- # # This method is called by SketchUp to determine the description that
17
- # # appears in the File > Import dialog's pulldown list of valid
18
- # # importers.
19
- # def description
20
- # return "Custom Text Importer (*.txt)"
21
- # end
22
- #
23
- # # This method is called by SketchUp to determine what file extension
24
- # # is associated with your importer.
25
- # def file_extension
26
- # return "txt"
27
- # end
28
- #
29
- # # This method is called by SketchUp to get a unique importer id.
30
- # def id
31
- # return "com.sketchup.importers.custom_txt"
32
- # end
33
- #
34
- # # This method is called by SketchUp to determine if the "Options"
35
- # # button inside the File > Import dialog should be enabled while your
36
- # # importer is selected.
37
- # def supports_options?
38
- # return true
39
- # end
40
- #
41
- # # This method is called by SketchUp when the user clicks on the
42
- # # "Options" button inside the File > Import dialog. You can use it to
43
- # # gather and store settings for your importer.
44
- # def do_options
45
- # # In a real use you would probably store this information in an
46
- # # instance variable.
47
- # my_settings = UI.inputbox(['My Import Option:'], ['1'],
48
- # "Import Options")
49
- # end
50
- #
51
- # # This method is called by SketchUp after the user has selected a file
52
- # # to import. This is where you do the real work of opening and
53
- # # processing the file.
54
- # def load_file(file_path, status)
55
- # UI.messagebox(file_path)
56
- # return 0 # 0 is the code for a successful import
57
- # end
58
- # end
59
- #
60
- # Sketchup.register_importer(TextImporter.new)
61
- #
62
- # @version SketchUp 6.0
63
- class Sketchup::Importer
64
-
65
- # Constants
66
-
67
- ImportCanceled = nil # Stub value.
68
- ImportFail = nil # Stub value.
69
- ImportFileNotFound = nil # Stub value.
70
- ImportSuccess = nil # Stub value.
71
- ImporterNotFound = nil # Stub value.
72
-
73
- # Instance Methods
74
-
75
- # This method is called by SketchUp to determine the description that appears
76
- # in the File > Import dialog's pulldown list of valid importers.
77
- #
78
- # Though it is common for the description to include the file extension
79
- # supported by the importer (such as "Text Importer (.txt)"), the actual
80
- # extension is defined in the file_extension method.
81
- #
82
- # @example
83
- # def description
84
- # return "Custom Text Importer (*.txt)"
85
- # end
86
- #
87
- # @return description - a brief string description
88
- #
89
- # @version SketchUp 6.0
90
- def description
91
- end
92
-
93
- # This method is called by SketchUp when the user clicks on the "Options"
94
- # button inside the File > Import dialog. You can use it to gather and store
95
- # settings for your importer.
96
- #
97
- # Only applicable if the importer supports options, meaning its
98
- # supports_options method returns true.
99
- #
100
- # @example
101
- # def id
102
- # return "com.sketchup.importers.custom_txt"
103
- # end
104
- #
105
- # @return id - an id string
106
- #
107
- # @version SketchUp 6.0
108
- def do_options
109
- end
110
-
111
- # This method is called by SketchUp to determine a single file extension is
112
- # associated with your importer. Only files that match this extension will be
113
- # shown to the user as they browse their harddrive for things to import.
114
- #
115
- # Ruby importers are only allowed to support a single extension.
116
- #
117
- # @example
118
- # def file_extension
119
- # return "txt"
120
- # end
121
- #
122
- # @return extension - typically a 3-letter string
123
- #
124
- # @version SketchUp 6.0
125
- def file_extension
126
- end
127
-
128
- # This method is called by SketchUp to determine a unique identifier for
129
- # your importer, typically something like "com.sketchup.importers.dxf".
130
- #
131
- # @example
132
- # def id
133
- # return "com.sketchup.importers.custom_txt"
134
- # end
135
- #
136
- # @return id - an id string
137
- #
138
- # @version SketchUp 6.0
139
- def id
140
- end
141
-
142
- # This method is called by SketchUp after the user has selected a file to
143
- # import. This is where you do the real work by opening the file via Ruby's
144
- # File object and processing it in whatever way you need.
145
- #
146
- # You must return an integer success code to SketchUp when you are done.
147
- # These are the codes that SketchUp understands and what will happen when
148
- # SketchUp receives each key.
149
- #
150
- # - 0 = Import Success (no additional dialog shown)
151
- # - 1 = Import Failed (no additional dialog shown)
152
- # - 2 = Import Cancelled by User (SketchUp will show a "cancelled" dialog)
153
- # - 4 = Import File not Found (SketchUp will show a "not found" dialog)
154
- # - 5 = SketchUp version not supported (no additional dialog shown)
155
- #
156
- # @example
157
- # def load_file(file_path, status)
158
- # # Here is where you would open the file and process it.
159
- # UI.messagebox(file_path)
160
- # return 0 # Success
161
- # end
162
- #
163
- # @param file_path
164
- # Absolute path to the file the user selected
165
- #
166
- # @param status
167
- # The status of the import so far. Contains true.
168
- #
169
- # @return success - an integer status code. See above.
170
- #
171
- # @version SketchUp 6.0
172
- def load_file(file_path, status)
173
- end
174
-
175
- # This method is called by SketchUp to determine if the "Options"
176
- # button inside the File > Import dialog should be enabled while your
177
- # importer is selected.
178
- #
179
- # @example
180
- # def supports_options?
181
- # return true
182
- # end
183
- #
184
- # @return [Boolean] supports_options - a boolean
185
- #
186
- # @version SketchUp 6.0
187
- def supports_options?
188
- end
189
-
190
- end
1
+ # Copyright:: Copyright 2020 Trimble Inc.
2
+ # License:: The MIT License (MIT)
3
+
4
+ # The Importer interface lets you build your own importers for SketchUp. To
5
+ # use this, you create a subclass of Importer and implement all of the
6
+ # methods described below. This will make your importer appear in the list
7
+ # that users see under File > Import, and you can use Ruby to do all of the
8
+ # work of opening the file and creating whatever you need inside SketchUp.
9
+ #
10
+ # Here is an example of a complete script that imports a .txt file and
11
+ # displays its contents in a messagebox.
12
+ #
13
+ # @example
14
+ # class TextImporter < Sketchup::Importer
15
+ #
16
+ # # This method is called by SketchUp to determine the description that
17
+ # # appears in the File > Import dialog's pulldown list of valid
18
+ # # importers.
19
+ # def description
20
+ # return "Custom Text Importer (*.txt)"
21
+ # end
22
+ #
23
+ # # This method is called by SketchUp to determine what file extension
24
+ # # is associated with your importer.
25
+ # def file_extension
26
+ # return "txt"
27
+ # end
28
+ #
29
+ # # This method is called by SketchUp to get a unique importer id.
30
+ # def id
31
+ # return "com.sketchup.importers.custom_txt"
32
+ # end
33
+ #
34
+ # # This method is called by SketchUp to determine if the "Options"
35
+ # # button inside the File > Import dialog should be enabled while your
36
+ # # importer is selected.
37
+ # def supports_options?
38
+ # return true
39
+ # end
40
+ #
41
+ # # This method is called by SketchUp when the user clicks on the
42
+ # # "Options" button inside the File > Import dialog. You can use it to
43
+ # # gather and store settings for your importer.
44
+ # def do_options
45
+ # # In a real use you would probably store this information in an
46
+ # # instance variable.
47
+ # my_settings = UI.inputbox(['My Import Option:'], ['1'],
48
+ # "Import Options")
49
+ # end
50
+ #
51
+ # # This method is called by SketchUp after the user has selected a file
52
+ # # to import. This is where you do the real work of opening and
53
+ # # processing the file.
54
+ # def load_file(file_path, status)
55
+ # UI.messagebox(file_path)
56
+ # return 0 # 0 is the code for a successful import
57
+ # end
58
+ # end
59
+ #
60
+ # Sketchup.register_importer(TextImporter.new)
61
+ #
62
+ # @version SketchUp 6.0
63
+ class Sketchup::Importer
64
+
65
+ # Constants
66
+
67
+ ImportCanceled = nil # Stub value.
68
+ ImportFail = nil # Stub value.
69
+ ImportFileNotFound = nil # Stub value.
70
+ ImportSuccess = nil # Stub value.
71
+ ImporterNotFound = nil # Stub value.
72
+
73
+ # Instance Methods
74
+
75
+ # This method is called by SketchUp to determine the description that appears
76
+ # in the File > Import dialog's pulldown list of valid importers.
77
+ #
78
+ # Though it is common for the description to include the file extension
79
+ # supported by the importer (such as "Text Importer (.txt)"), the actual
80
+ # extension is defined in the file_extension method.
81
+ #
82
+ # @example
83
+ # def description
84
+ # return "Custom Text Importer (*.txt)"
85
+ # end
86
+ #
87
+ # @return description - a brief string description
88
+ #
89
+ # @version SketchUp 6.0
90
+ def description
91
+ end
92
+
93
+ # This method is called by SketchUp when the user clicks on the "Options"
94
+ # button inside the File > Import dialog. You can use it to gather and store
95
+ # settings for your importer.
96
+ #
97
+ # Only applicable if the importer supports options, meaning its
98
+ # supports_options method returns true.
99
+ #
100
+ # @example
101
+ # def id
102
+ # return "com.sketchup.importers.custom_txt"
103
+ # end
104
+ #
105
+ # @return id - an id string
106
+ #
107
+ # @version SketchUp 6.0
108
+ def do_options
109
+ end
110
+
111
+ # This method is called by SketchUp to determine a single file extension is
112
+ # associated with your importer. Only files that match this extension will be
113
+ # shown to the user as they browse their harddrive for things to import.
114
+ #
115
+ # Ruby importers are only allowed to support a single extension.
116
+ #
117
+ # @example
118
+ # def file_extension
119
+ # return "txt"
120
+ # end
121
+ #
122
+ # @return extension - typically a 3-letter string
123
+ #
124
+ # @version SketchUp 6.0
125
+ def file_extension
126
+ end
127
+
128
+ # This method is called by SketchUp to determine a unique identifier for
129
+ # your importer, typically something like "com.sketchup.importers.dxf".
130
+ #
131
+ # @example
132
+ # def id
133
+ # return "com.sketchup.importers.custom_txt"
134
+ # end
135
+ #
136
+ # @return id - an id string
137
+ #
138
+ # @version SketchUp 6.0
139
+ def id
140
+ end
141
+
142
+ # This method is called by SketchUp after the user has selected a file to
143
+ # import. This is where you do the real work by opening the file via Ruby's
144
+ # File object and processing it in whatever way you need.
145
+ #
146
+ # You must return an integer success code to SketchUp when you are done.
147
+ # These are the codes that SketchUp understands and what will happen when
148
+ # SketchUp receives each key.
149
+ #
150
+ # - 0 = Import Success (no additional dialog shown)
151
+ # - 1 = Import Failed (no additional dialog shown)
152
+ # - 2 = Import Cancelled by User (SketchUp will show a "cancelled" dialog)
153
+ # - 4 = Import File not Found (SketchUp will show a "not found" dialog)
154
+ # - 5 = SketchUp version not supported (no additional dialog shown)
155
+ #
156
+ # @example
157
+ # def load_file(file_path, status)
158
+ # # Here is where you would open the file and process it.
159
+ # UI.messagebox(file_path)
160
+ # return 0 # Success
161
+ # end
162
+ #
163
+ # @param file_path
164
+ # Absolute path to the file the user selected
165
+ #
166
+ # @param status
167
+ # The status of the import so far. Contains true.
168
+ #
169
+ # @return success - an integer status code. See above.
170
+ #
171
+ # @version SketchUp 6.0
172
+ def load_file(file_path, status)
173
+ end
174
+
175
+ # This method is called by SketchUp to determine if the "Options"
176
+ # button inside the File > Import dialog should be enabled while your
177
+ # importer is selected.
178
+ #
179
+ # @example
180
+ # def supports_options?
181
+ # return true
182
+ # end
183
+ #
184
+ # @return [Boolean] supports_options - a boolean
185
+ #
186
+ # @version SketchUp 6.0
187
+ def supports_options?
188
+ end
189
+
190
+ end