Operations Guide Visual Enterprise Generator Version 7 PUBLIC Document Version: 1.0 – 2011-12-13
Operations Guide Visual Enterprise Generator Version 7
PUBLIC Document Version: 1.0 – 2011-12-13
Copyright
Version: 1.0 – 2011-12-13 PUBLIC 1 / 222
Copyright
© 2011 SAP AG. All rights reserved.
No part of this publication may be reproduced or transmitted in any form or for any purpose without the express permission of SAP AG. The information contained herein may be changed without prior notice.
Some software products marketed by SAP AG and its distributors contain proprietary software components of other software vendors.
Microsoft, Windows, Excel, Outlook, and PowerPoint are registered trademarks of Microsoft Corporation.
IBM, DB2, DB2 Universal Database, System i, System i5, System p, System p5, System x, System z, System z10, System z9, z10, z9, iSeries, pSeries, xSeries, zSeries, eServer, z/VM, z/OS, i5/OS, S/390, OS/390, OS/400, AS/400, S/390 Parallel Enterprise Server, PowerVM, Power Architecture, POWER6+, POWER6, POWER5+, POWER5, POWER, OpenPower, PowerPC, BatchPipes, BladeCenter, System Storage, GPFS, HACMP, RETAIN, DB2 Connect, RACF, Redbooks, OS/2, Parallel Sysplex, MVS/ESA, AIX, Intelligent Miner, WebSphere, Netfinity, Tivoli and Informix are trademarks or registered trademarks of IBM Corporation.
Linux is the registered trademark of Linus Torvalds in the U.S. and other countries.
Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either trademarks or registered trademarks of Adobe Systems Incorporated in the United States and/or other countries.
Oracle and Java are registered trademarks of Oracle.
UNIX, X/Open, OSF/1, and Motif are registered trademarks of the Open Group.
Citrix, ICA, Program Neighborhood, MetaFrame, WinFrame, VideoFrame, and MultiWin are trademarks or registered trademarks of Citrix Systems, Inc.
HTML, XML, XHTML and W3C are trademarks or registered trademarks of W3C ® , World Wide Web Consortium, Massachusetts Institute of Technology.
SAP, R/3, SAP NetWeaver, Duet, PartnerEdge, ByDesign, SAP BusinessObjects Explorer, StreamWork, SAP HANA, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and other countries.
Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company.
Sybase and Adaptive Server, iAnywhere, Sybase 365, SQL Anywhere, and other Sybase products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Sybase, Inc. Sybase is an SAP company.
All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.
Copyright
Version: 1.0 – 2011-12-13 PUBLIC 2 / 222
These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.
OpenEXR License Copyright © 2002, Industrial Light & Magic, a division of Lucas Digital Ltd. LLC. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
Neither the name of Industrial Light & Magic nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
JasPer Software License Copyright © 1999-2000, Image Power, Inc. and the University of British Columbia / Copyright (c) 2001 Michael David Adams. All rights reserved.
IMAGE POWER JPEG-2000 PUBLIC LICENSE
Grant
Permission is hereby granted, free of charge, to any person (the "User") obtaining a copy of this software and associated documentation, to deal in the JasPer Software without restriction, including without limitation the right to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the JasPer Software (in source and binary forms), and to permit persons to whom the JasPer Software is furnished to do so, provided further that the License Conditions below are met.
License Conditions
A. Redistributions of source code must retain the above copyright notice, and this list of conditions, and the following disclaimer.
B. Redistributions in binary form must reproduce the above copyright notice, and this list of conditions, and the following disclaimer in the documentation and/or other materials provided with the distribution.
C. Neither the name of Image Power, Inc. nor any other contributor (including, but not limited to, the University of British Columbia and Michael David Adams) may be used to endorse or promote products derived from this software without specific prior written permission.
Copyright
Version: 1.0 – 2011-12-13 PUBLIC 3 / 222
D. User agrees that it shall not commence any action against Image Power, Inc., the University of British Columbia, Michael David Adams, or any other contributors (collectively "Licensors") for infringement of any intellectual property rights ("IPR") held by the User in respect of any technology that User owns or has a right to license or sublicense and which is an element required in order toto claim compliance with ISO/IEC 15444-1 (that is, JPEG-2000 Part 1). "IPR" means all intellectual property rights worldwide arising under statutory or common law, and whether or not perfected, including, without limitation, all (i) patents and patent applications owned or licensable by User; (ii) rights associated with works of authorship including copyrights, copyright applications, copyright registrations, mask work rights, mask work applications, mask work registrations; (iii) rights relating to the protection of trade secrets and confidential information; (iv) any right analogous to those set forth in subsections (i), (ii), or (iii) and any other proprietary rights relating to intangible property (other than trademark, trade dress, or service mark rights); and (v) divisions, continuations, renewals, reissues and extensions of the foregoing (as and to the extent applicable) now existing, hereafter filed, issued or acquired.
E. If User commences an infringement action against any Licensor(s) then such Licensor(s) shall have the right to terminate User's license and all sublicenses that have been granted hereunder by User to other parties.
F. This software is for use only in hardware or software products that are compliant with ISO/IEC 15444-1 (that is, JPEG-2000 Part 1). No license or right to this Software is granted for products that do not comply with ISO/IEC 15444-1. The JPEG-2000 Part 1 standard can be purchased from the ISO.
THIS DISCLAIMER OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS LICENSE. NO USE OF THE JASPER SOFTWARE IS AUTHORIZED HEREUNDER EXCEPT UNDER THIS DISCLAIMER. THE JASPER SOFTWARE IS PROVIDED BY THE LICENSORS AND CONTRIBUTORS UNDER THIS LICENSE ON AN ``AS-IS'' BASIS, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES THAT THE JASPER SOFTWARE IS FREE OF DEFECTS, IS MERCHANTABLE, IS FIT FOR A PARTICULAR PURPOSE OR IS NON-INFRINGING. THOSE INTENDING TO USE THE JASPER SOFTWARE OR MODIFICATIONS THEREOF FOR USE IN HARDWARE OR SOFTWARE PRODUCTS ARE ADVISED THAT THEIR USE MAY INFRINGE EXISTING PATENTS, COPYRIGHTS, TRADEMARKS, OR OTHER INTELLECTUAL PROPERTY RIGHTS. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE JASPER SOFTWARE IS WITH THE USER. SHOULD ANY PART OF THE JASPER SOFTWARE PROVE DEFECTIVE IN ANY RESPECT, THE USER (AND NOT THE INITIAL DEVELOPERS, THE UNIVERSITY OF BRITISH COLUMBIA, IMAGE POWER, INC., MICHAEL DAVID ADAMS, OR ANY OTHER CONTRIBUTOR) SHALL ASSUME THE COST OF ANY NECESSARY SERVICING, REPAIR OR CORRECTION. UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL THEORY, WHETHER TORT (INCLUDING NEGLIGENCE), CONTRACT, OR OTHERWISE, SHALL THE INITIAL DEVELOPER, THE UNIVERSITY OF BRITISH COLUMBIA, IMAGE POWER, INC., MICHAEL DAVID ADAMS, ANY OTHER CONTRIBUTOR, OR ANY DISTRIBUTOR OF THE JASPER SOFTWARE, OR ANY SUPPLIER OF ANY OF SUCH PARTIES, BE LIABLE TO THE USER OR ANY OTHER PERSON FOR ANY INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY CHARACTER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR MALFUNCTION, OR ANY AND ALL OTHER COMMERCIAL DAMAGES OR LOSSES, EVEN IF SUCH PARTY HAD BEEN INFORMED, OR OUGHT TO HAVE KNOWN, OF THE POSSIBILITY OF SUCH DAMAGES. THE JASPER SOFTWARE AND UNDERLYING TECHNOLOGY ARE NOT FAULT-TOLERANT AND ARE NOT DESIGNED, MANUFACTURED OR INTENDED FOR USE OR RESALE AS ON-LINE CONTROL EQUIPMENT IN HAZARDOUS ENVIRONMENTS REQUIRING FAIL-SAFE PERFORMANCE, SUCH AS IN THE OPERATION OF NUCLEAR FACILITIES, AIRCRAFT NAVIGATION OR COMMUNICATION SYSTEMS, AIR TRAFFIC CONTROL, DIRECT LIFE SUPPORT MACHINES, OR WEAPONS SYSTEMS, IN WHICH THE FAILURE OF THE JASPER SOFTWARE OR UNDERLYING TECHNOLOGY OR PRODUCT COULD LEAD DIRECTLY TO
Copyright
Version: 1.0 – 2011-12-13 PUBLIC 4 / 222
DEATH, PERSONAL INJURY, OR SEVERE PHYSICAL OR ENVIRONMENTAL DAMAGE ("HIGH RISK ACTIVITIES"). LICENSOR SPECIFICALLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR HIGH RISK ACTIVITIES. USER WILL NOT KNOWINGLY USE, DISTRIBUTE OR RESELL THE JASPER SOFTWARE OR UNDERLYING TECHNOLOGY OR PRODUCTS FOR HIGH RISK ACTIVITIES AND WILL ENSURE THAT ITS CUSTOMERS AND END-USERS OF ITS PRODUCTS ARE PROVIDED WITH A COPY OF THE NOTICE SPECIFIED IN THIS SECTION.
NVIDIA CG Shader Library License Copyright © 2002, NVIDIA Corporation. All rights reserved.
NVIDIA Corporation("NVIDIA") supplies this software to you in consideration of your agreement to the following terms, and your use, installation, modification or redistribution of this NVIDIA software constitutes acceptance of these terms. If you do not agree with these terms, please do not use, install, modify or redistribute this NVIDIA software.
In consideration of your agreement to abide by the following terms, and subject to these terms, NVIDIA grants you a personal, non-exclusive license, under NVIDIA’s copyrights in this original NVIDIA software (the "NVIDIA Software"), to use, reproduce, modify and redistribute the NVIDIA Software, with or without modifications, in source and/or binary forms; provided that if you redistribute the NVIDIA Software, you must retain the copyright notice of NVIDIA, this notice and the following text and disclaimers in all such redistributions of the NVIDIA Software. Neither the name, trademarks, service marks nor logos of NVIDIA Corporation may be used to endorse or promote products derived from the NVIDIA Software without specific prior written permission from NVIDIA. Except as expressly stated in this notice, no other rights or licenses express or implied, are granted by NVIDIA herein, including but not limited to any patent rights that may be infringed by your derivative works or by other works in which the NVIDIA Software may be incorporated. No hardware is licensed hereunder.
THE NVIDIA SOFTWARE IS BEING PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION, WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR ITS USE AND OPERATION EITHER ALONE OR IN COMBINATION WITH OTHER PRODUCTS.
IN NO EVENT SHALL NVIDIA BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL, EXEMPLARY, CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, LOST PROFITS; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) OR ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION OF THE NVIDIA SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
TIFF License Copyright © 1988-1997 Sam Leffler / Copyright © 1991-1997 Silicon Graphics, Inc. All rights reserved.
Permission to use, copy, modify, distribute, and sell this software and its documentation for any purpose is hereby granted without fee, provided that (i) the above copyright notices and this permission notice appear in all copies of the software and related documentation, and (ii) the names of Sam Leffler and Silicon Graphics may not be used in any advertising or publicity relating to the software without the specific, prior written permission of Sam Leffler and Silicon Graphics.
THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Copyright
Version: 1.0 – 2011-12-13 PUBLIC 5 / 222
IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
Autodesk DWF Toolkit Disclaimer of Warranty © 1996-2005 Autodesk, Inc. All rights reserved.
The incorporated portions of the Autodesk DWF Toolkit are provided "AS IS" and without any warranty of any kind. AUTODESK DOES NOT MAKE AND HEREBY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTIES INCLUDING, BUT NOT LIMITED TO, THE WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
Document History
Version: 1.0 – 2011-12-13 PUBLIC 6 / 222
Document History
Version Date Change
1.0 13 December 2011
Rebranding
Contents
Version: 1.0 – 2011-12-13 PUBLIC 7 / 222
Contents
1 2D Raster Graphics .............................................................................................................. 17 1.1 go_2d_flip .......................................................................................................................... 17 1.2 go_2d_tograyscale ............................................................................................................... 17 1.3 go_2d_getmetadata .............................................................................................................. 17 1.4 go_2d_open ........................................................................................................................ 17 1.5 go_2d_rotate ....................................................................................................................... 18 1.6 go_2d_save ......................................................................................................................... 18 1.7 go_2d_save_fittopreserveaspectratio ..................................................................................... 18 2 2D Vector/3D Graphics ........................................................................................................ 19 2.1 go_animation_setproperties .................................................................................................. 19 2.2 go_thumbnail_createanimated .............................................................................................. 19 2.3 go_object_assigndefaultmaterialtoall ..................................................................................... 20 2.4 go_cadsearchpath_add ......................................................................................................... 20 2.5 go_cadsearchpath_clear ....................................................................................................... 20 2.6 go_camera_setactiveparams ................................................................................................. 20 2.7 go_camera_setactivefov ....................................................................................................... 21 2.8 go_camera_setactiveview ..................................................................................................... 21 2.9 go_camera_setactiveprojectionmode ..................................................................................... 22 2.10 go_plugin_checklicense ....................................................................................................... 22 2.11 go_object_deselectall ........................................................................................................... 23 2.12 go_context_load .................................................................................................................. 23 2.13 go_context_save .................................................................................................................. 23 2.14 go_thumbnail_createstatic .................................................................................................... 23 2.15 go_fileformat_getall ............................................................................................................ 23 2.16 go_scene_get2dmodeflag ..................................................................................................... 24 2.17 go_scene_getexternalfile ...................................................................................................... 24 2.18 go_fileformat_getbyguid ...................................................................................................... 24 2.19 go_plugin_getguidandlicensestatus ....................................................................................... 24 2.20 go_object_getselectedsurfacearea ......................................................................................... 25 2.21 go_object_getselectedvolume ............................................................................................... 25 2.22 go_view_isorthographic ....................................................................................................... 25 2.23 go_layer_create ................................................................................................................... 25 2.24 go_layer_delete ................................................................................................................... 26 2.25 go_layer_rename ................................................................................................................. 26 2.26 go_layer_getall .................................................................................................................... 26 2.27 go_scene_getexternalfiles..................................................................................................... 26
Contents
Version: 1.0 – 2011-12-13 PUBLIC 8 / 222
2.28 go_scene_getmaterials ......................................................................................................... 27 2.29 go_material_assign .............................................................................................................. 27 2.30 go_material_getparams ........................................................................................................ 27 2.31 go_material_gettexture ......................................................................................................... 28 2.32 go_material_import ............................................................................................................. 29 2.33 go_material_setambientcolor ................................................................................................ 29 2.34 go_material_setdiffusecolor ................................................................................................. 29 2.35 go_material_setdoublesidedflag ............................................................................................ 29 2.36 go_material_setemissivecolor ............................................................................................... 29 2.37 go_material_setglossinesslevel ............................................................................................. 30 2.38 go_material_setopacitylevel ................................................................................................. 30 2.39 go_material_setoutlinethickness ........................................................................................... 30 2.40 go_material_setparams ......................................................................................................... 30 2.41 go_material_setreflectionlevel .............................................................................................. 31 2.42 go_material_setrefractionlevel .............................................................................................. 31 2.43 go_material_setspecularlevel ................................................................................................ 31 2.44 go_material_setspecularcolor ............................................................................................... 32 2.45 go_material_settexture ......................................................................................................... 32 2.46 go_material_setwireframelinewidth ...................................................................................... 33 2.47 go_scene_mergeduplicatematerials ....................................................................................... 33 2.48 go_scene_mergefile ............................................................................................................. 33 2.49 go_scene_mergetransformedfile ........................................................................................... 34 2.50 go_scene_getmetadata ......................................................................................................... 34 2.51 go_scene_open .................................................................................................................... 34 2.52 go_scene_openwithplugin .................................................................................................... 35 2.53 go_scene_openempty ........................................................................................................... 35 2.54 go_render_raytrace .............................................................................................................. 35 2.55 go_scene_removeexternalfile ............................................................................................... 36 2.56 go_object_removebytype ..................................................................................................... 37 2.57 go_object_removeselected.................................................................................................... 37 2.58 go_scene_removeunusedmaterials ........................................................................................ 37 2.59 go_scene_resettransform ...................................................................................................... 37 2.60 go_scene_save .................................................................................................................... 38 2.61 go_scene_getanimations ....................................................................................................... 38 2.62 go_scene_zoom ................................................................................................................... 38 2.63 go_object_selectall .............................................................................................................. 38 2.64 go_object_selectbymetadata ................................................................................................. 39 2.65 go_plugin_selectforfile ........................................................................................................ 39 2.66 go_camera_settodefaultview................................................................................................. 39 2.67 go_markup_setvisibilityforall ............................................................................................... 39 2.68 go_object_setmetadatawithtype ............................................................................................ 40 2.69 go_object_setmetadata ......................................................................................................... 40 2.70 go_object_setname .............................................................................................................. 41 2.71 go_viewport_setsize ............................................................................................................ 41
Contents
Version: 1.0 – 2011-12-13 PUBLIC 9 / 222
2.72 go_scene_setviewaxis .......................................................................................................... 41 2.73 go_setting_setfloat ............................................................................................................... 41 2.74 go_setting_setinteger ........................................................................................................... 42 2.75 go_setting_setstring ............................................................................................................. 42 2.76 go_viewport_setmetadata ..................................................................................................... 42 2.77 go_step_export .................................................................................................................... 43 2.78 go_step_getall ..................................................................................................................... 43 2.79 go_scene_transform ............................................................................................................. 43 2.80 go_viewport_getall .............................................................................................................. 43 2.81 go_viewport_setactive ......................................................................................................... 44 2.82 go_object_setvisibility ......................................................................................................... 44 2.83 go_scene_getxreferences ...................................................................................................... 44 2.84 go_render_zbuffer ............................................................................................................... 45 2.85 goc_bounding_box .............................................................................................................. 46 2.86 goc_hidden_wireframe ......................................................................................................... 47 2.87 goc_line_illustration ............................................................................................................ 48 2.88 goc_sceneproperties ............................................................................................................. 49 2.89 goc_shaded_illustration ........................................................................................................ 53 2.90 goc_shaded_vertices ............................................................................................................ 56 2.91 goc_shaded_wireframe ........................................................................................................ 57 2.92 goc_solid ............................................................................................................................ 58 2.93 goc_solid_outline ................................................................................................................ 60 2.94 goc_solid_wireframe ........................................................................................................... 62 2.95 goc_transparent ................................................................................................................... 63 2.96 goc_transparent_bounding_box ............................................................................................ 65 2.97 goc_transparent_bounding_box_outline ................................................................................ 66 2.98 goc_transparent_wireframe .................................................................................................. 67 2.99 goc_vertices ........................................................................................................................ 68 2.100 goc_wireframe .................................................................................................................... 69 3 File/Directory/Path .............................................................................................................. 70 3.1 do_directory_attributes ........................................................................................................ 70 3.2 po_path_combine ................................................................................................................ 70 3.3 do_directory_copy ............................................................................................................... 71 3.4 do_directory_create ............................................................................................................. 71 3.5 do_directory_delete ............................................................................................................. 71 3.6 do_directory_deletefiles ....................................................................................................... 71 3.7 do_directory_exists .............................................................................................................. 72 3.8 do_directory_getdirectories .................................................................................................. 72 3.9 do_directory_getfiles ........................................................................................................... 72 3.10 do_directory_move .............................................................................................................. 72 3.11 fo_file_findtext ................................................................................................................... 73 3.12 fo_file_append .................................................................................................................... 73 3.13 fo_file_getattributes ............................................................................................................. 73 3.14 po_path_buildfilename ......................................................................................................... 74
Contents
Version: 1.0 – 2011-12-13 PUBLIC 10 / 222
3.15 fo_file_copy ........................................................................................................................ 74 3.16 fo_fileordirectory_create ...................................................................................................... 74 3.17 do_directory_createworkspacetempdir .................................................................................. 74 3.18 fo_file_delete ...................................................................................................................... 75 3.19 fo_file_delete_with_retry ..................................................................................................... 75 3.20 fo_file_exists ...................................................................................................................... 75 3.21 fo_file_move ....................................................................................................................... 75 3.22 po_path_resolveunc ............................................................................................................. 75 3.23 fo_file_savefromstring ......................................................................................................... 76 3.24 fo_file_gettempname ........................................................................................................... 76 3.25 fo_file_unzip ....................................................................................................................... 76 3.26 fo_file_zip .......................................................................................................................... 76 4 Flow Control ....................................................................................................................... 77 4.1 er_stopprocessing ................................................................................................................ 77 4.2 for-each .............................................................................................................................. 77 4.3 if ........................................................................................................................................ 77 4.4 pause .................................................................................................................................. 77 4.5 set ...................................................................................................................................... 78 4.6 standarderror ....................................................................................................................... 78 4.7 standardterminatehandler ..................................................................................................... 79 4.8 variable .............................................................................................................................. 79 4.9 while .................................................................................................................................. 79 5 General Operations .............................................................................................................. 80 5.1 guid_createnew ................................................................................................................... 80 5.2 datetime_tostring ................................................................................................................. 80 5.3 email_send .......................................................................................................................... 81 5.4 rhz_extractvzxml ................................................................................................................. 81 5.5 http_download .................................................................................................................... 81 5.6 http_upload ......................................................................................................................... 82 5.7 log_add .............................................................................................................................. 82 5.8 log_message ....................................................................................................................... 82 5.9 log_save ............................................................................................................................. 83 5.10 xml_setvalue ....................................................................................................................... 83 5.11 serverproperties_getall ......................................................................................................... 83 5.12 xml_extract ......................................................................................................................... 83 5.13 task_resultsdocument_tomsmq ............................................................................................. 84 5.14 task_resultsdocument_tofile ................................................................................................. 84 5.15 pdf_headerfooter ................................................................................................................. 84 5.16 pdf_mergefiles .................................................................................................................... 85 5.17 pdf_templatemerge .............................................................................................................. 86 5.18 job_start ............................................................................................................................. 86 5.19 task_start ............................................................................................................................ 86 5.20 keyvaluepair_response_setvalue ........................................................................................... 87 5.21 os_shellexecute ................................................................................................................... 87
Contents
Version: 1.0 – 2011-12-13 PUBLIC 11 / 222
5.22 keyvaluepair_response_writetofile ........................................................................................ 87 5.23 keyvaluepair_trigger_loadfromfile ........................................................................................ 87 5.24 string_tokenize .................................................................................................................... 88 5.25 os_waitforosprocessexit ....................................................................................................... 88 5.26 xml_attributeadd ................................................................................................................. 88 5.27 xml_elementadd .................................................................................................................. 89 5.28 xml_elementcount ............................................................................................................... 89 5.29 xml_elementexists ............................................................................................................... 89 5.30 xml_escapestring ................................................................................................................. 90 5.31 xml_getattributevalue .......................................................................................................... 90 5.32 xml_xslttransform ............................................................................................................... 90 6 Import/Export Settings ......................................................................................................... 91 6.1 Right_Hemisphere_Binary_ExportOptions ............................................................................ 91 6.2 Autodesk_3D_Studio_ExportOptions .................................................................................... 94 6.3 Visual_XML_ExportOptions ................................................................................................ 94 6.4 XAML_ExportOptions ........................................................................................................ 95 6.5 DirectX_Model_ExportOptions ............................................................................................ 96 6.6 AutoCAD_Design_Web_Format_ExportOptions ................................................................... 96 6.7 DICOM_Image_ExportOptions ............................................................................................ 97 6.8 Open_Inventor_File_ExportOptions ...................................................................................... 97 6.9 SOFTIMAGE_XSI_ExportOptions ....................................................................................... 98 6.10 3ds_Max_File_ExportOptions .............................................................................................. 99 6.11 VRML_Worlds_ExportOptions .......................................................................................... 100 6.12 Visual_Design_Stream_ExportOptions ............................................................................... 100 6.13 LightWave_Scene_ExportOptions ...................................................................................... 103 6.14 JPEG_2000_JPC_ExportOptions ........................................................................................ 103 6.15 Rhinoceros_3D_Model_ExportOptions ............................................................................... 103 6.16 Office_Powerpoint_Document_ExportOptions .................................................................... 104 6.17 HTML_Document_with_3D_ExportOptions ....................................................................... 107 6.18 LightWave_3D_and_Binary_Object_ExportOptions ............................................................ 111 6.19 OpenFlight_Scene_Description_Database_ExportOptions .................................................... 111 6.20 Maya_ASCII_Scene_ExportOptions ................................................................................... 112 6.21 Adobe_Portable_Document_2D__with_template__ExportOptions ........................................ 113 6.22 Tagged_Image_File_Format_ExportOptions ........................................................................ 116 6.23 AutoCAD_Drawing_Object_ExportOptions ........................................................................ 116 6.24 Portable_Network_Graphics_ExportOptions ........................................................................ 116 6.25 Universal_3D_export_ExportOptions .................................................................................. 117 6.26 JPEG_2000_JP2_ExportOptions ......................................................................................... 117 6.27 Maya_Binary_Scene_ExportOptions ................................................................................... 118 6.28 Maya_Interchange_File_Format_ExportOptions .................................................................. 118 6.29 Stereolithography_File_ExportOptions ................................................................................ 118 6.30 Adobe_Portable_Document_3D_ExportOptions .................................................................. 119 6.31 Flex_Web_Application_ExportOptions ............................................................................... 125 6.32 JTPMI_Files_ExportOptions .............................................................................................. 129
Contents
Version: 1.0 – 2011-12-13 PUBLIC 12 / 222
6.33 Google_SketchUp_Document_ExportOptions ..................................................................... 130 6.34 Adobe_Portable_Document_2D_ExportOptions .................................................................. 130 6.35 Right_Hemisphere_Material_ExportOptions ........................................................................ 131 6.36 Computer_Graphics_Metafile_ExportOptions...................................................................... 132 6.37 AutoCAD_Drawing_Interchange_ExportOptions ................................................................. 132 6.38 OpenEXR_Bitmap_ExportOptions ..................................................................................... 133 6.39 JPEG_Image_ExportOptions .............................................................................................. 133 6.40 Wavefront_Object_ExportOptions ...................................................................................... 134 6.41 Caligari_trueSpace_Object_ExportOptions .......................................................................... 134 6.42 Right_Hemisphere_Binary_ImportOptions .......................................................................... 134 6.43 Autodesk_3D_Studio_ImportOptions .................................................................................. 135 6.44 CATIA5_Assembly_Files_ImportOptions ........................................................................... 135 6.45 Visual_XML_ImportOptions .............................................................................................. 137 6.46 DirectX_Model_ImportOptions .......................................................................................... 137 6.47 Caligari_trueSpace_Scene_ImportOptions ........................................................................... 138 6.48 Pro_ENGINEER_Drawing_files_ImportOptions.................................................................. 138 6.49 AutoCAD_Design_Web_Format_ImportOptions ................................................................. 139 6.50 Open_Inventor_File_ImportOptions .................................................................................... 139 6.51 Solid_Edge_Assembly_files_ImportOptions ........................................................................ 140 6.52 N3ds_Max_File_ImportOptions ......................................................................................... 141 6.53 MicroStation_CAD_Graphic_files_ImportOptions ............................................................... 141 6.54 VRML_Worlds_ImportOptions .......................................................................................... 142 6.55 Visual_Design_Stream_ImportOptions ............................................................................... 143 6.56 LightWave_Scene_ImportOptions ...................................................................................... 144 6.57 Rhinoceros_3D_Model_ImportOptions ............................................................................... 144 6.58 Autodesk_3D_Studio_Project_ImportOptions...................................................................... 145 6.59 Autodesk_3D_Studio_Material_ImportOptions.................................................................... 145 6.60 LightWave_3D_and_Binary_Object_ImportOptions ............................................................ 145 6.61 Pro_ENGINEER_Assembly_files_ImportOptions ................................................................ 146 6.62 OpenFlight_Scene_Description_Database_ImportOptions .................................................... 147 6.63 Maya_ASCII_Scene_ImportOptions ................................................................................... 147 6.64 Gerber_File_ImportOptions ............................................................................................... 147 6.65 Tagged_Image_File_Format_ImportOptions ........................................................................ 148 6.66 AutoCAD_Drawing_Object_ImportOptions ........................................................................ 148 6.67 Parasolid_Part_and_Assembly_Files_ImportOptions ............................................................ 150 6.68 AutoCAD_Sheet_Set_File_ImportOptions .......................................................................... 151 6.69 Points_File_ImportOptions ................................................................................................ 151 6.70 Maya_Binary_Scene_ImportOptions ................................................................................... 152 6.71 Maya_Interchange_File_Format_ImportOptions .................................................................. 152 6.72 Universal_3D_import_ImportOptions ................................................................................. 152 6.73 CATIA4_Part_Files_ImportOptions .................................................................................... 153 6.74 Collada_ImportOptions ...................................................................................................... 154 6.75 Step_Part_and_Assembly_files_ImportOptions.................................................................... 155 6.76 Pro_ENGINEER_Neutral_files_ImportOptions ................................................................... 156
Contents
Version: 1.0 – 2011-12-13 PUBLIC 13 / 222
6.77 SolidWorks_Drawing_files_ImportOptions ......................................................................... 157 6.78 Pro_ENGINEER_Part_files_ImportOptions ........................................................................ 157 6.79 Protein_Data_Bank_ImportOptions .................................................................................... 158 6.80 JTPMI_Files_ImportOptions .............................................................................................. 159 6.81 Inventor_Part_files_ImportOptions ..................................................................................... 160 6.82 Portable_Graymap_Heightfield_ImportOptions ................................................................... 161 6.83 NX_Parts_and_Assemblies_ImportOptions ......................................................................... 162 6.84 CATIA4_Assembly_Files_ImportOptions ........................................................................... 163 6.85 Google_SketchUp_Document_ImportOptions ..................................................................... 165 6.86 SolidWorks_Part_files_ImportOptions ................................................................................ 165 6.87 Bundled_RH___RHB_files_ImportOptions ......................................................................... 166 6.88 Bundled_RH___RHB_files_ImportOptions ......................................................................... 167 6.89 AutoCAD_Drawing_Interchange_ImportOptions ................................................................. 167 6.90 CATIA5_Drawing_files_ImportOptions .............................................................................. 168 6.91 Inventor_Assembly_files_ImportOptions ............................................................................ 169 6.92 Adobe_Portable_Document_ImportOptions ......................................................................... 170 6.93 CATIA5_Part_files_ImportOptions .................................................................................... 170 6.94 Solid_Edge_Part_files_ImportOptions ................................................................................ 172 6.95 Iges_Part_and_Assembly_files_ImportOptions .................................................................... 173 6.96 CATIA_Graphical_Representation_Files_CGR__ImportOptions .......................................... 174 6.97 JPEG_Image_ImportOptions .............................................................................................. 175 6.98 Wavefront_Object_ImportOptions ...................................................................................... 175 6.99 ACIS_Part_and_Assembly_files_ImportOptions .................................................................. 176 6.100 Caligari_trueSpace_Object_ImportOptions .......................................................................... 177 6.101 SolidWorks_Assembly_files_ImportOptions ....................................................................... 177 7 Metadata ........................................................................................................................... 179 7.1 filemetadata_extract ........................................................................................................... 179 7.2 filemetadata_extractmsoffice .............................................................................................. 179 7.3 filemetadata_extractxmp .................................................................................................... 179 8 Modules ........................................................................................................................... 180 8.1 ApplyModifier .................................................................................................................. 180 8.2 bomfactory ....................................................................................................................... 180 8.3 Clean_Scene ..................................................................................................................... 181 8.4 cm_createbommodelview ................................................................................................... 181 8.5 cm_removeunwantednodes................................................................................................. 181 8.6 cm_renametoplevelnode ..................................................................................................... 181 8.7 cm_setaxissystemcolors ..................................................................................................... 182 8.8 cm_setmetadataunit ........................................................................................................... 182 8.9 cm_setpmialwaysontop ...................................................................................................... 182 8.10 cm_setpmibillboarding ....................................................................................................... 182 8.11 cm_setpmilinecolor ........................................................................................................... 183 8.12 cm_setpmitextcolor ........................................................................................................... 183 8.13 cm_setpointcolor_style ...................................................................................................... 183 8.14 cm_wireframe ................................................................................................................... 184
Contents
Version: 1.0 – 2011-12-13 PUBLIC 14 / 222
8.15 cm_wireframe_color .......................................................................................................... 184 8.16 convertaitopsd ................................................................................................................... 184 8.17 CreateDVIS ...................................................................................................................... 184 8.18 ct_clippingplane_crosssection ............................................................................................ 184 8.19 ct_color_objects ................................................................................................................ 185 8.20 ct_converttodoublesided..................................................................................................... 185 8.21 ct_explodeobjects .............................................................................................................. 186 8.22 ct_healmodel_advanced ..................................................................................................... 186 8.23 ct_invertfaces .................................................................................................................... 186 8.24 ct_invertfacesandnormals ................................................................................................... 187 8.25 ct_invertnormals ................................................................................................................ 187 8.26 ct_joinequalpoints ............................................................................................................. 187 8.27 ct_randomizeobjects .......................................................................................................... 187 8.28 ct_realight ......................................................................................................................... 188 8.29 ct_reducemodel_advanced.................................................................................................. 190 8.30 ct_remove_degenerate_triangles ......................................................................................... 191 8.31 ct_remove_duplicate_faces................................................................................................. 191 8.32 ct_remove_duplicate_materials ........................................................................................... 191 8.33 ct_remove_duplicate_meshes ............................................................................................. 191 8.34 ct_remove_invisible_polygons ........................................................................................... 191 8.35 ct_removeinternalparts ....................................................................................................... 192 8.36 ct_removesmallparts .......................................................................................................... 192 8.37 ct_separatemesh ................................................................................................................ 192 8.38 ct_unifynormals ................................................................................................................ 193 8.39 ct_uvmapping ................................................................................................................... 193 8.40 dgnhierarchyxml ............................................................................................................... 195 8.41 ill_advancedsettings ........................................................................................................... 195 8.42 ill_render .......................................................................................................................... 198 8.43 jtassociatepmi ................................................................................................................... 200 8.44 jthierarchyxml ................................................................................................................... 200 8.45 NeutralXmlGenerator ........................................................................................................ 200 8.46 pdf_2d_picturing ............................................................................................................... 201 8.47 pdf_2d_picturing_serial ..................................................................................................... 201 8.48 pdf_merge ........................................................................................................................ 202 8.49 pdf_print_all_metadata ...................................................................................................... 202 8.50 pdf_print_metadata ............................................................................................................ 203 8.51 pdf_protect ....................................................................................................................... 203 8.52 pdf_xfdf_integrate ............................................................................................................. 204 8.53 pmi_settings ...................................................................................................................... 204 8.54 pmi_visibility .................................................................................................................... 204 8.55 regenerate_scene_thumbnails ............................................................................................. 205 8.56 remove_vzxml_hierarchy_cache ......................................................................................... 205 8.57 RunFileQuery ................................................................................................................... 205 8.58 RunQuery ......................................................................................................................... 205
Contents
Version: 1.0 – 2011-12-13 PUBLIC 15 / 222
8.59 setsceneunits ..................................................................................................................... 206 8.60 validate_and_fix_scene_hierarchy ...................................................................................... 206 8.61 validate_and_fix_scene_layers ........................................................................................... 206 8.62 validate_scene_hierarchy ................................................................................................... 206 8.63 validate_scene_layers ........................................................................................................ 206 9 Repository ........................................................................................................................ 207 9.1 ro_audit_addrecord ............................................................................................................ 207 9.2 ro_asset_removeexternalsystemid ....................................................................................... 207 9.3 ro_asset_removespecifiedexternalsystemid .......................................................................... 207 9.4 ro_asset_getdetailsbyexternalsystemid ................................................................................ 208 9.5 ro_asset_getancestorinstances ............................................................................................. 208 9.6 ro_asset_getancestorassetids ............................................................................................... 209 9.7 ro_asset_getexternalsystemid ............................................................................................. 209 9.8 ro_asset_getparentassetids .................................................................................................. 209 9.9 ro_asset_getderivativesforversion ....................................................................................... 210 9.10 ro_asset_setexternalsystemid .............................................................................................. 210 9.11 ro_manifest_convertversion................................................................................................ 210 9.12 ro_entitydatabag_deletevalue ............................................................................................. 211 9.13 ro_absoluteinstance_downloadmasterderivative ................................................................... 211 9.14 ro_asset_downloadmasterderivative .................................................................................... 211 9.15 ro_asset_downloadoriginalfile ............................................................................................ 212 9.16 ro_asset_getassetidfromexternalsystemid ............................................................................. 212 9.17 ro_asset_getdetails ............................................................................................................. 212 9.18 ro_file_scanforassetbuildinfo .............................................................................................. 213 9.19 ro_job_getcreatedassetversions ........................................................................................... 213 9.20 ro_derivative_download ..................................................................................................... 214 9.21 ro_derivative_getdetails ..................................................................................................... 214 9.22 ro_derivative_getstream ..................................................................................................... 214 9.23 ro_entitydatabag_getvalue .................................................................................................. 215 9.24 ro_absoluteinstance_getabsoluteinstancescreatedbyjob ......................................................... 215 9.25 ro_asset_getassetidandversionfromexternalsystemid ............................................................. 215 9.26 ro_asset_getmasterderivativeid ........................................................................................... 215 9.27 ro_file_download .............................................................................................................. 216 9.28 ro_filetype_getforfile ......................................................................................................... 216 9.29 ro_view_getname .............................................................................................................. 216 9.30 ro_job_getproperty ............................................................................................................ 216 9.31 ro_job_setproperty ............................................................................................................. 217 9.32 ro_asset_setmetadatavalue.................................................................................................. 217 9.33 ro_entitydatabag_setvalue .................................................................................................. 217 10 Scriptable Operations ......................................................................................................... 218 10.1 script_execute ................................................................................................................... 218 11 SOAP Web ....................................................................................................................... 219 11.1 webservice_methodinvoke ................................................................................................. 219 11.2 webservice_operationgenerator ........................................................................................... 219
Contents
Version: 1.0 – 2011-12-13 PUBLIC 16 / 222
12 SQL Database ................................................................................................................... 220 12.1 database_executecommand................................................................................................. 220 13 Triggers ............................................................................................................................ 221 13.1 filetrigger .......................................................................................................................... 221 13.2 generictrigger .................................................................................................................... 221 13.3 simpletrigger ..................................................................................................................... 221 13.4 conversiontrigger ............................................................................................................... 221
2D Raster Graphics
Version: 1.0 – 2011-12-13 PUBLIC 17 / 222
1 2D Raster Graphics
1.1 go_2d_flip
Flips 2D images horizontally or vertically.
Parameter Name Parameter Type Parameter Description
direction string The direction to flip, must be horizontal or vertical. Possible Values
Horizontal horiz
Vertical vert
1.2 go_2d_tograyscale
Applies a grayscale mode to a 2D image.
1.3 go_2d_getmetadata
Extracts metadata information from an open 2D image.
Parameter Name Parameter Type Parameter Description
metadataobject metadataparameter2d The extracted image metadata.
outputfilepath filename An optional file to write the data to.
1.4 go_2d_open
Opens a 2D file so that other 2D operations can run.
Parameter Name Parameter Type Parameter Description
filename filename The location of the 2d file to open.
width integer The width of the 2d file.
height integer The height of the 2d file.
2D Raster Graphics
Version: 1.0 – 2011-12-13 PUBLIC 18 / 222
1.5 go_2d_rotate
Rotates an open 2D image in an anti-clockwise direction by the specified angle.
Parameter Name Parameter Type Parameter Description
angle integer The angle to rotate by, must be 90, 180 or 270. Possible Values
90 90
180 180
270 270
1.6 go_2d_save
Saves an open 2D image to a file in the specified format.
Parameter Name Parameter Type Parameter Description
filename filename Specify where to save the file.
fileformat string The 2d file type. eg, 'jpg', 'bmp'.
width integer The width in pixels of the image.
height integer The height in pixels of the image.
1.7 go_2d_save_fittopreserveaspectratio
Saves an open 2D image to a file in the specified format and preserves both the aspect ratio of the image and the canvas size of the output.
Parameter Name Parameter Type Parameter Description
filename filename Specifies the location to save the file.
fileformat string The 2d file type. eg, 'jpg', 'bmp'.
width integer The target width of the image.
height integer The target height of the image.
background integer The background color of the image.
transparency integer The background transparency level (0 is transparent, 100 is opaque).
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 19 / 222
2 2D Vector/3D Graphics
2.1 go_animation_setproperties
Sets specific properties for an animation range.
Parameter Name Parameter Type Parameter Description
animationrangeindex integer The index of the animation range.
starttime float Start Time(secs).
endtime float End Time(secs).
fps float Frames Per Second.
2.2 go_thumbnail_createanimated
Creates an animated GIF file thumbnail from the scene.
Parameter Name Parameter Type Parameter Description
outputfilename filename Output animation filename (optional if stream is provided).
outstream stream Output stream (optional if filename is provided).
width integer Width of the GIF file.
height integer Height of the GIF file.
axis integer Rotation axis. Can be x, y or z.Possible Values
X 0
Y 1
Z 2
frames integer Number of frames in animation.
delay integer Delay between frames of animation in milliseconds.
antialiasing integer Anti-Aliasing. Possible Values
None 0
2 x 2 1
3 x 3 2
4 x 4 3
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 20 / 222
2.3 go_object_assigndefaultmaterialtoall
Assigns the default material to all objects in a scene.
2.4 go_cadsearchpath_add
Sets additional search path for CAD plugins.
Parameter Name Parameter Type Parameter Description
path string Additional search path.
recurse boolean If true, check subdirectories for CAD files.
2.5 go_cadsearchpath_clear
Clears all additional paths for CAD plugins.
2.6 go_camera_setactiveparams
Sets the camera parameters for the the active camera.
Parameter Name Parameter Type Parameter Description
Camera string Accepts space delimited list of floats in following order: 16 for camera node 3d 4x4 row-major matrix, 1 for FOV, 3 for camera position, 3 for camera target coordinates, 3 for camera up vector,1 for camera aspect ratio, 1 for camera zoom factor and finally followed by 0 if the camera is orthographic.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 21 / 222
2.7 go_camera_setactivefov
Changes the active camera's field of view binding (minimum, maximum, horizontal, vertical) and angle.
Parameter Name Parameter Type Parameter Description
mode integer The field of view mode constant. 0=min, 1=max, 2=horizontal, 3=vertical. Possible Values
Minimum from Width/Height 0
Maximum from Width/Height 1
Horizontally 2
Vertically 3
fov float Field of view value in degrees (0-90).
2.8 go_camera_setactiveview
Changes the view of the active camera to a pre-defined view.
Parameter Name Parameter Type Parameter Description
View integer The camera view. Possible Values
Orthographic Left 1159
Orthographic Right 1160
Orthographic Top 1161
Orthographic Bottom 1162
Orthographic Front 1163
Orthographic Back 1164
30° Isometric LTF 11051
30° Isometric LTA 11052
30° Isometric RTA 11053
30° Isometric RTF 11054
30° Isometric LBF 11055
30° Isometric LBA 11056
27° Isometric RBA 11057
27° Isometric RBF 11058
27° Isometric LTF 11059
27° Isometric LTA 11060
27° Isometric RTA 11061
27° Isometric RTF 11062
45° Isometric LBF 11063
45° Isometric LBA 11064
45° Isometric RBA 11065
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 22 / 222
Parameter Name Parameter Type Parameter Description
45° Isometric RBF 11066
45° Isometric LTF 11067
45° Isometric LTA 11068
Dimetric RTA 11069
Dimetric RTF 11070
Dimetric LBF 11071
Dimetric LBA 11072
Dimetric RBA 11073
Dimetric RBF 11074
43°Trimetric LTF 11075
43°Trimetric LTA 11076
43°Trimetric RTA 11077
43°Trimetric RTF 11078
43°Trimetric LBF 11079
43°Trimetric LBA 11080
48°Trimetric RBA 11081
48°Trimetric RBF 11082
48°Trimetric LTF 11083
48°Trimetric LTA 11084
48°Trimetric RTA 11085
48°Trimetric RTF 11086
2.9 go_camera_setactiveprojectionmode
Toggles the perspective projection mode of the active camera.
Parameter Name Parameter Type Parameter Description
perspective boolean If true, set active camera projection mode to perspective, otherwise set to orthographic mode.
2.10 go_plugin_checklicense
Checks the licensing state of the specified plugin.
Parameter Name Parameter Type Parameter Description
pluginguid string GUID of plugin to check.
islicensed boolean Whether or not the plugin is licensed.
fileformatname string The name of the plugin file format, if found.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 23 / 222
2.11 go_object_deselectall
Clears the current object selection.
2.12 go_context_load
Loads the saved settings from an .xml file.
Parameter Name Parameter Type Parameter Description
filename filename The path to the file containing the saved context.
2.13 go_context_save
Creates and saves an .xml file that contains the settings used at run-time.
Parameter Name Parameter Type Parameter Description
filename filename Specifies where to save the file.
2.14 go_thumbnail_createstatic
Saves a scene as a 2D thumbnail file.
Parameter Name Parameter Type Parameter Description
width integer The width in pixels of the 2d file.
height integer The height in pixels of the 2d file.
infilename filename The name of the input file.
instream stream Input stream.
outfilename filename The name of the thumbnail.
outstream stream Thumbnail stream.
result boolean Result of operation.
2.15 go_fileformat_getall
Returns a list of the file formats for all current SAP Visual Enterprise Generator plugins.
Parameter Name Parameter Type Parameter Description
fileformats collectionparameter The collection of loaded plugins.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 24 / 222
2.16 go_scene_get2dmodeflag
Gets the current value of the 2d mode flag.
Parameter Name Parameter Type Parameter Description
current2dstate boolean Current value of 2d mode flag.
2.17 go_scene_getexternalfile
Gets an external file from the scene.
Parameter Name Parameter Type Parameter Description
filename string Name of the file in scene media folder.
outfilename filename The location of the file.
outstream stream Data stream.
2.18 go_fileformat_getbyguid
Gets the name of the file format matching a specified GUID.
Parameter Name Parameter Type Parameter Description
guid string File format/plugin GUID.
formatName string The name of the file format matching the specified GUID (if any).
2.19 go_plugin_getguidandlicensestatus
Retrieves the GUID and licensing status of a plugin using the file name of the plugin x3d file.
Parameter Name Parameter Type Parameter Description
pluginfilename string Filename (without full path and including extension - for example test.x3d ) of the plugin.
pluginguid string GUID of specified plugin.
islicensed boolean Whether or not the plugin is licensed.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 25 / 222
2.20 go_object_getselectedsurfacearea
Returns the surface area of the selected objects in the scene.
Parameter Name Parameter Type Parameter Description
surface double Surface area of selected objects.
2.21 go_object_getselectedvolume
Returns the volume of selected objects.
Parameter Name Parameter Type Parameter Description
volume double Volume of selected objects.
invertedvolume double The volume of the selected objects subtracted from the volume of the bounding box for the selected objects.
boundbox double The volume of the bounding box for the selected objects.
2.22 go_view_isorthographic
Determines whether the the projection mode of a view is perspective or orthographic.
Parameter Name Parameter Type Parameter Description
ViewId integer The id of the view to check.
IsOrtho boolean True if the view is orthographic, otherwise false.
2.23 go_layer_create
Creates a new layer in the scene.
Parameter Name Parameter Type Parameter Description
name string Name of the new layer.
objectid integer ID of the created layer object.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 26 / 222
2.24 go_layer_delete
Deletes a layer from the scene.
Parameter Name Parameter Type Parameter Description
name string Name of the layer. This is used to find the layer if 'objectid' is not specified.
objectid integer ID of the layer object.
2.25 go_layer_rename
Renames a layer in the scene.
Parameter Name Parameter Type Parameter Description
name string Name of the layer.
objectid integer ID of the layer object.
newname string Name of the layer. This is used to find the layer if 'objectid' is not specified.
2.26 go_layer_getall
Extracts information for all layers in the scene.
Parameter Name Parameter Type Parameter Description
objectcollection collectionparameter A collection of objects describing the object id, name and style of each layer found in the scene.
2.27 go_scene_getexternalfiles
Gets a list of external files from the scene.
Parameter Name Parameter Type Parameter Description
listoffiles collectionparameter A list of external media files in the scene.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 27 / 222
2.28 go_scene_getmaterials
Lists all the materials in the scene.
Parameter Name Parameter Type Parameter Description
materials collectionparameter List of materials in the scene.
scene_materials boolean Only list materials that are in use (applied to a mesh).
2.29 go_material_assign
Applies a specific material to the selected objects in the scene.
Parameter Name Parameter Type Parameter Description
materialname string Material name. Used to find the material if 'materialid' is not specified.
materialid integer Material object ID.
2.30 go_material_getparams
Gets the parameters for a particular material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
ambient integer Ambient light color.
diffuse integer Diffuse light color.
specular integer Specular light (reflection) color.
emissive integer Emissive light (glow) color.
opacity float Opacity of the material [0-100].
glossiness float Determines the model's highlighting [0-100].
speclevel float Intensity of the specular light [0-100].
reflection float Material's ability to reflect [0-100].
refraction float Determines how much light is bent when traveling through material [0-100].
doublesided boolean The double-sided attribute for the material.
rendoutlines boolean Render the thickness of outlines relative to the value of the 'linesvalue' parameter.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 28 / 222
linesvalue float Thickness of outlines if 'rendoutlines' parameter is set to True [0-100].
2.31 go_material_gettexture
Gets a specific texture definition for a specified material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
mapid integer Texture map id. Possible Values
Diffuse 0
Bump 1
Opacity 2
Reflection 3
Refraction 4
Specular 5
Ambient 6
Self Illumination 7
Specular Level 8
Glossiness 9
Ambient Occlusion 10
MAP #11 11
MAP #12 12
MAP #13 13
MAP #14 14
MAP #15 15
MAP #16 16
MAP #17 17
MAP #18 18
MAP #19 19
MAP #20 20
MAP #21 21
MAP #22 22
MAP #23 23
MAP #24 24
MAP #25 25
texture materialtextureparameter Material texture definition.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 29 / 222
2.32 go_material_import
Imports materials from an RHM file into the scene.
Parameter Name Parameter Type Parameter Description
filename filename Materials file.
materialsloaded collectionparameter A collection of objects describing the object id and name of each imported material.
2.33 go_material_setambientcolor
Sets the ambient color of a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
ambient integer Material ambient color.
2.34 go_material_setdiffusecolor
Sets the diffuse color for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
diffuse integer Material diffuse color.
2.35 go_material_setdoublesidedflag
Sets the doublesided parameter for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
doublesided boolean Material double sided flag.
2.36 go_material_setemissivecolor
Sets the emissive color for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
emissive integer Material emissive color.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 30 / 222
2.37 go_material_setglossinesslevel
Sets the glossiness parameter for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
glossiness float Material glossiness level [0-100].
2.38 go_material_setopacitylevel
Sets the opacity level for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
opacity float Material opacity level [0-100].
2.39 go_material_setoutlinethickness
Sets the render outlines parameter for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
rendoutlines boolean Material render outline flag.
linesvalue float Material outline thickness [0-100].
2.40 go_material_setparams
Sets the parameters for a material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
ambient integer Ambient light color.
diffuse integer Diffuse light color.
specular integer Specular light (reflection) color.
emissive integer Emissive light (glow) color.
opacity float Opacity of the material [0-100].
glossiness float Determines the model's highlighting [0-100].
speclevel float Intensity of the specular light [0-100].
reflection float Material's ability to reflect [0-100].
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 31 / 222
Parameter Name Parameter Type Parameter Description
refraction float Determines how much light is bent when travelling through material [0-100].
doublesided boolean The double-sided attribute for the material.
rendoutlines boolean Render the thickness of outlines relative to the value of the 'linesvalue' parameter.
linesvalue float Thickness of outlines if 'rendoutlines' parameter is set to True [0-100].
2.41 go_material_setreflectionlevel
Sets the reflection parameter of the material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
reflection float Material reflection level [0-100].
2.42 go_material_setrefractionlevel
Sets the refraction level parameter of the material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
refraction float Material refraction level [0-100].
2.43 go_material_setspecularlevel
Sets the specular level parameter of the material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
speclevel float Material specular level [0-100].
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 32 / 222
2.44 go_material_setspecularcolor
Sets the specular color parameter of the material.
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
specular integer Material specular color.
2.45 go_material_settexture
Sets a texture for a specific material .
Parameter Name Parameter Type Parameter Description
materialid integer Material object id.
mapid integer Texture object id. Possible Values
Diffuse 0
Bump 1
Opacity 2
Reflection 3
Refraction 4
Specular 5
Ambient 6
Self Illumination 7
Specular Level 8
Glossiness 9
Ambient Occlusion 10
MAP #11 11
MAP #12 12
MAP #13 13
MAP #14 14
MAP #15 15
MAP #16 16
MAP #17 17
MAP #18 18
MAP #19 19
MAP #20 20
MAP #21 21
MAP #22 22
MAP #23 23
MAP #24 24
MAP #25 25
texture materialtextureparameter Material texture object.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 33 / 222
2.46 go_material_setwireframelinewidth
Sets wireframe line width for all materials in the scene.
Parameter Name Parameter Type Parameter Description
wireframelinewidth float Wireframe line width to be applied to materials (>0).
2.47 go_scene_mergeduplicatematerials
Merges any duplicate materials in the scene.
2.48 go_scene_mergefile
Merges the specified 3D or 2D vector file into the current scene.
Parameter Name Parameter Type Parameter Description
filename filename Specifies the location of the file to merge with the current scene.
createfilenode boolean Specifies whether a containing node with the filename should be created.
objectpath collectionparameter Output parameter. List of paths for loaded objects.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 34 / 222
2.49 go_scene_mergetransformedfile
Merges the specified 3D or 2D vector file into the current scene, applying a transformation matrix to the imported geometry.
Parameter Name Parameter Type Parameter Description
filename filename Specifies the location of the file to merge with the current scene.
transformationstring string Specifies the transformation matrix to apply to the imported geometry.
createfilenode boolean Specifies whether a containing node with the filename should be created.
objectpath collectionparameter Output parameter. List of paths for loaded objects.
partid integer PartId that will be written in the node's metadata and used for instancing. Should be numeric.
instanceid integer InstanceId that will be written in the node's metadata and used for instancing. Should be numeric.
instancename string Specifies the name that will be set on the new node(s). If empty will keep original node names.
assettypeid integer Type of asset (Part|Sub-assembly).
createastopnode boolean If true all existing nodes will be children of merged file.
2.50 go_scene_getmetadata
Extracts metadata information from the current scene.
Parameter Name Parameter Type Parameter Description
metadataobject metadataparameter The extracted scene metadata.
externalfiles collectionparameter External files.
2.51 go_scene_open
Opens a 3D or 2D vector file, creating a new scene (any existing scene is discarded).
Parameter Name Parameter Type Parameter Description
filename filename The location of the file to open.
createfilenode boolean Specifies whether a containing node with the filename should be created.
warnings collectionparameter A collection of warning messages returned from the plugin.
warningsareerrors boolean Specifies whether operation should fail when warning messages are returned from the plugin.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 35 / 222
2.52 go_scene_openwithplugin
Opens a 3D or 2D vector file with a specified plugin, creating a new scene (any existing scene is discarded).
Parameter Name Parameter Type Parameter Description
filename filename The location of the file to open.
plugin string The GUID of the plugin to use when opening.
createfilenode boolean Specifies whether a containing node with the filename should be created.
warnings collectionparameter A collection of warning messages returned from the plugin.
warningsareerrors boolean Specifies whether operation should fail when warning messages are returned from the plugin.
loadmetadataonly boolean Specifies whether operation should load only metadata in scene hierarchy, without any geometry.
2.53 go_scene_openempty
Creates an empty 3D scene. Use in conjunction with go_mergefile to create new scenes.
Parameter Name Parameter Type Parameter Description
assetid integer If the AssetID is specified, the asset Id value will be set for the the empty scene.
2.54 go_render_raytrace
Saves a 2D view of a scene to a file using a raytrace rendering method.
Parameter Name Parameter Type Parameter Description
width integer The width in pixels of the 2d file.
height integer The height in pixels of the 2d file.
dpi integer Bitmap resolution (in DPI).
filename filename The name of the file.
fileformat string The 2d file format of the saved file.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 36 / 222
Parameter Name Parameter Type Parameter Description
bitmapformat integer Bitmap format (bits/pixel). Possible Values
RGB [8 bit per channel] 24
RGBA [8 bt per channel] 32
RGB [16 bit per channel] 48
RGBA [16 bit per channel] 64
RGBA [floating point HDR image] 128
antialiasing integer Anti-Aliasing. Possible Values
None 0
Adaptive 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
6 x 6 6
7 x 7 7
8 x 8 8
filtertexturemaps boolean Filter Texture Maps.
forcetwosidedpolygons boolean Force 2-sided Polygons.
shadows boolean Shadows.
softshadows boolean Soft Shadows.
raytracereflections boolean Raytrace Reflections.
raytracerefraction boolean Raytrace Refraction.
multithreading boolean Raytrace Multi-threading.
2.55 go_scene_removeexternalfile
Removes an external file from the scene.
Parameter Name Parameter Type Parameter Description
filename filename The name of the media file.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 37 / 222
2.56 go_object_removebytype
Removes all instances of a specific type of object from the scene.
Parameter Name Parameter Type Parameter Description
objecttype integer The type of object to remove. Possible Values
Object 1
Mesh 1
Material 2
Light 3
Camera 4
Bone 6
Markup 7
Procedural 8
2.57 go_object_removeselected
Removes the selected nodes from the scene.
2.58 go_scene_removeunusedmaterials
Removes any unused materials.
2.59 go_scene_resettransform
Resets transformation matrixes in all top level object to identity.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 38 / 222
2.60 go_scene_save
Saves the current scene to a file in the specified format.
Parameter Name Parameter Type Parameter Description
filename filename Specifies where to save the file.
fileformat string The format to save the file in. eg. rh, 3ds.
options integer Objects to save: all, visible only or selected only. Possible Values
Save all 0
Save visible only 1
Save selected only 2
2.61 go_scene_getanimations
Retrieves all animation sequences in the scene.
Parameter Name Parameter Type Parameter Description
animationranges collectionparameter Holds the collection of animation sequences.
2.62 go_scene_zoom
Sets the scene's zoom factor.
Parameter Name Parameter Type Parameter Description
Zoom integer The new zoom setting. Possible Values
Default View 0
View To Visible Objects 1
View To All Objects 2
View To Selected Objects 3
2.63 go_object_selectall
Selects or deselects all objects in the scene.
Parameter Name Parameter Type Parameter Description
select boolean True to select, false to deselect.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 39 / 222
2.64 go_object_selectbymetadata
Selects the first object (if any) in the scene that has the specified metadata value.
Parameter Name Parameter Type Parameter Description
name string Metadata name.
value string Metadata value.
category string Metadata category.
includehidden boolean Include hidden.
2.65 go_plugin_selectforfile
Selects the plugin to use to open a particular file.
Parameter Name Parameter Type Parameter Description
filename filename The file name to open.
stream stream Unused.
guid string GUID of selected plugin.
name string Name of selected plugin.
assemblyheirarchyxmltype string Unused.
enginefiletype string The graphics engine classification for this file. possible values ft3D, ft2D, ftTypeUnknown.
2.66 go_camera_settodefaultview
Sets the active camera view to the default camera position.
2.67 go_markup_setvisibilityforall
Shows or hides all markup elements.
Parameter Name Parameter Type Parameter Description
Show Markups boolean True to show markups, false to hide markups.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 40 / 222
2.68 go_object_setmetadatawithtype
Sets a single user or system metadata property value on an object in the scene.
Parameter Name Parameter Type Parameter Description
ObjectPath string The path to the object for which this metadata will be applied. If unspecified, the metadata is applied to all top level objects in the scene.
SystemMetadata boolean True to set system metadata, False to set user metadata.
MetadataGroup string The metadata group/category.
MetadataProperty string The property key of the metadata being set.
MetadataType string The data type of the metadata being set.
MetadataValue string The property value of the metadata being set.
ObjectType integer When set to Node (0), metadata is attached to the object specified by the object path. When set to Reference (1) metadata is attached to all instances of the object specified by the object path. Possible Values
Node 0
Reference 1
2.69 go_object_setmetadata
Assigns the metadata key specified to a single object within a scene.
Parameter Name Parameter Type Parameter Description
objectpath string Path that uniquely identifies this object.
category string Metadata category.
keyname string Metadata key name.
keyvalue string Metadata key value.
objecttype integer Node: metadata is attached to the node determined by the object path. Reference: metadata is attached to all instances of the object. Possible Values
Node 0
Reference 1
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 41 / 222
2.70 go_object_setname
Assigns a display name to a single object within a scene.
Parameter Name Parameter Type Parameter Description
objectpath string Path that uniquely identifies this object.
objectname string Name to be set.
2.71 go_viewport_setsize
Sets the size (in pixels) of the active viewport.
Parameter Name Parameter Type Parameter Description
width integer Required output width.
height integer Required output height.
2.72 go_scene_setviewaxis
Sets the view axis for the current scene.
Parameter Name Parameter Type Parameter Description
ViewUp string Defines the xyz-axis to be used for the up orientation of the scene.
ViewRight string Defines the xyz-axis to be used for the right orientation of the scene.
2.73 go_setting_setfloat
Sets the value of a plugin floating point setting.
Parameter Name Parameter Type Parameter Description
plugin string The name of the plugin.
key string The name of the setting.
value float The value to use.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 42 / 222
2.74 go_setting_setinteger
Sets the value of a plugin integer setting.
Parameter Name Parameter Type Parameter Description
plugin string The name of the plugin.
key string The name of the setting.
value integer The value to use.
2.75 go_setting_setstring
Sets the value of a plugin string setting.
Parameter Name Parameter Type Parameter Description
plugin string The name of the plugin.
key string The name of the setting.
value string The value to use.
2.76 go_viewport_setmetadata
Set a metadata field on a viewport.
Parameter Name Parameter Type Parameter Description
viewportobjectid integer The viewport object id.
category string The metadata category.
fieldname string The metadata field name.
fieldvalue string The metadata field value.
path string The metadata path.
subid string The SubId.
datatype string The data type.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 43 / 222
2.77 go_step_export
Exports a step or procedure from the scene.
Parameter Name Parameter Type Parameter Description
objectid integer Step or procedure ID.
filename filename Full path to the output file. Can be *.AVI or any other supported bitmap file format. In case of bitmap file this operation will create one file per frame of animation.
width integer Output width.
height integer Output height.
subtitles boolean Set to True to include subtitles.
result boolean Result of operation.
2.78 go_step_getall
Lists all the steps and procedures in the scene.
Parameter Name Parameter Type Parameter Description
procedures collectionparameter The steps and procedures found in the scene.
2.79 go_scene_transform
Applies the transformation information into an open scene.
Parameter Name Parameter Type Parameter Description
transformationstring string Specifies the transformation matrix.
replacematrix boolean TRUE to replace scene matrix, FALSE to multiply them.
2.80 go_viewport_getall
Extracts all views from scene.
Parameter Name Parameter Type Parameter Description
objectcollection collectionparameter Holds a collection of object names.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 44 / 222
2.81 go_viewport_setactive
Sets a viewport as the active viewport.
Parameter Name Parameter Type Parameter Description
name string Name of the viewport. Used to find the vieport if 'objectid' is not specified.
objectid integer ID of the viewport object.
2.82 go_object_setvisibility
Sets the visibility status for the selected objects.
Parameter Name Parameter Type Parameter Description
visible boolean The visibility status. True for visible, False for hidden.
recursechildren boolean Apply visible status recursively to child nodes.
2.83 go_scene_getxreferences
Extracts cross-reference information for all texture files associated with a scene.
Parameter Name Parameter Type Parameter Description
collection collectionparameter Holds a collection of cross-reference parameters.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 45 / 222
2.84 go_render_zbuffer
Saves a 2D view of a scene to a file using a Z-buffer rendering method.
Parameter Name Parameter Type Parameter Description
width integer The width in pixels of the 2d file.
height integer The height in pixels of the 2d file.
dpi integer Resolution of output image (in DPI).
filename filename The name of the file.
fileformat string The 2d file format of the saved file.
bitmapformat integer Bitmap format (in bits/pixel). Possible Values
RGB [8 bit per channel] 24
RGBA [8 bt per channel] 32
RGB [16 bit per channel] 48
RGBA [16 bit per channel] 64
RGBA [floating point HDR image]
128
rendermode integer The rendering mode. Possible Values
Bounding Box 1
Transparent bounding box 2
Transparent bounding box outline
3
Vertices 4
Shaded Vertices 5
Wireframe 6
Shaded Wireframe 7
Solid 8
Transparent 9
Solid Wireframe 10
Transparent Wireframe 11
Line Illustration 12
Solid Outline 13
Shaded Illustration 14
Hidden Wireframe 15
antialiasing integer Anti-Aliasing. Possible Values
None 0
2 x 2 1
3 x 3 2
4 x 4 3
renderadditnlitems boolean Render Additional Items.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 46 / 222
2.85 goc_bounding_box
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Bounding_box_of_all_objects integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 47 / 222
2.86 goc_hidden_wireframe
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
Outline_width float No Description Provided.
Lines_in_Line_Illustration_mode integer No Description Provided.
Faces_in_Line_Illustration_mode integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 48 / 222
2.87 goc_line_illustration
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
Outline_width float No Description Provided.
Outline_angle float No Description Provided.
Lines_in_Line_Illustration_mode integer No Description Provided.
Faces_in_Line_Illustration_mode integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 49 / 222
2.88 goc_sceneproperties
Parameter Name Parameter Type Parameter Description
Material_Override_Ambient integer No Description Provided.
none integer No Description Provided.
Scene_Up_Axis integer No Description Provided. Possible Values:
Z 0
Y 4
No Change 6
Ambient_percentage float No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Specular boolean No Description Provided.
Environment_Gamma float No Description Provided.
Material_Override_Diffuse integer No Description Provided.
Show_Cross_Section boolean No Description Provided.
Use_Default_Material boolean No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
Smoothing_angle_ float No Description Provided.
Outline_width float No Description Provided.
Show_Textures boolean No Description Provided.
Use_existing_lights boolean No Description Provided.
Global_ambient_color integer No Description Provided.
Bone_affect_area___Maximum__ integer No Description Provided.
Specular_percentage float No Description Provided.
Wire_grid integer No Description Provided.
Solid_grid_dark_cell integer No Description Provided.
Environment_Exposure float No Description Provided.
Material_Override_Emission integer No Description Provided.
N2D_Files_Background integer No Description Provided.
Output_Size_border__margin integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 50 / 222
Parameter Name Parameter Type Parameter Description
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Vertex-cross_color integer No Description Provided.
Transparent_grid_dark_cell integer No Description Provided.
Viewport_labels integer No Description Provided.
Subdivision_control_mesh integer No Description Provided.
Y_axis integer No Description Provided.
Vertices_in_Vertices_mode integer No Description Provided.
Lines_in_Shaded_Illustration_mode integer No Description Provided.
Default_material_emissive_color integer No Description Provided.
Default_material_diffuse_color integer No Description Provided.
Bounding_box_of_scene integer No Description Provided.
Position integer No Description Provided. Possible Values
Auto 0
Offset 1
Absolute Position 2
Custom_Position float No Description Provided.
Border_of_selected_face integer No Description Provided.
Current_Auto_Position float No Description Provided.
Selection_highlight integer No Description Provided.
Bones integer No Description Provided.
Default_material_specular_color integer No Description Provided.
Bounding_box_of_all_objects integer No Description Provided.
Illustration_background_bottom integer No Description Provided.
Cutting_plane integer No Description Provided.
Blur_Radius integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 51 / 222
Parameter Name Parameter Type Parameter Description
Image_Size integer No Description Provided. Possible Values
64 64
128 128
256 256
512 512
1024 1024
2048 2048
Illustration_Viewport_labels integer No Description Provided.
Lines_in_Line_Illustration_mode integer No Description Provided.
Render_Method integer No Description Provided. Possible Values
Bounding box 1
Transparent bounding box 2
Transparent bounding box outline 3
Vertices 4
Shaded Vertices 5
Wireframe 6
Shaded Wireframe 7
Solid 8
Transparent 9
Solid Wireframe 10
Transparent Wireframe 11
Line Illustration 12
Solid Outline 13
Shaded Illustration 14
Hidden Wireframe 15
Global_illumination_color integer No Description Provided.
Material_Override_Specular integer No Description Provided.
Show_Markups boolean No Description Provided.
Show_Transparency boolean No Description Provided.
Double-sided boolean No Description Provided.
Opacity float No Description Provided.
Show_Intersections boolean No Description Provided.
Outline_angle float No Description Provided.
Show_Scene_Bounding_Box boolean No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 52 / 222
Parameter Name Parameter Type Parameter Description
Light_type integer No Description Provided. Possible Values
No Lights 35
White Lights 35
Day Light 35
Hard Lights 35
Colored Lights Red/Green 35
Colored Lights Blue/Green 35
Blue Lights 35
Marsiano Lights 35
Cube Lights 35
CAD Optimized Lights 35
Single Light From Eye 35
Emission_percentage float No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Smoothing boolean No Description Provided.
Transparent_grid_light_cell integer No Description Provided.
Selected_faces integer No Description Provided.
Transparent_bounding_box integer No Description Provided.
Shadow boolean No Description Provided.
Diffuse_percentage float No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Output_size_outer_area integer No Description Provided.
Non_Output_Size_area integer No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Bones boolean No Description Provided.
Use_Existing_Smoothing boolean No Description Provided.
Shadow integer No Description Provided.
Bone_influence_area integer No Description Provided.
X_axis integer No Description Provided.
Bounding_box_of_selected_objects integer No Description Provided.
Illustration_detailed_view_border integer No Description Provided.
Faces_in_Line_Illustration_mode integer No Description Provided.
Fog integer No Description Provided.
Lines_in_Solid_or_Transparent_mode integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 53 / 222
Parameter Name Parameter Type Parameter Description
Background_top integer No Description Provided.
Detailed_view_border integer No Description Provided.
Render_Exposure float No Description Provided.
Environment_Rotation float No Description Provided.
Render_Gamma float No Description Provided.
Bone_affect_area___Minimum__ integer No Description Provided.
Cross_section_outline integer No Description Provided.
Z_axis integer No Description Provided.
Solid_grid_light_cell integer No Description Provided.
Background_bottom integer No Description Provided.
Surface_normals integer No Description Provided.
Default_material_ambient_color integer No Description Provided.
Lines_in_Wireframe_mode integer No Description Provided.
Illustration_background_top integer No Description Provided.
2.89 goc_shaded_illustration
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 54 / 222
Parameter Name Parameter Type Parameter Description
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Use_existing_lights boolean No Description Provided.
Smoothing_angle_ float No Description Provided.
Use_Existing_Smoothing boolean No Description Provided.
Smoothing boolean No Description Provided.
Use_Default_Material boolean No Description Provided.
Show_Transparency boolean No Description Provided.
Show_Textures boolean No Description Provided.
Light_type integer No Description Provided. Possible Values
No Lights 35
White Lights 35
Day Light 35
Hard Lights 35
Colored Lights Red/Green 35
Colored Lights Blue/Green 35
Blue Lights 35
Marsiano Lights 35
Cube Lights 35
CAD Optimized Lights 35
Single Light From Eye 35
Specular boolean No Description Provided.
Global_ambient_color integer No Description Provided.
Global_illumination_color integer No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
Material_Override_Ambient integer No Description Provided.
Material_Override_Diffuse integer No Description Provided.
Material_Override_Specular integer No Description Provided.
Material_Override_Emission integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 55 / 222
Parameter Name Parameter Type Parameter Description
Outline_width float No Description Provided.
Outline_angle float No Description Provided.
Ambient_percentage float No Description Provided.
Diffuse_percentage float No Description Provided.
Specular_percentage float No Description Provided.
Emission_percentage float No Description Provided.
Lines_in_Line_Illustration_mode integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 56 / 222
2.90 goc_shaded_vertices
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 57 / 222
2.91 goc_shaded_wireframe
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 58 / 222
2.92 goc_solid
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Use_existing_lights boolean No Description Provided.
Smoothing_angle_ float No Description Provided.
Use_Existing_Smoothing boolean No Description Provided.
Smoothing boolean No Description Provided.
Use_Default_Material boolean No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 59 / 222
Parameter Name Parameter Type Parameter Description
Show_Transparency boolean No Description Provided.
Show_Textures boolean No Description Provided.
Light_type integer No Description Provided. Possible Values
No Lights 35
White Lights 35
Day Light 35
Hard Lights 35
Colored Lights Red/Green 35
Colored Lights Blue/Green 35
Blue Lights 35
Marsiano Lights 35
Cube Lights 35
CAD Optimized Lights 35
Single Light From Eye 35
Specular boolean No Description Provided.
Global_ambient_color integer No Description Provided.
Global_illumination_color integer No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 60 / 222
2.93 goc_solid_outline
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Use_existing_lights boolean No Description Provided.
Smoothing_angle_ float No Description Provided.
Use_Existing_Smoothing boolean No Description Provided.
Smoothing boolean No Description Provided.
Use_Default_Material boolean No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 61 / 222
Parameter Name Parameter Type Parameter Description
Show_Transparency boolean No Description Provided.
Show_Textures boolean No Description Provided.
Light_type integer No Description Provided. Possible Values
No Lights 35
White Lights 35
Day Light 35
Hard Lights 35
Colored Lights Red/Green 35
Colored Lights Blue/Green 35
Blue Lights 35
Marsiano Lights 35
Cube Lights 35
CAD Optimized Lights 35
Single Light From Eye 35
Specular boolean No Description Provided.
Global_ambient_color integer No Description Provided.
Global_illumination_color integer No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
Outline_width float No Description Provided.
Outline_angle float No Description Provided.
Lines_in_Line_Illustration_mode integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 62 / 222
2.94 goc_solid_wireframe
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 63 / 222
2.95 goc_transparent
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Use_existing_lights boolean No Description Provided.
Smoothing_angle_ float No Description Provided.
Use_Existing_Smoothing boolean No Description Provided.
Smoothing boolean No Description Provided.
Use_Default_Material boolean No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 64 / 222
Parameter Name Parameter Type Parameter Description
Show_Textures boolean No Description Provided.
Light_type integer No Description Provided. Possible Values
No Lights 35
White Lights 35
Day Light 35
Hard Lights 35
Colored Lights Red/Green 35
Colored Lights Blue/Green 35
Blue Lights 35
Marsiano Lights 35
Cube Lights 35
CAD Optimized Lights 35
Single Light From Eye 35
Specular boolean No Description Provided.
Global_ambient_color integer No Description Provided.
Global_illumination_color integer No Description Provided.
Show_Back-Facing_Geometry boolean No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 65 / 222
2.96 goc_transparent_bounding_box
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Transparent_bounding_box integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 66 / 222
2.97 goc_transparent_bounding_box_outline
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
Bounding_box_of_all_objects integer No Description Provided.
Transparent_bounding_box integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 67 / 222
2.98 goc_transparent_wireframe
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 68 / 222
2.99 goc_vertices
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
2D Vector/3D Graphics
Version: 1.0 – 2011-12-13 PUBLIC 69 / 222
2.100 goc_wireframe
Parameter Name Parameter Type Parameter Description
Scene_Up_Axis integer No Description Provided. Possible Values
Z 0
Y 4
No Change 6
Set_Grid_Mode integer No Description Provided. Possible Values
No Grid 0
Wire Grid 1
Solid Grid 2
Transparent Grid 3
Grid_size integer No Description Provided. Possible Values
1 x 1 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
7 x 7 7
10 x 10 10
15 x 15 15
Show_Scene_Bounding_Box boolean No Description Provided.
Show_Scene_Axes boolean No Description Provided.
Show_Cameras_and_Lights boolean No Description Provided.
Show_Vertices boolean No Description Provided.
Show_Cross_Section boolean No Description Provided.
Show_Intersections boolean No Description Provided.
Shadow boolean No Description Provided.
Show_Markups boolean No Description Provided.
Show_Bones boolean No Description Provided.
Show_Depth_Cue boolean No Description Provided.
Background_top integer No Description Provided.
Background_bottom integer No Description Provided.
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 70 / 222
3 File/Directory/Path
3.1 do_directory_attributes
Retrieves file system attributes for the specified directory.
Parameter Name Parameter Type Parameter Description
directoryname string The name of the directory.
readonly boolean True if the readonly flag is set for the directory, otherwise false.
archive boolean True if the archive flag is set for the directory, otherwise false.
system boolean True if the system flag is set for the directory, otherwise false.
hidden boolean True if the hidden flag is set for the directory, otherwise false.
compressed boolean True if the compressed flag is set for the directory, otherwise false.
creationtime string Returns the creation time as reported by the operating system.
lastwritetime string Returns the last write time as reported by the operating system.
3.2 po_path_combine
Creates a new path to a directory or file by combining two paths.
Parameter Name Parameter Type Parameter Description
basedirectory string The directory on which the new path is based. This must start with a drive letter or be a UNC path.
combinewith string The path to a file or directory. This must NOT start with a drive letter or be a UNC path.
resultpath string The combination of the base directory with the path to a file or directory.
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 71 / 222
3.3 do_directory_copy
Copies a directory to a different destination. If 'overwrite' is set to true, existing files will be overwritten.
Parameter Name Parameter Type Parameter Description
from string The location of the directory to be copied.
to string The destination directory where the directory is to be copied to.
overwrite boolean Set to true to overwrite the files that already exist.
recurse boolean Set to true to copy sub-directories.
3.4 do_directory_create
Creates a file system directory.
Parameter Name Parameter Type Parameter Description
directoryname string Full path to the directory to create.
3.5 do_directory_delete
Deletes a file system directory.
Parameter Name Parameter Type Parameter Description
directoryname string The name of the directory to delete.
recurse boolean Set to true to recurse sub-directories.
3.6 do_directory_deletefiles
Deletes selected files from within a directory.
Parameter Name Parameter Type Parameter Description
directory string The directory where the files are going to be deleted.
pattern string The search pattern to match files that are to be deleted.
recurse boolean If True, recurse sub directories.
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 72 / 222
3.7 do_directory_exists
Tests to see whether or not a directory exists.
Parameter Name Parameter Type Parameter Description
directoryname string The name of the directory that is to be tested for existance.
exists boolean True if the directory exists, otherwise false.
3.8 do_directory_getdirectories
Returns the names of all directories matching a search pattern in the specified directory.
Parameter Name Parameter Type Parameter Description
directory string The directory to search in.
match string The search pattern to use for finding directories.
recurse boolean Set to true to search sub-directories.
directories collectionparameter The matching directories found.
3.9 do_directory_getfiles
Returns the names of all files matching a search pattern in the specified directory.
Parameter Name Parameter Type Parameter Description
directory string The directory to search in.
match string The search pattern to use for finding files.
recurse boolean Set to true to search sub-directories.
files collectionparameter The matching files found.
3.10 do_directory_move
Moves a directory to a new location.
Parameter Name Parameter Type Parameter Description
from string The location of the directory to move.
to string The location to move the directory to.
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 73 / 222
3.11 fo_file_findtext
Searches for text in a file.
Parameter Name Parameter Type Parameter Description
filename filename The file to look in.
texttofind string The text to find.
exists boolean True if the text was found.
3.12 fo_file_append
Appends data to a specified file.
Parameter Name Parameter Type Parameter Description
data string String to be appended to the end of the file.
filename filename The file to write the data to.
3.13 fo_file_getattributes
Retrieves file system attributes for a specified file.
Parameter Name Parameter Type Parameter Description
filename filename The name of the file.
readonly boolean True if the readonly flag is set for the file, otherwise false.
archive boolean True if the archive flag is set for the file, otherwise false.
system boolean True if the system flag is set for the file, otherwise false.
hidden boolean True if the hidden flag is set for the file, otherwise false.
compressed boolean True if the compressed flag is set for the file, otherwise false.
length integer Returns the length of the file in bytes.
creationtime string Returns the file creation time as reported by the operating system.
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 74 / 222
3.14 po_path_buildfilename
Builds a path from a combination of parts (directory, filename, filename without extension, extension, root)
Parameter Name Parameter Type Parameter Description
FileNameParts filename The parts of the file name.
FileName string The built file name.
3.15 fo_file_copy
Copies a file. If 'overwrite' is set to true, any existing file will be overwritten.
Parameter Name Parameter Type Parameter Description
from filename The location of the file to be copied.
to filename The location the file is to be copied to.
overwrite boolean If true, the target file will be overwritten if it already exists.
3.16 fo_fileordirectory_create
Creates a new file system file or directory.
Parameter Name Parameter Type Parameter Description
isfile boolean Set to true if this is a file or false if a directory.
filename filename Full path to the file or directory to create.
3.17 do_directory_createworkspacetempdir
Creates a new temporary folder under a workspace folder and returns the full path.
Parameter Name Parameter Type Parameter Description
tempfolder string Returns full path of the temporary folder under workspace folder.
uselocalworkspace boolean If true, the temporary folder will be created in the local workspace (on the local server), otherwise it will be created in the global workspace (in the Visual Enterprise Generator share).
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 75 / 222
3.18 fo_file_delete
Deletes an file system file.
Parameter Name Parameter Type Parameter Description
filename filename The file to delete.
3.19 fo_file_delete_with_retry
Delete a file from disk, with exponential backoff on failure
Parameter Name Parameter Type Parameter Description
FileName filename The file to delete.
MaxRetries integer Maximum number of retries.
3.20 fo_file_exists
Tests to see whether or not a file exists.
Parameter Name Parameter Type Parameter Description
filename filename The name of the file that is to be tested for existence.
exists boolean True if the file exists otherwise false.
3.21 fo_file_move
Moves a file to a new location.
Parameter Name Parameter Type Parameter Description
from filename The location of the file to move.
to filename The location to move the file to.
3.22 po_path_resolveunc
Checks whether a UNC Path resides on a local drive, and returns the local path.
Parameter Name Parameter Type Parameter Description
uncpath string The UNC path to be resolved.
localpath string The local path if it could be resolved.
resolved boolean True if the UNC path could be resolved to a local path.
File/Directory/Path
Version: 1.0 – 2011-12-13 PUBLIC 76 / 222
3.23 fo_file_savefromstring
Saves a string to a file. If the file already exists it will be overwritten.
Parameter Name Parameter Type Parameter Description
filename filename Output file name.
data string Data to save.
3.24 fo_file_gettempname
Generates a unique temporary file name. This operation replaces the 'namewithoutextension' part of the 'fromfilename' with a system generated GUID.
Parameter Name Parameter Type Parameter Description
fromfilename filename The parameter that identifies a file name to base the temporary file name on.
tempfilename filename The generated temporary file name.
3.25 fo_file_unzip
Extracts ZIP archive to specified location.
Parameter Name Parameter Type Parameter Description
filename filename The zip file to open.
location string The destination folder path.
3.26 fo_file_zip
Creates ZIP archive in the specified location.
Parameter Name Parameter Type Parameter Description
foldername string Folder with files that will be zipped.
searchpattern string File search pattern. Multiple patterns must be separated by semicolon (*.bmp; *.jpg). *.* will include all files.
includesubfolders boolean If true will add files from subfolders.
filename filename ZIP archive name.
Flow Control
Version: 1.0 – 2011-12-13 PUBLIC 77 / 222
4 Flow Control
4.1 er_stopprocessing
Stops further processing.
Parameter Name Parameter Type Parameter Description
errmessage string Error message.
4.2 for-each
Performs specified operations for each object returned defined by an XPath expression. Note: One for-each operation cannot be the immediate child of another for-each operation.
Parameter Name Parameter Type Parameter Description
currentvalue object The current value of the foreach operation.
4.3 if
Processes one of two possible sets of child operations. The children of the 'then' branch are executed if the XPath condition evaluates to true, otherwise the children of the 'else' branch are executed..
4.4 pause
Pauses process execution for a specified number of seconds.
Parameter Name Parameter Type Parameter Description
seconds integer The number of seconds to pause.
Flow Control
Version: 1.0 – 2011-12-13 PUBLIC 78 / 222
4.5 set
Sets the value of a variable in the process.
Parameter Name Parameter Type Parameter Description
name string The variable name.
value string The value to set the variable to.
4.6 standarderror
Captures errors that occur while processing an operation and then determines the course of action to take.
Parameter Name Parameter Type Parameter Description
stacktrace string Output parameter. Will be populated with a stack trace for diagnostic purposes.
raisedby string Output parameter. Will be populated with the name of the operation that raised (threw) the error.
message string Output parameter. Will be populated with the associated error message.
action string Input parameter, set to either 'raise', 'continue' or 'exit'. If raise then the error is thrown to the next level where it may be handled. If 'continue' Visual Enterprise Generator will continue processing the next operation. If 'exit' Visual Enterprise Generator will exit the process. Possible Values
raise raise
continue continue
Flow Control
Version: 1.0 – 2011-12-13 PUBLIC 79 / 222
4.7 standardterminatehandler
Standard terminate handler
4.8 variable
Creates a process level global variable and sets its initial value.
Parameter Name Parameter Type Parameter Description
value string The value of the variable.
4.9 while
Processes its child operations repeatedly until the XPath condition evaluates to false.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 80 / 222
5 General Operations
5.1 guid_createnew
Creates a new GUID.
Parameter Name Parameter Type Parameter Description
createdguid string The created GUID.
5.2 datetime_tostring
Formats an input datetime string using the specified format string.
Parameter Name Parameter Type Parameter Description
inputstring datetime The input datetime to format. Set to 'now()' for current datetime or any valid datetime string format.
formatmask string The format mask, d = short date format, D = long date format, t = short time format, T = long time format, g = short date/short time. Search Microsoft help for 'Standard DateTime Format Strings' for more.
outputstring string The formatted output.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 81 / 222
5.3 email_send
Sends an email via an SMTP server.
Parameter Name Parameter Type Parameter Description
smtp string The address of the SMTP server that will send the email. eg. smtp.mydomain.com.
subject string The subject line of the email.
body string The body text of the email.
bodyformat integer The body format of the email. Possible Values
TEXT 0
HTML 1
from string The sender of the email. Some SMTP servers require that this is a valid email account on the SMTP server.
to string The email address(s) of the intended recipient of the email.
attachments string A semi colon delimited list of files to attach to the email message.
5.4 rhz_extractvzxml
Extracts the model.vzxml from the specified .RHZ file to specified file name.
Parameter Name Parameter Type Parameter Description
RhzFilePath filename RHZ File containing model.vzxml to extract.
OutputFilePath filename Fully qualified path to save the model.vzxml file to.
5.5 http_download
Download file from URL over HTTP protocol
Parameter Name Parameter Type Parameter Description
Url string Source URL.
FilePath filename Target file name.
StatusCode integer HTTP status code from download request.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 82 / 222
5.6 http_upload
Upload file to specified URL using HTTP protocol
Parameter Name Parameter Type Parameter Description
Url string Target URL.
FilePath filename Source file name.
ContentType string The MIME type of the file to be stored.
StatusCode integer HTTP status code from upload request.
5.7 log_add
Saves a message of a specified type to the log file.
Parameter Name Parameter Type Parameter Description
autoflush boolean True if the log should be automatically flushed and closed when all child operations are complete. If False then Save and Close should be explicitly called.
filename filename The log file path.
level integer The level of message to record. 0=Error, 1=warning, 2=info. If 0 only logs error message, 1 will log warnings and error messages, 2 logs error, warning and info messages. Possible Values
Error 0
Warning 1
Info 2
5.8 log_message
Logs a message to the log file.
Parameter Name Parameter Type Parameter Description
eventtype integer The type of error message, 'error' = 0, 'warning' = 1, 'info' = 2. Possible Values
Error 0
Warning 1
Info 3
message string The text to add to the log.
filename filename The external text file to add to the log if 'message' is not specified.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 83 / 222
5.9 log_save
Saves the log file to the specified location.
Parameter Name Parameter Type Parameter Description
filename filename The log file path.
5.10 xml_setvalue
Sets a text value in an XML file.
Parameter Name Parameter Type Parameter Description
filename filename XML file name.
propertyname string XPath expression to use to find node(s) to modify.
propertyvalue string Value to set as the node's inner text.
5.11 serverproperties_getall
Retrieves installation configuration information.
Parameter Name Parameter Type Parameter Description
smtp_server string Configured SMTP server.
GlobalWorkspace string Path to global farm workspace.
LocalWorkspace string Path to local server workspace.
InstallPath string Path where Visual Enterprise Generator is installed on the local server.
ServerId string Name of the processing engine running this process.
ServerVersion string Software version of the processing engine running this process.
5.12 xml_extract
Inserts the contents of an external XML document into the task results document.
Parameter Name Parameter Type Parameter Description
filename filename The name of the XML file to read.
data collectionparameter The XML elements that were read from the file, in the same structure as in the file.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 84 / 222
5.13 task_resultsdocument_tomsmq
Enqueues the task results document to an MSMQ queue.
Parameter Name Parameter Type Parameter Description
queuename string The MSMQ queue name.
label string The MSMQ message label.
5.14 task_resultsdocument_tofile
Writes the XML task results document to an external file.
Parameter Name Parameter Type Parameter Description
outputfile filename The name of the XML file to write the task results document to.
transformation string The name of the XSLT transformation file that will be used to format the XML (Optional).
5.15 pdf_headerfooter
Copies content of existing PDF and add header or footer.
Parameter Name Parameter Type Parameter Description
inputfile filename The location of the PDF template.
outputfile filename The resulting PDF file name path. Will be overwritten if already exists.
alignment string 'Left', 'Right', 'Center', 'Justify'. Where to align text in the header/footer.
pagenumbers boolean True if you want page numbers in header or footer.
headerorfooter string Placement on the document, 'HEADER' or 'FOOTER'.
textbefore string Text to be displayed before page number.
textafter string Text to be displayed after the page number. Valid only if pagenumbers = True.
lmargin integer Set left margin.
tmargin integer Set top margin.
rmargin integer Set right margin.
bmargin integer Set bottom margin.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 85 / 222
Parameter Name Parameter Type Parameter Description
font string Font name and optional style to use as comma separated. The font name should be first, and the style(s) following. E.g. 'Arial,bold'. Valid style entries include 'normal', 'bold', 'italic', 'oblique', 'underline', 'line-through'.
fontsize integer Font point size.
5.16 pdf_mergefiles
Merges PDF files using iTextSharp library, with options to create a table of contents and set a header for each page.
Parameter Name Parameter Type Parameter Description
filelist string List of files to be merged. Files must be separated by semicolon characters.
outfile filename The resulting PDF file name.
addtoc boolean Set to TRUE to add table of contents.
toctitle string Title of table of contents. This setting only applies if not using a table of contents template PDF document.
tocstartpercent integer The table of contents start. The percentage down the page (between 0 and 100) where the first table of contents row will begin. This setting only applies if a TOC template PDF is specified.
tocwidthpercent integer The table of contents width. A percentage of the width of the page (between 0 and 100). This setting only applies if a TOC template PDF is specified.
toctemplatefilename string Optional. A single page PDF document containing the table of contents to add to the output document.
totalpages integer The total number of pages in the resulting PDF file.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 86 / 222
5.17 pdf_templatemerge
Uses iTextSharp library to load the specified PDF template form and fill values for named fields.
Parameter Name Parameter Type Parameter Description
templatefile filename The location of the pdf template.
outputfile filename The output PDF file path. Will be overwritten if already exists.
fieldlist string A delimited list of field names and values.
namevaluedelimiter string The character between a field name and its corresponding value in the FieldList.
fielddelimiter string The character to separate name value pairs in the FieldList.
5.18 job_start
Starts a new job managed job.
Parameter Name Parameter Type Parameter Description
workflow string The name of the workflow to start a job for.
parentjobid integer The job ID of the parent job, if applicable.
name string The job name.
owner string The username of the job owner.
notification_email string The email address to notify when the job completes.
priority string The job priority (Normal, Low, High).
jobid integer The ID of the new job.
5.19 task_start
Sends single notification to initiate a process.
Parameter Name Parameter Type Parameter Description
queuename string The MSMQ queue name to send the notification to (Optional).
process string The name of the process to start.
processparams string The process trigger parameters, if any. Use the format <param1>value1</param1><param2>value2</param2>.
transactionalqueue boolean Whether or not the destination queue is a transactional queue.
priority string The priority of the process between 1 and 10, where 1 is the highest priority (Optional).
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 87 / 222
5.20 keyvaluepair_response_setvalue
Sets a key/value pair to be used in a SimpleResponse file.
Parameter Name Parameter Type Parameter Description
Name string The name of the value.
Value string The value to set.
5.21 os_shellexecute
Executes a shell command.
Parameter Name Parameter Type Parameter Description
command string The path to the file to execute.
arguments string The arguments to the command to execute. Tokens of the form %NAME% in this string will be replaced with the values of the parameter NAME.
timeout integer The number of milliseconds to wait for the process to finish, after which the process will be terminated (0 = no timeout).
returncode integer The exit code returned by the executed command.
5.22 keyvaluepair_response_writetofile
Writes a set of simple (key/value pair) results to a specified file.
Parameter Name Parameter Type Parameter Description
ResultsFile filename The destination file for the response.
5.23 keyvaluepair_trigger_loadfromfile
Reads a set of key/value pairs out of a file and stores the values in process variables.
Parameter Name Parameter Type Parameter Description
TriggerFile filename The path to a file containing trigger parameters to read.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 88 / 222
5.24 string_tokenize
Splits a string into tokens.
Parameter Name Parameter Type Parameter Description
inputstring string The input string.
delimiter string The token delimiter.
tokens collectionparameter A collection of tokens.
5.25 os_waitforosprocessexit
Waits for an operating system process to exit.
Parameter Name Parameter Type Parameter Description
processname string The name of the operating system process to wait for.
machinename string The host name or IP address of the machine that the operating system process is running on.
5.26 xml_attributeadd
Adds an attribute to an existing element in an existing XML file.
Parameter Name Parameter Type Parameter Description
xmlfilepath filename The path to the XML file to modify.
attributename string The name of the attribute to add.
attributenamespace string The namespace of the attribute to add.
attributevalue string The value of the attribute to add.
elementxpath string The XPath expression identifying the element to add the attribute to.
namespacemappings string A pipe '|' separated list of prefix=namespace pairs.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 89 / 222
5.27 xml_elementadd
Adds an element to an existing XML file.
Parameter Name Parameter Type Parameter Description
xmlfilepath filename The path to the XML file to modify.
elementname string The name of the element to add.
elementnamespace string The namespace of the element to add.
parentelementxpath string The XPath expression identifying the parent element of the element to be added.
elementposition integer An identifying the position of added element beneath its parent.
namespacemappings string A pipe '|' separated list of prefix=namespace pairs.
5.28 xml_elementcount
Returns the number of XML elements matched by an XPath expression.
Parameter Name Parameter Type Parameter Description
xmlfilepath filename The path of the XML file to read.
elementxpath string The XPath expression identifying the elements to find.
matchingelementcount integer The number of XML elements matching the XPath expression.
namespacemappings string A pipe '|' separated list of prefix=namespace pairs.
5.29 xml_elementexists
Returns whether an XPath expression can be resolved to a single XML element.
Parameter Name Parameter Type Parameter Description
xmlfilepath filename The path of the XML file to read.
elementxpath string The XPath expression identifying the element to find.
xmlelementexists boolean Returns whether the XPath expression matched a single XML element.
namespacemappings string A pipe '|' separated list of prefix=namespace pairs.
General Operations
Version: 1.0 – 2011-12-13 PUBLIC 90 / 222
5.30 xml_escapestring
Escapes invalid XML characters from the input string.
Parameter Name Parameter Type Parameter Description
input_string filename The input string.
output_string filename The escaped output string.
5.31 xml_getattributevalue
Adds an attribute to an existing element in an existing XML file.
Parameter Name Parameter Type Parameter Description
xmlfilepath filename The path of the XML file to read.
elementxpath string The XPath expression identifying the element to find.
attributename string The name of the attribute to find.
attributenamespace string The namespace of the attribute to find.
attributevalue string The value of the attribute.
namespacemappings string A pipe '|' separated list of prefix=namespace pairs.
5.32 xml_xslttransform
Applies and XSLT transformation to an XML file.
Parameter Name Parameter Type Parameter Description
xslt_filepath filename The path to the XSLT file to read.
input_filepath filename The path to the input XML file.
output_filepath filename The path to the output XML file.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 91 / 222
6 Import/Export Settings
6.1 Right_Hemisphere_Binary_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
compress boolean Compression.
animation boolean Export animation.
q_points integer Vertices quality. Possible Values
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
q_uv integer UV vertices quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 92 / 222
Parameter Name Parameter Type Parameter Description
q_normals integer Normals quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
protect integer File protection. Possible Values
No 0
Conversion Protected
1
Read Only 2
measurements boolean Disable measurements.
viewports boolean Export viewports.
thm string Thumbnail. Possible Values
No thumbnail No thumbnail
32 X 32 32 X 32
48 X 48 48 X 48
64 X 64 64 X 64
72 X 72 72 X 72
80 X 80 80 X 80
90 X 90 90 X 90
100 X 100 100 X 100
120 X 120 120 X 120
128 X 128 128 X 128
150 X 150 150 X 150
180 X 180 180 X 180
200 X 200 200 X 200
encrypt boolean Password Encrypted.
watermark_action integer Watermark. Possible Values
Preserve 0
Add/Overwrite 1
Remove 2
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 93 / 222
Parameter Name Parameter Type Parameter Description
watermark string Watermark file.
N7zip_Mode integer Compression mode. Possible Values
Very Fast -1
Fast 0
Normal 1
Best 2
N7zip_DicSize integer Dictionary size. Possible Values
32 KB 15
64 KB 16
128 KB 17
256 KB 18
512 KB 19
1 MB 20
2 MB 21
4 MB 22
8 MB 23
16 MB 24
32 MB 25
64 MB 26
128 MB 27
export_safe_form integer Saving solid objects. Possible Values
Only solid 0
Solid and mesh 1
Only mesh 2
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 94 / 222
6.2 Autodesk_3D_Studio_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
e_UV boolean Texture coordinates.
e_ignoreUV boolean Remove UV scale and offset from materials.
e_saveh boolean Export hierarchy information.
e_savesmooth boolean Export smooth groups data.
e_matrix boolean Export local matrix.
e_lights boolean Export lights.
e_cameras boolean Export cameras.
e_defcameras boolean Export default camera.
6.3 Visual_XML_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
export_validate_xml boolean Validate XML.
export_using_memory_stream boolean Use memory streams.
export_rh_file_compression_level integer RH file compression. Possible Values
Very Fast -1
Fast 0
Normal 1
Best 2
export_generate_dsids boolean Generate Visaul Enterprise Generator Ids.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 95 / 222
6.4 XAML_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
e_root_element_type integer Root element type. Possible Values
Model3D 1
Viewport3D 2
e_animation_behaviour integer Animation behaviour. Possible Values
Play once 1
Repeat 2
e_copy_viewer boolean Include standalone viewer with model.
e_launch_viewer boolean Launch viewer after export.
e_back_materials boolean Export back materials.
e_default_lights boolean Export default lights.
e_use_quaternions boolean Use quaternions for rotation.
e_force_srt boolean Use scale/rotation/translation order for transformations.
e_viewport_max_width integer Max width.
e_viewport_max_height integer Max height.
e_tex_save boolean Save textures.
e_tex_existing integer Overwrite existing. Possible Values
Replace 0
Skip 1
Rename 2
e_tex_format integer Convert textures to. Possible Values
PNG - Portable Network Graphics
1
JPG - JPEG Image 2
TIF - Tagged Image File Format
3
BMP - Windows Bitmap Graphics
4
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 96 / 222
6.5 DirectX_Model_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ASCII boolean ASCII mode.
Materials boolean Export materials.
Templates boolean Export templates.
TopFrame boolean Add top level frame.
LeftHand boolean Flip coordinate system.
SaveSkin boolean Export skins.
SaveEmptyBones boolean Export empty bones.
NoBonesMesh boolean Export bones without meshes.
all_nodes boolean Export empty nodes.
MaxNodeName integer Maximum object name.
Normals boolean Export normals.
FlipNormal boolean Invert normals.
Textures boolean Texture coordinates.
e_maxpoly integer Maximum vertices in polygon.
6.6 AutoCAD_Design_Web_Format_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
DWFExportFormat integer Mode. Possible Values
Auto-select 0
3D model 2
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 97 / 222
6.7 DICOM_Image_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
compression integer Compression. Possible Values
Raw data 0
RLE compression 1
color integer Photometric interpretation. Possible Values
Monochrome 1 0
Monochrome 2 1
RGB 2
6.8 Open_Inventor_File_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
Indent boolean Add indents.
Lights boolean Export lights.
Cameras boolean Export cameras.
DefCamera boolean Export default camera.
Normals boolean Export normals.
TxtCrd boolean Export texture coordinates.
Lines boolean Export polylines.
Materials boolean Export materials.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 98 / 222
6.9 SOFTIMAGE_XSI_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
SaveAsVersion integer Version. Possible Values
XSI 3.5 Realtime materials 0
XSI 3.5 Softimage materials 1
XSI 3.0 2
Materials boolean Export materials.
Textures boolean Export textures.
Normals boolean Export normals.
TopFrame boolean Add top level frame.
FlipNormal boolean Invert normals.
Indents boolean Add indents.
ExportPerVertexColor boolean Export per vertex color.
Change_Axes boolean Swap Y and Z axes.
UseNulls boolean Create dummy objects.
MakeCompatible boolean XSI 2.0 compatibility.
anim__rescale boolean Rescale animation.
anim__rescaletype integer Rescale type. Possible Values
Length (cs) 0
By percent 1
anim__setLengthTo float Centiseconds.
anim__rescalepercent float Percent.
anim__reverse boolean Reverse animation sequence.
anim__mergekeys boolean Remove redundant keys.
anim__sampleanimation boolean Sample animation.
anim__samplerate integer Sample frames.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 99 / 222
6.10 3ds_Max_File_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
e2m_triangulate boolean Triangulate.
e2m_normals boolean Export normals.
e2m_subd_mode integer SubD mode. Possible Values
Export control mesh 1
Export final mesh 2
e2m_use_skins boolean Export skins.
e2m_use_lights boolean Export lights.
e2m_use_cameras boolean Export cameras.
e2m_use_default_camera boolean Export default camera.
e2m_hide_dummies boolean Hide dummy nodes.
e2m_group_mode integer Group mode. Possible Values
Do not create 0
Create as opened 1
Create as closed 2
e2m_conv_inst_2_uniq boolean Convert instances to unique.
e2m_pass_metadata boolean Export metadata.
mpo_use_remote_server boolean Use remote 3ds Max DCom server.
mpo_remote_server_name string Remote 3ds Max DCom server name.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 100 / 222
6.11 VRML_Worlds_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
Type integer Version. Possible Values
VRML 1.0 1
VRML 2.0 2
Indent boolean Add indents.
e_flip boolean Flip coordinate system.
Lights boolean Export lights.
Cameras boolean Export cameras.
DefCamera boolean Export default camera.
Normals boolean Export normals.
TxtCrd boolean Export texture coordinates.
Lines boolean Export polylines.
Materials boolean Export materials.
e_maxpoly integer Max vertices in polygon.
6.12 Visual_Design_Stream_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
FileExpiration boolean File expiration.
ExpirationDays integer Days to expire.
MatrixType integer Accuracy. Possible Values
float 0
double 1
autodetect 2
MatrixTolerance string Tolerance.
TextureType integer Texture type. Possible Values
None 0
PNG 1
JPG 2
ColorsAsBytes boolean Colors accuracy.
WriteGlossinessAndSpecularLevel boolean Glossiness and Specular level.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 101 / 222
Parameter Name Parameter Type Parameter Description
DetectMaterialInstances integer Detect material instances. Possible Values
NO 0
YES 1
YES + ignore material names 2
LODType integer Number of LODs. Possible Values
None 0
Points, low (every 16th) 1
Points, medium low (every 8th)
2
Points, medium (every 4th) 3
Points, medium high (every 2nd)
4
Points, high (every square root of 2)
5
Triangles, low (10%, 50%) 6
Triangles, medium (5%, 10%, 25%, 50%)
7
Triangles, high (5%, 10%, 25%, 38%, 50%, 75%)
8
LODMinVertices integer Minimum vertices in LOD.
SubmeshMaxTriangles integer Submesh triangle count.
SubmeshSplitTries integer Submesh split attempts.
PositionQuants integer Vertices quality. Possible Values
10% 256
20% 1024
30% 4096
40% 8192
50% 16384
60% 32768
70% 65536
80% 262144
90% 524288
100% 0
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 102 / 222
Parameter Name Parameter Type Parameter Description
NormalQuants integer Normals quality. Possible Values
10% 359
20% 719
30% 1439
40% 2879
50% 5759
60% 11519
70% 23039
80% 32768
90% 65536
100% 0
TexCoordQuants integer UV vertices quality. Possible Values
10% 256
20% 1024
30% 4096
40% 8192
50% 16384
60% 32768
70% 65536
80% 262144
90% 524288
100% 0
Metadata integer Processing. Possible Values
Don't export 0
No instancing 1
Partial instancing (sets only) 2
Full instancing (sets and values)
3
MinRecordsForTable integer Min records for table.
MinDuplicatesForTable integer Min duplicates for table.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 103 / 222
6.13 LightWave_Scene_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
SaveVersion integer Version. Possible Values
LightWave 5.6 1
LightWave 6.0 2
layered_object boolean Export single layered object.
ExportSkin boolean Export skins.
oneinstance boolean Export one object instance.
e_viewport boolean Export viewport.
e_lights boolean Export lights.
folder string Copy objects to folder.
prefix string Use prefix.
6.14 JPEG_2000_JPC_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
lossy boolean Lossy compression.
targetpercentage integer Percentage file size.
6.15 Rhinoceros_3D_Model_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
RhinoExportSkipHiddenObjects boolean Skip hidden objects.
RhinoExportPutCurvesInSingleLayer boolean Put all curves in single layer.
RhinoExportLights boolean Export lights.
RhinoExportCameras boolean Export cameras.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 104 / 222
6.16 Office_Powerpoint_Document_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
template string Template. Possible Values
basic.htm basic.htm
basic_2007.htm basic_2007.htm
steps_n_views.htm steps_n_views.htm
steps_n_views_2007.htm steps_n_views_2007.htm
use_external_template boolean Use external template.
external_template filename External template.
preview boolean Open in browser/program.
rh_compress boolean Compression.
rh_animation boolean Export animation.
rh_q_points integer Vertices quality. Possible Values
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
rh_q_uv integer UV vertices quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 105 / 222
Parameter Name Parameter Type Parameter Description
rh_q_normals integer Normals quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
rh_protect integer File protection. Possible Values
No 0
Conversion Protected 1
Read Only 2
rh_measurements boolean Disable measurements.
rh_viewports boolean Export viewports.
rh_thm string Thumbnail. Possible Values
No thumbnail No thumbnail
32 X 32 32 X 32
48 X 48 48 X 48
64 X 64 64 X 64
72 X 72 72 X 72
80 X 80 80 X 80
90 X 90 90 X 90
100 X 100 100 X 100
120 X 120 120 X 120
128 X 128 128 X 128
150 X 150 150 X 150
180 X 180 180 X 180
200 X 200 200 X 200
rh_encrypt boolean Password Encrypted.
rh_watermark_action integer Watermark. Possible Values
Preserve 0
Add/Overwrite 1
Remove 2
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 106 / 222
Parameter Name Parameter Type Parameter Description
rh_watermark string Watermark file.
rh_7zip_Mode integer Compression mode. Possible Values
Very Fast -1
Fast 0
Normal 1
Best 2
rh_7zip_DicSize integer Dictionary size. Possible Values
32 KB 15
64 KB 16
128 KB 17
256 KB 18
512 KB 19
1 MB 20
2 MB 21
4 MB 22
8 MB 23
16 MB 24
32 MB 25
64 MB 26
128 MB 27
rh_export_safe_form integer Saving solid objects. Possible Values
Only solid 0
Solid and mesh 1
Only mesh 2
AUTHOR string Author.
TITLE string Title.
DESCRIPTION string Description.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 107 / 222
6.17 HTML_Document_with_3D_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
template string Template. Possible Values
animation_n_layers.html animation_n_layers.html
ansi_style.html ansi_style.html
ansi_style_ex.html ansi_style_ex.html
basic.html basic.html
catia_pmi_selection.html catia_pmi_selection.html
java_scripting.html java_scripting.html
jt_pmi_selection.html jt_pmi_selection.html
marsiano_style.html marsiano_style.html
object_only.html object_only.html
simple_animation.html simple_animation.html
standard_views.html standard_views.html
steps_n_model_views.html steps_n_model_views.html
steps_n_parts.html steps_n_parts.html
steps_n_procs.html steps_n_procs.html
test_sample.html test_sample.html
use_external_template
boolean Use external template.
external_template filename External template.
preview boolean Open in browser/program.
rh_compress boolean Compression.
rh_animation boolean Export animation.
rh_q_points integer Vertices quality. Possible Values
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 108 / 222
Parameter Name Parameter Type Parameter Description
rh_q_uv integer UV vertices quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
rh_q_normals integer Normals quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
rh_protect integer File protection. Possible Values
No 0
Conversion Protected 1
Read Only 2
rh_measurements boolean Disable measurements.
rh_viewports boolean Export viewports.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 109 / 222
Parameter Name Parameter Type Parameter Description
rh_thm string Thumbnail. Possible Values
No thumbnail No thumbnail
32 X 32 32 X 32
48 X 48 48 X 48
64 X 64 64 X 64
72 X 72 72 X 72
80 X 80 80 X 80
90 X 90 90 X 90
100 X 100 100 X 100
120 X 120 120 X 120
128 X 128 128 X 128
150 X 150 150 X 150
180 X 180 180 X 180
200 X 200 200 X 200
rh_encrypt boolean Password Encrypted.
rh_watermark_action
integer Watermark. Possible Values
Preserve 0
Add/Overwrite 1
Remove 2
rh_watermark string Watermark file.
rh_7zip_Mode integer Compression mode. Possible Values
Very Fast -1
Fast 0
Normal 1
Best 2
rh_7zip_DicSize integer Dictionary size. Possible Values
32 KB 15
64 KB 16
128 KB 17
256 KB 18
512 KB 19
1 MB 20
2 MB 21
4 MB 22
8 MB 23
16 MB 24
32 MB 25
64 MB 26
128 MB 27
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 110 / 222
Parameter Name Parameter Type Parameter Description
rh_export_safe_form
integer Saving solid objects. Possible Values
Only solid 0
Solid and mesh 1
Only mesh 2
AUTHOR string Author.
TITLE string Title.
DESCRIPTION string Description.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 111 / 222
6.18 LightWave_3D_and_Binary_Object_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
SaveVersion integer Version. Possible Values
LightWave 5.6 0
LightWave 6.0 1
SubDExportMode integer Export SubDs. Possible Values
Final mesh 0
Control mesh 1
Control mesh using PTCH chunk
2
SaveUVfiles boolean Create .uv files.
SaveUVIM boolean Export UVs using chunks.
SaveUV boolean Export UVs.
SaveVMAD boolean Use discontinuous UVs.
SaveExtraMaps boolean Export extra maps.
6.19 OpenFlight_Scene_Description_Database_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
e_local boolean Export vertices in local object space.
e_uv boolean Export UVs.
e_normals boolean Per vertex normals.
e_colors boolean Per vertex colors.
e_ref boolean Use instances and references.
e_colorpal boolean Export color palette.
e_empty_nodes boolean Export empty nodes.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 112 / 222
6.20 Maya_ASCII_Scene_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
XAxes integer Up axis in Maya. Possible Values
Y 1
Z 0
exp_opt_maximum_vertices_in_polygon integer Maximum vertices in polygon.
XDoubleSided boolean Mark surfaces as double sided.
XBlinn integer Material type. Possible Values
Phong 0
Blinn 1
XSkins boolean Export skins.
exp_opt_tessellate_nurbs boolean Tessellate NURBS.
opt_maya_version integer Maya version. Possible Values
None -1
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 113 / 222
6.21 Adobe_Portable_Document_2D__with_template__ExportOptions
Parameter Name Parameter Type
Parameter Description
fileformat None Provided
No Description Provided.
p1_internal_template_filename string Template. Possible Values
2D 4 Tab Views 4_Tab_2D_Views_v1.0.xml
2D ANSI Size A Landscape 11 X 8.5
ANSI_Size_A_Landscape_11_X_8.5_Template.xml
2D ANSI Size A Portrait 8.5 X 11
ANSI_Size_A_Portrait_8.5_X_11_Template.xml
2D ANSI Size A Portrait 8.5 X 11 with Title Block
ANSI_Size_A_Portrait_TB_Template.xml
2D ANSI Size B Landscape 17 X 11
ANSI_Size_B_Landscape_17_X_11_Template.xml
2D ANSI Size B Landscape 17 X 11 with Title Block
ANSI_Size_B_Landscape_TB_Template.xml
2D ANSI Size B Portrait 11 X 17
ANSI_Size_B_Portrait_11_X_17_Template.xml
2D ANSI Size C Landscape 22 X 17
ANSI_Size_C_Landscape_22_X_17_Template.xml
2D ANSI Size C Portrait 17 X 22
ANSI_Size_C_Portrait_17_X_22_Template.xml
2D ANSI Size D Landscape 34 X 22
ANSI_Size_D_Landscape_34_X_22_Template.xml
2D ANSI Size D Portrait 22 X 34
ANSI_Size_D_Portrait_22_X_34_Template.xml
2D ANSI Size E Landscape 44 X 34
ANSI_Size_E_Landscape_44_X_34_Template.xml
2D ANSI Size E Portrait 34 X 44
ANSI_Size_E_Portrait_34_X_44_Template.xml
2D Arch Size A Landscape 12 X 9
Arch_Size_A_Landscape_12_X_9_Template.xml
2D Arch Size A Portrait 9 X 12
Arch_Size_A_Portrait_9_X_12_Template.xml
2D Arch Size B Landscape 18 X 12
Arch_Size_B_Landscape_18_X_12_Template.xml
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 114 / 222
Parameter Name Parameter Type
Parameter Description
2D Arch Size B Portrait 12 X 18
Arch_Size_B_Portrait_12_X_18_Template.xml
2D Arch Size C Landscape 24 X 18
Arch_Size_C_Landscape_24_X_18_Template.xml
2D Arch Size C Portrait 18 X 24
Arch_Size_C_Portrait_18_X_24_Template.xml
2D Arch Size D Landscape 36 X 24
Arch_Size_D_Landscape_36_X_24_Template.xml
2D Arch Size D Portrait 24 X 36
Arch_Size_D_Portrait_24_X_36_Template.xml
2D Arch Size E Landscape 48 X 36
Arch_Size_E_Landscape_48_X_36_Template.xml
2D Arch Size E Portrait 36 X 48
Arch_Size_E_Portrait_36_X_48_Template.xml
2D Basic Landscape Letter Template
Basic_Horiz_Letter_2D_Template.xml
2D Basic Portrait Letter Template
Basic_Vert_Letter_2D_Template.xml
2D ISOSize A0 Landscape 1189 X 841
ISO_Size_A0_Landscape_1189_X_841_Template..xml
2D ISOSize A0 Portrait 841 X 1189
ISO_Size_A0_Portrait_841_X_1189_Template..xml
2D ISOSize A1 Landscape 841 X 594
ISO_Size_A1_Landscape_841_X_594_Template..xml
2D ISOSize A1 Portrait 594 X 841
ISO_Size_A1_Portrait_594_X_841_Template..xml
2D ISOSize A2 Landscape 594 X 420
ISO_Size_A2_Landscape_594_X_420_Template..xml
2D ISOSize A2 Portrait 420 X 594
ISO_Size_A2_Portrait_420_X_594_Template..xml
2D ISOSize A3 Landscape 420 X 297
ISO_Size_A3_Landscape_420_X_297_Template..xml
2D ISOSize A3 Portrait 297 X 420
ISO_Size_A3_Portrait_297_X_420_Template..xml
2D ISOSize A4 Landscape 297 X 210
ISO_Size_A4_Landscape_297_X_210_Template..xml
2D ISOSize A4 Portrait 210 X 297
ISO_Size_A4_Portrait_210_X_297_Template..xml
p1_use_external_template boolean Use External Template.
p1_external_template_filename filename External Template.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 115 / 222
Parameter Name Parameter Type
Parameter Description
p1_annot_place_title string 3D Model or 2D Image Target. Possible Values
2D_Annotation1 2D_Annotation1
2D_Annotation2 2D_Annotation2
2D_Annotation3 2D_Annotation3
2D_Annotation4 2D_Annotation4
p1_run_acrobat boolean Start Adobe Acrobat After Publishing.
p2_2d_image_align integer Align. Possible Values
Stretch 0
Fit to Left/Top 1
Fit to Center/Top 2
Fit to Right/Top 3
Fit to Left/Center 4
Fit to Center/Center 5
Fit to Right/Center 6
Fit to Left/Bottom 7
Fit to Center/Bottom 8
Fit to Right/Bottom 9
p3_xfdf_filename filename XFDF File Name.
p3_attach_filename filename Attachments.
p3_js_doc_filename filename Doc Level JS.
p3_js_page_filename filename Page Level JS.
p3_js_cntx_filename filename 3D Level JS.
p3_use_watermark boolean Add Watermark with following text.
p3_watermark_text string Watermark Text.
p3_use_md_password boolean Password protect editing of PDF.
p3_md_password password Password.
p3_use_op_password boolean Password protect opening of PDF.
p3_op_password password Password.
p3_enable_annots_rename boolean Enable PDF for Merging.
md_title string Title.
md_author string Author.
md_subject string Subject.
md_keywords string Keywords.
md_auto_title boolean Auto-generate Title.
md_auto_subject boolean Auto-generate Subject.
md_auto_keywords boolean Add Parts List to Keywords.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 116 / 222
6.22 Tagged_Image_File_Format_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
grayscale boolean Always in greyscale.
multipage boolean Save multipage.
compression integer Compression. Possible Values
LZW 0
Deflate 1
CCITTFAX3 2
CCITTFAX4 3
savecolormgntinfo boolean Save ICC color managemet info.
6.23 AutoCAD_Drawing_Object_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
FileVersion integer Output Version. Possible Values
AutoCAD 2007 0
AutoCAD 2004 1
AutoCAD 2000 2
AutoCAD R14 3
AutoCAD R13 4
AutoCAD R11/R12 5
6.24 Portable_Network_Graphics_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
INTERLACE boolean Interlaced.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 117 / 222
6.25 Universal_3D_export_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
AcrobatVersionCompatibility integer File format. Possible Values
U3D ECMA 1st Edition 1792
U3D ECMA 3rd Edition 2048
MeshCompression boolean Mesh compression.
TextureJPG integer Texture compression type. Possible Values
PNG 0
JPEG 1
Normals boolean Normals.
DefaultCamera boolean Default camera.
NonUnique boolean Append data to non-unique names.
SkinBones boolean Skin and bones.
FixBoneHierarchy boolean Fix bone hierarchy.
MetadataAsXML boolean Metadata.
CompressionPreset integer Compression preset. Possible Values
Custom 0
Game 1
CAD 2
MeshVertexQuality integer Vertices.
MeshNormalQuality integer Normals.
MeshDiffuseQuality integer Vertex colors.
MeshTexcoordQuality integer Texture coordinates.
TextureCompressionQuality integer JPEG quality.
6.26 JPEG_2000_JP2_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
lossy boolean Lossy compression.
targetpercentage integer Percentage file size.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 118 / 222
6.27 Maya_Binary_Scene_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
XAxes integer Up axis in Maya. Possible Values
Y 1
Z 0
exp_opt_maximum_vertices_in_polygon integer Maximum vertices in polygon.
XDoubleSided boolean Mark surfaces as double sided.
XBlinn integer Material type. Possible Values
Phong 0
Blinn 1
XSkins boolean Export skins.
exp_opt_tessellate_nurbs boolean Tessellate NURBS.
opt_maya_version integer Maya version. Possible Values
None -1
6.28 Maya_Interchange_File_Format_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
opt_maya_version integer Maya version. Possible Values
None -1
6.29 Stereolithography_File_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ascii boolean ASCII mode.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 119 / 222
6.30 Adobe_Portable_Document_3D_ExportOptions
Parameter Name Parameter Type
Parameter Description
fileformat None Provided
No Description Provided.
p1_internal_template_filename string Template. Possible Values
3D Architecture Walkthrough and Views
Architecture_Walkthrough_Views_Template.xml
3D Basic Landscape Letter Template
Basic_Horiz_Letter_3D_Template.xml
3D Basic Portrait Letter Template
Basic_Vert_Letter_3D_Template.xml
3D Basic Views Landscape Letter Template
Basic_Views_Horiz_Letter_3D_Template.xml
3D Basic Views Portrait Letter Template
Basic_Views_Vert_Letter_3D_Template.xml
3D BOM Basic Views Landscape Letter
BOM_Basic_Views_Landscape_Template_v1.0.xml
3D BOM Basic Views Portrait Letter
BOM_Basic_Views_Portrait_Template_v1.0.xml
3D BOM Simple Letter Landscape Template
BOM_Simple_Landscape_Template_v1.0.xml
3D BOM Simple Letter Portrait Template
BOM_Simple_Portrait_Template_v1.0.xml
3D Catia v5 PMI Template
Catia_PMI_Template_v1.0.xml
3D JT PMI Template JT_PMI_Template_v2.0.xml
3D Procedures Steps BOM Template
Procedures_Steps_BOM_Template_v1.0.xml
3D Simple Animation Template
Simple_Animation_Template.xml
3D Steps BOM List Template
Steps_BOM_Template_v1.0.xml
3D Steps Parts List Template
Steps_Parts_Template_v1.0.xml
3D Steps Portrait Template
Steps_Simple_Portrait_Template_1.0.xml
3D Steps Simple Template
Steps_Simple_Template.xml
2D 4 Tab Views 4_Tab_2D_Views_v1.0.xml
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 120 / 222
Parameter Name Parameter Type
Parameter Description
2D ANSI Size A Landscape 11 X 8.5
ANSI_Size_A_Landscape_11_X_8.5_Template.xml
2D ANSI Size A Portrait 8.5 X 11
ANSI_Size_A_Portrait_8.5_X_11_Template.xml
2D ANSI Size A Portrait 8.5 X 11 with Title Block
ANSI_Size_A_Portrait_TB_Template.xml
2D ANSI Size B Landscape 17 X 11
ANSI_Size_B_Landscape_17_X_11_Template.xml
2D ANSI Size B Landscape 17 X 11 with Title Block
ANSI_Size_B_Landscape_TB_Template.xml
2D ANSI Size B Portrait 11 X 17
ANSI_Size_B_Portrait_11_X_17_Template.xml
2D ANSI Size C Landscape 22 X 17
ANSI_Size_C_Landscape_22_X_17_Template.xml
2D ANSI Size C Portrait 17 X 22
ANSI_Size_C_Portrait_17_X_22_Template.xml
2D ANSI Size D Landscape 34 X 22
ANSI_Size_D_Landscape_34_X_22_Template.xml
2D ANSI Size D Portrait 22 X 34
ANSI_Size_D_Portrait_22_X_34_Template.xml
2D ANSI Size E Landscape 44 X 34
ANSI_Size_E_Landscape_44_X_34_Template.xml
2D ANSI Size E Portrait 34 X 44
ANSI_Size_E_Portrait_34_X_44_Template.xml
2D Arch Size A Landscape 12 X 9
Arch_Size_A_Landscape_12_X_9_Template.xml
2D Arch Size A Portrait 9 X 12
Arch_Size_A_Portrait_9_X_12_Template.xml
2D Arch Size B Landscape 18 X 12
Arch_Size_B_Landscape_18_X_12_Template.xml
2D Arch Size B Portrait 12 X 18
Arch_Size_B_Portrait_12_X_18_Template.xml
2D Arch Size C Landscape 24 X 18
Arch_Size_C_Landscape_24_X_18_Template.xml
2D Arch Size C Portrait 18 X 24
Arch_Size_C_Portrait_18_X_24_Template.xml
2D Arch Size D Landscape 36 X 24
Arch_Size_D_Landscape_36_X_24_Template.xml
2D Arch Size D Portrait 24 X 36
Arch_Size_D_Portrait_24_X_36_Template.xml
2D Arch Size E Landscape 48 X 36
Arch_Size_E_Landscape_48_X_36_Template.xml
2D Arch Size E Portrait 36 X 48
Arch_Size_E_Portrait_36_X_48_Template.xml
2D Basic Landscape Letter Template
Basic_Horiz_Letter_2D_Template.xml
2D Basic Portrait Letter Template
Basic_Vert_Letter_2D_Template.xml
2D ISOSize A0 Landscape 1189 X 841
ISO_Size_A0_Landscape_1189_X_841_Template..xml
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 121 / 222
Parameter Name Parameter Type
Parameter Description
2D ISOSize A0 Portrait 841 X 1189
ISO_Size_A0_Portrait_841_X_1189_Template..xml
2D ISOSize A1 Landscape 841 X 594
ISO_Size_A1_Landscape_841_X_594_Template..xml
2D ISOSize A1 Portrait 594 X 841
ISO_Size_A1_Portrait_594_X_841_Template..xml
2D ISOSize A2 Landscape 594 X 420
ISO_Size_A2_Landscape_594_X_420_Template..xml
2D ISOSize A2 Portrait 420 X 594
ISO_Size_A2_Portrait_420_X_594_Template..xml
2D ISOSize A3 Landscape 420 X 297
ISO_Size_A3_Landscape_420_X_297_Template..xml
2D ISOSize A3 Portrait 297 X 420
ISO_Size_A3_Portrait_297_X_420_Template..xml
2D ISOSize A4 Landscape 297 X 210
ISO_Size_A4_Landscape_297_X_210_Template..xml
2D ISOSize A4 Portrait 210 X 297
ISO_Size_A4_Portrait_210_X_297_Template..xml
p1_use_external_template boolean Use External Template.
p1_external_template_filename
filename External Template.
p1_annot_place_title string 3D Model or 2D Image Target. Possible Values
3D_Annotation1 3D_Annotation1
3D_Annotation2 3D_Annotation2
3D_Annotation3 3D_Annotation3
3D_Annotation4 3D_Annotation4
2D_Annotation1 2D_Annotation1
2D_Annotation2 2D_Annotation2
2D_Annotation3 2D_Annotation3
2D_Annotation4 2D_Annotation4
p1_run_acrobat boolean Start Adobe Acrobat After Publishing.
p2_poster_render_idx integer Preview Image. Possible Values
Raster Image via Software Z-Buffer Render 0
External Raster Image 2
External Vector File (in .PDF) 3
Vector Image via Illustration Module 4
Raster Image via DirectX-9 Render 5
p2_external_image_filename
filename External File.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 122 / 222
Parameter Name Parameter Type
Parameter Description
p2_texture_quality float Texture Quality. Possible Values
10% 10.0
20% 20.0
30% 30.0
40% 40.0
50% 50.0
60% 60.0
70% 70.0
80% 80.0
90% 90.0
100% 100.0
p2_store_normals boolean Save Normals.
p2_store_metadata boolean Store metadata.
p2_vectorize_callouts integer Vectorize Callouts. Possible Values
Standard 0
Vector 1
Raster 2
p2_use_bkgnd boolean Publish Current 3D Scene Background Image.
p2_use_bkgnd_ext boolean Publish External 3D Scene Background Image.
p2_bkgnd_filename filename External File.
p2_annot3d_auto_activate boolean Activate 3D Model.
p2_annot3d_show_3d_toolbar
boolean Show Toolbar of 3D Model.
p2_annot3d_store_cameras
boolean Save Cameras to Adobe Acrobat.
p2_annot3d_store_modelviews
boolean Save Model Views to Adobe Acrobat.
p2_callouts_2_pmi boolean Mark All Callouts as PMI objects.
p2_mini_java boolean Minimize Java Code Generation.
p2_2d_image_creator_index
integer Image Format. Possible Values
Raster Image via Software Z-Buffer Render 0
Vector Image via 2D PDF Module 2
Vector Image via Illustration Module 3
Raster Image via DirectX-9 Render 5
p3_xfdf_filename filename XFDF File Name.
p3_attach_filename filename Attachments.
p3_js_doc_filename filename Doc Level JS.
p3_js_page_filename filename Page Level JS.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 123 / 222
Parameter Name Parameter Type
Parameter Description
p3_js_cntx_filename filename 3D Level JS.
p3_use_watermark boolean Add Watermark with following text.
p3_watermark_text string Watermark Text.
p3_use_md_password boolean Password protect editing of PDF.
p3_md_password password Password.
p3_use_op_password boolean Password protect opening of PDF.
p3_op_password password Password.
p3_enable_annots_rename boolean Enable PDF for Merging.
md_title string Title.
md_author string Author.
md_subject string Subject.
md_keywords string Keywords.
md_auto_title boolean Auto-generate Title.
md_auto_subject boolean Auto-generate Subject.
md_auto_keywords boolean Add Parts List to Keywords.
zb_aa integer Antialiasing. Possible Values
None 0
Adaptive 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
6 x 6 6
7 x 7 7
8 x 8 8
zb_add_items boolean Render additional items.
rt_aa integer Antialiasing. Possible Values
None 0
Adaptive 1
2 x 2 2
3 x 3 3
4 x 4 4
5 x 5 5
6 x 6 6
7 x 7 7
8 x 8 8
rt_dsides_poly boolean Double-sided polygons.
rt_filter_tmaps boolean Filter texture maps.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 124 / 222
Parameter Name Parameter Type
Parameter Description
rt_rayt_refl boolean Raytrace reflections.
rt_refr boolean Refractions.
rt_shadows boolean Shadows.
rt_soft_shadows boolean Soft shadows.
rt_mt boolean Use multithreaded rendering.
vo_line_thickness float Line Thickness.
vo_bndr_thickness float Boundary Thickness.
vo_tolerance_angle float Tolerance Angle.
vo_calc_intersections boolean Calculate Intersections.
vo_remove_hidden_lines boolean Remove Hidden Lines.
vo_show_as_wireframe boolean Show as Wireframe.
vo_use_objects_colors boolean Use Objects Color.
vo_special_color integer Line Color.
vo_place_bom integer BOM. Possible Values
None 0
Right 3
Bottom 2
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 125 / 222
6.31 Flex_Web_Application_ExportOptions
Parameter Name Parameter Type
Parameter Description
fileformat None Provided
No Description Provided.
template string Template. Possible Values
BOM_ImageFlow_Model_Views_And_Portfolios.xml
BOM_ImageFlow_Model_Views_And_Portfolios.xml
BOM_ImageFlow_Steps_And_Procedures.xml
BOM_ImageFlow_Steps_And_Procedures.xml
BOM_Metadata_Model_Views_And_Portfolios.xml
BOM_Metadata_Model_Views_And_Portfolios.xml
BOM_Metadata_Steps_And_Procedures.xml
BOM_Metadata_Steps_And_Procedures.xml
BOM_Model_Views_And_Portfolios.xml
BOM_Model_Views_And_Portfolios.xml
BOM_Steps_And_Procedures.xml BOM_Steps_And_Procedures.xml
BOM_Steps_And_Procedures_w_Logo.xml
BOM_Steps_And_Procedures_w_Logo.xml
Model_Views_And_Portfolios_Basic.xml
Model_Views_And_Portfolios_Basic.xml
Steps_And_Procedures_Advanced.xml
Steps_And_Procedures_Advanced.xml
Steps_And_Procedures_Basic.xml Steps_And_Procedures_Basic.xml
use_external_template
boolean Use external template.
external_template filename External template.
preview boolean Open in browser/program.
rh_compress boolean Compression.
rh_animation boolean Export animation.
rh_q_points integer Vertices quality. Possible Values
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 126 / 222
Parameter Name Parameter Type
Parameter Description
rh_q_uv integer UV vertices quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
rh_q_normals integer Normals quality. Possible Values
OFF 0
10% 10
20% 20
30% 30
40% 40
50% 50
60% 60
70% 70
80% 80
90% 90
100% (lossless) 100
rh_protect integer File protection. Possible Values
No 0
Conversion Protected 1
Read Only 2
rh_measurements boolean Disable measurements.
rh_viewports boolean Export viewports.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 127 / 222
Parameter Name Parameter Type
Parameter Description
rh_thm string Thumbnail. Possible Values
No thumbnail No thumbnail
32 X 32 32 X 32
48 X 48 48 X 48
64 X 64 64 X 64
72 X 72 72 X 72
80 X 80 80 X 80
90 X 90 90 X 90
100 X 100 100 X 100
120 X 120 120 X 120
128 X 128 128 X 128
150 X 150 150 X 150
180 X 180 180 X 180
200 X 200 200 X 200
rh_encrypt boolean Password Encrypted.
rh_watermark_action
integer Watermark. Possible Values
Preserve 0
Add/Overwrite 1
Remove 2
rh_watermark string Watermark file.
rh_7zip_Mode integer Compression mode. Possible Values
Very Fast -1
Fast 0
Normal 1
Best 2
rh_7zip_DicSize integer Dictionary size. Possible Values
32 KB 15
64 KB 16
128 KB 17
256 KB 18
512 KB 19
1 MB 20
2 MB 21
4 MB 22
8 MB 23
16 MB 24
32 MB 25
64 MB 26
128 MB 27
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 128 / 222
Parameter Name Parameter Type
Parameter Description
rh_export_safe_form
integer Saving solid objects. Possible Values
Only solid 0
Solid and mesh 1
Only mesh 2
AUTHOR string Author.
TITLE string Title.
DESCRIPTION string Description.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 129 / 222
6.32 JTPMI_Files_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
FileExportType integer Type. Possible Values
Monolithic 0
Per part 1
Fully Shattered 2
CompressionSettings integer Compression type. Possible Values
No compression 0
Version 7.0 1
Version 8.0 2
Automatic 3
Version 8.1 4
Version 8.2 5
Version 9.0 6
Version 9.1 7
Version 9.2 8
Version 9.3 9
Version 9.4 10
Version 9.5 11
ExportLODs boolean Generate lower LODs.
ExportPMI boolean Export PMI.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 130 / 222
6.33 Google_SketchUp_Document_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
polyline boolean Export polylines.
BackMaterial boolean Create back material too.
NoSmothEdgeVisible boolean Corner edges are visible.
MergeCoplanarFaces boolean Merge all the coplanar faces.
OptimizePoints boolean Optimize points.
ExportVersion integer File Version. Possible Values
3 3
4 4
5 5
6 6
7 7
8 8
6.34 Adobe_Portable_Document_2D_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ExportCompress boolean Compress PDF.
ExportLaunchPDF boolean Open PDF after saving.
ExportFonts integer Text and Fonts. Possible Values
Geometry only 0
Geometry with hidden text 1
Embedded fonts 2
ExportFlatten boolean Flatten Layers.
ExportImagePPI integer Bitmap resolution (DPI).
ExportActiveViewOnly boolean Export Active View only.
ExportIncludeHidden boolean Export Hidden Objects.
Monochrome boolean Black and White.
ExportBitmapsOnly boolean Export whole pages as bitmaps.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 131 / 222
Parameter Name Parameter Type Parameter Description
ColorCompensate integer Color compensate for paper. Possible Values
B&W Swap 0
Darken 1
Invert Color 2
Invert Brightness 3
IncludeViews integer Viewports to include. Possible Values
Page layouts only 0
All 1
6.35 Right_Hemisphere_Material_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
compress boolean Compression.
protect boolean File protection.
defmat boolean Export default material.
thm string Thumbnail. Possible Values
No thumbnail No thumbnail
32 X 32 32 X 32
48 X 48 48 X 48
64 X 64 64 X 64
72 X 72 72 X 72
80 X 80 80 X 80
90 X 90 90 X 90
100 X 100 100 X 100
120 X 120 120 X 120
128 X 128 128 X 128
150 X 150 150 X 150
180 X 180 180 X 180
200 X 200 200 X 200
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 132 / 222
6.36 Computer_Graphics_Metafile_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
Version integer Version. Possible Values
1 (most compatible) 0
3 (best curves) 1
4 (Hotspots) 2
Precision integer Numeric precision. Possible Values
16 bit integer 0
32 bit floating point 1
32 bit fixed point 2
Auto select 3
UseRLE boolean Encode raster images with RLE.
XMLCompanion boolean XML Companion file.
6.37 AutoCAD_Drawing_Interchange_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
FileFormat integer Output Format. Possible Values
AutoCAD DXF file 1
AutoCAD DXF binary file 2
FileVersion integer Output Version. Possible Values
AutoCAD 2007 0
AutoCAD 2004 1
AutoCAD 2000 2
AutoCAD R14 3
AutoCAD R13 4
AutoCAD R11/R12 5
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 133 / 222
6.38 OpenEXR_Bitmap_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
Compression integer Compression type. Possible Values
None 0
Run-length encoding 1
zlib single scan lines 2
zlib 16 block scan lines 3
Piz-based wavelet 4
Lossy 24-bit float compression
5
LineOrder integer Line order. Possible Values
Use lowest Y coordinate scan line
0
Use highest Y coordinate scan line
1
6.39 JPEG_Image_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
e_quality integer Image quality.
savecolormgntinfo boolean Save ICC color managemet info.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 134 / 222
6.40 Wavefront_Object_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
e_compact boolean Compact data.
e_mtl boolean Create material file.
e_normals boolean Export vertex normals.
e_txt boolean Export texture coordinates.
e_flatonly boolean Triangulate non-flat polygons.
e_flip boolean Flip coordinate system.
e_SubD boolean Create SubD control mesh.
e_maxpoly integer Max vertices in polygon.
e_FixMaterials boolean Replace material colors.
e_string_len integer Max string length before wrap.
e_digits_v integer Vertices (v).
e_digits_vn integer Normals (vn).
e_digits_vt integer UVs (vt).
6.41 Caligari_trueSpace_Object_ExportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ascii boolean ASCII mode.
MoveAxis boolean Move object axis to object centre.
Rescale boolean Rescale.
ScaleValue float Percent of workplace.
6.42 Right_Hemisphere_Binary_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
i_IgnoreVP boolean Use Current Viewport Settings.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 135 / 222
6.43 Autodesk_3D_Studio_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
KeyFrame boolean Import keyframe data.
Animation boolean Import animation.
FixBadParity boolean Repair mirror transformed objects.
6.44 CATIA5_Assembly_Files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
loadconstruction integer Import construction geometry. Possible Values
NO 0
All except partbodies 1
ALL 2
displayconstruction boolean Display construction geometry.
importconfigurationlevel integer Import representations. Possible Values
Default 1
All 0
importmetadata boolean Import metadata.
collectmetadata boolean Collect metadata to geometry.
importonlytoplevelmetadata boolean Top level metadata only.
partnaming integer Part naming. Possible Values
Part name 0
Instance name 1
Part then instance 2
Instance then part 3
importselectionset boolean Import selection sets.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 136 / 222
Parameter Name Parameter Type Parameter Description
import2DSketch integer Import 2D sketch geometry. Possible Values
No 2D sketch geometry 0
Both 2D sketch wireframes and points
1
Only 2D sketch wireframes 2
Only 2D sketch points 3
compacttree boolean Compact scene tree.
rulexmlfile filename XML file for collapse rules.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
angulartoleranceceiling float Angular tolerance cap.
chordheighttoleranceceiling float Chord height tolerance cap.
importpmi boolean Import PMI.
importhiddenpmi boolean Import hidden PMI.
importmodelview boolean Import modelviews.
importcapture boolean Import captures.
realtimesectiongeometry boolean Create extra section geometry.
initialviewwithpmi boolean Create Initial view with PMI.
initialviewwithoutpmi boolean Create Initial view without PMI.
importcoordinateaxis boolean Import axis systems.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
wireframeontop boolean Draw wireframes on top.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 137 / 222
Parameter Name Parameter Type Parameter Description
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.45 Visual_XML_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
import_validate_xml boolean Validate XML.
import_load_child_model_views boolean Load child model views.
6.46 DirectX_Model_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
Animation boolean Import animation data.
Camera boolean Use DirectX camera position.
JoinMaterials boolean Join equal materials.
JoinV boolean Optimize vertices.
JoinT boolean Optimize texture points.
RightHand boolean Flip coordinate system.
UseBones boolean Import skins.
OptimizeH boolean Optimize hierarchy.
FixAlpha boolean Treat fully transparent materials as opaque.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 138 / 222
6.47 Caligari_trueSpace_Scene_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
JoinMaterials boolean Join equal materials.
ReadAnim boolean Import animation.
6.48 Pro_ENGINEER_Drawing_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
drawingbkcolor integer Drawing paper colour.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
surfacediscretization float Curve discretization.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 139 / 222
6.49 AutoCAD_Design_Web_Format_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
DWFPagesToImport integer Import pages. Possible Values
All 0
First 1
ShowPaperObject integer Show paper in 2D views. Possible Values
Always 1
Never 0
By file 2
ImportTTFText integer Import TrueType fonts as. Possible Values
Polygons 1
Outlines 2
Character primitives 3
ImportEdges boolean Import edges.
6.50 Open_Inventor_File_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
i_Flip boolean Flip coordinate system.
i_Collapse boolean Collapsing hierarchy.
i_Optimize boolean Optimize hierarchy.
i_MeshOptimize boolean Optimize geometry.
i_GenUV boolean Create UVs.
i_tQuality float Text quality.
i_tExtrude float Text extrude.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 140 / 222
6.51 Solid_Edge_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
assemblyoveridecolor boolean Apply assembly-level color.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 141 / 222
6.52 N3ds_Max_File_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
m2e_use_pivot boolean Apply pivot data to nodes.
m2e_convert_nurbs boolean Convert NURBSes to meshes.
m2e_convert_patch boolean Convert patches to meshes.
m2e_use_skin boolean Use skin modifiers.
m2e_use_morph boolean Use morph modifiers.
m2e_wire_color_2_mtl boolean Create materials for wire colors.
m2e_conv_inst_2_uniq boolean Convert instances to unique.
m2e_pass_metadata boolean Import metadata.
m2e_use_animation boolean Import animation.
m2e_use_sampling boolean Perform sampling.
m2e_sample_frames integer Sample any animation every frame.
m2e_sample_vertex boolean Use vertex animation.
mpo_use_remote_server boolean Use remote 3ds Max DCom server.
mpo_remote_server_name string Remote 3ds Max DCom server name.
6.53 MicroStation_CAD_Graphic_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
group integer Grouping. Possible Values
Level 0
Individual Element 1
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
loadconstruction boolean Construction Geometry.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 142 / 222
Parameter Name Parameter Type Parameter Description
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
importpmi boolean Import PMI.
importmodelview boolean Import modelviews.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.54 VRML_Worlds_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
i_Flip boolean Flip coordinate system.
i_Collapse boolean Collapsing hierarchy.
i_Optimize boolean Optimize hierarchy.
i_MeshOptimize boolean Optimize geometry.
i_GenUV boolean Create UVs.
i_tQuality float Text quality.
i_tExtrude float Text extrude.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 143 / 222
6.55 Visual_Design_Stream_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
DeepVision boolean Deep Vision.
SuppressBelowTopLevel boolean Suppress top level nodes.
LoadThreads integer Stream geometry. Possible Values
Separate thread 0
Main thread for first frame 1
Disabled 2
StreamMetadata boolean Stream metadata.
PreloadIndexTables boolean Preload index tables.
PreloadDataTables integer Preload data tables. Possible Values
NO 0
Metadata only 1
Everything but nodes and geometry
2
Everything but geometry 3
Everything 4
VramStrategy integer Video RAM strategy. Possible Values
Non-GPU 0
GPU 1
Overclocked GPU (not recommended)
2
VramSizeMB integer Video RAM size (MB).
RamSizeMB integer RAM size (MB).
TwoSidedLighting boolean 2-sided lighting for back-facing triangles.
UseLODs boolean Use LODs.
replicateEnable boolean Enable.
replicateX integer X count.
replicateY integer Y count.
replicateZ integer Z count.
replicateSX float X scale.
replicateSY float Y scale.
replicateSZ float Z scale.
EmulateTextureMapping boolean Emulate texture mapping [very slow].
debugMinPixels integer Minimum number of pixels for visible mesh.
debugLeafVisibleFrames integer Frames to treat leaf visible.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 144 / 222
Parameter Name Parameter Type Parameter Description
kdTries integer KD tries.
kdMaxDepth integer KD max depth.
kdMaxTriangles integer KD max triangles in leaf.
6.56 LightWave_Scene_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
joinmat boolean Optimize materials.
Folders string Content folders.
PromptForMissingFiles boolean Prompt for missing files.
6.57 Rhinoceros_3D_Model_ImportOptions
Parameter Name Parameter Type
Parameter Description
fileformat None Provided
No Description Provided.
RhinoImportSkipObjectsFromHiddenLayers boolean Skip objects in hidden layers.
RhinoImportSkipHiddenObjects boolean Skip hidden objects.
RhinoImportPutCurvesInSingleGroup boolean Put all curves in single group.
RhinoImportGroupObjectsInRhinoLayers boolean Group objects in RHINO layers.
RhinoImportSurfaceAlwaysDoubleSided boolean Surfaces always double sided.
RhinoImportSplitBrepFaces boolean Split B-Rep faces into separate objects.
RhinoImportLights boolean Import lights.
RhinoImportCameras boolean Import cameras.
RhinoImportMode integer Import mode. Possible Values
Polygonal Mesh 0
Nurbs 1
RhinoImportCurves boolean Import curves.
RhinoImportPoints boolean Import points.
RhinoImportPointSets boolean Import pointsets.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 145 / 222
6.58 Autodesk_3D_Studio_Project_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
KeyFrame boolean Import keyframe data.
Animation boolean Import animation.
FixBadParity boolean Repair mirror transformed objects.
6.59 Autodesk_3D_Studio_Material_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
KeyFrame boolean Import keyframe data.
Animation boolean Import animation.
FixBadParity boolean Repair mirror transformed objects.
6.60 LightWave_3D_and_Binary_Object_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
breakobject boolean Create sub-objects by material names.
textures boolean Create texture coordinates.
chkwrap boolean Check wrapping.
readUView boolean Import .uv files.
readSUBD boolean Import SubDs.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 146 / 222
6.61 Pro_ENGINEER_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importpmi boolean Import PMI.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 147 / 222
6.62 OpenFlight_Scene_Description_Database_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
i_lod boolean Convert distance LOD to scene level LOD.
i_normals boolean Read per vertex normals.
6.63 Maya_ASCII_Scene_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ChangeAxes integer Up axis in Maya. Possible Values
Y 1
Z 0
imp_opt_cameras boolean Import cameras.
SaveDefPerspCamera boolean Import perspective camera.
SaveLights boolean Import lights.
SaveAnimation boolean Import animation.
FrameSkip integer Number of frames between samples.
ReadNURBS boolean Tessellate NURBS.
opt_maya_version integer Maya version. Possible Values
None -1
6.64 Gerber_File_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
fliphorizontally boolean Flip horizontally.
flipvertically boolean Flip vertically.
rotate90DegCW boolean Rotate 90 degree CW.
rotate90DegACW boolean Rotate 90 degree ACW.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 148 / 222
6.65 Tagged_Image_File_Format_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
applycolormgnt boolean Apply ICC color management.
colorprofile integer ICC Color Profile. Possible Values
Default Monitor Profile 0
sRGB IEC61966-2.1 1
Adobe RGB (1998) 2
Apple RGB 3
ColorMatch RGB 4
rendintent integer Rendering Intent. Possible Values
Perceptual 0
Relative Colorimetric 1
Saturation 2
Absolute Colorimetric 3
profilefolder string Color Profile Repository.
6.66 AutoCAD_Drawing_Object_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
AllLayout integer Import. Possible Values
Active layout 0
Model and layouts 1
Model only 2
ForceToWireframe integer Viewport shading. Possible Values
From file 0
2D wireframe 1
ImportHiddenLayers boolean Import hidden layers.
ImportLineTypes integer Import line types. Possible Values
Continuous lines 0
Complex as geometry 1
All as geometry 2
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 149 / 222
Parameter Name Parameter Type Parameter Description
ReplaceText boolean Replace text.
ImportText integer Import text. Possible Values
As polylines 0
As polygons 1
UseMaterialsForColors boolean Use materials for colors.
ModelShadeOverride integer Model shading. Possible Values
From file 0
2D wireframe 1
Gouraud shaded 2
EnableNamedView integer Use named view. Possible Values
Never 0
Only if no Paper-Space Layout exist
1
Always 2
EnableModelZoomExtent boolean Zoom to extents.
EnableModelDarkBackground boolean Dark background palette.
ModelBackgroundColor integer Background color.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 150 / 222
6.67 Parasolid_Part_and_Assembly_Files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 151 / 222
6.68 AutoCAD_Sheet_Set_File_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ForceToWireframe integer Viewport shading. Possible Values
From file 0
2D wireframe 1
ImportHiddenLayers boolean Import hidden layers.
ImportLineTypes integer Import line types. Possible Values
Continuous lines 0
Complex as geometry 1
All as geometry 2
ReplaceText boolean Replace text.
ImportText integer Import text. Possible Values
As polylines 0
As polygons 1
UseMaterialsForColors boolean Use materials for colors.
6.69 Points_File_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
import_as integer Import as. Possible Values
Pointset 0
Mesh 1
import_as_mesh_if_colors boolean Import as mesh if colors are present.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 152 / 222
6.70 Maya_Binary_Scene_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ChangeAxes integer Up axis in Maya. Possible Values
Y 1
Z 0
imp_opt_cameras boolean Import cameras.
SaveDefPerspCamera boolean Import perspective camera.
SaveLights boolean Import lights.
SaveAnimation boolean Import animation.
FrameSkip integer Number of frames between samples.
ReadNURBS boolean Tessellate NURBS.
opt_maya_version integer Maya version. Possible Values
None -1
6.71 Maya_Interchange_File_Format_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
opt_maya_version integer Maya version. Possible Values
None -1
6.72 Universal_3D_import_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
LOD boolean Import LOD.
ParseMetaData boolean Parse metadata.
ParseNonUnique boolean Remove append data from names.
LODLevels integer Levels.
LODMinVertices integer Create LOD if mesh has minimum vertices.
LODMinVerticesCase2 integer Create LOD if minimum vertices in file.
LODMinFileVerticesForCase2 integer Minimum vertices per mesh.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 153 / 222
6.73 CATIA4_Part_Files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
load2d3d integer 2D/3D Loading. Possible Values
Load both 2D and 3D 0
Load 3D only 1
Load 2D only 2
drawingbkcolor integer Drawing.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
collapselevel boolean Collapse geometry.
doublesidedsurfaces boolean Double sided surfaces.
importconfigurationlevel integer Workspaces. Possible Values
All 0
Master Only 1
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importpmi boolean Import PMI.
importcoordinateaxis boolean Import axis systems.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 154 / 222
Parameter Name Parameter Type Parameter Description
importwireframe boolean Import wireframes.
wireframeontop boolean Draw wireframes on top.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.74 Collada_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
joinequalpoint boolean Join equal points.
optimizematerial boolean Remove duplicate material.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 155 / 222
6.75 Step_Part_and_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
importmetadata boolean Import metadata.
importpmi boolean Import PMI.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 156 / 222
6.76 Pro_ENGINEER_Neutral_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 157 / 222
6.77 SolidWorks_Drawing_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.78 Pro_ENGINEER_Part_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 158 / 222
Parameter Name Parameter Type Parameter Description
importpmi boolean Import PMI.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.79 Protein_Data_Bank_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
SphereSegements integer Sphere segments.
StickSegements integer Sticks segments.
ViewType integer View. Possible Values
Wire 0
Balls and sticks 1
Spacefill 2
Backbone 3
ObjectsColor integer Color. Possible Values
Monochrome 0
By Atom 1
By Residue 2
By Chain 3
Rainbow 4
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 159 / 222
6.80 JTPMI_Files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
ImportMetadata boolean Import metadata.
LoadSolid integer Import splines, surfaces and solids. Possible Values
NO 0
YES 1
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
LoadLod integer Level of detail. Possible Values
All 0
Highest 2
Medium 1 3
Medium 2 4
Medium 3 5
Lowest 1
CollapseSubnodes boolean Collapse subnodes.
importpmi boolean Import PMI.
importhiddenpmi boolean Import hidden PMI.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 160 / 222
Parameter Name Parameter Type Parameter Description
LoadModelViews integer Load modelviews. Possible Values
All 0
Top-level 1
Assembly 2
Parts 3
None 4
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.81 Inventor_Part_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
approach integer Approach. Possible Values
Quick View (Inventor Tesselation)
0
Load Inventor Solids 1
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 161 / 222
Parameter Name Parameter Type Parameter Description
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.82 Portable_Graymap_Heightfield_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
kX float Scale X factor.
kY float Scale Z factor.
kZ float Scale Y factor.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 162 / 222
6.83 NX_Parts_and_Assemblies_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
load2d3d integer 2D/3D Loading. Possible Values
Load both 2D and 3D 0
Load 3D only 1
Load 2D only 2
drawingbkcolor integer Drawing paper colour.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importconfigurationlevel integer Import configuration. Possible Values
All 0
As Saved 1
User defined 2
configurationname string User Specified Name.
referencesetselect integer Reference Set. Possible Values
As Saved 0
Entire 1
User Specified 2
referencesetname string User Specified Name.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 163 / 222
Parameter Name Parameter Type Parameter Description
importpmi boolean Import PMI.
importmodelview boolean Import modelviews.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
sheetbody boolean Import sheet bodies.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.84 CATIA4_Assembly_Files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
load2d3d integer 2D/3D Loading. Possible Values
Load both 2D and 3D 0
Load 3D only 1
Load 2D only 2
drawingbkcolor integer Drawing.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
collapselevel boolean Collapse geometry.
doublesidedsurfaces boolean Double sided surfaces.
importsolid boolean Import splines, surfaces and solids.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 164 / 222
Parameter Name Parameter Type Parameter Description
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importpmi boolean Import PMI.
importcoordinateaxis boolean Import axis systems.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
wireframeontop boolean Draw wireframes on top.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 165 / 222
6.85 Google_SketchUp_Document_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
createEdgesFace boolean Outline faces.
LinesSeparateHierarchy boolean Import lines into separate hierarchy.
LinesRenderOrder integer Lines render order.
useSketchUpTesselate boolean SketchUp tessellation.
createDefaultMaterial boolean Create default SketchUp material.
createUVW boolean Create UVW texture coordinates.
createBackFaces integer Create back faces. Possible Values
NO 0
as separate node 1
in same node 2
6.86 SolidWorks_Part_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
approach integer Approach. Possible Values
Quick View (Solidworks Tesselation)
0
Load Solidworks Solids 1
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importconfigurationlevel integer Import configuration. Possible Values
All 0
As Saved 1
User defined 2
configurationname string User Specified Name.
importpmi boolean Import PMI.
importsolid boolean Import splines, surfaces and solids.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 166 / 222
Parameter Name Parameter Type Parameter Description
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.87 Bundled_RH___RHB_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
fillhole boolean Not translated.
ActivateModelview boolean Activate Model View.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 167 / 222
6.88 Bundled_RH___RHB_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
fillhole boolean Not translated.
ActivateModelview boolean Activate Model View.
6.89 AutoCAD_Drawing_Interchange_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
AllLayout integer Import. Possible Values
Active layout 0
Model and layouts 1
Model only 2
ForceToWireframe integer Viewport shading. Possible Values
From file 0
2D wireframe 1
ImportHiddenLayers boolean Import hidden layers.
ImportLineTypes integer Import line types. Possible Values
Continuous lines 0
Complex as geometry 1
All as geometry 2
ReplaceText boolean Replace text.
ImportText integer Import text. Possible Values
As polylines 0
As polygons 1
UseMaterialsForColors boolean Use materials for colors.
ModelShadeOverride integer Model shading. Possible Values
From file 0
2D wireframe 1
Gouraud shaded 2
EnableModelZoomExtent boolean Zoom to extents.
EnableModelDarkBackground boolean Dark background palette.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 168 / 222
Parameter Name Parameter Type Parameter Description
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
6.90 CATIA5_Drawing_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
drawingbkcolor integer Drawing paper colour.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
surfacediscretization float Curve discretization.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 169 / 222
6.91 Inventor_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
approach integer Approach. Possible Values
Quick View (Inventor Tesselation)
0
Load Inventor Solids 1
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 170 / 222
6.92 Adobe_Portable_Document_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
smooth_text boolean Smooth Text.
smooth_lines boolean Smooth Lines.
smooth_images boolean Smooth Images.
output_dpi integer Output DPI. Possible Values
60 60
96 96
150 150
300 300
6.93 CATIA5_Part_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
loadconstruction integer Import construction geometry. Possible Values
NO 0
All except partbodies 1
ALL 2
displayconstruction boolean Display construction geometry.
importmetadata boolean Import metadata.
collectmetadata boolean Collect metadata to geometry.
importselectionset boolean Import selection sets.
import2DSketch integer Import 2D sketch geometry. Possible Values
No 2D sketch geometry 0
Both 2D sketch wireframes and points
1
Only 2D sketch wireframes 2
Only 2D sketch points 3
compacttree boolean Compact scene tree.
rulexmlfile filename XML file for collapse rules.
importsolid boolean Import splines, surfaces and solids.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 171 / 222
Parameter Name Parameter Type Parameter Description
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
angulartoleranceceiling float Angular tolerance cap.
chordheighttoleranceceiling float Chord height tolerance cap.
importpmi boolean Import PMI.
importhiddenpmi boolean Import hidden PMI.
importmodelview boolean Import modelviews.
importcapture boolean Import captures.
realtimesectiongeometry boolean Create extra section geometry.
initialviewwithpmi boolean Create Initial view with PMI.
initialviewwithoutpmi boolean Create Initial view without PMI.
importcoordinateaxis boolean Import axis systems.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
wireframeontop boolean Draw wireframes on top.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 172 / 222
6.94 Solid_Edge_Part_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 173 / 222
6.95 Iges_Part_and_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 174 / 222
6.96 CATIA_Graphical_Representation_Files_CGR__ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
collectmetadata boolean Collect metadata to geometry.
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importwireframe boolean Import wireframes.
wireframeontop boolean Draw wireframes on top.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 175 / 222
6.97 JPEG_Image_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
applycolormgnt boolean Apply ICC color management.
colorprofile integer ICC Color Profile. Possible Values
Default Monitor Profile 0
sRGB IEC61966-2.1 1
Adobe RGB (1998) 2
Apple RGB 3
ColorMatch RGB 4
rendintent integer Rendering Intent. Possible Values
Perceptual 0
Relative Colorimetric 1
Saturation 2
Absolute Colorimetric 3
profilefolder string Color Profile Repository.
6.98 Wavefront_Object_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
l_mtl boolean Import material file.
l_flip boolean Flip coordinate system.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 176 / 222
6.99 ACIS_Part_and_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
importmetadata boolean Import metadata.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
importsurfaces boolean Import surfaces.
importpoints boolean Import points.
importplanes boolean Import planes.
importwireframe boolean Import wireframes.
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 177 / 222
6.100 Caligari_trueSpace_Object_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
JoinMaterials boolean Join equal materials.
ReadAnim boolean Import animation.
6.101 SolidWorks_Assembly_files_ImportOptions
Parameter Name Parameter Type Parameter Description
fileformat None Provided No Description Provided.
approach integer Approach. Possible Values
Quick View (Solidworks Tesselation)
0
Load Solidworks Solids 1
loadhidden boolean Import hidden objects.
makehiddenvisible boolean Display hidden objects.
importmetadata boolean Import metadata.
importconfigurationlevel integer Import configuration. Possible Values
All 0
As Saved 1
User defined 2
configurationname string User Specified Name.
importpmi boolean Import PMI.
importsolid boolean Import splines, surfaces and solids.
tesslevel integer Tessellation Level. Possible Values
Very low 0
Low 1
Medium Low 2
Medium 3
Medium High 4
High 5
Very high 6
User defined 7
angulartolerance float Angular tolerance.
chordheighttolerance float Chord height tolerance.
Import/Export Settings
Version: 1.0 – 2011-12-13 PUBLIC 178 / 222
Parameter Name Parameter Type Parameter Description
scaletessellationparameters integer Chord height behavior. Possible Values
Absolute 0
Scaled 1
tm__RX float X.
tm__RY float Y.
tm__RZ float Z.
tm__SX float X.
tm__SY float Y.
tm__SZ float Z.
tm__PX float X.
tm__PY float Y.
tm__PZ float Z.
Metadata
Version: 1.0 – 2011-12-13 PUBLIC 179 / 222
7 Metadata
7.1 filemetadata_extract
Extracts Microsoft Office or XMP metadata from the specified file.
Parameter Name Parameter Type Parameter Description
filename filename Full path to the file with metadata.
outfilename filename Full path to the output XML file.
7.2 filemetadata_extractmsoffice
Extracts Microsoft Office metadata from file specified.
Parameter Name Parameter Type Parameter Description
filename filename Full path to the MS office file.
outfilename filename Full path to the output XML file.
7.3 filemetadata_extractxmp
Extracts XMP metadata from the file specified.
Parameter Name Parameter Type Parameter Description
filename filename Full path to the file containing XMP metadata.
outfilename filename Full path to the output XML file.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 180 / 222
8 Modules
8.1 ApplyModifier
Parameter Name Parameter Type Parameter Description
Modifier integer No Description Provided. Possible Values
e3_mod_axisdir 101
e3_mod_bend 102
e3_mod_mirror 109
e3_mod_noise 114
e3_mod_wave 115
e3_mod_skew 117
e3_mod_inflate 120
e3_mod_stretch 124
e3_mod_taper 122
e3_mod_twist 124
e3_mod_ripple 136
e3_mod_spline 163
8.2 bomfactory
Creates an xml file for given CAD file.
Parameter Name Parameter Type Parameter Description
input_file_name filename Input File Name.
output_xml_file filename Output File Name.
export_directory string Output Directory.
file_type_guid string File Type GUID.
absolute_path boolean Absolute path.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 181 / 222
8.3 Clean_Scene
Cleans the scene and removes unused objects.
Parameter Name Parameter Type Parameter Description
Remove_Unused_Animations boolean No Description Provided.
Remove_Empty_Nodes boolean No Description Provided.
Remove_Unused_Materials boolean No Description Provided.
Remove_Model_Views boolean No Description Provided.
Remove_Unused_Layers boolean No Description Provided.
Remove_Metadata boolean No Description Provided.
Remove_Notes_And_Etc boolean No Description Provided.
Remove_Mesh_Dupes boolean No Description Provided.
Remove_EnvMaps_And_Backplates boolean No Description Provided.
Merge_Equal_Materials boolean No Description Provided.
Remove_Unused_Hidden_Cameras boolean No Description Provided.
8.4 cm_createbommodelview
Creates a modelview for each BOM in the scene.
8.5 cm_removeunwantednodes
Removes unwanted nodes according to defined xml file.
Parameter Name Parameter Type Parameter Description
xmlpath filename The input file xml file.
removewithchild boolean Remove the node even if it has children.
removeemptynodes boolean Remove the node if it is empty.
8.6 cm_renametoplevelnode
Renames the top level node in the scene.
Parameter Name Parameter Type Parameter Description
new_name string New name for the top level node.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 182 / 222
8.7 cm_setaxissystemcolors
Sets the axis system colors.
Parameter Name Parameter Type Parameter Description
XR integer X axis Red value.
XG integer X axis Green value.
XB integer X axis Blue value.
YR integer Y axis Red value.
YG integer Y axis Green value.
YB integer Y axis Blue value.
ZR integer Z axis Red value.
ZG integer Z axis Green value.
ZB integer Z axis Blue value.
8.8 cm_setmetadataunit
Resets the metadata value to scene unit.
Parameter Name Parameter Type Parameter Description
xmlpath filename The input file xml file for unit conversion.
8.9 cm_setpmialwaysontop
Sets PMI always on top.
Parameter Name Parameter Type Parameter Description
alwaysontop boolean Set always on top status.
8.10 cm_setpmibillboarding
Sets PMI billboarding.
Parameter Name Parameter Type Parameter Description
billboarding integer Set billboarding status. Possible Values
None 0
Full 1
Flip Label 2
Modules
Version: 1.0 – 2011-12-13 PUBLIC 183 / 222
8.11 cm_setpmilinecolor
Sets PMI line color.
Parameter Name Parameter Type Parameter Description
leaderlineR integer Red value for leader lines.
leaderlineG integer Green value for leader lines.
leaderlineB integer Blue value for leader lines.
8.12 cm_setpmitextcolor
Sets PMI text color.
Parameter Name Parameter Type Parameter Description
TextR integer Red value for texts.
TextG integer Green value for texts.
TextB integer Blue value for texts.
8.13 cm_setpointcolor_style
Sets points color and style.
Parameter Name Parameter Type Parameter Description
pointColorR integer Red value for points.
pointColorG integer Green value for points.
pointColorB integer Blue value for points.
pointStyle integer Point style. Possible Values
Dot 0
Square 1
Star 2
Plus 3
Cross 4
Circle 5
Rhomb 6
Modules
Version: 1.0 – 2011-12-13 PUBLIC 184 / 222
8.14 cm_wireframe
Puts wireframe on top.
Parameter Name Parameter Type Parameter Description
putwireframesontop boolean Put wireframes on top.
8.15 cm_wireframe_color
Sets wireframe color.
Parameter Name Parameter Type Parameter Description
wireframeColorR integer Red value for wireframes.
wireframeColorG integer Green value for wireframes.
wireframeColorB integer Blue value for wireframes.
8.16 convertaitopsd
Converts an .ai file into .pdf.
Parameter Name Parameter Type Parameter Description
input_ai_file filename Input .ai file name.
output_psd_file filename Output .psd file name.
dpi float Target DPI.
8.17 CreateDVIS
Creates DVIS data.
Parameter Name Parameter Type Parameter Description
dvis_filename filename Path to .dvis file.
8.18 ct_clippingplane_crosssection
Cross sectioning with clipping plane.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 185 / 222
8.19 ct_color_objects
Applies different colors to adjacent objects.
Parameter Name Parameter Type Parameter Description
ColorSchemeXmlFile filename Color schema xml filename.
colors_count integer Colors count.
color_0 integer No Description Provided.
color_1 integer No Description Provided.
color_2 integer No Description Provided.
color_3 integer No Description Provided.
color_4 integer No Description Provided.
color_5 integer No Description Provided.
color_6 integer No Description Provided.
color_7 integer No Description Provided.
color_8 integer No Description Provided.
color_9 integer No Description Provided.
ObjectColorMode integer Simple cylic or XML schema. Possible Values
Simple Cyclic 0
XML Schema 1
8.20 ct_converttodoublesided
Doubles the number of faces of all objects in the model.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 186 / 222
8.21 ct_explodeobjects
Breaks out all the objects from the model.
Parameter Name Parameter Type Parameter Description
movement_precision float Movement precision: best: 0, fastest: 10.
duration float Duration of the animation.
parallel boolean Explode parallel to the axes.
num_stages integer Number of stages for explode animation.
mode integer Explode mode. Possible Values
All axes 0
XY axes 1
XZ axes 2
YZ axes 3
sequences boolean Create separate animation for each stage.
smart_axis boolean Try to find best axis.
group_type integer Object group mode. Possible Values
Distance 0
Size 1
inverse boolean Object grouping direct or inverse.
create_layers boolean Create new layer for each stage.
8.22 ct_healmodel_advanced
Repairs faces, cracks, geometry, and duplicated edges using advanced settings.
Parameter Name Parameter Type Parameter Description
skip_hidden_meshes boolean True: to skip hidden meshes.
create_new_meshes boolean True: to create new meshes instead reusing existing.
output_one_mesh boolean Combine meshes.
join_vertices float Join vertices threshold.
join_edges_enable boolean True: to join vertices with edges.
join_edges float Join vertices with edges threshold.
8.23 ct_invertfaces
Inverts all faces.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 187 / 222
8.24 ct_invertfacesandnormals
Inverts all faces and surface normals.
8.25 ct_invertnormals
Inverts all surface normals.
8.26 ct_joinequalpoints
Joins all the points that have equal (coincident) x,y,z coordinates.
Parameter Name Parameter Type Parameter Description
tolerance float Tolerance between points to join.
8.27 ct_randomizeobjects
Randomizes all object points.
Parameter Name Parameter Type Parameter Description
tolerance float Amount of distortion.
units_or_percentage integer Distortion mode. Possible Values
percentage 0
units 1
Modules
Version: 1.0 – 2011-12-13 PUBLIC 188 / 222
8.28 ct_realight
Creates realight effect to a model.
Parameter Name Parameter Type Parameter Description
store_vertex_colors integer Store ambient occlusion as vertex colors.
store_texture_maps integer Store ambient occlusion texture maps.
rays_per_sample integer The number of per vertex or per sub-pixel surface samples.
brightness float Level of brightness of the ambient occlusion.
map_generation integer Source from which maps are generated. Possible Values
Existing materials 0
Existing diffuse materials 1
outcome integer Manner in which maps are generated. Possible Values
Replace diffuse map 0
Merge into diffuse map 1
Add new light map 2
samples integer The number of per sub-pixel surface samples.
prefilter integer Applies color bleed around the polygon groups.
noise float Applies white noise to the texture map.
blur integer Applies Gaussian blur to the texture map.
map_size integer When set to 0 all maps will have a same size. Othrwise, created maps will have size based on the maximum dimension of the largest object.
width integer The width of the maps in pixels.
height integer The height of the maps in pixels.
max_dimension integer The maximum dimension of the largest map.
round_size_power2 integer Rounds up the maximum width and height values to the closest power of two.
save_internal_image integer Saves the texture maps in the internal application memory.
prefix string The prefix to append to the new map names.
path string The location in which to save the maps.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 189 / 222
Parameter Name Parameter Type Parameter Description
format integer The format in which to save the maps. Possible Values
JPEG image (.jpg) 0
Layered Image Format (.LiF)
1
PNG Image (.png) 2
PPM Image (.ppm) 3
TARGA Image (.tga) 4
TIFF Image (.tif) 5
Windows Bitmap (.bmp) 6
virtual_ground_plane integer When set to 1, use a virtual ground plane to calculate the illumination.
distance float The distance between the model and the ground plane.
size float The percentage size of the ground plane compared to the size of the model.
calc_by_part integer When set to 1, ambient occlusion will be calculated saparately for eacj part.
channel_number integer Number of the UV channel to use.
map_mode integer Ambient occlusion map mode.Possible Values
Modulate 0
Replace 1
Additive 2
ray_length float Limit the test ray length. When set to 0, infinite ray will be used.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 190 / 222
8.29 ct_reducemodel_advanced
Reduces the number of polygons in a model using advanced settings.
Parameter Name Parameter Type Parameter Description
keep_percent float Percentage of polys to keep.
skip_hidden_meshes boolean True: to skip hidden meshes.
create_new_meshes boolean True: to create new meshes instead reusing existing.
normalize_meshes integer Set to 1 or 2 on very small scenes (bbox less than 1E-3) or for big and thin parts. Possible Values
Off 0
On 1
Auto 2
enable_postfix boolean True: enable postfix on reduced models names.
postfix string Postfix for reduced models names.
enable_join_vertices boolean True: enable join vertices.
join_vertices float Percent of longest bbox diagonal.
enable_join_normals boolean True: enable join normals.
join_normals float Tolerance for join normals.
enable_join_uv boolean True: enable join uv.
join_uv float Tolerance for join uv.
enable_join_colors boolean True: enable join colors.
join_colors float Tolerance for join colors.
influence_normals float Normals influence.
enable_influence_uv boolean True: enable influence uv.
influence_uv float Uvs influence.
enable_influence_materials boolean True: enable influence materials.
influence_materials float Materials influence.
enable_influence_colors boolean True: enable influence colors.
influence_colors float Colors influence.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 191 / 222
8.30 ct_remove_degenerate_triangles
Removes Degenerate Triangles.
8.31 ct_remove_duplicate_faces
Removes Duplicate Faces.
8.32 ct_remove_duplicate_materials
Removes Duplicate Materials.
8.33 ct_remove_duplicate_meshes
Removes Duplicate Meshes.
Parameter Name Parameter Type Parameter Description
keep_metadata boolean No Description Provided.
8.34 ct_remove_invisible_polygons
Removes internal polygons from the scene.
Parameter Name Parameter Type Parameter Description
quality integer Can not be negative. Higher values means higher quality.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 192 / 222
8.35 ct_removeinternalparts
Hides or deletes internal objects in the model.
Parameter Name Parameter Type Parameter Description
process_hide boolean True: process hidden objects.
method integer No Description Provided. Possible Values
Hide 0
Select 1
Hide and select 2
Delete 3
quality integer 1=max speed, 3=max quality.
process_transparent boolean True: take transparency of an object into account.
8.36 ct_removesmallparts
Removes small objects from the model.
Parameter Name Parameter Type Parameter Description
percentage float Percentage from scenes bbox of an object min size (0 - 100).
units float Object min size in scene's units.
used_type integer Type of value - percentage of scene bbox or absolute units. Possible Values
Percentage 0
Units 1
8.37 ct_separatemesh
Separates meshes.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 193 / 222
8.38 ct_unifynormals
Aligns all surface normals in the same direction.
Parameter Name Parameter Type Parameter Description
highlight_color integer Used if process method set to highlight.
process_hide boolean True: to process hidden object.
method integer Action for suspicious nodes. Possible Values
Do nothing 0
Select 1
Highlight 2
Make double-sided 3
quality integer 1=max speed, 5=max quality.
polygons boolean True: to apply algorithm to polygons.
8.39 ct_uvmapping
Creates uvs and assigns to all the objects in the scene.
Parameter Name Parameter Type Parameter Description
mapper integer The type of UV mapping to apply to the selected objects. Possible Values
VAMP 0
Cube 1
Rigid 2
packer integer The method of packing the UVs. Possible Values
Clump 0
Rectangular 1
Simple 2
vamp_tolerance float The angle between the projection plane and the mapped polygon. For example, 0 degrees creates many small UV edges (co-planar polygons are grouped together) to create finer UV mapping. Whereas, 90 degrees creates fewer but larger UV edges (large partitions with distorted polygons) to create more chunky UV mapping.
spacing float The spacing between the packed UVs.
preserve_orientation integer If set to 'true', preserves the UV orientation of the UVs.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 194 / 222
Parameter Name Parameter Type Parameter Description
fill_space integer If set to 'true', spaces the UVs according to the spacing percentage. That is, it resizes the partitions to maximize the use of the texture space of the UVs.
pack_per_material integer If set to 'true', packs UVs that use the same material, separately. For example, if polygons 1 and 2 use material type A, and polygon 3 uses material B, polygons 1 and 2 are packed separately from polygon 3. Otherwise polygons 1, 2, and 3 are packed together, sharing the same texture but retaining their own material.
map_per_element integer If set to '1', keeps mesh elements together when mapping; '2', keeps mesh Part IDs together when mapping.
relaxer integer The method of relaxing the UVs.Possible Values
None 0
Knead Even 1
Knead Aligned 2
Knead Hybrid 3
Relax 4
relax_iterations integer Number of relax iterations to perform for the 'Relax' relaxer.
uvchannel integer UV Channel to generate mapping to.
texturescale boolean Disable texture scaling.
use_texture_size boolean Enable scaling of the UV coordinates according to the textire size.
texture_size_u float Texture size in U direction.
texture_size_v float Texture size in V direction.
texture_units float Texture units. Possible Values
Generic 0
Millimeters 0.001
Centimeters 0.01
Meters 1.0
Kilometers 1000
Inches 0.0254
Feet 0.3048
Miles 1609.344
Points 0.000352
Picas 0.00423
Modules
Version: 1.0 – 2011-12-13 PUBLIC 195 / 222
8.40 dgnhierarchyxml
Creates an xml file for given Microstation file.
Parameter Name Parameter Type Parameter Description
input_file_name filename The name of the Microstation assembly file that is used to generate the .xml file.
output_xml_file filename The name of the .xml file.
export_directory string The directory in which to save additional output files for this operation.
file_type_guid string File Type GUID.
absolute_path boolean Absolute path.
8.41 ill_advancedsettings
Sets advanced parameters.
Parameter Name Parameter Type Parameter Description
hide_back-facing_geometry boolean If set to 'true', any back-facing geometry is hidden. This option ensures that any faces/polygons that you cannot see are not rendered, therefore increasing processing speed.
multithreading boolean If set to 'true', rendering is performed in multiple threads. You need to have a multithreaded processor to use this feature.
multiple_layers boolean If set to 'true', polylines are groupped into multiple layers (one layer per original mesh). Otherwise, all polylines belong to a single layer. This parameter is only applied if file_type parameter is set to '.ai'.
cgm_companion_file boolean If set to 'true', XML companion file is created. This parameter is only applied if file_type parameter is set to '.cgm'.
cgm_version integer Used to select the version of CGM files. Version 1 is the most compatible. Version 4 has WebCGM hotspots functionality. This parameter is only applied if file_type parameter is set to '.cgm'. Possible Values
Version 3 0
Version 4/WebCGM 1
Modules
Version: 1.0 – 2011-12-13 PUBLIC 196 / 222
Parameter Name Parameter Type Parameter Description
thicknthin_method integer Used to select the thick'n'thinning method. Possible Values
Complete 0
Pop line 1
Silhouette 2
raster_vector_file integer Used to select options relating to the creation of a 'hybrid' image file when rendering to the .svg format. This parameter is only applied if file_type parameter is set to '.svg', '.ai' or '.cgm'. 'Flat color fill' option is also supported for '.swf'. Possible Values
None 0
Render Software Z-buffer
1
Render Raytracer 2
Flat color fill 3
raster_image_size_scale float The amount used to scale the hybrid file image. For example, if you enter 1, the new image is the same size as the original viewport image. If you enter 2, the new image is double the size of the original viewport image.
join_different_types boolean If set to 'true', different edge types may be joined into a single polyline.
min_join_angle float If the angle between two adjacent edges if more than 'min_join_angle', then they may be joined into a single polyline.
filter_approximate_boundary boolean If set to 'true', shared boundary edges are approximated. This is effective for source scenes where geometry has cracks.
line_filtering_tolerance float Determines the tolerance to apply when filtering lines. That is, it removes any duplicated and/or unnecessary additional lines that may be displayed in the rendered file. Negative values turn this parameter off.
filter_break_intersections boolean Used to select if lines should be broken at intersections. This is effective for later manual filtering.
contour_detection_accuracy integer Number of pixels used for contour processing. Possible Values
Low 0
Medium 1
High 2
Modules
Version: 1.0 – 2011-12-13 PUBLIC 197 / 222
Parameter Name Parameter Type Parameter Description
contour_detection_match_original boolean Try to match to contours from original geometry.
rational_approximation_tolerance double Determines the tolerance of converting rational curves to non-rational. Only for scenes with Solids. Only for .svg and .ai formats.
curve_tesselation_tolerance double Determines the tolerance of converting rational curves into polylines. Only for scenes with Solids. All formats except .svg and .ai.
voxel_visibility_detection boolean Used to select if voxel visibility detection should be used instead of polygon detection. Only for scenes with Solids.
fit_splines_on_regions boolean Used to select if fills and hotspot regions should be approximated with splines.
use_part_id boolean If set to 'true', rendering will take into account Part ID information.
lock_font_size boolean If set to 'true', callout's font size will be same as in the callout settings, not taking into account viewport scaling.
order_lines_by_z boolean If set to 'true', lines will be ordered by their Z value. Otherwise lines are grouped by objects.
reduce_lines boolean If set to 'true', Illustrate will try to remove overlapping lines to produce smaller file.
reduce_splines boolean If set to 'true', Illustrate will try to convert lines to splines.
reduce_splines_tolerance float Determines the tolerance for converting lines to splines.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 198 / 222
8.42 ill_render
Creates an illustration of the current scene and saves to file.
Parameter Name Parameter Type Parameter Description
file filename The name and location to save the output file.
file_type integer Used to select the format in which you want to save the scene. Possible Values
.ai 0
.dxf 1
.rh 2
.cgm binary 3
.swf 4
.svg 5
.tif 6
.eps 7
tolerance_angle float The tolerance angle for all rendered outlines.
line_thickness float The width for the lines of the rendered image in pixels for .tiff format and in 'paper_units' for all other formats.
boundary_thickness float The width for the boundary lines of the rendered image in pixels for .tiff format and in 'paper_units' for all other formats.
calculate_intersections boolean If set to 'true', draws lines along all face-face intersections of the rendered scene.
remove_hidden_lines boolean If set to 'true', removes lines that are hidden by the geometry in the rendered image.
show_as_wireframe boolean If set to 'true', shows the rendered image as a wire frame, all edges are treated as outline edges.
paper_units integer Used to select the units of measuring 'paper_size_width', 'paper_size_height', 'line_thickness' and 'boundary_thickness'. If file type is .tiff, this option is ignored (pixels are used as units in .tiff). Possible Values
inches 0
cm 1
mm 2
points 3
picas 4
Modules
Version: 1.0 – 2011-12-13 PUBLIC 199 / 222
Parameter Name Parameter Type Parameter Description
paper_size_width float Width for the printed image in pixels for .tiff and in 'paper_units' for all other formats.
paper_size_height float Height for the printed image in pixels for .tiff and in 'paper_units' for all other formats.
virtual_window_width integer The range of width coordinates for vector images, or the width dimension in pixels for raster images. You must enter a value greater than 0 for an output file to be created. We recommend entering 1000 for best results, and using the same value for the virtual_window_height parameter. Also sets image size for .tiff format.
virtual_window_height integer The range of width coordinates for vector images, or the width dimension in pixels for raster images. You must enter a value greater than 0 for an output file to be created. We recommend entering 1000 for best results, and using the same value for virtual_window_width. Also sets image size for .tiff format.
object_colour boolean If set to 'true', uses the model's color for object lines. If set to 'false', uses the color set in the line_color parameter.
line_colour integer Used to select the color for rendered image lines. This parameter is only applied if the object_color parameter is set to 'false'.
background_colour integer Used to select a color for the background if you are saving to the .swf, .cgm or .svg format.
include_bom integer Determines if, and where the BOM is placed on the rendered image. You must include the partlist_drawcallouts operation within the process for this parameter to be applied. Possible Values
None 0
Text file 1
XML file 4
Bottom 2
Right 3
dpi float The resolution of the illustration in dpi.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 200 / 222
8.43 jtassociatepmi
Processes PMI associations on reconstructed assembly.
8.44 jthierarchyxml
Creates an xml file for given OpenJT file.
Parameter Name Parameter Type Parameter Description
input_file_name filename The name of the JT assembly file that is used to generate the .xml file.
output_xml_file filename The name of the .xml file.
export_directory string The directory in which to save additional output files for this operation.
8.45 NeutralXmlGenerator
Creates an xml file for given neutral assembly file.
Parameter Name Parameter Type Parameter Description
input_file_name filename Input File Name.
output_xml_file filename Output File Name.
export_directory string Output Directory.
file_type_guid string File Type GUID.
absolute_path boolean Absolute path.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 201 / 222
8.46 pdf_2d_picturing
Inserts a simple 2d image into .pdf a document.
Parameter Name Parameter Type Parameter Description
src_filename filename The source template filename.
dst_filename filename The OUT document filename.
target_place_title string Title of annotation, whe must be placed 2D.
image_filename string The image to inserting filename.
xfdf_filename string This file can have some data (in XFDF form), that will be imported into pdf.
enable_for_merging boolean If set to 'true', annots, fields and etc will be renamed (ready for documents merge).
N2d_image_align integer Align of 2D image. Possible Values
Stretch 0
Fit to Left/Top 1
Fit to Center/Top 2
Fit to Right/Top 3
Fit to Left/Center 4
Fit to Center/Center 5
Fit to Right/Center 6
Fit to Left/Bottom 7
Fit to Center/Bottom 8
Fit to Right/Bottom 9
8.47 pdf_2d_picturing_serial
Inserts a list of 2d images into .a pdf document.
Parameter Name Parameter Type Parameter Description
src_filename filename The source template filename.
dst_filename filename The OUT document filename.
images_filenames_list string The list of filenames of images to inserting.
xfdf_filename string This file can have some data (in XFDF form), that will be imported into pdf.
enable_for_merging boolean If set to 'true', annots, fields and etc will be renamed (ready for documents merge).
Modules
Version: 1.0 – 2011-12-13 PUBLIC 202 / 222
8.48 pdf_merge
Performs merging of .pdf documents into one.
Parameter Name Parameter Type Parameter Description
source_filenames string A lot of source filenames, delimited by ; or , .
result_filename filename Result filename.
8.49 pdf_print_all_metadata
Prints all Metadata into .a pdf document.
Parameter Name Parameter Type Parameter Description
output_filename filename The name with which to save the exported .pdf file.
template_filename filename The filename of the PDF template.
node_annot string Name of annot, used for node name.
child_annot string Name of annot, used for node name.
name_annot string Name of annot, used for metadata name.
data_annot string Name of annot, used for metadata value.
area_annot string Name of annot, used for area in template.
parent_name string Regular expression, used as parent-name pattern, if empty - all parents will included.
node_name string Regular expression, used as node-name pattern, if empty - all child will included, but parent_name can't be empty.
child_name string Regular expression, used as child-name pattern, if empty - all child will included.
include_child boolean Recursive collecting from founded node for it's child.
exclude_geometry boolean Use only child, that don't have any geometry.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 203 / 222
8.50 pdf_print_metadata
Prints Metadata into a .pdf document (like XFDF method, use entries from template).
Parameter Name Parameter Type Parameter Description
output_filename filename The name with which to save the exported .pdf file.
template_filename filename The filename of the PDF template.
node_name string Used as node-name pattern.
blocks_per_page integer Count of blocks per page.
8.51 pdf_protect
Performs a protection process on a .pdf document.
Parameter Name Parameter Type Parameter Description
src_filename filename The IN document filename.
dst_filename filename The OUT document filename.
use_md_password boolean Password protect editing of PDF.
md_password_text string Password for modification.
use_op_password boolean Enable for commenting in Adobe Reader.
op_password_text string Password for opening.
use_watermark boolean Add Watermark with following text.
watermark_text string Watermark.
doc_right_print boolean Allow PRINT of document rights.
doc_right_edit boolean Allow EDIT of document rights.
doc_right_copy boolean Allow COPY of document rights.
doc_right_edit_notes boolean Allow EDIT_NOTES of document rights.
doc_right_fill_n_sign boolean Allow FILL_AND_SIGN of document rights.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 204 / 222
8.52 pdf_xfdf_integrate
Applies .xfdf to a .pdf document.
Parameter Name Parameter Type Parameter Description
src_filename filename The IN document filename.
dst_filename filename The OUT document filename.
xfdf_filename string This file can have some data (in XFDF form), that will be imported into pdf.
enable_for_merging boolean If set to 'true', annots, fields and etc will be renamed (ready for documents merge).
8.53 pmi_settings
Sets global settings for a scene with PMI.
Parameter Name Parameter Type Parameter Description
always_on_top boolean If set to 'true', draws the markup and markup leaders on top of all the objects in the scene.
leader_color integer Used to select the color of the markup leaders.
text_color integer Used to select the vector text color.
8.54 pmi_visibility
Controls visibility of various PMI types.
Parameter Name Parameter Type Parameter Description
show_text_markups boolean Display Text Markups.
show_rich_text_markups boolean Display Rich Text Markups.
show_gdt_markups boolean Display GDT Markups.
show_dimension_markups boolean Display Dimension Markups.
show_roughness_markups boolean Display Roughness Markups.
show_welding_markups boolean Display Welding Markups.
affect_only_markups_in_active_viewport boolean Apply changes only to markups in active viewport.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 205 / 222
8.55 regenerate_scene_thumbnails
Generates thumbnails for scene step, model and detail views.
Parameter Name Parameter Type Parameter Description
regenerate_model_view_thumbnails boolean Regenerate model view thumbnails.
regenerate_step_view_thumbnails boolean Regenerate step view thumbnails.
regenerate_detail_view_thumbnails boolean Regenerate detail view thumbnails.
8.56 remove_vzxml_hierarchy_cache
Removes VzXml specific hierarchy cache from the scene.
Parameter Name Parameter Type
Parameter Description
keep_all_metadata_as_selector_metadata boolean Copy metadata from VzXml hierarchy to scene nodes.
keep_selector_ds_ids boolean Keep VzXml hierarchy selector ds ids on scene nodes.
keep_selector_external_ids boolean Keep VzXml hierarchy selector external ids on scene nodes.
keep_all_metadata_as_entity_metadata boolean Copy metadata from VzXml hierarchy to entity descriptors associated with scene nodes.
8.57 RunFileQuery
Runs a query from a file on the specified scene.
Parameter Name Parameter Type Parameter Description
queryfile filename Query file path.
8.58 RunQuery
Runs a query on the specified scene.
Parameter Name Parameter Type Parameter Description
query string Query text.
Modules
Version: 1.0 – 2011-12-13 PUBLIC 206 / 222
8.59 setsceneunits
Sets scene units.
Parameter Name Parameter Type Parameter Description
multiplier double Unit Multiplier.
units integer Default scene units. Possible Values
Generic units 0
MilliMeters 1
Centimeters 2
Meters 3
KiloMeters 4
Inches 5
Feet 6
Miles 7
Points 8
Picas 9
rescale boolean Scale for conversion.
ExcludePoints boolean Exclude points from unit conversion.
8.60 validate_and_fix_scene_hierarchy
Validates scene hierarchy and fixes errors.
8.61 validate_and_fix_scene_layers
Validates scene layers and fixes errors.
8.62 validate_scene_hierarchy
Validates scene hierarchy.
8.63 validate_scene_layers
Validates scene layers.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 207 / 222
9 Repository
9.1 ro_audit_addrecord
Adds an audit record for an asset.
Parameter Name Parameter Type Parameter Description
assetid integer Asset ID to add audit record for.
auditmessage string Audit Message.
9.2 ro_asset_removeexternalsystemid
Removes any associated external system id from a specific asset version.
Parameter Name Parameter Type Parameter Description
assetid integer Asset Id.
assetversion string Asset version number. Optional, if specified operation will clear partner system Id and version from this version only, else it will clear it from all versions of asset specified.
9.3 ro_asset_removespecifiedexternalsystemid
Removes external system ids that match the external system id information supplied from the asset versions they are associated with.
Parameter Name Parameter Type Parameter Description
partnertype string Partner system name.
partnerid string Partner Id.
partnerversion string Partner system version (optional).
partnerrevision string Partner system revision (optional).
projectname string Project name.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 208 / 222
9.4 ro_asset_getdetailsbyexternalsystemid
Gets the details of an asset specified by external system id.
Parameter Name Parameter Type Parameter Description
partnersystem string The External System Name to look up.
partnerid string The External System ID to look up.
partnerversion string The External System Version to look up.
partnerrevision string The External System Revision to look up.
projectid integer The ID of the Project to perform the lookup in.
projectname string The name of the project to perform the lookup in.
assetid integer The Asset ID if found.
assetversion integer The Asset version if found.
processstatus string Processing status (Unused).
assettype string The Asset type.
assetfile string The Asset file name.
deepserverfolder string The SAP Visual Enterprise Generator folder the asset was uploaded to.
9.5 ro_asset_getancestorinstances
Gets the asset instance IDs of ancestors of the specified asset.
Parameter Name Parameter Type Parameter Description
assetid integer The child asset id.
ancestorinstancecount integer The number of ancestor asset instances found.
ancestorinstanceids collectionparameter The list of all the ancestor asset instance IDs.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 209 / 222
9.6 ro_asset_getancestorassetids
Gets the asset IDs of all ancestors of the specified asset.
Parameter Name Parameter Type Parameter Description
assetid integer The child asset ID to look up ancestors for.
ancestorassetcount integer The number of ancestor assets found.
ancestorassetids collectionparameter The list of all the ancestor asset IDs.
9.7 ro_asset_getexternalsystemid
Gets the external system id for an asset version.
Parameter Name Parameter Type Parameter Description
assetid integer The asset ID.
assetversion string The asset version.
partnerid string The External System Name of the asset, if any.
externalsystemid string The External System ID of the asset, if any.
externalsystemversion string The External System Version of the asset, if any.
externalsystemrevision string The External System Revision of the asset, if any.
9.8 ro_asset_getparentassetids
Gets the parent asset IDs of a given asset ID.
Parameter Name Parameter Type Parameter Description
assetid integer The asset ID.
parentassetcount integer The number of parent assets found.
parentassetids collectionparameter The list of all parent asset IDs.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 210 / 222
9.9 ro_asset_getderivativesforversion
Gets the list of all existing derivatives for a specified asset.
Parameter Name Parameter Type Parameter Description
assetid integer The asset ID to list derivatives for.
assetversion string If specified, the asset version to list derivatives for, otherwise, the current version.
extension string If specified, only derivatives with the specified file extension will be listed.
derivatives collectionparameter The details of the matching derivatives.
9.10 ro_asset_setexternalsystemid
Sets the external system ID for a specific asset version.
Parameter Name Parameter Type Parameter Description
assetid integer The asset ID.
assetversion string The asset version.
partnersystem string The external system name.
partnerid string The external system ID.
partnerversion string The external system version.
partnerrevision string The external system revision.
9.11 ro_manifest_convertversion
Converts between different versions of file upload manifests.
Parameter Name Parameter Type Parameter Description
source filename The source manifest file to convert.
sourceversion string The version of the source manifest file ('V1', or 'V2').
destination filename The destination file to place the converted manifest into.
destinationversion string The version of the destination manifest file ('V1', or 'V2').
Repository
Version: 1.0 – 2011-12-13 PUBLIC 211 / 222
9.12 ro_entitydatabag_deletevalue
Deletes an item from the entity data bag.
Parameter Name Parameter Type Parameter Description
entityid integer ID of the entity.
entitytype string Type of the entity.
name string Name of the data property to delete.
9.13 ro_absoluteinstance_downloadmasterderivative
Downloads the RHZ master derivative of an absolute instance from the repository.
Parameter Name Parameter Type Parameter Description
absoluteinstanceid integer The ID of the absolute instance to download.
outputfilepath filename The file to save the downloaded absolute instance to.
addtocache boolean Whether or not to add the output to the download cache.
absoluteinstancename string The name of the downloaded absolute instance.
9.14 ro_asset_downloadmasterderivative
Downloads the RHZ master derivative of an asset from the repository.
Parameter Name Parameter Type Parameter Description
assetid integer The asset ID of the asset to download.
assetversion integer The version of the asset to download (Optional).
outputfilepath filename The file to save the downloaded asset to.
addtocache boolean Whether or not to add the output to the download cache.
assetname string The name of the downloaded asset.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 212 / 222
9.15 ro_asset_downloadoriginalfile
Gets the current version of an asset, and stores it in a specified file system location.
Parameter Name Parameter Type Parameter Description
location string The path of a filesystem folder to save the file to.
assetid integer The asset ID to retrieve.
filename filename The fully qualified path of the file to save.
9.16 ro_asset_getassetidfromexternalsystemid
Gets the asset ID of the asset that an external system ID is applied to.
Parameter Name Parameter Type Parameter Description
project_id integer The project ID of the project to look in.
externalsystem_name string The external system name.
externalsystem_uid string The external system uid.
asset_id integer The asset ID of the asset identified by the specified external system details, if any.
9.17 ro_asset_getdetails
Gets information about a particular asset version.
Parameter Name Parameter Type Parameter Description
assetid integer Asset ID.
assetversion integer Asset Version.
masterderivativeid integer Master Derivative ID.
masterderivativename string Master Derivative Name.
derivativefilename string Master Derivative File Name.
origfileid integer Original File ID.
origfilename string Original File Name.
origfullpath string Original File full path uploaded from.
assettype string Asset Type.
toplevel boolean Whether asset was uploaded as top level.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 213 / 222
9.18 ro_file_scanforassetbuildinfo
Gets the file processing information to process the specified file as an asset.
Parameter Name Parameter Type Parameter Description
filename filename The file to analyze.
derivativeprocesshint string The name of the process that the caller wishes to use to create master derivatives for this asset. Is treated as a hint only. (Optional).
requireplugin boolean Whether a plugin file type is required or not (Default: false).
filetypename string The human readable name of the file type that was selected to process this file.
filetypeid integer The file type ID, or 0 if no matching file type in the database.
pluginguid string The GUID of the plugin that should be used to process this file.
mimetype string The MIME type that should be used when this file is downloaded.
assettypes string The asset types that can be used when storing this file as an asset (comma-delimited list).
derivativeprocess string The name of the process that should be used to create the master derivative for this asset.
storeoriginals boolean Whether originals should be stored for this asset.
thumbnailgenerator string The thumbnail generator that should be used to generate thumbnails for this asset ('DeepServer', 'OperatingSystem', or 'None').
9.19 ro_job_getcreatedassetversions
Gets the asset versions created by a particular job.
Parameter Name Parameter Type Parameter Description
jobid string The job ID.
versions collectionparameter Collection of the asset versions created by the job, if any.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 214 / 222
9.20 ro_derivative_download
Gets a derivative or a thumbnail for a derivative, saving it to the specified file system location.
Parameter Name Parameter Type Parameter Description
location string The location to save file to. The filename is determined from derivative name.
derivativeid integer The ID of the derivative to retrieve.
filename filename The fully qualified path of the saved file.
9.21 ro_derivative_getdetails
Gets information about a specified derivative.
Parameter Name Parameter Type Parameter Description
derivativeid integer The Derivative ID to look up details for.
assetid integer Asset ID.
assetversion integer Asset Version.
derivativetypeid integer Derivative Type ID.
derivativefilename string Derivative filename.
9.22 ro_derivative_getstream
Gets a derivative or a thumbnail for a derivative into a stream in the process.
Parameter Name Parameter Type Parameter Description
derivativeid integer The derivative ID to get the stream for.
thumbnail boolean Whether to return a stream for the derivative, or its thumbnail.
writemode boolean Whether the stream should be writable or not.
stream stream The derivative or thumbnail stream.
filename filename The file name stored in the database for the derivative.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 215 / 222
9.23 ro_entitydatabag_getvalue
Gets an item from the entity data bag.
Parameter Name Parameter Type Parameter Description
entityid integer ID of the entity.
entitytype string Type of the entity.
name string Name of the data property to get.
value string The property value.
9.24 ro_absoluteinstance_getabsoluteinstancescreatedbyjob
Gets the top-level absolute instances created by a particular job.
Parameter Name Parameter Type Parameter Description
jobid string The job ID.
instances collectionparameter Collection of the top-level absolute instances created by the job, if any.
9.25 ro_asset_getassetidandversionfromexternalsystemid
Gets the asset ID and asset version for an external system ID.
Parameter Name Parameter Type Parameter Description
externalsystem string External partner name.
externalsystemid string External partner ID.
externalsystemversion string External partner version.
externalsystemrevison string External partner revision.
projectid integer Project ID.
assetid integer Asset ID.
assetversion integer Asset version.
9.26 ro_asset_getmasterderivativeid
Gets the master derivative ID for a given asset ID.
Parameter Name Parameter Type Parameter Description
assetid integer The Asset ID.
masterderivativeid integer The Master Derivative ID, if any.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 216 / 222
9.27 ro_file_download
Downloads the file with the specified ID and saves it to a file system file.
Parameter Name Parameter Type Parameter Description
fileid integer The ID of the file to retrieve.
filename filename The fully qualified path to save the file to.
9.28 ro_filetype_getforfile
Gets the file type ID with the specified plugin GUID and asset type.
Parameter Name Parameter Type Parameter Description
pluginguid string The plugin GUID.
filename filename The file name of the file to perform the lookup for.
assettypeid integer The asset type ID to use as a hint for the file type lookup. (Optional).
filetypeid integer The ID of the original file type, or 0 if no match found.
mimetype string The MIME type of the original file, or an empty string if no match found.
9.29 ro_view_getname
Returns view name for a given view ID.
Parameter Name Parameter Type Parameter Description
viewid integer View ID.
viewname string View name.
9.30 ro_job_getproperty
Gets the value of the job property with the specified name.
Parameter Name Parameter Type Parameter Description
jobid integer The job ID.
propertyname string The name of the job property to get the value for.
propertyvalue string The job property value.
Repository
Version: 1.0 – 2011-12-13 PUBLIC 217 / 222
9.31 ro_job_setproperty
Sets the value of a job property.
Parameter Name Parameter Type Parameter Description
propertyname string The name of the job property to set value for.
jobid integer The job ID.
propertyvalue string The property value to set.
9.32 ro_asset_setmetadatavalue
Adds or updates metadata on a specified asset.
Parameter Name Parameter Type Parameter Description
assetid integer The asset ID to apply the metadata changes to.
category integer The Category ID (Either category ID or name must be provided).
categoryname string The Category name (Either category ID or name must be provided).
name string The field name of the metadata value to set.
value string The metadata field value to set.
subnodeid string The Node ID to set metadata for (Optional).
subnodepath string The Node path on which metadata is being set (Optional).
9.33 ro_entitydatabag_setvalue
Sets the value of an item in the entity databag.
Parameter Name Parameter Type Parameter Description
entityid integer The ID of the entity.
entitytype string The type of the entity.
name string The name of the property to set.
value string The value to set.
Scriptable Operations
Version: 1.0 – 2011-12-13 PUBLIC 218 / 222
10 Scriptable Operations
10.1 script_execute
Executes a script block.
Parameter Name Parameter Type Parameter Description
script scriptblock The script block to execute.
sandbox boolean Whether or not to run the script in a sandbox.
SOAP Web
Version: 1.0 – 2011-12-13 PUBLIC 219 / 222
11 SOAP Web
11.1 webservice_methodinvoke
Calls a method on an external application web service.
Parameter Name Parameter Type Parameter Description
assemblyname string The generated Web Method Proxy assembly.
typename string The type of the Web Service proxy.
methodname string The name of the web method or operation.
endpoint string The Web Service Endpoint.
11.2 webservice_operationgenerator
Creates operations to communicate with external application web services.
Parameter Name Parameter Type Parameter Description
wsdllocation string The location of the wsdl, typically a URL.
username string Username for accessing the wsdl.
password string Password for accessing the wsdl.
toolboxgroup string The toolbox group to add the operation to.
prefix string A prefix that is added to the Operation name to ensure uniqueness. Used when multiple web services have methods of the same name.
strongnamekeyfile string This is the location of the strong name key file that is used when generating Web Service proxy DLL files.
operations collectionparameter The names of all operations that have been generated.
messages collectionparameter A log of operations, parameters and errors generated.
SQL Database
Version: 1.0 – 2011-12-13 PUBLIC 220 / 222
12 SQL Database
12.1 database_executecommand
Runs a SQL server stored procedure and returns the results.
Parameter Name Parameter Type Parameter Description
connectionstring string Input parameter, the connection string. eg. 'Data Source={servername}; Integrated Security=SSPI; Initial Catalog={databasename;}'.
commandtimeout integer Input parameter, the maximum number of seconds to wait for a command to execute. (0=infinite).
command string Input parameter, The name of the stored procedure to execute. e.g. 'spGetAssetId'.
dataset db_dataset Output parameter, The results of the executed stored procedure.
Triggers
Version: 1.0 – 2011-12-13 PUBLIC 221 / 222
13 Triggers
13.1 filetrigger
A trigger that includes a file parameter.
Parameter Name Parameter Type Parameter Description
context contextparameter The task context.
filename filename Location of the file to process.
13.2 generictrigger
A generic trigger that only includes the task context.
Parameter Name Parameter Type Parameter Description
context contextparameter The task context.
13.3 simpletrigger
Trigger that supports name/value pair parameters.
Parameter Name Parameter Type Parameter Description
context contextparameter The task context.
request xmi_simpletrigger The input parameter.
response xmo_simpletrigger The output parameter.
13.4 conversiontrigger
A trigger used by conversion server processes.
Parameter Name Parameter Type Parameter Description
context contextparameter The task context.
filename filename The input file name.
outputfolder string The output folder path.