sketchup-api-stubs 0.7.7 → 0.7.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (154) hide show
  1. checksums.yaml +4 -4
  2. data/lib/sketchup-api-stubs/sketchup.rb +151 -147
  3. data/lib/sketchup-api-stubs/stubs/{array.rb → Array.rb} +741 -741
  4. data/lib/sketchup-api-stubs/stubs/Geom/BoundingBox.rb +322 -322
  5. data/lib/sketchup-api-stubs/stubs/Geom/Bounds2d.rb +172 -172
  6. data/lib/sketchup-api-stubs/stubs/Geom/LatLong.rb +126 -126
  7. data/lib/sketchup-api-stubs/stubs/Geom/OrientedBounds2d.rb +102 -102
  8. data/lib/sketchup-api-stubs/stubs/Geom/Point2d.rb +400 -400
  9. data/lib/sketchup-api-stubs/stubs/Geom/Point3d.rb +661 -661
  10. data/lib/sketchup-api-stubs/stubs/Geom/PolygonMesh.rb +509 -509
  11. data/lib/sketchup-api-stubs/stubs/Geom/Transformation.rb +476 -478
  12. data/lib/sketchup-api-stubs/stubs/Geom/Transformation2d.rb +263 -263
  13. data/lib/sketchup-api-stubs/stubs/Geom/UTM.rb +141 -141
  14. data/lib/sketchup-api-stubs/stubs/Geom/Vector2d.rb +522 -522
  15. data/lib/sketchup-api-stubs/stubs/Geom/Vector3d.rb +693 -691
  16. data/lib/sketchup-api-stubs/stubs/{geom.rb → Geom.rb} +351 -351
  17. data/lib/sketchup-api-stubs/stubs/{languagehandler.rb → LanguageHandler.rb} +93 -92
  18. data/lib/sketchup-api-stubs/stubs/Layout/AngularDimension.rb +595 -573
  19. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinition.rb +747 -411
  20. data/lib/sketchup-api-stubs/stubs/Layout/AutoTextDefinitions.rb +183 -179
  21. data/lib/sketchup-api-stubs/stubs/Layout/ConnectionPoint.rb +70 -70
  22. data/lib/sketchup-api-stubs/stubs/Layout/Document.rb +517 -515
  23. data/lib/sketchup-api-stubs/stubs/Layout/Ellipse.rb +29 -29
  24. data/lib/sketchup-api-stubs/stubs/Layout/Entities.rb +148 -148
  25. data/lib/sketchup-api-stubs/stubs/Layout/Entity.rb +353 -353
  26. data/lib/sketchup-api-stubs/stubs/Layout/FormattedText.rb +354 -349
  27. data/lib/sketchup-api-stubs/stubs/Layout/Grid.rb +311 -311
  28. data/lib/sketchup-api-stubs/stubs/Layout/Group.rb +261 -261
  29. data/lib/sketchup-api-stubs/stubs/Layout/Image.rb +91 -91
  30. data/lib/sketchup-api-stubs/stubs/Layout/Label.rb +370 -370
  31. data/lib/sketchup-api-stubs/stubs/Layout/Layer.rb +218 -218
  32. data/lib/sketchup-api-stubs/stubs/Layout/LayerInstance.rb +128 -128
  33. data/lib/sketchup-api-stubs/stubs/Layout/Layers.rb +225 -225
  34. data/lib/sketchup-api-stubs/stubs/Layout/LinearDimension.rb +567 -567
  35. data/lib/sketchup-api-stubs/stubs/Layout/LockedEntityError.rb +10 -10
  36. data/lib/sketchup-api-stubs/stubs/Layout/LockedLayerError.rb +11 -11
  37. data/lib/sketchup-api-stubs/stubs/Layout/Page.rb +183 -183
  38. data/lib/sketchup-api-stubs/stubs/Layout/PageInfo.rb +387 -387
  39. data/lib/sketchup-api-stubs/stubs/Layout/Pages.rb +209 -209
  40. data/lib/sketchup-api-stubs/stubs/Layout/Path.rb +344 -344
  41. data/lib/sketchup-api-stubs/stubs/Layout/Rectangle.rb +174 -174
  42. data/lib/sketchup-api-stubs/stubs/Layout/ReferenceEntity.rb +82 -0
  43. data/lib/sketchup-api-stubs/stubs/Layout/SketchUpModel.rb +692 -694
  44. data/lib/sketchup-api-stubs/stubs/Layout/Style.rb +1519 -1519
  45. data/lib/sketchup-api-stubs/stubs/Layout/Table.rb +290 -290
  46. data/lib/sketchup-api-stubs/stubs/Layout/TableCell.rb +149 -149
  47. data/lib/sketchup-api-stubs/stubs/Layout/TableColumn.rb +139 -139
  48. data/lib/sketchup-api-stubs/stubs/Layout/TableRow.rb +135 -135
  49. data/lib/sketchup-api-stubs/stubs/Layout.rb +25 -25
  50. data/lib/sketchup-api-stubs/stubs/{length.rb → Length.rb} +278 -278
  51. data/lib/sketchup-api-stubs/stubs/{numeric.rb → Numeric.rb} +249 -249
  52. data/lib/sketchup-api-stubs/stubs/Sketchup/Animation.rb +144 -144
  53. data/lib/sketchup-api-stubs/stubs/Sketchup/AppObserver.rb +169 -157
  54. data/lib/sketchup-api-stubs/stubs/Sketchup/ArcCurve.rb +209 -209
  55. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionaries.rb +150 -152
  56. data/lib/sketchup-api-stubs/stubs/Sketchup/AttributeDictionary.rb +281 -286
  57. data/lib/sketchup-api-stubs/stubs/Sketchup/Axes.rb +149 -149
  58. data/lib/sketchup-api-stubs/stubs/Sketchup/Behavior.rb +302 -302
  59. data/lib/sketchup-api-stubs/stubs/Sketchup/Camera.rb +478 -478
  60. data/lib/sketchup-api-stubs/stubs/Sketchup/ClassificationSchema.rb +63 -63
  61. data/lib/sketchup-api-stubs/stubs/Sketchup/Classifications.rb +121 -122
  62. data/lib/sketchup-api-stubs/stubs/Sketchup/Color.rb +294 -294
  63. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentDefinition.rb +659 -577
  64. data/lib/sketchup-api-stubs/stubs/Sketchup/ComponentInstance.rb +593 -594
  65. data/lib/sketchup-api-stubs/stubs/Sketchup/Console.rb +76 -76
  66. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionLine.rb +257 -257
  67. data/lib/sketchup-api-stubs/stubs/Sketchup/ConstructionPoint.rb +32 -32
  68. data/lib/sketchup-api-stubs/stubs/Sketchup/Curve.rb +201 -201
  69. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionList.rb +449 -425
  70. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionObserver.rb +74 -74
  71. data/lib/sketchup-api-stubs/stubs/Sketchup/DefinitionsObserver.rb +104 -104
  72. data/lib/sketchup-api-stubs/stubs/Sketchup/Dimension.rb +165 -165
  73. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionLinear.rb +306 -306
  74. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionObserver.rb +42 -42
  75. data/lib/sketchup-api-stubs/stubs/Sketchup/DimensionRadial.rb +87 -87
  76. data/lib/sketchup-api-stubs/stubs/Sketchup/Drawingelement.rb +406 -396
  77. data/lib/sketchup-api-stubs/stubs/Sketchup/Edge.rb +397 -502
  78. data/lib/sketchup-api-stubs/stubs/Sketchup/EdgeUse.rb +211 -211
  79. data/lib/sketchup-api-stubs/stubs/Sketchup/Entities.rb +1239 -1126
  80. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesBuilder.rb +261 -0
  81. data/lib/sketchup-api-stubs/stubs/Sketchup/EntitiesObserver.rb +127 -127
  82. data/lib/sketchup-api-stubs/stubs/Sketchup/Entity.rb +545 -545
  83. data/lib/sketchup-api-stubs/stubs/Sketchup/EntityObserver.rb +60 -60
  84. data/lib/sketchup-api-stubs/stubs/Sketchup/ExtensionsManager.rb +125 -126
  85. data/lib/sketchup-api-stubs/stubs/Sketchup/Face.rb +937 -917
  86. data/lib/sketchup-api-stubs/stubs/Sketchup/FrameChangeObserver.rb +102 -104
  87. data/lib/sketchup-api-stubs/stubs/Sketchup/Group.rb +750 -750
  88. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Request.rb +282 -292
  89. data/lib/sketchup-api-stubs/stubs/Sketchup/Http/Response.rb +62 -62
  90. data/lib/sketchup-api-stubs/stubs/Sketchup/Http.rb +27 -27
  91. data/lib/sketchup-api-stubs/stubs/Sketchup/Image.rb +468 -468
  92. data/lib/sketchup-api-stubs/stubs/Sketchup/ImageRep.rb +266 -266
  93. data/lib/sketchup-api-stubs/stubs/Sketchup/Importer.rb +189 -189
  94. data/lib/sketchup-api-stubs/stubs/Sketchup/InputPoint.rb +406 -405
  95. data/lib/sketchup-api-stubs/stubs/Sketchup/InstanceObserver.rb +84 -84
  96. data/lib/sketchup-api-stubs/stubs/Sketchup/InstancePath.rb +306 -306
  97. data/lib/sketchup-api-stubs/stubs/Sketchup/Layer.rb +326 -327
  98. data/lib/sketchup-api-stubs/stubs/Sketchup/LayerFolder.rb +422 -422
  99. data/lib/sketchup-api-stubs/stubs/Sketchup/Layers.rb +427 -427
  100. data/lib/sketchup-api-stubs/stubs/Sketchup/LayersObserver.rb +249 -249
  101. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing/ExtensionLicense.rb +86 -86
  102. data/lib/sketchup-api-stubs/stubs/Sketchup/Licensing.rb +48 -48
  103. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyle.rb +24 -24
  104. data/lib/sketchup-api-stubs/stubs/Sketchup/LineStyles.rb +114 -112
  105. data/lib/sketchup-api-stubs/stubs/Sketchup/Loop.rb +137 -137
  106. data/lib/sketchup-api-stubs/stubs/Sketchup/Material.rb +414 -414
  107. data/lib/sketchup-api-stubs/stubs/Sketchup/Materials.rb +317 -318
  108. data/lib/sketchup-api-stubs/stubs/Sketchup/MaterialsObserver.rb +142 -142
  109. data/lib/sketchup-api-stubs/stubs/Sketchup/Menu.rb +93 -93
  110. data/lib/sketchup-api-stubs/stubs/Sketchup/Model.rb +1652 -1654
  111. data/lib/sketchup-api-stubs/stubs/Sketchup/ModelObserver.rb +357 -357
  112. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsManager.rb +130 -131
  113. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProvider.rb +271 -284
  114. data/lib/sketchup-api-stubs/stubs/Sketchup/OptionsProviderObserver.rb +58 -58
  115. data/lib/sketchup-api-stubs/stubs/Sketchup/Overlay.rb +490 -0
  116. data/lib/sketchup-api-stubs/stubs/Sketchup/OverlaysManager.rb +116 -0
  117. data/lib/sketchup-api-stubs/stubs/Sketchup/Page.rb +797 -797
  118. data/lib/sketchup-api-stubs/stubs/Sketchup/Pages.rb +361 -363
  119. data/lib/sketchup-api-stubs/stubs/Sketchup/PagesObserver.rb +77 -77
  120. data/lib/sketchup-api-stubs/stubs/Sketchup/PickHelper.rb +478 -478
  121. data/lib/sketchup-api-stubs/stubs/Sketchup/RegionalSettings.rb +43 -43
  122. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptions.rb +361 -364
  123. data/lib/sketchup-api-stubs/stubs/Sketchup/RenderingOptionsObserver.rb +45 -45
  124. data/lib/sketchup-api-stubs/stubs/Sketchup/SectionPlane.rb +150 -150
  125. data/lib/sketchup-api-stubs/stubs/Sketchup/Selection.rb +458 -459
  126. data/lib/sketchup-api-stubs/stubs/Sketchup/SelectionObserver.rb +115 -115
  127. data/lib/sketchup-api-stubs/stubs/Sketchup/Set.rb +212 -212
  128. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfo.rb +255 -257
  129. data/lib/sketchup-api-stubs/stubs/Sketchup/ShadowInfoObserver.rb +59 -59
  130. data/lib/sketchup-api-stubs/stubs/Sketchup/Skp.rb +40 -40
  131. data/lib/sketchup-api-stubs/stubs/Sketchup/Style.rb +69 -69
  132. data/lib/sketchup-api-stubs/stubs/Sketchup/Styles.rb +217 -217
  133. data/lib/sketchup-api-stubs/stubs/Sketchup/Text.rb +262 -262
  134. data/lib/sketchup-api-stubs/stubs/Sketchup/Texture.rb +217 -217
  135. data/lib/sketchup-api-stubs/stubs/Sketchup/TextureWriter.rb +237 -237
  136. data/lib/sketchup-api-stubs/stubs/Sketchup/Tool.rb +834 -835
  137. data/lib/sketchup-api-stubs/stubs/Sketchup/Tools.rb +132 -132
  138. data/lib/sketchup-api-stubs/stubs/Sketchup/ToolsObserver.rb +156 -156
  139. data/lib/sketchup-api-stubs/stubs/Sketchup/UVHelper.rb +75 -71
  140. data/lib/sketchup-api-stubs/stubs/Sketchup/Vertex.rb +142 -142
  141. data/lib/sketchup-api-stubs/stubs/Sketchup/View.rb +1311 -1307
  142. data/lib/sketchup-api-stubs/stubs/Sketchup/ViewObserver.rb +45 -45
  143. data/lib/sketchup-api-stubs/stubs/{sketchup.rb → Sketchup.rb} +1377 -1353
  144. data/lib/sketchup-api-stubs/stubs/{sketchupextension.rb → SketchupExtension.rb} +353 -353
  145. data/lib/sketchup-api-stubs/stubs/{string.rb → String.rb} +24 -24
  146. data/lib/sketchup-api-stubs/stubs/UI/Command.rb +389 -317
  147. data/lib/sketchup-api-stubs/stubs/UI/HtmlDialog.rb +494 -478
  148. data/lib/sketchup-api-stubs/stubs/UI/Notification.rb +269 -269
  149. data/lib/sketchup-api-stubs/stubs/UI/Toolbar.rb +241 -240
  150. data/lib/sketchup-api-stubs/stubs/UI/WebDialog.rb +635 -633
  151. data/lib/sketchup-api-stubs/stubs/{ui.rb → UI.rb} +683 -672
  152. data/lib/sketchup-api-stubs/stubs/_top_level.rb +303 -311
  153. data/lib/sketchup-api-stubs.rb +1 -1
  154. metadata +20 -16
@@ -1,189 +1,189 @@
1
- # Copyright:: Copyright 2021 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
- #
57
- # return Sketchup::Importer::ImportSuccess
58
- # end
59
- # end
60
- #
61
- # Sketchup.register_importer(TextImporter.new)
62
- #
63
- # @version SketchUp 6.0
64
- class Sketchup::Importer
65
-
66
- # Constants
67
-
68
- ImportCanceled = nil # Stub value.
69
- ImportFail = nil # Stub value.
70
- ImportFileNotFound = nil # Stub value.
71
- ImportSuccess = 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:
148
- #
149
- # - Sketchup::Importer::ImportSuccess
150
- # - Sketchup::Importer::ImportFail
151
- # - Sketchup::Importer::ImportCanceled - SketchUp will show a "cancelled" dialog
152
- # - Sketchup::Importer::ImportFileNotFound - SketchUp will show a "not found" dialog
153
- #
154
- # @example
155
- # def load_file(file_path, status)
156
- # # Here is where you would open the file and process it.
157
- # puts file_path
158
- #
159
- # return Sketchup::Importer::ImportSuccess
160
- # end
161
- #
162
- # @param file_path
163
- # Absolute path to the file the user selected
164
- #
165
- # @param status
166
- # The status of the import so far. Contains true.
167
- #
168
- # @return success - an integer status code. See above.
169
- #
170
- # @version SketchUp 6.0
171
- def load_file(file_path, status)
172
- end
173
-
174
- # This method is called by SketchUp to determine if the "Options"
175
- # button inside the File > Import dialog should be enabled while your
176
- # importer is selected.
177
- #
178
- # @example
179
- # def supports_options?
180
- # return true
181
- # end
182
- #
183
- # @return [Boolean] supports_options - a boolean
184
- #
185
- # @version SketchUp 6.0
186
- def supports_options?
187
- end
188
-
189
- end
1
+ # Copyright:: Copyright 2023 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
+ #
57
+ # return Sketchup::Importer::ImportSuccess
58
+ # end
59
+ # end
60
+ #
61
+ # Sketchup.register_importer(TextImporter.new)
62
+ #
63
+ # @version SketchUp 6.0
64
+ class Sketchup::Importer
65
+
66
+ # Constants
67
+
68
+ ImportCanceled = nil # Stub value.
69
+ ImportFail = nil # Stub value.
70
+ ImportFileNotFound = nil # Stub value.
71
+ ImportSuccess = 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:
148
+ #
149
+ # - Sketchup::Importer::ImportSuccess
150
+ # - Sketchup::Importer::ImportFail
151
+ # - Sketchup::Importer::ImportCanceled - SketchUp will show a "cancelled" dialog
152
+ # - Sketchup::Importer::ImportFileNotFound - SketchUp will show a "not found" dialog
153
+ #
154
+ # @example
155
+ # def load_file(file_path, status)
156
+ # # Here is where you would open the file and process it.
157
+ # puts file_path
158
+ #
159
+ # return Sketchup::Importer::ImportSuccess
160
+ # end
161
+ #
162
+ # @param file_path
163
+ # Absolute path to the file the user selected
164
+ #
165
+ # @param status
166
+ # The status of the import so far. Contains true.
167
+ #
168
+ # @return success - an integer status code. See above.
169
+ #
170
+ # @version SketchUp 6.0
171
+ def load_file(file_path, status)
172
+ end
173
+
174
+ # This method is called by SketchUp to determine if the "Options"
175
+ # button inside the File > Import dialog should be enabled while your
176
+ # importer is selected.
177
+ #
178
+ # @example
179
+ # def supports_options?
180
+ # return true
181
+ # end
182
+ #
183
+ # @return [Boolean] supports_options - a boolean
184
+ #
185
+ # @version SketchUp 6.0
186
+ def supports_options?
187
+ end
188
+
189
+ end