-
Notifications
You must be signed in to change notification settings - Fork 9
/
file.exporter_options.html
406 lines (363 loc) · 18.8 KB
/
file.exporter_options.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<!-- VIEWPORT -->
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- AUTHOR and GENERATOR -->
<meta name="author" content="SketchUp Extensibility Team">
<meta name="generator" content="YARD https://yardoc.org">
<!-- TITLE -->
<title>
File: Exporter Options — SketchUp Ruby API Documentation
</title>
<!-- SHORTCUT ICON -->
<link rel="shortcut icon" type="image/vnd.microsoft.icon"
href="https://ruby.sketchup.com/favicon.ico" />
<!-- GENERIC META PROPERTIES -->
<meta name="url" content="https://ruby.sketchup.com/file.exporter_options.html" />
<meta name="image" content="https://ruby.sketchup.com/images/Ruby.svg" />
<meta name="title" content="File: Exporter Options" />
<meta name="name" content="SketchUp Ruby API Documentation" />
<meta name="description" content="Exporter Options" />
<!-- OPEN GRAPH META PROPERTIES -->
<meta property="og:site_name" content="SketchUp Ruby API Documentation" />
<meta property="og:type" content="website" />
<meta property="og:image" content="https://ruby.sketchup.com/images/Ruby.svg" />
<meta property="og:image:width" content="60" />
<meta property="og:image:height" content="60" />
<meta property="og:title" content="File: Exporter Options" />
<meta property="og:url" content="https://ruby.sketchup.com/file.exporter_options.html" />
<meta property="og:description" content="Exporter Options" />
<!-- TWITTER CARD META PROPERTIES -->
<meta name="twitter:card" content="summary" />
<meta name="twitter:site" content="@sketchup" />
<meta name="twitter:title" content="File: Exporter Options" />
<meta name="twitter:description" content="Exporter Options" />
<meta name="twitter:image:src" content="https://ruby.sketchup.com/images/Ruby.svg?s=120" />
<meta name="twitter:url" content="https://ruby.sketchup.com/file.exporter_options.html" />
<!-- STYLESHEETS -->
<link rel="stylesheet" type="text/css"
href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,400italic" />
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/sketchup.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/rubyapi.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="css/rouge.css" type="text/css" charset="utf-8" />
<!-- SCRIPTS -->
<script type="text/javascript">
pathId = "exporter_options";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/jquery-migrate.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
<script>
// Every time this page is loaded, it sends this action to SketchUp, telling
// SketchUp that a new page has loaded that has example snippets that should
// be replaced with code editors. Nothing happens if the page is loaded in a
// regular browser outside of the SketchUp client.
$( document ).ready(function() {
if (typeof sketchup == 'object') {
sketchup.page_loaded();
}
});
</script>
</head>
<body>
<!-- SU - start -->
<header id="navbar" role="banner" class="navbar navbar-fixed-top navbar-inverse">
<div id="api-documentation-header">
<div class="navbar-header">
<a class="logo navbar-btn pull-left" href="https://developer.sketchup.com" title="Home">
<img src="images/sketchup-logo.svg" alt="SketchUp">
</a>
<a class="name navbar-brand" href="/en" title="Home">SketchUp Developer Center</a>
<!-- .btn-navbar is used as the toggle for collapsed navbar content -->
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
</div>
<div class="navbar-collapse collapse">
<nav role="navigation">
<ul class="menu nav navbar-nav">
<li class="first leaf"><a href="https://forums.sketchup.com/c/developers">Community</a></li>
<li class="leaf"><a href="https://blog.sketchup.com/">SketchUp Blog</a></li>
<li class="leaf"><a href="https://www.sketchup.com/download" class="top-menu--download-button">Download</a></li>
<li class="last expanded dropdown">
<a href="https://www.trimble.com" class="trimble-top-menu-item dropdown-toggle" data-target="#" data-toggle="dropdown"><img src="images/trimble-logo-white.svg" alt="Trimble"><span class="caret"></span></a>
<ul class="dropdown-menu">
<li class="first leaf"><a href="https://connect.trimble.com/">Trimble Connect</a></li>
<li class="leaf"><a href="https://www.trimble.com/Corporate/About_Trimble.aspx">About Trimble</a></li>
<li class="last leaf"><a href="https://buildings.trimble.com/">Trimble Buildings</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</header>
<!-- SU - end -->
<div id="su-content">
<div class="nav_wrap">
<iframe id="nav" src="file_list.html"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: Exporter Options</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'>
<h1 id="label-Exporter+Options">Exporter Options</h1>
<p>The SketchUp Ruby API has different exporter plugins that are shipped with the product. Below is a list of the <strong>valid</strong> options that each exporter will accept. If an <strong>invalid</strong> option is provided, it will be silently ignored.</p>
<h2 id="label-All+Exporters">All Exporters</h2>
<ul><li>
<p><code>:show_summary</code> - Boolean to indicate whether to show the summary dialog.</p>
</li></ul>
<h2 id="label-3ds+Max+-283DS-29">3ds Max (3DS)</h2>
<ul><li>
<p><code>:units</code> - Specifies the export units.</p>
<ul><li>
<p>values: <code>"model"</code>, <code>"inch"</code>, <code>"foot"</code>, <code>"yard"</code>, <code>"mile"</code>, <code>"mm"</code>, <code>"cm"</code>, <code>"m"</code>, or <code>"km"</code></p>
</li></ul>
</li><li>
<p><code>:geometry</code> - Specifies what geometry to export.</p>
<ul><li>
<p>values: <code>"full_hierarchy"</code>, <code>"by_layer"</code>, <code>"by_material"</code>, or <code>"single_object"</code></p>
</li></ul>
</li><li>
<p><code>:doublesided_faces</code> - Boolean to indicate whether to export 2-sided faces.</p>
</li><li>
<p><code>:faces</code> - Specifies how to export faces.</p>
<ul><li>
<p>values: <code>"not_two_sided"</code>, <code>"two_sided_as_material"</code>, <code>"two_sided_as_geometry"</code></p>
</li></ul>
</li><li>
<p><code>:edges</code> - Boolean to indicate whether to export edges.</p>
</li><li>
<p><code>:texture_maps</code> - Boolean to indicate whether to export texture maps.</p>
</li><li>
<p><code>:preserve_texture_coords</code> - Boolean to indicate whether texture coordinates are to be preserved.</p>
</li><li>
<p><code>:cameras</code> - Boolean to indicate whether to export cameras from Scenes.</p>
</li><li>
<p><code>:selectionset_only</code> - Boolean to indicate whether to export the selected entities.</p>
</li></ul>
<h2 id="label-Collada+-28DAE-29">Collada (DAE)</h2>
<ul><li>
<p><code>:triangulated_faces</code> - Boolean to indicate whether to export triangulated faces.</p>
</li><li>
<p><code>:doublesided_faces</code> - Boolean to indicate whether to export 2-sided faces.</p>
</li><li>
<p><code>:edges</code> - Boolean to indicate whether to export edges.</p>
</li><li>
<p><code>:author_attribution</code> - Boolean to indicate whether to export model credits.</p>
</li><li>
<p><code>:hidden_geometry</code> - Boolean to indicate whether to export hidden geometry.</p>
</li><li>
<p><code>:preserve_instancing</code> - Boolean to indicate whether to preserve component hierarchies.</p>
</li><li>
<p><code>:texture_maps</code> - Boolean to indicate whether to export texture maps.</p>
</li><li>
<p><code>:selectionset_only</code> - Boolean to indicate whether to export the selected entities.</p>
</li><li>
<p><code>:camera_lookat</code> - Boolean to indicate whether to export the camera looking at the target.</p>
</li></ul>
<h2 id="label-3D+Autocad+-28DWG-2FDXF-29">3D Autocad (DWG/DXF)</h2>
<ul><li>
<p><code>:acad_version</code> - Specifies the autocad_version to export.</p>
<ul><li>
<p>values: <code>"acad_12"</code>, <code>"acad_13"</code>, <code>"acad_14"</code>, <code>"acad_2000"</code>, <code>"acad_2004"</code>, <code>"acad_2007"</code>, <code>"acad_2010"</code>, <code>"acad_2013"</code></p>
</li></ul>
</li><li>
<p><code>:faces_flag</code> - Boolean to indcate whether to export faces.</p>
</li><li>
<p><code>:construction_geometry</code> - Boolean to indicate whether to export construction geometry.</p>
</li><li>
<p><code>:dimensions</code> - Boolean to indicate whether to export dimensions.</p>
</li><li>
<p><code>:text</code> - Boolean to indicate whether to export text objects.</p>
</li><li>
<p><code>:edges</code> - Boolean to indicate whether to export edges.</p>
</li></ul>
<h2 id="label-Filmbox+Autodesk+-28FBX-29">Filmbox Autodesk (FBX)</h2>
<ul><li>
<p><code>:units</code> - Specifies the export units.</p>
<ul><li>
<p>values: <code>"model"</code>, <code>"inch"</code>, <code>"foot"</code>, <code>"yard"</code>, <code>"mile"</code>, <code>"mm"</code>, <code>"cm"</code>, <code>"m"</code> or <code>"km"</code></p>
</li></ul>
</li><li>
<p><code>:triangulated_faces</code> - Boolean to indicate whether to export triangulated faces.</p>
</li><li>
<p><code>:doublesided_faces</code> - Boolean to indicated whether to export 2-sided faces.</p>
</li><li>
<p><code>:texture_maps</code> - Boolean to indicate whether to export texture maps.</p>
</li><li>
<p><code>:seperate_disconnected_faces</code> - Boolean to indicate whether to export separate disconnected faces.</p>
</li><li>
<p><code>:swap_yz</code> - Boolean to indicate whether to swap Y and Z coordinates (Y is up).</p>
</li><li>
<p><code>:selectionset_only</code> - Boolean to indicate whether to export the selected entities.</p>
</li></ul>
<h2 id="label-Industry+Foundation+Classes+-28IFC-29">Industry Foundation Classes (IFC)</h2>
<ul><li>
<p><code>:hidden_geometry</code> - Boolean to indicate whether to export hidden geometry.</p>
</li><li>
<p><code>:doublesided_faces</code> - Boolean to indicate whether to export 2-sided faces.</p>
</li><li>
<p><code>:ifc_mapped_items</code> - Boolean to indicate whether to export IFC mapped items.</p>
</li><li>
<p><code>:ifc_types</code> - An Array of strings indicating IFC elements to export. One or more of the following values can be in the array. If there are no values in the array, no geometry will be exported.</p>
<ul><li>
<p>values: <code>"IfcNonDefined"</code>, <code>"IfcBeam"</code>, <code>"IfcBuilding"</code>, <code>"IfcBuildingElementProxy"</code>, <code>"IfcBuildingStorey"</code>, <code>"IfcColumn"</code>, <code>"IfcCurtainWall"</code>, <code>"IfcDoor"</code>, <code>"IfcFooting"</code>, <code>"IfcFurnishingElement"</code>, <code>"IfcMember"</code>, <code>"IfcPile"</code>, <code>"IfcPlate"</code>, <code>"IfcProject"</code>, <code>"IfcRailing"</code>, <code>"IfcRamp"</code>, <code>"IfcRampFlight"</code>, <code>"IfcRoof"</code>, <code>"IfcSite"</code>, <code>"IfcSlab"</code>, <code>"IfcSpace"</code>, <code>"IfcStair"</code>, <code>"IfcStairFlight"</code>, <code>"IfcWall"</code>, <code>"IfcWallStandardCase"</code>, <code>"IfcWindow"</code></p>
</li></ul>
</li></ul>
<h2 id="label-Google+Earth+-28KMZ-29">Google Earth (KMZ)</h2>
<ul><li>
<p><code>:author_attribution</code> - Boolean to indicate whether to export model credits.</p>
</li><li>
<p><code>:hidden_geometry</code> - Boolean to indicate whether to export hidden geometry</p>
</li></ul>
<h2 id="label-OBJ">OBJ</h2>
<ul><li>
<p><code>:units</code> - Specifies the export units.</p>
<ul><li>
<p>values: <code>"model"</code>, <code>"inch"</code>, <code>"foot"</code>, <code>"yard"</code>, <code>"mile"</code>, <code>"mm"</code>, <code>"cm"</code>, <code>"m"</code>, or <code>"km"</code></p>
</li></ul>
</li><li>
<p><code>:triangulated_faces</code> - Boolean to indicate whether to export triangulated faces.</p>
</li><li>
<p><code>:doublesided_faces</code> - Boolean to indicate whether to export 2-sided faces.</p>
</li><li>
<p><code>:edges</code> - Boolean to indicate whether to export edges.</p>
</li><li>
<p><code>:texture_maps</code> - Boolean to indicate whether to export texture maps.</p>
</li><li>
<p><code>:swap_yz</code> - Boolean to indicate whether to swap Y and Z coordinates (Y is up).</p>
</li><li>
<p><code>:selectionset_only</code> - Boolean to indicate whether to export the selected entities.</p>
</li></ul>
<h2 id="label-Softimage+XSI+3D+Image+-28XSI-29">Softimage XSI 3D Image (XSI)</h2>
<ul><li>
<p><code>:units</code> - Specifies the export units.</p>
<ul><li>
<p>values: <code>"model"</code>, <code>"inch"</code>, <code>"foot"</code>, <code>"yard"</code>, <code>"mile"</code>, <code>"mm"</code>, <code>"cm"</code>, <code>"m"</code>, or <code>"km"</code></p>
</li></ul>
</li><li>
<p><code>:triangulated_faces</code> - Boolean to indicate whether to export triangulated faces.</p>
</li><li>
<p><code>:doublesided_faces</code> - Boolean to indicate whether to export 2-sided faces.</p>
</li><li>
<p><code>:edges</code> - Boolean to indicate whether to export edges.</p>
</li><li>
<p><code>:texture_maps</code> - Boolean to indicate whether to export texture maps.</p>
</li><li>
<p><code>:swap_yz</code> - Boolean to indicate whether to swap Y and Z coordinates (Y is up).</p>
</li><li>
<p><code>:selectionset_only</code> - Boolean to indicate whether to export the selected entities.</p>
</li></ul>
<h2 id="label-Virtual+Reality+Modeling+Language+-28WRL-29">Virtual Reality Modeling Language (WRL)</h2>
<ul><li>
<p><code>:doublesided_faces</code> - Boolean to indicate whether to export 2-sided faces.</p>
</li><li>
<p><code>:cameras</code> - Boolean to indicate whether to export cameras.</p>
</li><li>
<p><code>:use_vrml_orientation</code> - Boolean to indicate whether to use VRML standard orientation.</p>
</li><li>
<p><code>:edges</code> - Boolean to indicate whether to export edges.</p>
</li><li>
<p><code>:texture_maps</code> - Boolean to indicate whether to export texture maps.</p>
</li><li>
<p><code>:allow_mirrored_components</code> - Boolean to indicate whether to allow mirrored components.</p>
</li><li>
<p><code>:material_override</code> - Boolean to indicate whether to check for material overrides.</p>
</li></ul>
<h2 id="label-PDF+-28Windows-29">PDF (Windows)</h2>
<ul><li>
<p><code>:output_profile_lines</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:output_section_lines</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:edge_extensions</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:match_screen_profiles</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:match_screen_section</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:match_screen_extensions</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:full_scale</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:map_fonts</code> (default = <code>true</code>)</p>
</li><li>
<p><code>:drawing_units</code> (default = <code>Length::Inches</code>)</p>
</li><li>
<p><code>:extension_units</code> (default = <code>Length::Feet</code>)</p>
</li><li>
<p><code>:height_units</code> (default = <code>Length::Feet</code>)</p>
</li><li>
<p><code>:model_units</code> (default = <code>Length::Feet</code>)</p>
</li><li>
<p><code>:width_units</code> (default = <code>Length::Feet</code>)</p>
</li><li>
<p><code>:extension_length</code> (default = <code>0.0</code>)</p>
</li><li>
<p><code>:line_width</code> (default = <code>0.0</code>)</p>
</li><li>
<p><code>:line_width_section</code> (default = <code>0.0</code>)</p>
</li><li>
<p><code>:length_in_drawing</code> (default = <code>1.0</code>)</p>
</li><li>
<p><code>:length_in_model</code> (default = <code>1.0</code>)</p>
</li><li>
<p><code>:window_height</code> (default = <code>1.0</code>)</p>
</li></ul>
<h2 id="label-PDF+-28Mac-29">PDF (Mac)</h2>
<ul><li>
<p><code>:line_weight</code> (default = <code>0.5</code>)</p>
</li><li>
<p><code>:imageWidth</code> (default = <code>50</code>)</p>
</li><li>
<p><code>:imageHeight</code> (default = <code>50</code>)</p>
</li></ul>
<h2 id="label-STereoLithography+-28STL-29">STereoLithography (STL)</h2>
<ul><li>
<p><code>:units</code> - Specifies the export units.</p>
<ul><li>
<p>values: <code>"model"</code>, <code>"inch"</code>, <code>"feet"</code>, <code>"mm"</code>, <code>"cm"</code>, <code>"m"</code></p>
</li></ul>
</li><li>
<p><code>:format</code> - Specifies how the data is represented in the file.</p>
<ul><li>
<p>values: <code>"ascii"</code>, <code>"binary"</code></p>
</li></ul>
</li><li>
<p><code>:selectionset_only</code> - Boolean to indicate whether to export the selected entities.</p>
</li><li>
<p><code>:swap_yz</code> - Boolean to indicate whether to swap Y and Z coordinates (Y is up).</p>
</li></ul>
</div></div>
<div id="footer">
Generated by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
</div>
</div>
</div>
</body>
</html>