Operations Guide

Visual Enterprise Generator Version 7

PUBLIC Document Version: 1.0 2011-12-13

Copyright

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.

Version: 1.0 2011-12-13

PUBLIC

1 / 222

Copyright
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.

Version: 1.0 2011-12-13

PUBLIC

2 / 222

Copyright
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
Version: 1.0 2011-12-13

PUBLIC

3 / 222

Copyright
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 NVIDIAs 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.

Version: 1.0 2011-12-13

PUBLIC

4 / 222

Copyright
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 NONINFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.

Version: 1.0 2011-12-13

PUBLIC

5 / 222

Document History

Document History

Version 1.0

Date 13 December 2011

Change Rebranding

Version: 1.0 2011-12-13

PUBLIC

6 / 222

Contents

Contents

1 1.1 1.2 1.3 1.4 1.5 1.6 1.7 2 2.1 2.2 2.3 2.4 2.5 2.6 2.7 2.8 2.9 2.10 2.11 2.12 2.13 2.14 2.15 2.16 2.17 2.18 2.19 2.20 2.21 2.22 2.23 2.24 2.25 2.26 2.27

2D Raster Graphics.............................................................................................................. 17 go_2d_flip .......................................................................................................................... 17 go_2d_tograyscale ............................................................................................................... 17 go_2d_getmetadata .............................................................................................................. 17 go_2d_open ........................................................................................................................ 17 go_2d_rotate ....................................................................................................................... 18 go_2d_save ......................................................................................................................... 18 go_2d_save_fittopreserveaspectratio ..................................................................................... 18 2D Vector/3D Graphics........................................................................................................ 19 go_animation_setproperties .................................................................................................. 19 go_thumbnail_createanimated .............................................................................................. 19 go_object_assigndefaultmaterialtoall..................................................................................... 20 go_cadsearchpath_add ......................................................................................................... 20 go_cadsearchpath_clear ....................................................................................................... 20 go_camera_setactiveparams ................................................................................................. 20 go_camera_setactivefov ....................................................................................................... 21 go_camera_setactiveview ..................................................................................................... 21 go_camera_setactiveprojectionmode ..................................................................................... 22 go_plugin_checklicense ....................................................................................................... 22 go_object_deselectall ........................................................................................................... 23 go_context_load .................................................................................................................. 23 go_context_save .................................................................................................................. 23 go_thumbnail_createstatic .................................................................................................... 23 go_fileformat_getall ............................................................................................................ 23 go_scene_get2dmodeflag ..................................................................................................... 24 go_scene_getexternalfile ...................................................................................................... 24 go_fileformat_getbyguid ...................................................................................................... 24 go_plugin_getguidandlicensestatus ....................................................................................... 24 go_object_getselectedsurfacearea ......................................................................................... 25 go_object_getselectedvolume ............................................................................................... 25 go_view_isorthographic ....................................................................................................... 25 go_layer_create ................................................................................................................... 25 go_layer_delete ................................................................................................................... 26 go_layer_rename ................................................................................................................. 26 go_layer_getall.................................................................................................................... 26 go_scene_getexternalfiles..................................................................................................... 26 PUBLIC
7 / 222

Version: 1.0 2011-12-13

Contents
2.28 2.29 2.30 2.31 2.32 2.33 2.34 2.35 2.36 2.37 2.38 2.39 2.40 2.41 2.42 2.43 2.44 2.45 2.46 2.47 2.48 2.49 2.50 2.51 2.52 2.53 2.54 2.55 2.56 2.57 2.58 2.59 2.60 2.61 2.62 2.63 2.64 2.65 2.66 2.67 2.68 2.69 2.70 2.71 go_scene_getmaterials ......................................................................................................... 27 go_material_assign .............................................................................................................. 27 go_material_getparams ........................................................................................................ 27 go_material_gettexture......................................................................................................... 28 go_material_import ............................................................................................................. 29 go_material_setambientcolor ................................................................................................ 29 go_material_setdiffusecolor ................................................................................................. 29 go_material_setdoublesidedflag ............................................................................................ 29 go_material_setemissivecolor ............................................................................................... 29 go_material_setglossinesslevel ............................................................................................. 30 go_material_setopacitylevel ................................................................................................. 30 go_material_setoutlinethickness ........................................................................................... 30 go_material_setparams......................................................................................................... 30 go_material_setreflectionlevel .............................................................................................. 31 go_material_setrefractionlevel .............................................................................................. 31 go_material_setspecularlevel ................................................................................................ 31 go_material_setspecularcolor ............................................................................................... 32 go_material_settexture ......................................................................................................... 32 go_material_setwireframelinewidth ...................................................................................... 33 go_scene_mergeduplicatematerials ....................................................................................... 33 go_scene_mergefile ............................................................................................................. 33 go_scene_mergetransformedfile ........................................................................................... 34 go_scene_getmetadata ......................................................................................................... 34 go_scene_open .................................................................................................................... 34 go_scene_openwithplugin .................................................................................................... 35 go_scene_openempty ........................................................................................................... 35 go_render_raytrace .............................................................................................................. 35 go_scene_removeexternalfile ............................................................................................... 36 go_object_removebytype ..................................................................................................... 37 go_object_removeselected.................................................................................................... 37 go_scene_removeunusedmaterials ........................................................................................ 37 go_scene_resettransform ...................................................................................................... 37 go_scene_save .................................................................................................................... 38 go_scene_getanimations....................................................................................................... 38 go_scene_zoom ................................................................................................................... 38 go_object_selectall .............................................................................................................. 38 go_object_selectbymetadata ................................................................................................. 39 go_plugin_selectforfile ........................................................................................................ 39 go_camera_settodefaultview................................................................................................. 39 go_markup_setvisibilityforall ............................................................................................... 39 go_object_setmetadatawithtype ............................................................................................ 40 go_object_setmetadata ......................................................................................................... 40 go_object_setname .............................................................................................................. 41 go_viewport_setsize ............................................................................................................ 41 PUBLIC
8 / 222

Version: 1.0 2011-12-13

Contents
2.72 2.73 2.74 2.75 2.76 2.77 2.78 2.79 2.80 2.81 2.82 2.83 2.84 2.85 2.86 2.87 2.88 2.89 2.90 2.91 2.92 2.93 2.94 2.95 2.96 2.97 2.98 2.99 2.100 3 3.1 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 go_scene_setviewaxis .......................................................................................................... 41 go_setting_setfloat............................................................................................................... 41 go_setting_setinteger ........................................................................................................... 42 go_setting_setstring ............................................................................................................. 42 go_viewport_setmetadata ..................................................................................................... 42 go_step_export .................................................................................................................... 43 go_step_getall ..................................................................................................................... 43 go_scene_transform ............................................................................................................. 43 go_viewport_getall .............................................................................................................. 43 go_viewport_setactive ......................................................................................................... 44 go_object_setvisibility ......................................................................................................... 44 go_scene_getxreferences ...................................................................................................... 44 go_render_zbuffer ............................................................................................................... 45 goc_bounding_box .............................................................................................................. 46 goc_hidden_wireframe......................................................................................................... 47 goc_line_illustration ............................................................................................................ 48 goc_sceneproperties............................................................................................................. 49 goc_shaded_illustration........................................................................................................ 53 goc_shaded_vertices ............................................................................................................ 56 goc_shaded_wireframe ........................................................................................................ 57 goc_solid ............................................................................................................................ 58 goc_solid_outline ................................................................................................................ 60 goc_solid_wireframe ........................................................................................................... 62 goc_transparent ................................................................................................................... 63 goc_transparent_bounding_box ............................................................................................ 65 goc_transparent_bounding_box_outline ................................................................................ 66 goc_transparent_wireframe .................................................................................................. 67 goc_vertices ........................................................................................................................ 68 goc_wireframe .................................................................................................................... 69 File/Directory/Path .............................................................................................................. 70 do_directory_attributes ........................................................................................................ 70 po_path_combine ................................................................................................................ 70 do_directory_copy ............................................................................................................... 71 do_directory_create ............................................................................................................. 71 do_directory_delete ............................................................................................................. 71 do_directory_deletefiles ....................................................................................................... 71 do_directory_exists.............................................................................................................. 72 do_directory_getdirectories .................................................................................................. 72 do_directory_getfiles ........................................................................................................... 72 do_directory_move .............................................................................................................. 72 fo_file_findtext ................................................................................................................... 73 fo_file_append .................................................................................................................... 73 fo_file_getattributes ............................................................................................................. 73 po_path_buildfilename......................................................................................................... 74 PUBLIC
9 / 222

Version: 1.0 2011-12-13

Contents
3.15 3.16 3.17 3.18 3.19 3.20 3.21 3.22 3.23 3.24 3.25 3.26 4 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9 5 5.1 5.2 5.3 5.4 5.5 5.6 5.7 5.8 5.9 5.10 5.11 5.12 5.13 5.14 5.15 5.16 5.17 5.18 5.19 5.20 5.21 fo_file_copy........................................................................................................................ 74 fo_fileordirectory_create ...................................................................................................... 74 do_directory_createworkspacetempdir .................................................................................. 74 fo_file_delete ...................................................................................................................... 75 fo_file_delete_with_retry ..................................................................................................... 75 fo_file_exists ...................................................................................................................... 75 fo_file_move....................................................................................................................... 75 po_path_resolveunc ............................................................................................................. 75 fo_file_savefromstring ......................................................................................................... 76 fo_file_gettempname ........................................................................................................... 76 fo_file_unzip....................................................................................................................... 76 fo_file_zip .......................................................................................................................... 76 Flow Control ....................................................................................................................... 77 er_stopprocessing ................................................................................................................ 77 for-each .............................................................................................................................. 77 if ........................................................................................................................................ 77 pause .................................................................................................................................. 77 set ...................................................................................................................................... 78 standarderror ....................................................................................................................... 78 standardterminatehandler ..................................................................................................... 79 variable .............................................................................................................................. 79 while .................................................................................................................................. 79 General Operations .............................................................................................................. 80 guid_createnew ................................................................................................................... 80 datetime_tostring ................................................................................................................. 80 email_send .......................................................................................................................... 81 rhz_extractvzxml ................................................................................................................. 81 http_download .................................................................................................................... 81 http_upload ......................................................................................................................... 82 log_add .............................................................................................................................. 82 log_message ....................................................................................................................... 82 log_save ............................................................................................................................. 83 xml_setvalue ....................................................................................................................... 83 serverproperties_getall ......................................................................................................... 83 xml_extract ......................................................................................................................... 83 task_resultsdocument_tomsmq ............................................................................................. 84 task_resultsdocument_tofile ................................................................................................. 84 pdf_headerfooter ................................................................................................................. 84 pdf_mergefiles .................................................................................................................... 85 pdf_templatemerge .............................................................................................................. 86 job_start ............................................................................................................................. 86 task_start ............................................................................................................................ 86 keyvaluepair_response_setvalue ........................................................................................... 87 os_shellexecute ................................................................................................................... 87 PUBLIC
10 / 222

Version: 1.0 2011-12-13

Contents
5.22 5.23 5.24 5.25 5.26 5.27 5.28 5.29 5.30 5.31 5.32 6 6.1 6.2 6.3 6.4 6.5 6.6 6.7 6.8 6.9 6.10 6.11 6.12 6.13 6.14 6.15 6.16 6.17 6.18 6.19 6.20 6.21 6.22 6.23 6.24 6.25 6.26 6.27 6.28 6.29 6.30 6.31 6.32 keyvaluepair_response_writetofile ........................................................................................ 87 keyvaluepair_trigger_loadfromfile ........................................................................................ 87 string_tokenize .................................................................................................................... 88 os_waitforosprocessexit ....................................................................................................... 88 xml_attributeadd ................................................................................................................. 88 xml_elementadd .................................................................................................................. 89 xml_elementcount ............................................................................................................... 89 xml_elementexists ............................................................................................................... 89 xml_escapestring ................................................................................................................. 90 xml_getattributevalue .......................................................................................................... 90 xml_xslttransform ............................................................................................................... 90 Import/Export Settings ......................................................................................................... 91 Right_Hemisphere_Binary_ExportOptions ............................................................................ 91 Autodesk_3D_Studio_ExportOptions.................................................................................... 94 Visual_XML_ExportOptions ................................................................................................ 94 XAML_ExportOptions ........................................................................................................ 95 DirectX_Model_ExportOptions ............................................................................................ 96 AutoCAD_Design_Web_Format_ExportOptions ................................................................... 96 DICOM_Image_ExportOptions ............................................................................................ 97 Open_Inventor_File_ExportOptions...................................................................................... 97 SOFTIMAGE_XSI_ExportOptions ....................................................................................... 98 3ds_Max_File_ExportOptions .............................................................................................. 99 VRML_Worlds_ExportOptions .......................................................................................... 100 Visual_Design_Stream_ExportOptions ............................................................................... 100 LightWave_Scene_ExportOptions ...................................................................................... 103 JPEG_2000_JPC_ExportOptions ........................................................................................ 103 Rhinoceros_3D_Model_ExportOptions ............................................................................... 103 Office_Powerpoint_Document_ExportOptions .................................................................... 104 HTML_Document_with_3D_ExportOptions ....................................................................... 107 LightWave_3D_and_Binary_Object_ExportOptions ............................................................ 111 OpenFlight_Scene_Description_Database_ExportOptions .................................................... 111 Maya_ASCII_Scene_ExportOptions ................................................................................... 112 Adobe_Portable_Document_2D__with_template__ExportOptions ........................................ 113 Tagged_Image_File_Format_ExportOptions........................................................................ 116 AutoCAD_Drawing_Object_ExportOptions ........................................................................ 116 Portable_Network_Graphics_ExportOptions........................................................................ 116 Universal_3D_export_ExportOptions.................................................................................. 117 JPEG_2000_JP2_ExportOptions......................................................................................... 117 Maya_Binary_Scene_ExportOptions................................................................................... 118 Maya_Interchange_File_Format_ExportOptions .................................................................. 118 Stereolithography_File_ExportOptions................................................................................ 118 Adobe_Portable_Document_3D_ExportOptions .................................................................. 119 Flex_Web_Application_ExportOptions ............................................................................... 125 JTPMI_Files_ExportOptions .............................................................................................. 129 PUBLIC
11 / 222

Version: 1.0 2011-12-13

Contents
6.33 6.34 6.35 6.36 6.37 6.38 6.39 6.40 6.41 6.42 6.43 6.44 6.45 6.46 6.47 6.48 6.49 6.50 6.51 6.52 6.53 6.54 6.55 6.56 6.57 6.58 6.59 6.60 6.61 6.62 6.63 6.64 6.65 6.66 6.67 6.68 6.69 6.70 6.71 6.72 6.73 6.74 6.75 6.76 Google_SketchUp_Document_ExportOptions ..................................................................... 130 Adobe_Portable_Document_2D_ExportOptions .................................................................. 130 Right_Hemisphere_Material_ExportOptions........................................................................ 131 Computer_Graphics_Metafile_ExportOptions...................................................................... 132 AutoCAD_Drawing_Interchange_ExportOptions ................................................................. 132 OpenEXR_Bitmap_ExportOptions ..................................................................................... 133 JPEG_Image_ExportOptions .............................................................................................. 133 Wavefront_Object_ExportOptions ...................................................................................... 134 Caligari_trueSpace_Object_ExportOptions .......................................................................... 134 Right_Hemisphere_Binary_ImportOptions .......................................................................... 134 Autodesk_3D_Studio_ImportOptions.................................................................................. 135 CATIA5_Assembly_Files_ImportOptions ........................................................................... 135 Visual_XML_ImportOptions .............................................................................................. 137 DirectX_Model_ImportOptions .......................................................................................... 137 Caligari_trueSpace_Scene_ImportOptions ........................................................................... 138 Pro_ENGINEER_Drawing_files_ImportOptions.................................................................. 138 AutoCAD_Design_Web_Format_ImportOptions ................................................................. 139 Open_Inventor_File_ImportOptions.................................................................................... 139 Solid_Edge_Assembly_files_ImportOptions ........................................................................ 140 N3ds_Max_File_ImportOptions ......................................................................................... 141 MicroStation_CAD_Graphic_files_ImportOptions ............................................................... 141 VRML_Worlds_ImportOptions .......................................................................................... 142 Visual_Design_Stream_ImportOptions ............................................................................... 143 LightWave_Scene_ImportOptions ...................................................................................... 144 Rhinoceros_3D_Model_ImportOptions ............................................................................... 144 Autodesk_3D_Studio_Project_ImportOptions...................................................................... 145 Autodesk_3D_Studio_Material_ImportOptions.................................................................... 145 LightWave_3D_and_Binary_Object_ImportOptions ............................................................ 145 Pro_ENGINEER_Assembly_files_ImportOptions ................................................................ 146 OpenFlight_Scene_Description_Database_ImportOptions .................................................... 147 Maya_ASCII_Scene_ImportOptions ................................................................................... 147 Gerber_File_ImportOptions ............................................................................................... 147 Tagged_Image_File_Format_ImportOptions........................................................................ 148 AutoCAD_Drawing_Object_ImportOptions ........................................................................ 148 Parasolid_Part_and_Assembly_Files_ImportOptions ............................................................ 150 AutoCAD_Sheet_Set_File_ImportOptions .......................................................................... 151 Points_File_ImportOptions ................................................................................................ 151 Maya_Binary_Scene_ImportOptions................................................................................... 152 Maya_Interchange_File_Format_ImportOptions .................................................................. 152 Universal_3D_import_ImportOptions ................................................................................. 152 CATIA4_Part_Files_ImportOptions.................................................................................... 153 Collada_ImportOptions ...................................................................................................... 154 Step_Part_and_Assembly_files_ImportOptions.................................................................... 155 Pro_ENGINEER_Neutral_files_ImportOptions ................................................................... 156 PUBLIC
12 / 222

Version: 1.0 2011-12-13

Contents
6.77 6.78 6.79 6.80 6.81 6.82 6.83 6.84 6.85 6.86 6.87 6.88 6.89 6.90 6.91 6.92 6.93 6.94 6.95 6.96 6.97 6.98 6.99 6.100 6.101 7 7.1 7.2 7.3 8 8.1 8.2 8.3 8.4 8.5 8.6 8.7 8.8 8.9 8.10 8.11 8.12 8.13 8.14 SolidWorks_Drawing_files_ImportOptions ......................................................................... 157 Pro_ENGINEER_Part_files_ImportOptions ........................................................................ 157 Protein_Data_Bank_ImportOptions .................................................................................... 158 JTPMI_Files_ImportOptions .............................................................................................. 159 Inventor_Part_files_ImportOptions ..................................................................................... 160 Portable_Graymap_Heightfield_ImportOptions ................................................................... 161 NX_Parts_and_Assemblies_ImportOptions ......................................................................... 162 CATIA4_Assembly_Files_ImportOptions ........................................................................... 163 Google_SketchUp_Document_ImportOptions ..................................................................... 165 SolidWorks_Part_files_ImportOptions ................................................................................ 165 Bundled_RH___RHB_files_ImportOptions ......................................................................... 166 Bundled_RH___RHB_files_ImportOptions ......................................................................... 167 AutoCAD_Drawing_Interchange_ImportOptions ................................................................. 167 CATIA5_Drawing_files_ImportOptions.............................................................................. 168 Inventor_Assembly_files_ImportOptions ............................................................................ 169 Adobe_Portable_Document_ImportOptions......................................................................... 170 CATIA5_Part_files_ImportOptions .................................................................................... 170 Solid_Edge_Part_files_ImportOptions ................................................................................ 172 Iges_Part_and_Assembly_files_ImportOptions .................................................................... 173 CATIA_Graphical_Representation_Files_CGR__ImportOptions .......................................... 174 JPEG_Image_ImportOptions .............................................................................................. 175 Wavefront_Object_ImportOptions ...................................................................................... 175 ACIS_Part_and_Assembly_files_ImportOptions .................................................................. 176 Caligari_trueSpace_Object_ImportOptions .......................................................................... 177 SolidWorks_Assembly_files_ImportOptions ....................................................................... 177 Metadata ........................................................................................................................... 179 filemetadata_extract........................................................................................................... 179 filemetadata_extractmsoffice .............................................................................................. 179 filemetadata_extractxmp .................................................................................................... 179 Modules ........................................................................................................................... 180 ApplyModifier .................................................................................................................. 180 bomfactory ....................................................................................................................... 180 Clean_Scene ..................................................................................................................... 181 cm_createbommodelview ................................................................................................... 181 cm_removeunwantednodes................................................................................................. 181 cm_renametoplevelnode..................................................................................................... 181 cm_setaxissystemcolors ..................................................................................................... 182 cm_setmetadataunit ........................................................................................................... 182 cm_setpmialwaysontop ...................................................................................................... 182 cm_setpmibillboarding....................................................................................................... 182 cm_setpmilinecolor ........................................................................................................... 183 cm_setpmitextcolor ........................................................................................................... 183 cm_setpointcolor_style ...................................................................................................... 183 cm_wireframe ................................................................................................................... 184 PUBLIC
13 / 222

Version: 1.0 2011-12-13

Contents
8.15 8.16 8.17 8.18 8.19 8.20 8.21 8.22 8.23 8.24 8.25 8.26 8.27 8.28 8.29 8.30 8.31 8.32 8.33 8.34 8.35 8.36 8.37 8.38 8.39 8.40 8.41 8.42 8.43 8.44 8.45 8.46 8.47 8.48 8.49 8.50 8.51 8.52 8.53 8.54 8.55 8.56 8.57 8.58 cm_wireframe_color .......................................................................................................... 184 convertaitopsd ................................................................................................................... 184 CreateDVIS ...................................................................................................................... 184 ct_clippingplane_crosssection ............................................................................................ 184 ct_color_objects ................................................................................................................ 185 ct_converttodoublesided..................................................................................................... 185 ct_explodeobjects .............................................................................................................. 186 ct_healmodel_advanced ..................................................................................................... 186 ct_invertfaces .................................................................................................................... 186 ct_invertfacesandnormals ................................................................................................... 187 ct_invertnormals................................................................................................................ 187 ct_joinequalpoints ............................................................................................................. 187 ct_randomizeobjects .......................................................................................................... 187 ct_realight......................................................................................................................... 188 ct_reducemodel_advanced.................................................................................................. 190 ct_remove_degenerate_triangles ......................................................................................... 191 ct_remove_duplicate_faces................................................................................................. 191 ct_remove_duplicate_materials ........................................................................................... 191 ct_remove_duplicate_meshes ............................................................................................. 191 ct_remove_invisible_polygons ........................................................................................... 191 ct_removeinternalparts ....................................................................................................... 192 ct_removesmallparts .......................................................................................................... 192 ct_separatemesh ................................................................................................................ 192 ct_unifynormals ................................................................................................................ 193 ct_uvmapping ................................................................................................................... 193 dgnhierarchyxml ............................................................................................................... 195 ill_advancedsettings........................................................................................................... 195 ill_render .......................................................................................................................... 198 jtassociatepmi ................................................................................................................... 200 jthierarchyxml ................................................................................................................... 200 NeutralXmlGenerator ........................................................................................................ 200 pdf_2d_picturing ............................................................................................................... 201 pdf_2d_picturing_serial ..................................................................................................... 201 pdf_merge ........................................................................................................................ 202 pdf_print_all_metadata ...................................................................................................... 202 pdf_print_metadata ............................................................................................................ 203 pdf_protect ....................................................................................................................... 203 pdf_xfdf_integrate ............................................................................................................. 204 pmi_settings...................................................................................................................... 204 pmi_visibility .................................................................................................................... 204 regenerate_scene_thumbnails ............................................................................................. 205 remove_vzxml_hierarchy_cache ......................................................................................... 205 RunFileQuery ................................................................................................................... 205 RunQuery ......................................................................................................................... 205 PUBLIC
14 / 222

Version: 1.0 2011-12-13

Contents
8.59 8.60 8.61 8.62 8.63 9 9.1 9.2 9.3 9.4 9.5 9.6 9.7 9.8 9.9 9.10 9.11 9.12 9.13 9.14 9.15 9.16 9.17 9.18 9.19 9.20 9.21 9.22 9.23 9.24 9.25 9.26 9.27 9.28 9.29 9.30 9.31 9.32 9.33 10 10.1 11 11.1 11.2 setsceneunits ..................................................................................................................... 206 validate_and_fix_scene_hierarchy ...................................................................................... 206 validate_and_fix_scene_layers ........................................................................................... 206 validate_scene_hierarchy ................................................................................................... 206 validate_scene_layers ........................................................................................................ 206 Repository ........................................................................................................................ 207 ro_audit_addrecord ............................................................................................................ 207 ro_asset_removeexternalsystemid ....................................................................................... 207 ro_asset_removespecifiedexternalsystemid .......................................................................... 207 ro_asset_getdetailsbyexternalsystemid ................................................................................ 208 ro_asset_getancestorinstances ............................................................................................. 208 ro_asset_getancestorassetids ............................................................................................... 209 ro_asset_getexternalsystemid ............................................................................................. 209 ro_asset_getparentassetids .................................................................................................. 209 ro_asset_getderivativesforversion ....................................................................................... 210 ro_asset_setexternalsystemid .............................................................................................. 210 ro_manifest_convertversion................................................................................................ 210 ro_entitydatabag_deletevalue ............................................................................................. 211 ro_absoluteinstance_downloadmasterderivative ................................................................... 211 ro_asset_downloadmasterderivative .................................................................................... 211 ro_asset_downloadoriginalfile ............................................................................................ 212 ro_asset_getassetidfromexternalsystemid............................................................................. 212 ro_asset_getdetails............................................................................................................. 212 ro_file_scanforassetbuildinfo .............................................................................................. 213 ro_job_getcreatedassetversions ........................................................................................... 213 ro_derivative_download ..................................................................................................... 214 ro_derivative_getdetails ..................................................................................................... 214 ro_derivative_getstream ..................................................................................................... 214 ro_entitydatabag_getvalue .................................................................................................. 215 ro_absoluteinstance_getabsoluteinstancescreatedbyjob ......................................................... 215 ro_asset_getassetidandversionfromexternalsystemid ............................................................. 215 ro_asset_getmasterderivativeid ........................................................................................... 215 ro_file_download .............................................................................................................. 216 ro_filetype_getforfile ......................................................................................................... 216 ro_view_getname .............................................................................................................. 216 ro_job_getproperty ............................................................................................................ 216 ro_job_setproperty............................................................................................................. 217 ro_asset_setmetadatavalue.................................................................................................. 217 ro_entitydatabag_setvalue .................................................................................................. 217 Scriptable Operations......................................................................................................... 218 script_execute ................................................................................................................... 218 SOAP Web ....................................................................................................................... 219 webservice_methodinvoke ................................................................................................. 219 webservice_operationgenerator ........................................................................................... 219 PUBLIC
15 / 222

Version: 1.0 2011-12-13

Contents
12 12.1 13 13.1 13.2 13.3 13.4 SQL Database ................................................................................................................... 220 database_executecommand................................................................................................. 220 Triggers ............................................................................................................................ 221 filetrigger .......................................................................................................................... 221 generictrigger .................................................................................................................... 221 simpletrigger ..................................................................................................................... 221 conversiontrigger............................................................................................................... 221

Version: 1.0 2011-12-13

PUBLIC

16 / 222

2D Raster Graphics

2D Raster Graphics

1.1

go_2d_flip

Flips 2D images horizontally or vertically.

Parameter Name direction Parameter Type string Parameter Description The direction to flip, must be horizontal or vertical. Possible Values Horizontal Vertical horiz 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 metadataobject outputfilepath Parameter Type metadataparameter2d filename Parameter Description The extracted image metadata. 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 filename width height Parameter Type filename integer integer Parameter Description The location of the 2d file to open. The width of the 2d file. The height of the 2d file.

Version: 1.0 2011-12-13

PUBLIC

17 / 222

2D Raster Graphics

1.5

go_2d_rotate

Rotates an open 2D image in an anti-clockwise direction by the specified angle.

Parameter Name angle Parameter Type integer Parameter Description The angle to rotate by, must be 90, 180 or 270. Possible Values 90 180 270 90 180 270

1.6

go_2d_save

Saves an open 2D image to a file in the specified format.

Parameter Name filename fileformat width height Parameter Type filename string integer integer Parameter Description Specify where to save the file. The 2d file type. eg, 'jpg', 'bmp'. The width in pixels of the image. 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 filename fileformat width height background transparency Parameter Type filename string integer integer integer integer Parameter Description Specifies the location to save the file. The 2d file type. eg, 'jpg', 'bmp'. The target width of the image. The target height of the image. The background color of the image. The background transparency level (0 is transparent, 100 is opaque).

Version: 1.0 2011-12-13

PUBLIC

18 / 222

2D Vector/3D Graphics

2D Vector/3D Graphics

2.1

go_animation_setproperties

Sets specific properties for an animation range.

Parameter Name animationrangeindex starttime endtime fps Parameter Type integer float float float Parameter Description The index of the animation range. Start Time(secs). End Time(secs). Frames Per Second.

2.2

go_thumbnail_createanimated

Creates an animated GIF file thumbnail from the scene.

Parameter Name outputfilename outstream width height axis Parameter Type filename stream integer integer integer Parameter Description Output animation filename (optional if stream is provided). Output stream (optional if filename is provided). Width of the GIF file. Height of the GIF file. Rotation axis. Can be x, y or z. Possible Values X Y Z frames delay antialiasing integer integer integer 0 1 2

Number of frames in animation. Delay between frames of animation in milliseconds. Anti-Aliasing. Possible Values None 2x2 3x3 4x4 0 1 2 3
19 / 222

Version: 1.0 2011-12-13

PUBLIC

2D Vector/3D Graphics

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 path recurse Parameter Type string boolean Parameter Description Additional search path. 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 Camera Parameter Type string Parameter Description 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.

Version: 1.0 2011-12-13

PUBLIC

20 / 222

2D Vector/3D Graphics

2.7

go_camera_setactivefov

Changes the active camera's field of view binding (minimum, maximum, horizontal, vertical) and angle.
Parameter Name mode Parameter Type integer Parameter Description The field of view mode constant. 0=min, 1=max, 2=horizontal, 3=vertical. Possible Values Minimum from Width/Height Maximum from Width/Height Horizontally Vertically fov float 0 1 2 3

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 View Parameter Type integer Parameter Description The camera view. Possible Values Orthographic Left Orthographic Right Orthographic Top Orthographic Bottom Orthographic Front Orthographic Back 30 Isometric LTF 30 Isometric LTA 30 Isometric RTA 30 Isometric RTF 30 Isometric LBF 30 Isometric LBA 27 Isometric RBA 27 Isometric RBF 27 Isometric LTF 27 Isometric LTA 27 Isometric RTA 27 Isometric RTF 45 Isometric LBF 45 Isometric LBA 45 Isometric RBA 1159 1160 1161 1162 1163 1164 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065

Version: 1.0 2011-12-13

PUBLIC

21 / 222

2D Vector/3D Graphics
Parameter Name Parameter Type Parameter Description 45 Isometric RBF 45 Isometric LTF 45 Isometric LTA Dimetric RTA Dimetric RTF Dimetric LBF Dimetric LBA Dimetric RBA Dimetric RBF 43Trimetric LTF 43Trimetric LTA 43Trimetric RTA 43Trimetric RTF 43Trimetric LBF 43Trimetric LBA 48Trimetric RBA 48Trimetric RBF 48Trimetric LTF 48Trimetric LTA 48Trimetric RTA 48Trimetric RTF 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 11079 11080 11081 11082 11083 11084 11085 11086

2.9

go_camera_setactiveprojectionmode

Toggles the perspective projection mode of the active camera.

Parameter Name perspective Parameter Type boolean Parameter Description 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 pluginguid islicensed fileformatname Parameter Type string boolean string Parameter Description GUID of plugin to check. Whether or not the plugin is licensed. The name of the plugin file format, if found.

Version: 1.0 2011-12-13

PUBLIC

22 / 222

2D Vector/3D Graphics

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 filename Parameter Type filename Parameter Description 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 filename Parameter Type filename Parameter Description Specifies where to save the file.

2.14 go_thumbnail_createstatic
Saves a scene as a 2D thumbnail file.
Parameter Name width height infilename instream outfilename outstream result Parameter Type integer integer filename stream filename stream boolean Parameter Description The width in pixels of the 2d file. The height in pixels of the 2d file. The name of the input file. Input stream. The name of the thumbnail. Thumbnail stream. 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 fileformats Parameter Type collectionparameter Parameter Description The collection of loaded plugins.

Version: 1.0 2011-12-13

PUBLIC

23 / 222

2D Vector/3D Graphics

2.16 go_scene_get2dmodeflag
Gets the current value of the 2d mode flag.
Parameter Name current2dstate Parameter Type boolean Parameter Description Current value of 2d mode flag.

2.17 go_scene_getexternalfile
Gets an external file from the scene.
Parameter Name filename outfilename outstream Parameter Type string filename stream Parameter Description Name of the file in scene media folder. The location of the file. Data stream.

2.18 go_fileformat_getbyguid
Gets the name of the file format matching a specified GUID.
Parameter Name guid formatName Parameter Type string string Parameter Description File format/plugin GUID. 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 pluginfilename Parameter Type string Parameter Description Filename (without full path and including extension - for example test.x3d ) of the plugin. GUID of specified plugin. Whether or not the plugin is licensed.

pluginguid islicensed

string boolean

Version: 1.0 2011-12-13

PUBLIC

24 / 222

2D Vector/3D Graphics

2.20 go_object_getselectedsurfacearea
Returns the surface area of the selected objects in the scene.
Parameter Name surface Parameter Type double Parameter Description Surface area of selected objects.

2.21 go_object_getselectedvolume
Returns the volume of selected objects.
Parameter Name volume invertedvolume Parameter Type double double Parameter Description Volume of selected objects. The volume of the selected objects subtracted from the volume of the bounding box for the selected objects. The volume of the bounding box for the selected objects.

boundbox

double

2.22 go_view_isorthographic
Determines whether the the projection mode of a view is perspective or orthographic.
Parameter Name ViewId IsOrtho Parameter Type integer boolean Parameter Description The id of the view to check. True if the view is orthographic, otherwise false.

2.23 go_layer_create
Creates a new layer in the scene.
Parameter Name name objectid Parameter Type string integer Parameter Description Name of the new layer. ID of the created layer object.

Version: 1.0 2011-12-13

PUBLIC

25 / 222

2D Vector/3D Graphics

2.24 go_layer_delete
Deletes a layer from the scene.
Parameter Name name Parameter Type string Parameter Description Name of the layer. This is used to find the layer if 'objectid' is not specified. ID of the layer object.

objectid

integer

2.25 go_layer_rename
Renames a layer in the scene.
Parameter Name name objectid newname Parameter Type string integer string Parameter Description Name of the layer. ID of the layer object. 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 objectcollection Parameter Type collectionparameter Parameter Description 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 listoffiles Parameter Type collectionparameter Parameter Description A list of external media files in the scene.

Version: 1.0 2011-12-13

PUBLIC

26 / 222

2D Vector/3D Graphics

2.28 go_scene_getmaterials
Lists all the materials in the scene.
Parameter Name materials scene_materials Parameter Type collectionparameter boolean Parameter Description List of materials in the scene. 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 materialname Parameter Type string Parameter Description Material name. Used to find the material if 'materialid' is not specified. Material object ID.

materialid

integer

2.30 go_material_getparams
Gets the parameters for a particular material.
Parameter Name materialid ambient diffuse specular emissive opacity glossiness speclevel reflection refraction Parameter Type integer integer integer integer integer float float float float float Parameter Description Material object id. Ambient light color. Diffuse light color. Specular light (reflection) color. Emissive light (glow) color. Opacity of the material [0-100]. Determines the model's highlighting [0-100]. Intensity of the specular light [0100]. Material's ability to reflect [0-100]. Determines how much light is bent when traveling through material [0100]. The double-sided attribute for the material. Render the thickness of outlines relative to the value of the 'linesvalue' parameter.

doublesided rendoutlines

boolean boolean

Version: 1.0 2011-12-13

PUBLIC

27 / 222

2D Vector/3D Graphics
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 materialid mapid Parameter Type integer integer Parameter Description Material object id. Texture map id. Possible Values Diffuse Bump Opacity Reflection Refraction Specular Ambient Self Illumination Specular Level Glossiness Ambient Occlusion MAP #11 MAP #12 MAP #13 MAP #14 MAP #15 MAP #16 MAP #17 MAP #18 MAP #19 MAP #20 MAP #21 MAP #22 MAP #23 MAP #24 MAP #25 texture materialtextureparameter 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

Material texture definition.

Version: 1.0 2011-12-13

PUBLIC

28 / 222

2D Vector/3D Graphics

2.32 go_material_import
Imports materials from an RHM file into the scene.
Parameter Name filename materialsloaded Parameter Type filename collectionparameter Parameter Description Materials file. 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 materialid ambient Parameter Type integer integer Parameter Description Material object id. Material ambient color.

2.34 go_material_setdiffusecolor
Sets the diffuse color for a material.
Parameter Name materialid diffuse Parameter Type integer integer Parameter Description Material object id. Material diffuse color.

2.35 go_material_setdoublesidedflag
Sets the doublesided parameter for a material.
Parameter Name materialid doublesided Parameter Type integer boolean Parameter Description Material object id. Material double sided flag.

2.36 go_material_setemissivecolor
Sets the emissive color for a material.
Parameter Name materialid emissive
Version: 1.0 2011-12-13

Parameter Type integer integer

Parameter Description Material object id. Material emissive color.

PUBLIC

29 / 222

2D Vector/3D Graphics

2.37 go_material_setglossinesslevel
Sets the glossiness parameter for a material.
Parameter Name materialid glossiness Parameter Type integer float Parameter Description Material object id. Material glossiness level [0-100].

2.38 go_material_setopacitylevel
Sets the opacity level for a material.
Parameter Name materialid opacity Parameter Type integer float Parameter Description Material object id. Material opacity level [0-100].

2.39 go_material_setoutlinethickness
Sets the render outlines parameter for a material.
Parameter Name materialid rendoutlines linesvalue Parameter Type integer boolean float Parameter Description Material object id. Material render outline flag. Material outline thickness [0-100].

2.40 go_material_setparams
Sets the parameters for a material.
Parameter Name materialid ambient diffuse specular emissive opacity glossiness speclevel reflection Parameter Type integer integer integer integer integer float float float float Parameter Description Material object id. Ambient light color. Diffuse light color. Specular light (reflection) color. Emissive light (glow) color. Opacity of the material [0-100]. Determines the model's highlighting [0-100]. Intensity of the specular light [0100]. Material's ability to reflect [0-100].

Version: 1.0 2011-12-13

PUBLIC

30 / 222

2D Vector/3D Graphics
Parameter Name refraction Parameter Type float Parameter Description Determines how much light is bent when travelling through material [0100]. The double-sided attribute for the material. Render the thickness of outlines relative to the value of the 'linesvalue' parameter. Thickness of outlines if 'rendoutlines' parameter is set to True [0-100].

doublesided rendoutlines

boolean boolean

linesvalue

float

2.41 go_material_setreflectionlevel
Sets the reflection parameter of the material.
Parameter Name materialid reflection Parameter Type integer float Parameter Description Material object id. Material reflection level [0-100].

2.42 go_material_setrefractionlevel
Sets the refraction level parameter of the material.
Parameter Name materialid refraction Parameter Type integer float Parameter Description Material object id. Material refraction level [0-100].

2.43 go_material_setspecularlevel
Sets the specular level parameter of the material.
Parameter Name materialid speclevel Parameter Type integer float Parameter Description Material object id. Material specular level [0-100].

Version: 1.0 2011-12-13

PUBLIC

31 / 222

2D Vector/3D Graphics

2.44 go_material_setspecularcolor
Sets the specular color parameter of the material.
Parameter Name materialid specular Parameter Type integer integer Parameter Description Material object id. Material specular color.

2.45 go_material_settexture
Sets a texture for a specific material .
Parameter Name materialid mapid Parameter Type integer integer Parameter Description Material object id.
Texture object id. Possible Values Diffuse Bump Opacity Reflection Refraction Specular Ambient Self Illumination Specular Level Glossiness Ambient Occlusion MAP #11 MAP #12 MAP #13 MAP #14 MAP #15 MAP #16 MAP #17 MAP #18 MAP #19 MAP #20 MAP #21 MAP #22 MAP #23 MAP #24 MAP #25 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

texture

materialtextureparameter

Material texture object.

Version: 1.0 2011-12-13

PUBLIC

32 / 222

2D Vector/3D Graphics

2.46 go_material_setwireframelinewidth
Sets wireframe line width for all materials in the scene.
Parameter Name wireframelinewidth Parameter Type float Parameter Description 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 filename createfilenode objectpath Parameter Type filename boolean collectionparameter Parameter Description Specifies the location of the file to merge with the current scene. Specifies whether a containing node with the filename should be created. Output parameter. List of paths for loaded objects.

Version: 1.0 2011-12-13

PUBLIC

33 / 222

2D Vector/3D Graphics

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 filename transformationstring createfilenode objectpath partid Parameter Type filename string boolean collectionparameter integer Parameter Description Specifies the location of the file to merge with the current scene. Specifies the transformation matrix to apply to the imported geometry. Specifies whether a containing node with the filename should be created. Output parameter. List of paths for loaded objects. PartId that will be written in the node's metadata and used for instancing. Should be numeric. InstanceId that will be written in the node's metadata and used for instancing. Should be numeric. Specifies the name that will be set on the new node(s). If empty will keep original node names. Type of asset (Part|Sub-assembly). If true all existing nodes will be children of merged file.

instanceid

integer

instancename

string

assettypeid createastopnode

integer boolean

2.50 go_scene_getmetadata
Extracts metadata information from the current scene.
Parameter Name metadataobject externalfiles Parameter Type metadataparameter collectionparameter Parameter Description The extracted scene metadata. 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 filename createfilenode warnings warningsareerrors Parameter Type filename boolean collectionparameter boolean Parameter Description The location of the file to open. Specifies whether a containing node with the filename should be created. A collection of warning messages returned from the plugin. Specifies whether operation should fail when warning messages are returned from the plugin.

Version: 1.0 2011-12-13

PUBLIC

34 / 222

2D Vector/3D Graphics

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 filename plugin createfilenode warnings warningsareerrors Parameter Type filename string boolean collectionparameter boolean Parameter Description The location of the file to open. The GUID of the plugin to use when opening. Specifies whether a containing node with the filename should be created. A collection of warning messages returned from the plugin. Specifies whether operation should fail when warning messages are returned from the plugin. Specifies whether operation should load only metadata in scene hierarchy, without any geometry.

loadmetadataonly

boolean

2.53 go_scene_openempty
Creates an empty 3D scene. Use in conjunction with go_mergefile to create new scenes.
Parameter Name assetid Parameter Type integer Parameter Description 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 width height dpi filename fileformat Parameter Type integer integer integer filename string Parameter Description The width in pixels of the 2d file. The height in pixels of the 2d file. Bitmap resolution (in DPI). The name of the file. The 2d file format of the saved file.

Version: 1.0 2011-12-13

PUBLIC

35 / 222

2D Vector/3D Graphics
Parameter Name bitmapformat Parameter Type integer Parameter Description Bitmap format (bits/pixel). Possible Values RGB [8 bit per channel] RGBA [8 bt per channel] RGB [16 bit per channel] RGBA [16 bit per channel] RGBA [floating point HDR image] antialiasing integer Anti-Aliasing. Possible Values None Adaptive 2x2 3x3 4x4 5x5 6x6 7x7 8x8 filtertexturemaps forcetwosidedpolygons shadows softshadows raytracereflections raytracerefraction multithreading boolean boolean boolean boolean boolean boolean boolean Filter Texture Maps. Force 2-sided Polygons. Shadows. Soft Shadows. Raytrace Reflections. Raytrace Refraction. Raytrace Multi-threading. 0 1 2 3 4 5 6 7 8 24 32 48 64 128

2.55 go_scene_removeexternalfile
Removes an external file from the scene.
Parameter Name filename Parameter Type filename Parameter Description The name of the media file.

Version: 1.0 2011-12-13

PUBLIC

36 / 222

2D Vector/3D Graphics

2.56 go_object_removebytype
Removes all instances of a specific type of object from the scene.
Parameter Name objecttype Parameter Type integer Parameter Description The type of object to remove. Possible Values Object Mesh Material Light Camera Bone Markup Procedural 1 1 2 3 4 6 7 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.

Version: 1.0 2011-12-13

PUBLIC

37 / 222

2D Vector/3D Graphics

2.60 go_scene_save
Saves the current scene to a file in the specified format.
Parameter Name filename fileformat options Parameter Type filename string integer Parameter Description Specifies where to save the file. The format to save the file in. eg. rh, 3ds. Objects to save: all, visible only or selected only. Possible Values Save all Save visible only Save selected only 0 1 2

2.61 go_scene_getanimations
Retrieves all animation sequences in the scene.
Parameter Name animationranges Parameter Type collectionparameter Parameter Description Holds the collection of animation sequences.

2.62 go_scene_zoom
Sets the scene's zoom factor.
Parameter Name Zoom Parameter Type integer Parameter Description The new zoom setting. Possible Values Default View View To Visible Objects View To All Objects View To Selected Objects 0 1 2 3

2.63 go_object_selectall
Selects or deselects all objects in the scene.
Parameter Name select Parameter Type boolean Parameter Description True to select, false to deselect.

Version: 1.0 2011-12-13

PUBLIC

38 / 222

2D Vector/3D Graphics

2.64 go_object_selectbymetadata
Selects the first object (if any) in the scene that has the specified metadata value.
Parameter Name name value category includehidden Parameter Type string string string boolean Parameter Description Metadata name. Metadata value. Metadata category. Include hidden.

2.65 go_plugin_selectforfile
Selects the plugin to use to open a particular file.
Parameter Name filename stream guid name assemblyheirarchyxmltype enginefiletype Parameter Type filename stream string string string string Parameter Description The file name to open. Unused. GUID of selected plugin. Name of selected plugin. Unused. 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 Show Markups Parameter Type boolean Parameter Description True to show markups, false to hide markups.

Version: 1.0 2011-12-13

PUBLIC

39 / 222

2D Vector/3D Graphics

2.68 go_object_setmetadatawithtype
Sets a single user or system metadata property value on an object in the scene.
Parameter Name ObjectPath Parameter Type string Parameter Description 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. True to set system metadata, False to set user metadata. The metadata group/category. The property key of the metadata being set. The data type of the metadata being set. The property value of the metadata being set. 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 Reference 0 1

SystemMetadata MetadataGroup MetadataProperty MetadataType MetadataValue ObjectType

boolean string string string string integer

2.69 go_object_setmetadata
Assigns the metadata key specified to a single object within a scene.
Parameter Name objectpath category keyname keyvalue objecttype Parameter Type string string string string integer Parameter Description Path that uniquely identifies this object. Metadata category. Metadata key name. Metadata key value. 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 Reference 0 1

Version: 1.0 2011-12-13

PUBLIC

40 / 222

2D Vector/3D Graphics

2.70 go_object_setname
Assigns a display name to a single object within a scene.
Parameter Name objectpath objectname Parameter Type string string Parameter Description Path that uniquely identifies this object. Name to be set.

2.71 go_viewport_setsize
Sets the size (in pixels) of the active viewport.
Parameter Name width height Parameter Type integer integer Parameter Description Required output width. Required output height.

2.72 go_scene_setviewaxis
Sets the view axis for the current scene.
Parameter Name ViewUp ViewRight Parameter Type string string Parameter Description Defines the xyz-axis to be used for the up orientation of the scene. 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 plugin key value Parameter Type string string float Parameter Description The name of the plugin. The name of the setting. The value to use.

Version: 1.0 2011-12-13

PUBLIC

41 / 222

2D Vector/3D Graphics

2.74 go_setting_setinteger
Sets the value of a plugin integer setting.
Parameter Name plugin key value Parameter Type string string integer Parameter Description The name of the plugin. The name of the setting. The value to use.

2.75 go_setting_setstring
Sets the value of a plugin string setting.
Parameter Name plugin key value Parameter Type string string string Parameter Description The name of the plugin. The name of the setting. The value to use.

2.76 go_viewport_setmetadata
Set a metadata field on a viewport.
Parameter Name viewportobjectid category fieldname fieldvalue path subid datatype Parameter Type integer string string string string string string Parameter Description The viewport object id. The metadata category. The metadata field name. The metadata field value. The metadata path. The SubId. The data type.

Version: 1.0 2011-12-13

PUBLIC

42 / 222

2D Vector/3D Graphics

2.77 go_step_export
Exports a step or procedure from the scene.
Parameter Name objectid filename Parameter Type integer filename Parameter Description Step or procedure ID. 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. Output width. Output height. Set to True to include subtitles. Result of operation.

width height subtitles result

integer integer boolean boolean

2.78 go_step_getall
Lists all the steps and procedures in the scene.
Parameter Name procedures Parameter Type collectionparameter Parameter Description The steps and procedures found in the scene.

2.79 go_scene_transform
Applies the transformation information into an open scene.
Parameter Name transformationstring replacematrix Parameter Type string boolean Parameter Description Specifies the transformation matrix. TRUE to replace scene matrix, FALSE to multiply them.

2.80 go_viewport_getall
Extracts all views from scene.
Parameter Name objectcollection Parameter Type collectionparameter Parameter Description Holds a collection of object names.

Version: 1.0 2011-12-13

PUBLIC

43 / 222

2D Vector/3D Graphics

2.81 go_viewport_setactive
Sets a viewport as the active viewport.
Parameter Name name Parameter Type string Parameter Description Name of the viewport. Used to find the vieport if 'objectid' is not specified. ID of the viewport object.

objectid

integer

2.82 go_object_setvisibility
Sets the visibility status for the selected objects.
Parameter Name visible recursechildren Parameter Type boolean boolean Parameter Description The visibility status. True for visible, False for hidden. 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 collection Parameter Type collectionparameter Parameter Description Holds a collection of crossreference parameters.

Version: 1.0 2011-12-13

PUBLIC

44 / 222

2D Vector/3D Graphics

2.84 go_render_zbuffer
Saves a 2D view of a scene to a file using a Z-buffer rendering method.
Parameter Name width height dpi filename fileformat bitmapformat Parameter Type integer integer integer filename string integer Parameter Description The width in pixels of the 2d file. The height in pixels of the 2d file. Resolution of output image (in DPI). The name of the file. The 2d file format of the saved file. Bitmap format (in bits/pixel). Possible Values RGB [8 bit per channel] RGBA [8 bt per channel] RGB [16 bit per channel] RGBA [16 bit per channel] RGBA [floating point HDR image] rendermode integer The rendering mode. Possible Values Bounding Box Transparent bounding box Transparent bounding box outline Vertices Shaded Vertices Wireframe Shaded Wireframe Solid Transparent Solid Wireframe Transparent Wireframe Line Illustration Solid Outline Shaded Illustration Hidden Wireframe antialiasing integer Anti-Aliasing. Possible Values None 2x2 3x3 4x4 renderadditnlitems boolean Render Additional Items. 0 1 2 3 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 24 32 48 64 128

Version: 1.0 2011-12-13

PUBLIC

45 / 222

2D Vector/3D Graphics

2.85 goc_bounding_box

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Bounding_box_of_all_objects

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

46 / 222

2D Vector/3D Graphics

2.86 goc_hidden_wireframe

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Show_Back-Facing_Geometry Outline_width Lines_in_Line_Illustration_mode Faces_in_Line_Illustration_mode

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer boolean float integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

47 / 222

2D Vector/3D Graphics

2.87 goc_line_illustration

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Show_Back-Facing_Geometry Outline_width Outline_angle Lines_in_Line_Illustration_mode Faces_in_Line_Illustration_mode

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer boolean float float integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.
48 / 222

Version: 1.0 2011-12-13

PUBLIC

2D Vector/3D Graphics

2.88 goc_sceneproperties

Parameter Name Material_Override_Ambient none Scene_Up_Axis

Parameter Type integer integer integer

Parameter Description No Description Provided. No Description Provided. No Description Provided. Possible Values: Z Y No Change 0 4 6

Ambient_percentage Show_Scene_Axes Specular Environment_Gamma Material_Override_Diffuse Show_Cross_Section Use_Default_Material Show_Back-Facing_Geometry Smoothing_angle_ Outline_width Show_Textures Use_existing_lights Global_ambient_color Bone_affect_area___Maximum__ Specular_percentage Wire_grid Solid_grid_dark_cell Environment_Exposure Material_Override_Emission N2D_Files_Background Output_Size_border__margin

float boolean boolean float integer boolean boolean boolean float float boolean boolean integer integer float integer integer float integer integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

49 / 222

2D Vector/3D Graphics
Parameter Name Grid_size Parameter Type integer Parameter Description No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 Vertex-cross_color Transparent_grid_dark_cell Viewport_labels Subdivision_control_mesh Y_axis Vertices_in_Vertices_mode Lines_in_Shaded_Illustration_mode Default_material_emissive_color Default_material_diffuse_color Bounding_box_of_scene Position integer integer integer integer integer integer integer integer integer integer integer No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. Possible Values Auto Offset Absolute Position Custom_Position Border_of_selected_face Current_Auto_Position Selection_highlight Bones Default_material_specular_color Bounding_box_of_all_objects Illustration_background_bottom Cutting_plane Blur_Radius float integer float integer integer integer integer integer integer integer No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. 0 1 2 1 2 3 4 5 7 10 15

Version: 1.0 2011-12-13

PUBLIC

50 / 222

2D Vector/3D Graphics
Parameter Name Image_Size Parameter Type integer Parameter Description No Description Provided. Possible Values 64 128 256 512 1024 2048 Illustration_Viewport_labels Lines_in_Line_Illustration_mode Render_Method integer integer integer No Description Provided. No Description Provided. No Description Provided. Possible Values Bounding box Transparent bounding box Transparent bounding box outline Vertices Shaded Vertices Wireframe Shaded Wireframe Solid Transparent Solid Wireframe Transparent Wireframe Line Illustration Solid Outline Shaded Illustration Hidden Wireframe Global_illumination_color Material_Override_Specular Show_Markups Show_Transparency Double-sided Opacity Show_Intersections Outline_angle Show_Scene_Bounding_Box integer integer boolean boolean boolean float boolean float boolean No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 64 128 256 512 1024 2048

Version: 1.0 2011-12-13

PUBLIC

51 / 222

2D Vector/3D Graphics
Parameter Name Light_type Parameter Type integer Parameter Description No Description Provided. Possible Values No Lights White Lights Day Light Hard Lights Colored Lights Red/Green Colored Lights Blue/Green Blue Lights Marsiano Lights Cube Lights CAD Optimized Lights Single Light From Eye Emission_percentage Show_Depth_Cue Smoothing Transparent_grid_light_cell Selected_faces Transparent_bounding_box Shadow Diffuse_percentage Show_Cameras_and_Lights Set_Grid_Mode float boolean boolean integer integer integer boolean float boolean integer No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid Output_size_outer_area Non_Output_Size_area Show_Vertices Show_Bones Use_Existing_Smoothing Shadow Bone_influence_area X_axis Bounding_box_of_selected_objects Illustration_detailed_view_border Faces_in_Line_Illustration_mode Fog Lines_in_Solid_or_Transparent_mode
Version: 1.0 2011-12-13

35 35 35 35 35 35 35 35 35 35 35

0 1 2 3

integer integer boolean boolean boolean integer integer integer integer integer integer integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.
52 / 222

PUBLIC

2D Vector/3D Graphics
Parameter Name Background_top Detailed_view_border Render_Exposure Environment_Rotation Render_Gamma Bone_affect_area___Minimum__ Cross_section_outline Z_axis Solid_grid_light_cell Background_bottom Surface_normals Default_material_ambient_color Lines_in_Wireframe_mode Illustration_background_top Parameter Type integer integer float float float integer integer integer integer integer integer integer integer integer Parameter Description No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

2.89 goc_shaded_illustration

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15
53 / 222

Version: 1.0 2011-12-13

PUBLIC

2D Vector/3D Graphics
Parameter Name Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Use_existing_lights Smoothing_angle_ Use_Existing_Smoothing Smoothing Use_Default_Material Show_Transparency Show_Textures Light_type Parameter Type boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer boolean float boolean boolean boolean boolean boolean integer Parameter Description No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. Possible Values No Lights White Lights Day Light Hard Lights Colored Lights Red/Green Colored Lights Blue/Green Blue Lights Marsiano Lights Cube Lights CAD Optimized Lights Single Light From Eye Specular Global_ambient_color Global_illumination_color Show_Back-Facing_Geometry Material_Override_Ambient Material_Override_Diffuse Material_Override_Specular Material_Override_Emission boolean integer integer boolean integer integer integer integer No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. 35 35 35 35 35 35 35 35 35 35 35

Version: 1.0 2011-12-13

PUBLIC

54 / 222

2D Vector/3D Graphics
Parameter Name Outline_width Outline_angle Ambient_percentage Diffuse_percentage Specular_percentage Emission_percentage Lines_in_Line_Illustration_mode Parameter Type float float float float float float integer Parameter Description No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

55 / 222

2D Vector/3D Graphics

2.90 goc_shaded_vertices

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

56 / 222

2D Vector/3D Graphics

2.91 goc_shaded_wireframe

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

57 / 222

2D Vector/3D Graphics

2.92 goc_solid

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Use_existing_lights Smoothing_angle_ Use_Existing_Smoothing Smoothing Use_Default_Material

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer boolean float boolean boolean boolean

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.
58 / 222

Version: 1.0 2011-12-13

PUBLIC

2D Vector/3D Graphics
Parameter Name Show_Transparency Show_Textures Light_type Parameter Type boolean boolean integer Parameter Description No Description Provided. No Description Provided. No Description Provided. Possible Values No Lights White Lights Day Light Hard Lights Colored Lights Red/Green Colored Lights Blue/Green Blue Lights Marsiano Lights Cube Lights CAD Optimized Lights Single Light From Eye Specular Global_ambient_color Global_illumination_color Show_Back-Facing_Geometry boolean integer integer boolean No Description Provided. No Description Provided. No Description Provided. No Description Provided. 35 35 35 35 35 35 35 35 35 35 35

Version: 1.0 2011-12-13

PUBLIC

59 / 222

2D Vector/3D Graphics

2.93 goc_solid_outline

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Use_existing_lights Smoothing_angle_ Use_Existing_Smoothing Smoothing Use_Default_Material

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer boolean float boolean boolean boolean

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.
60 / 222

Version: 1.0 2011-12-13

PUBLIC

2D Vector/3D Graphics
Parameter Name Show_Transparency Show_Textures Light_type Parameter Type boolean boolean integer Parameter Description No Description Provided. No Description Provided. No Description Provided. Possible Values No Lights White Lights Day Light Hard Lights Colored Lights Red/Green Colored Lights Blue/Green Blue Lights Marsiano Lights Cube Lights CAD Optimized Lights Single Light From Eye Specular Global_ambient_color Global_illumination_color Show_Back-Facing_Geometry Outline_width Outline_angle Lines_in_Line_Illustration_mode boolean integer integer boolean float float integer No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. 35 35 35 35 35 35 35 35 35 35 35

Version: 1.0 2011-12-13

PUBLIC

61 / 222

2D Vector/3D Graphics

2.94 goc_solid_wireframe

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

62 / 222

2D Vector/3D Graphics

2.95 goc_transparent

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Use_existing_lights Smoothing_angle_ Use_Existing_Smoothing Smoothing Use_Default_Material

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer boolean float boolean boolean boolean

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.
63 / 222

Version: 1.0 2011-12-13

PUBLIC

2D Vector/3D Graphics
Parameter Name Show_Textures Light_type Parameter Type boolean integer Parameter Description No Description Provided. No Description Provided. Possible Values No Lights White Lights Day Light Hard Lights Colored Lights Red/Green Colored Lights Blue/Green Blue Lights Marsiano Lights Cube Lights CAD Optimized Lights Single Light From Eye Specular Global_ambient_color Global_illumination_color Show_Back-Facing_Geometry boolean integer integer boolean No Description Provided. No Description Provided. No Description Provided. No Description Provided. 35 35 35 35 35 35 35 35 35 35 35

Version: 1.0 2011-12-13

PUBLIC

64 / 222

2D Vector/3D Graphics

2.96 goc_transparent_bounding_box

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Transparent_bounding_box

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

65 / 222

2D Vector/3D Graphics

2.97 goc_transparent_bounding_box_outline

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom Bounding_box_of_all_objects Transparent_bounding_box

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

66 / 222

2D Vector/3D Graphics

2.98 goc_transparent_wireframe

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

67 / 222

2D Vector/3D Graphics

2.99 goc_vertices

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

68 / 222

2D Vector/3D Graphics

2.100 goc_wireframe

Parameter Name Scene_Up_Axis

Parameter Type integer

Parameter Description No Description Provided. Possible Values Z Y No Change 0 4 6

Set_Grid_Mode

integer

No Description Provided. Possible Values No Grid Wire Grid Solid Grid Transparent Grid 0 1 2 3

Grid_size

integer

No Description Provided. Possible Values 1x1 2x2 3x3 4x4 5x5 7x7 10 x 10 15 x 15 1 2 3 4 5 7 10 15

Show_Scene_Bounding_Box Show_Scene_Axes Show_Cameras_and_Lights Show_Vertices Show_Cross_Section Show_Intersections Shadow Show_Markups Show_Bones Show_Depth_Cue Background_top Background_bottom

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer integer

No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided.

Version: 1.0 2011-12-13

PUBLIC

69 / 222

File/Directory/Path

File/Directory/Path

3.1

do_directory_attributes

Retrieves file system attributes for the specified directory.

Parameter Name directoryname readonly archive system hidden compressed creationtime lastwritetime Parameter Type string boolean boolean boolean boolean boolean string string Parameter Description The name of the directory. True if the readonly flag is set for the directory, otherwise false. True if the archive flag is set for the directory, otherwise false. True if the system flag is set for the directory, otherwise false. True if the hidden flag is set for the directory, otherwise false. True if the compressed flag is set for the directory, otherwise false. Returns the creation time as reported by the operating system. 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 basedirectory Parameter Type string Parameter Description The directory on which the new path is based. This must start with a drive letter or be a UNC path. The path to a file or directory. This must NOT start with a drive letter or be a UNC path. The combination of the base directory with the path to a file or directory.

combinewith

string

resultpath

string

Version: 1.0 2011-12-13

PUBLIC

70 / 222

File/Directory/Path

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 from to overwrite recurse Parameter Type string string boolean boolean Parameter Description The location of the directory to be copied. The destination directory where the directory is to be copied to. Set to true to overwrite the files that already exist. Set to true to copy sub-directories.

3.4

do_directory_create

Creates a file system directory.

Parameter Name directoryname Parameter Type string Parameter Description Full path to the directory to create.

3.5

do_directory_delete

Deletes a file system directory.

Parameter Name directoryname recurse Parameter Type string boolean Parameter Description The name of the directory to delete. Set to true to recurse subdirectories.

3.6

do_directory_deletefiles

Deletes selected files from within a directory.

Parameter Name directory pattern recurse Parameter Type string string boolean Parameter Description The directory where the files are going to be deleted. The search pattern to match files that are to be deleted. If True, recurse sub directories.

Version: 1.0 2011-12-13

PUBLIC

71 / 222

File/Directory/Path

3.7

do_directory_exists

Tests to see whether or not a directory exists.

Parameter Name directoryname exists Parameter Type string boolean Parameter Description The name of the directory that is to be tested for existance. 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 directory match recurse directories Parameter Type string string boolean collectionparameter Parameter Description The directory to search in. The search pattern to use for finding directories. Set to true to search sub-directories. 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 directory match recurse files Parameter Type string string boolean collectionparameter Parameter Description The directory to search in. The search pattern to use for finding files. Set to true to search sub-directories. The matching files found.

3.10 do_directory_move
Moves a directory to a new location.
Parameter Name from to Parameter Type string string Parameter Description The location of the directory to move. The location to move the directory to.

Version: 1.0 2011-12-13

PUBLIC

72 / 222

File/Directory/Path

3.11 fo_file_findtext
Searches for text in a file.
Parameter Name filename texttofind exists Parameter Type filename string boolean Parameter Description The file to look in. The text to find. True if the text was found.

3.12 fo_file_append
Appends data to a specified file.
Parameter Name data filename Parameter Type string filename Parameter Description String to be appended to the end of the file. The file to write the data to.

3.13 fo_file_getattributes
Retrieves file system attributes for a specified file.
Parameter Name filename readonly archive system hidden compressed length creationtime Parameter Type filename boolean boolean boolean boolean boolean integer string Parameter Description The name of the file. True if the readonly flag is set for the file, otherwise false. True if the archive flag is set for the file, otherwise false. True if the system flag is set for the file, otherwise false. True if the hidden flag is set for the file, otherwise false. True if the compressed flag is set for the file, otherwise false. Returns the length of the file in bytes. Returns the file creation time as reported by the operating system.

Version: 1.0 2011-12-13

PUBLIC

73 / 222

File/Directory/Path

3.14 po_path_buildfilename
Builds a path from a combination of parts (directory, filename, filename without extension, extension, root)
Parameter Name FileNameParts FileName Parameter Type filename string Parameter Description The parts of the file name. 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 from to overwrite Parameter Type filename filename boolean Parameter Description The location of the file to be copied. The location the file is to be copied to. 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 isfile filename Parameter Type boolean filename Parameter Description Set to true if this is a file or false if a directory. 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 tempfolder uselocalworkspace Parameter Type string boolean Parameter Description Returns full path of the temporary folder under workspace folder. 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).

Version: 1.0 2011-12-13

PUBLIC

74 / 222

File/Directory/Path

3.18 fo_file_delete
Deletes an file system file.
Parameter Name filename Parameter Type filename Parameter Description The file to delete.

3.19 fo_file_delete_with_retry
Delete a file from disk, with exponential backoff on failure
Parameter Name FileName MaxRetries Parameter Type filename integer Parameter Description The file to delete. Maximum number of retries.

3.20 fo_file_exists
Tests to see whether or not a file exists.
Parameter Name filename exists Parameter Type filename boolean Parameter Description The name of the file that is to be tested for existence. True if the file exists otherwise false.

3.21 fo_file_move
Moves a file to a new location.
Parameter Name from to Parameter Type filename filename Parameter Description The location of the file to move. 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 uncpath localpath resolved Parameter Type string string boolean Parameter Description The UNC path to be resolved. The local path if it could be resolved. True if the UNC path could be resolved to a local path.

Version: 1.0 2011-12-13

PUBLIC

75 / 222

File/Directory/Path

3.23 fo_file_savefromstring
Saves a string to a file. If the file already exists it will be overwritten.
Parameter Name filename data Parameter Type filename string Parameter Description Output file name. 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 fromfilename Parameter Type filename Parameter Description The parameter that identifies a file name to base the temporary file name on. The generated temporary file name.

tempfilename

filename

3.25 fo_file_unzip
Extracts ZIP archive to specified location.
Parameter Name filename location Parameter Type filename string Parameter Description The zip file to open. The destination folder path.

3.26 fo_file_zip
Creates ZIP archive in the specified location.
Parameter Name foldername searchpattern Parameter Type string string Parameter Description Folder with files that will be zipped. File search pattern. Multiple patterns must be separated by semicolon (*.bmp; *.jpg). *.* will include all files. If true will add files from subfolders. ZIP archive name.

includesubfolders filename

boolean filename

Version: 1.0 2011-12-13

PUBLIC

76 / 222

Flow Control

Flow Control

4.1

er_stopprocessing

Stops further processing.

Parameter Name errmessage Parameter Type string Parameter Description 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 currentvalue Parameter Type object Parameter Description 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 seconds Parameter Type integer Parameter Description The number of seconds to pause.

Version: 1.0 2011-12-13

PUBLIC

77 / 222

Flow Control

4.5

set

Sets the value of a variable in the process.

Parameter Name name value Parameter Type string string Parameter Description The variable name. 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 stacktrace Parameter Type string Parameter Description Output parameter. Will be populated with a stack trace for diagnostic purposes. Output parameter. Will be populated with the name of the operation that raised (threw) the error. Output parameter. Will be populated with the associated error message. 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 continue raise continue

raisedby

string

message action

string string

Version: 1.0 2011-12-13

PUBLIC

78 / 222

Flow Control

4.7

standardterminatehandler

Standard terminate handler

4.8

variable

Creates a process level global variable and sets its initial value.
Parameter Name value Parameter Type string Parameter Description The value of the variable.

4.9

while

Processes its child operations repeatedly until the XPath condition evaluates to false.

Version: 1.0 2011-12-13

PUBLIC

79 / 222

General Operations

General Operations

5.1

guid_createnew

Creates a new GUID.

Parameter Name createdguid Parameter Type string Parameter Description The created GUID.

5.2

datetime_tostring

Formats an input datetime string using the specified format string.

Parameter Name inputstring Parameter Type datetime Parameter Description The input datetime to format. Set to 'now()' for current datetime or any valid datetime string format. 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. The formatted output.

formatmask

string

outputstring

string

Version: 1.0 2011-12-13

PUBLIC

80 / 222

General Operations

5.3

email_send

Sends an email via an SMTP server.

Parameter Name smtp Parameter Type string Parameter Description The address of the SMTP server that will send the email. eg. smtp.mydomain.com. The subject line of the email. The body text of the email. The body format of the email. Possible Values TEXT HTML from string 0 1

subject body bodyformat

string string integer

The sender of the email. Some SMTP servers require that this is a valid email account on the SMTP server. The email address(s) of the intended recipient of the email. A semi colon delimited list of files to attach to the email message.

to attachments

string string

5.4

rhz_extractvzxml

Extracts the model.vzxml from the specified .RHZ file to specified file name.
Parameter Name RhzFilePath OutputFilePath Parameter Type filename filename Parameter Description RHZ File containing model.vzxml to extract. Fully qualified path to save the model.vzxml file to.

5.5

http_download

Download file from URL over HTTP protocol

Parameter Name Url FilePath StatusCode Parameter Type string filename integer Parameter Description Source URL. Target file name. HTTP status code from download request.

Version: 1.0 2011-12-13

PUBLIC

81 / 222

General Operations

5.6

http_upload

Upload file to specified URL using HTTP protocol

Parameter Name Url FilePath ContentType StatusCode Parameter Type string filename string integer Parameter Description Target URL. Source file name. The MIME type of the file to be stored. HTTP status code from upload request.

5.7

log_add

Saves a message of a specified type to the log file.

Parameter Name autoflush Parameter Type boolean Parameter Description 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. The log file path. 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 Warning Info 0 1 2

filename level

filename integer

5.8

log_message

Logs a message to the log file.

Parameter Name eventtype Parameter Type integer Parameter Description The type of error message, 'error' = 0, 'warning' = 1, 'info' = 2. Possible Values Error Warning Info message filename string filename The text to add to the log. The external text file to add to the log if 'message' is not specified.
82 / 222

0 1 3

Version: 1.0 2011-12-13

PUBLIC

General Operations

5.9

log_save

Saves the log file to the specified location.

Parameter Name filename Parameter Type filename Parameter Description The log file path.

5.10 xml_setvalue
Sets a text value in an XML file.
Parameter Name filename propertyname propertyvalue Parameter Type filename string string Parameter Description XML file name. XPath expression to use to find node(s) to modify. Value to set as the node's inner text.

5.11 serverproperties_getall
Retrieves installation configuration information.
Parameter Name smtp_server GlobalWorkspace LocalWorkspace InstallPath Parameter Type string string string string Parameter Description Configured SMTP server. Path to global farm workspace. Path to local server workspace. Path where Visual Enterprise Generator is installed on the local server. Name of the processing engine running this process. Software version of the processing engine running this process.

ServerId ServerVersion

string string

5.12 xml_extract
Inserts the contents of an external XML document into the task results document.
Parameter Name filename data Parameter Type filename collectionparameter Parameter Description The name of the XML file to read. The XML elements that were read from the file, in the same structure as in the file.

Version: 1.0 2011-12-13

PUBLIC

83 / 222

General Operations

5.13 task_resultsdocument_tomsmq
Enqueues the task results document to an MSMQ queue.
Parameter Name queuename label Parameter Type string string Parameter Description The MSMQ queue name. The MSMQ message label.

5.14 task_resultsdocument_tofile
Writes the XML task results document to an external file.
Parameter Name outputfile transformation Parameter Type filename string Parameter Description The name of the XML file to write the task results document to. 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 inputfile outputfile alignment Parameter Type filename filename string Parameter Description The location of the PDF template. The resulting PDF file name path. Will be overwritten if already exists. 'Left', 'Right', 'Center', 'Justify'. Where to align text in the header/footer. True if you want page numbers in header or footer. Placement on the document, 'HEADER' or 'FOOTER'. Text to be displayed before page number. Text to be displayed after the page number. Valid only if pagenumbers = True. Set left margin. Set top margin. Set right margin. Set bottom margin.

pagenumbers headerorfooter textbefore textafter

boolean string string string

lmargin tmargin rmargin bmargin

integer integer integer integer

Version: 1.0 2011-12-13

PUBLIC

84 / 222

General Operations
Parameter Name font Parameter Type string Parameter Description 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'. Font point size.

fontsize

integer

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 filelist Parameter Type string Parameter Description List of files to be merged. Files must be separated by semicolon characters. The resulting PDF file name. Set to TRUE to add table of contents. Title of table of contents. This setting only applies if not using a table of contents template PDF document. 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. 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. Optional. A single page PDF document containing the table of contents to add to the output document. The total number of pages in the resulting PDF file.

outfile addtoc toctitle

filename boolean string

tocstartpercent

integer

tocwidthpercent

integer

toctemplatefilename

string

totalpages

integer

Version: 1.0 2011-12-13

PUBLIC

85 / 222

General Operations

5.17 pdf_templatemerge
Uses iTextSharp library to load the specified PDF template form and fill values for named fields.
Parameter Name templatefile outputfile fieldlist namevaluedelimiter Parameter Type filename filename string string Parameter Description The location of the pdf template. The output PDF file path. Will be overwritten if already exists. A delimited list of field names and values. The character between a field name and its corresponding value in the FieldList. The character to separate name value pairs in the FieldList.

fielddelimiter

string

5.18 job_start
Starts a new job managed job.
Parameter Name workflow parentjobid name owner notification_email priority jobid Parameter Type string integer string string string string integer Parameter Description The name of the workflow to start a job for. The job ID of the parent job, if applicable. The job name. The username of the job owner. The email address to notify when the job completes. The job priority (Normal, Low, High). The ID of the new job.

5.19 task_start
Sends single notification to initiate a process.
Parameter Name queuename process processparams transactionalqueue priority Parameter Type string string string boolean string Parameter Description The MSMQ queue name to send the notification to (Optional). The name of the process to start. The process trigger parameters, if any. Use the format <param1>value1</param1><param2>value2</param2>. Whether or not the destination queue is a transactional queue. The priority of the process between 1 and 10, where 1 is the highest priority (Optional).

Version: 1.0 2011-12-13

PUBLIC

86 / 222

General Operations

5.20 keyvaluepair_response_setvalue
Sets a key/value pair to be used in a SimpleResponse file.
Parameter Name Name Value Parameter Type string string Parameter Description The name of the value. The value to set.

5.21 os_shellexecute
Executes a shell command.
Parameter Name command arguments Parameter Type string string Parameter Description The path to the file to execute. 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. The number of milliseconds to wait for the process to finish, after which the process will be terminated (0 = no timeout). The exit code returned by the executed command.

timeout

integer

returncode

integer

5.22 keyvaluepair_response_writetofile
Writes a set of simple (key/value pair) results to a specified file.
Parameter Name ResultsFile Parameter Type filename Parameter Description 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 TriggerFile Parameter Type filename Parameter Description The path to a file containing trigger parameters to read.

Version: 1.0 2011-12-13

PUBLIC

87 / 222

General Operations

5.24 string_tokenize
Splits a string into tokens.
Parameter Name inputstring delimiter tokens Parameter Type string string collectionparameter Parameter Description The input string. The token delimiter. A collection of tokens.

5.25 os_waitforosprocessexit
Waits for an operating system process to exit.
Parameter Name processname machinename Parameter Type string string Parameter Description The name of the operating system process to wait for. 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 xmlfilepath attributename attributenamespace attributevalue elementxpath namespacemappings Parameter Type filename string string string string string Parameter Description The path to the XML file to modify. The name of the attribute to add. The namespace of the attribute to add. The value of the attribute to add. The XPath expression identifying the element to add the attribute to. A pipe '|' separated list of prefix=namespace pairs.

Version: 1.0 2011-12-13

PUBLIC

88 / 222

General Operations

5.27 xml_elementadd
Adds an element to an existing XML file.
Parameter Name xmlfilepath elementname elementnamespace parentelementxpath Parameter Type filename string string string Parameter Description The path to the XML file to modify. The name of the element to add. The namespace of the element to add. The XPath expression identifying the parent element of the element to be added. An identifying the position of added element beneath its parent. A pipe '|' separated list of prefix=namespace pairs.

elementposition namespacemappings

integer string

5.28 xml_elementcount
Returns the number of XML elements matched by an XPath expression.
Parameter Name xmlfilepath elementxpath matchingelementcount namespacemappings Parameter Type filename string integer string Parameter Description The path of the XML file to read. The XPath expression identifying the elements to find. The number of XML elements matching the XPath expression. 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 xmlfilepath elementxpath xmlelementexists Parameter Type filename string boolean Parameter Description The path of the XML file to read. The XPath expression identifying the element to find. Returns whether the XPath expression matched a single XML element. A pipe '|' separated list of prefix=namespace pairs.

namespacemappings

string

Version: 1.0 2011-12-13

PUBLIC

89 / 222

General Operations

5.30 xml_escapestring
Escapes invalid XML characters from the input string.
Parameter Name input_string output_string Parameter Type filename filename Parameter Description The input string. The escaped output string.

5.31 xml_getattributevalue
Adds an attribute to an existing element in an existing XML file.
Parameter Name xmlfilepath elementxpath attributename attributenamespace attributevalue namespacemappings Parameter Type filename string string string string string Parameter Description The path of the XML file to read. The XPath expression identifying the element to find. The name of the attribute to find. The namespace of the attribute to find. The value of the attribute. A pipe '|' separated list of prefix=namespace pairs.

5.32 xml_xslttransform
Applies and XSLT transformation to an XML file.
Parameter Name xslt_filepath input_filepath output_filepath Parameter Type filename filename filename Parameter Description The path to the XSLT file to read. The path to the input XML file. The path to the output XML file.

Version: 1.0 2011-12-13

PUBLIC

90 / 222

Import/Export Settings

Import/Export Settings

6.1

Right_Hemisphere_Binary_ExportOptions

Parameter Name fileformat compress animation q_points

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Compression. Export animation. Vertices quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) 10 20 30 40 50 60 70 80 90 100

q_uv

integer

UV vertices quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) 0 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

91 / 222

Import/Export Settings
Parameter Name q_normals Parameter Type integer Parameter Description Normals quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) protect integer File protection. Possible Values No Conversion Protected Read Only measurements viewports thm boolean boolean string Disable measurements. Export viewports. Thumbnail. Possible Values No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200 encrypt watermark_action boolean integer Password Encrypted. Watermark. Possible Values Preserve Add/Overwrite Remove
Version: 1.0 2011-12-13

0 10 20 30 40 50 60 70 80 90 100

0 1 2

No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200

0 1 2
92 / 222

PUBLIC

Import/Export Settings
Parameter Name watermark N7zip_Mode Parameter Type string integer Parameter Description Watermark file. Compression mode. Possible Values Very Fast Fast Normal Best N7zip_DicSize integer Dictionary size. Possible Values 32 KB 64 KB 128 KB 256 KB 512 KB 1 MB 2 MB 4 MB 8 MB 16 MB 32 MB 64 MB 128 MB export_safe_form integer Saving solid objects. Possible Values Only solid Solid and mesh Only mesh 0 1 2 15 16 17 18 19 20 21 22 23 24 25 26 27 -1 0 1 2

Version: 1.0 2011-12-13

PUBLIC

93 / 222

Import/Export Settings

6.2

Autodesk_3D_Studio_ExportOptions

Parameter Name fileformat e_UV e_ignoreUV e_saveh e_savesmooth e_matrix e_lights e_cameras e_defcameras

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean

Parameter Description No Description Provided. Texture coordinates. Remove UV scale and offset from materials. Export hierarchy information. Export smooth groups data. Export local matrix. Export lights. Export cameras. Export default camera.

6.3

Visual_XML_ExportOptions

Parameter Name fileformat export_validate_xml export_using_memory_stream export_rh_file_compression_level

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Validate XML. Use memory streams. RH file compression. Possible Values Very Fast Fast Normal Best -1 0 1 2

export_generate_dsids

boolean

Generate Visaul Enterprise Generator Ids.

Version: 1.0 2011-12-13

PUBLIC

94 / 222

Import/Export Settings

6.4

XAML_ExportOptions

Parameter Name fileformat e_root_element_type

Parameter Type None Provided integer

Parameter Description No Description Provided. Root element type. Possible Values Model3D Viewport3D 1 2

e_animation_behaviour

integer

Animation behaviour. Possible Values Play once Repeat 1 2

e_copy_viewer e_launch_viewer e_back_materials e_default_lights e_use_quaternions e_force_srt e_viewport_max_width e_viewport_max_height e_tex_save e_tex_existing

boolean boolean boolean boolean boolean boolean integer integer boolean integer

Include standalone viewer with model. Launch viewer after export. Export back materials. Export default lights. Use quaternions for rotation. Use scale/rotation/translation order for transformations. Max width. Max height. Save textures. Overwrite existing. Possible Values Replace Skip Rename 0 1 2

e_tex_format

integer

Convert textures to. Possible Values PNG - Portable Network Graphics JPG - JPEG Image TIF - Tagged Image File Format BMP - Windows Bitmap Graphics 1 2 3 4

Version: 1.0 2011-12-13

PUBLIC

95 / 222

Import/Export Settings

6.5

DirectX_Model_ExportOptions

Parameter Name fileformat ASCII Materials Templates TopFrame LeftHand SaveSkin SaveEmptyBones NoBonesMesh all_nodes MaxNodeName Normals FlipNormal Textures e_maxpoly

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean boolean integer boolean boolean boolean integer

Parameter Description No Description Provided. ASCII mode. Export materials. Export templates. Add top level frame. Flip coordinate system. Export skins. Export empty bones. Export bones without meshes. Export empty nodes. Maximum object name. Export normals. Invert normals. Texture coordinates. Maximum vertices in polygon.

6.6

AutoCAD_Design_Web_Format_ExportOptions

Parameter Name fileformat DWFExportFormat

Parameter Type None Provided integer

Parameter Description No Description Provided. Mode. Possible Values Auto-select 3D model 0 2

Version: 1.0 2011-12-13

PUBLIC

96 / 222

Import/Export Settings

6.7

DICOM_Image_ExportOptions

Parameter Name fileformat compression

Parameter Type None Provided integer

Parameter Description No Description Provided. Compression. Possible Values Raw data RLE compression 0 1

color

integer

Photometric interpretation. Possible Values Monochrome 1 Monochrome 2 RGB 0 1 2

6.8

Open_Inventor_File_ExportOptions

Parameter Name fileformat Indent Lights Cameras DefCamera Normals TxtCrd Lines Materials

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean

Parameter Description No Description Provided. Add indents. Export lights. Export cameras. Export default camera. Export normals. Export texture coordinates. Export polylines. Export materials.

Version: 1.0 2011-12-13

PUBLIC

97 / 222

Import/Export Settings

6.9

SOFTIMAGE_XSI_ExportOptions

Parameter Name fileformat SaveAsVersion

Parameter Type None Provided integer

Parameter Description No Description Provided. Version. Possible Values XSI 3.5 Realtime materials XSI 3.5 Softimage materials XSI 3.0 0 1 2

Materials Textures Normals TopFrame FlipNormal Indents ExportPerVertexColor Change_Axes UseNulls MakeCompatible anim__rescale anim__rescaletype

boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer

Export materials. Export textures. Export normals. Add top level frame. Invert normals. Add indents. Export per vertex color. Swap Y and Z axes. Create dummy objects. XSI 2.0 compatibility. Rescale animation. Rescale type. Possible Values Length (cs) By percent 0 1

anim__setLengthTo anim__rescalepercent anim__reverse anim__mergekeys anim__sampleanimation anim__samplerate

float float boolean boolean boolean integer

Centiseconds. Percent. Reverse animation sequence. Remove redundant keys. Sample animation. Sample frames.

Version: 1.0 2011-12-13

PUBLIC

98 / 222

Import/Export Settings

6.10 3ds_Max_File_ExportOptions

Parameter Name fileformat e2m_triangulate e2m_normals e2m_subd_mode

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Triangulate. Export normals. SubD mode. Possible Values Export control mesh Export final mesh 1 2

e2m_use_skins e2m_use_lights e2m_use_cameras e2m_use_default_camera e2m_hide_dummies e2m_group_mode

boolean boolean boolean boolean boolean integer

Export skins. Export lights. Export cameras. Export default camera. Hide dummy nodes. Group mode. Possible Values Do not create Create as opened Create as closed 0 1 2

e2m_conv_inst_2_uniq e2m_pass_metadata mpo_use_remote_server mpo_remote_server_name

boolean boolean boolean string

Convert instances to unique. Export metadata. Use remote 3ds Max DCom server. Remote 3ds Max DCom server name.

Version: 1.0 2011-12-13

PUBLIC

99 / 222

Import/Export Settings

6.11 VRML_Worlds_ExportOptions

Parameter Name fileformat Type

Parameter Type None Provided integer

Parameter Description No Description Provided. Version. Possible Values VRML 1.0 VRML 2.0 1 2

Indent e_flip Lights Cameras DefCamera Normals TxtCrd Lines Materials e_maxpoly

boolean boolean boolean boolean boolean boolean boolean boolean boolean integer

Add indents. Flip coordinate system. Export lights. Export cameras. Export default camera. Export normals. Export texture coordinates. Export polylines. Export materials. Max vertices in polygon.

6.12 Visual_Design_Stream_ExportOptions

Parameter Name fileformat FileExpiration ExpirationDays MatrixType

Parameter Type None Provided boolean integer integer

Parameter Description No Description Provided. File expiration. Days to expire. Accuracy. Possible Values float double autodetect 0 1 2

MatrixTolerance TextureType

string integer

Tolerance. Texture type. Possible Values None PNG JPG 0 1 2

ColorsAsBytes WriteGlossinessAndSpecularLevel
Version: 1.0 2011-12-13

boolean boolean

Colors accuracy. Glossiness and Specular level.

100 / 222

PUBLIC

Import/Export Settings
Parameter Name DetectMaterialInstances Parameter Type integer Parameter Description Detect material instances. Possible Values NO YES YES + ignore material names LODType integer Number of LODs. Possible Values None Points, low (every 16th) Points, medium low (every 8th) Points, medium (every 4th) Points, medium high (every 2nd) Points, high (every square root of 2) Triangles, low (10%, 50%) Triangles, medium (5%, 10%, 25%, 50%) Triangles, high (5%, 10%, 25%, 38%, 50%, 75%) LODMinVertices SubmeshMaxTriangles SubmeshSplitTries PositionQuants integer integer integer integer Minimum vertices in LOD. Submesh triangle count. Submesh split attempts. Vertices quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% 256 1024 4096 8192 16384 32768 65536 262144 524288 0 0 1 2 3 4 5 6 7 8 0 1 2

Version: 1.0 2011-12-13

PUBLIC

101 / 222

Import/Export Settings
Parameter Name NormalQuants Parameter Type integer Parameter Description Normals quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% TexCoordQuants integer UV vertices quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% Metadata integer Processing. Possible Values Don't export No instancing Partial instancing (sets only) Full instancing (sets and values) MinRecordsForTable MinDuplicatesForTable integer integer Min records for table. Min duplicates for table. 0 1 2 3 256 1024 4096 8192 16384 32768 65536 262144 524288 0 359 719 1439 2879 5759 11519 23039 32768 65536 0

Version: 1.0 2011-12-13

PUBLIC

102 / 222

Import/Export Settings

6.13 LightWave_Scene_ExportOptions

Parameter Name fileformat SaveVersion

Parameter Type None Provided integer

Parameter Description No Description Provided. Version. Possible Values LightWave 5.6 LightWave 6.0 1 2

layered_object ExportSkin oneinstance e_viewport e_lights folder prefix

boolean boolean boolean boolean boolean string string

Export single layered object. Export skins. Export one object instance. Export viewport. Export lights. Copy objects to folder. Use prefix.

6.14 JPEG_2000_JPC_ExportOptions

Parameter Name fileformat lossy targetpercentage

Parameter Type None Provided boolean integer

Parameter Description No Description Provided. Lossy compression. Percentage file size.

6.15 Rhinoceros_3D_Model_ExportOptions

Parameter Name fileformat RhinoExportSkipHiddenObjects RhinoExportPutCurvesInSingleLayer RhinoExportLights RhinoExportCameras

Parameter Type None Provided boolean boolean boolean boolean

Parameter Description No Description Provided. Skip hidden objects. Put all curves in single layer. Export lights. Export cameras.

Version: 1.0 2011-12-13

PUBLIC

103 / 222

Import/Export Settings

6.16 Office_Powerpoint_Document_ExportOptions

Parameter Name fileformat template

Parameter Type None Provided string

Parameter Description No Description Provided. Template. Possible Values basic.htm basic_2007.htm steps_n_views.htm steps_n_views_2007.htm basic.htm basic_2007.htm steps_n_views.htm steps_n_views_2007.htm

use_external_template external_template preview rh_compress rh_animation rh_q_points

boolean filename boolean boolean boolean integer

Use external template. External template. Open in browser/program. Compression. Export animation. Vertices quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) 10 20 30 40 50 60 70 80 90 100

rh_q_uv

integer

UV vertices quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) 0 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

104 / 222

Import/Export Settings
Parameter Name rh_q_normals Parameter Type integer Parameter Description Normals quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) rh_protect integer File protection. Possible Values No Conversion Protected Read Only rh_measurements rh_viewports rh_thm boolean boolean string Disable measurements. Export viewports. Thumbnail. Possible Values No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200 rh_encrypt rh_watermark_action boolean integer Password Encrypted. Watermark. Possible Values Preserve Add/Overwrite Remove 0 1 2 No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200 0 1 2 0 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

105 / 222

Import/Export Settings
Parameter Name rh_watermark rh_7zip_Mode Parameter Type string integer Parameter Description Watermark file. Compression mode. Possible Values Very Fast Fast Normal Best rh_7zip_DicSize integer Dictionary size. Possible Values 32 KB 64 KB 128 KB 256 KB 512 KB 1 MB 2 MB 4 MB 8 MB 16 MB 32 MB 64 MB 128 MB rh_export_safe_form integer Saving solid objects. Possible Values Only solid Solid and mesh Only mesh AUTHOR TITLE DESCRIPTION string string string Author. Title. Description. 0 1 2 15 16 17 18 19 20 21 22 23 24 25 26 27 -1 0 1 2

Version: 1.0 2011-12-13

PUBLIC

106 / 222

Import/Export Settings

6.17 HTML_Document_with_3D_ExportOptions

Parameter Name fileformat template

Parameter Type None Provided string

Parameter Description No Description Provided. Template. Possible Values animation_n_layers.html ansi_style.html ansi_style_ex.html basic.html catia_pmi_selection.html java_scripting.html jt_pmi_selection.html marsiano_style.html object_only.html simple_animation.html standard_views.html steps_n_model_views.html steps_n_parts.html steps_n_procs.html test_sample.html animation_n_layers.html ansi_style.html ansi_style_ex.html basic.html catia_pmi_selection.html java_scripting.html jt_pmi_selection.html marsiano_style.html object_only.html simple_animation.html standard_views.html steps_n_model_views.html steps_n_parts.html steps_n_procs.html test_sample.html

use_external_tem plate external_template preview rh_compress rh_animation rh_q_points

boolean filename boolean boolean boolean integer

Use external template. External template. Open in browser/program. Compression. Export animation. Vertices quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

107 / 222

Import/Export Settings
Parameter Name rh_q_uv Parameter Type integer Parameter Description UV vertices quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) rh_q_normals integer Normals quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) rh_protect integer File protection. Possible Values No Conversion Protected Read Only rh_measurements rh_viewports boolean boolean Disable measurements. Export viewports. 0 1 2 0 10 20 30 40 50 60 70 80 90 100 0 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

108 / 222

Import/Export Settings
Parameter Name rh_thm Parameter Type string Parameter Description Thumbnail. Possible Values
No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200 No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200

rh_encrypt rh_watermark_acti on

boolean integer

Password Encrypted. Watermark. Possible Values Preserve Add/Overwrite Remove 0 1 2

rh_watermark rh_7zip_Mode

string integer

Watermark file. Compression mode. Possible Values Very Fast Fast Normal Best -1 0 1 2

rh_7zip_DicSize

integer

Dictionary size. Possible Values

32 KB 64 KB 128 KB 256 KB 512 KB 1 MB 2 MB 4 MB 8 MB 16 MB 32 MB 64 MB 128 MB 15 16 17 18 19 20 21 22 23 24 25 26 27

Version: 1.0 2011-12-13

PUBLIC

109 / 222

Import/Export Settings
Parameter Name rh_export_safe_fo rm Parameter Type integer Parameter Description Saving solid objects. Possible Values Only solid Solid and mesh Only mesh AUTHOR TITLE DESCRIPTION string string string Author. Title. Description. 0 1 2

Version: 1.0 2011-12-13

PUBLIC

110 / 222

Import/Export Settings

6.18 LightWave_3D_and_Binary_Object_ExportOptions

Parameter Name fileformat SaveVersion

Parameter Type None Provided integer

Parameter Description No Description Provided. Version. Possible Values LightWave 5.6 LightWave 6.0 0 1

SubDExportMode

integer

Export SubDs. Possible Values Final mesh Control mesh Control mesh using PTCH chunk 0 1 2

SaveUVfiles SaveUVIM SaveUV SaveVMAD SaveExtraMaps

boolean boolean boolean boolean boolean

Create .uv files. Export UVs using chunks. Export UVs. Use discontinuous UVs. Export extra maps.

6.19

OpenFlight_Scene_Description_Database_ExportOptions

Parameter Name fileformat e_local e_uv e_normals e_colors e_ref e_colorpal e_empty_nodes

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean

Parameter Description No Description Provided. Export vertices in local object space. Export UVs. Per vertex normals. Per vertex colors. Use instances and references. Export color palette. Export empty nodes.

Version: 1.0 2011-12-13

PUBLIC

111 / 222

Import/Export Settings

6.20 Maya_ASCII_Scene_ExportOptions

Parameter Name fileformat XAxes

Parameter Type None Provided integer

Parameter Description No Description Provided. Up axis in Maya. Possible Values Y Z 1 0

exp_opt_maximum_vertices_in_polygon XDoubleSided XBlinn

integer boolean integer

Maximum vertices in polygon. Mark surfaces as double sided. Material type. Possible Values Phong Blinn 0 1

XSkins exp_opt_tessellate_nurbs opt_maya_version

boolean boolean integer

Export skins. Tessellate NURBS. Maya version. Possible Values None -1

Version: 1.0 2011-12-13

PUBLIC

112 / 222

Import/Export Settings

6.21 Adobe_Portable_Document_2D__with_template__Export Options

Parameter Name fileformat p1_internal_template_filename

Parameter Type None Provided string

Parameter Description No Description Provided.

Template. Possible Values 2D 4 Tab Views 2D ANSI Size A Landscape 11 X 8.5 2D ANSI Size A Portrait 8.5 X 11 2D ANSI Size A Portrait 8.5 X 11 with Title Block 2D ANSI Size B Landscape 17 X 11 2D ANSI Size B Landscape 17 X 11 with Title Block 2D ANSI Size B Portrait 11 X 17 2D ANSI Size C Landscape 22 X 17 2D ANSI Size C Portrait 17 X 22 2D ANSI Size D Landscape 34 X 22 2D ANSI Size D Portrait 22 X 34 2D ANSI Size E Landscape 44 X 34 2D ANSI Size E Portrait 34 X 44 2D Arch Size A Landscape 12 X 9 2D Arch Size A Portrait 9 X 12 2D Arch Size B Landscape 18 X 12 4_Tab_2D_Views_v1.0.xml ANSI_Size_A_Landscape_11_X_8.5_Tem plate.xml ANSI_Size_A_Portrait_8.5_X_11_Templat e.xml ANSI_Size_A_Portrait_TB_Template.xml

ANSI_Size_B_Landscape_17_X_11_Temp late.xml ANSI_Size_B_Landscape_TB_Template.x ml

ANSI_Size_B_Portrait_11_X_17_Template .xml ANSI_Size_C_Landscape_22_X_17_Temp late.xml ANSI_Size_C_Portrait_17_X_22_Template .xml ANSI_Size_D_Landscape_34_X_22_Temp late.xml ANSI_Size_D_Portrait_22_X_34_Template .xml ANSI_Size_E_Landscape_44_X_34_Temp late.xml ANSI_Size_E_Portrait_34_X_44_Template .xml Arch_Size_A_Landscape_12_X_9_Templa te.xml Arch_Size_A_Portrait_9_X_12_Template.x ml Arch_Size_B_Landscape_18_X_12_Templ ate.xml

Version: 1.0 2011-12-13

PUBLIC

113 / 222

Import/Export Settings
Parameter Name Parameter Type Parameter Description
2D Arch Size B Portrait 12 X 18 2D Arch Size C Landscape 24 X 18 2D Arch Size C Portrait 18 X 24 2D Arch Size D Landscape 36 X 24 2D Arch Size D Portrait 24 X 36 2D Arch Size E Landscape 48 X 36 2D Arch Size E Portrait 36 X 48 2D Basic Landscape Letter Template 2D Basic Portrait Letter Template 2D ISOSize A0 Landscape 1189 X 841 2D ISOSize A0 Portrait 841 X 1189 2D ISOSize A1 Landscape 841 X 594 2D ISOSize A1 Portrait 594 X 841 2D ISOSize A2 Landscape 594 X 420 2D ISOSize A2 Portrait 420 X 594 2D ISOSize A3 Landscape 420 X 297 2D ISOSize A3 Portrait 297 X 420 2D ISOSize A4 Landscape 297 X 210 2D ISOSize A4 Portrait 210 X 297 Arch_Size_B_Portrait_12_X_18_Template. xml Arch_Size_C_Landscape_24_X_18_Templ ate.xml Arch_Size_C_Portrait_18_X_24_Template. xml Arch_Size_D_Landscape_36_X_24_Templ ate.xml Arch_Size_D_Portrait_24_X_36_Template. xml Arch_Size_E_Landscape_48_X_36_Templ ate.xml Arch_Size_E_Portrait_36_X_48_Template. xml Basic_Horiz_Letter_2D_Template.xml

Basic_Vert_Letter_2D_Template.xml

ISO_Size_A0_Landscape_1189_X_841_T emplate..xml ISO_Size_A0_Portrait_841_X_1189_Templ ate..xml ISO_Size_A1_Landscape_841_X_594_Te mplate..xml ISO_Size_A1_Portrait_594_X_841_Templa te..xml ISO_Size_A2_Landscape_594_X_420_Te mplate..xml ISO_Size_A2_Portrait_420_X_594_Templa te..xml ISO_Size_A3_Landscape_420_X_297_Te mplate..xml ISO_Size_A3_Portrait_297_X_420_Templa te..xml ISO_Size_A4_Landscape_297_X_210_Te mplate..xml ISO_Size_A4_Portrait_210_X_297_Templa te..xml

p1_use_external_template p1_external_template_filename

boolean filename

Use External Template. External Template.

Version: 1.0 2011-12-13

PUBLIC

114 / 222

Import/Export Settings
Parameter Name p1_annot_place_title Parameter Type string Parameter Description 3D Model or 2D Image Target. Possible Values 2D_Annotation1 2D_Annotation2 2D_Annotation3 2D_Annotation4 p1_run_acrobat p2_2d_image_align boolean integer 2D_Annotation1 2D_Annotation2 2D_Annotation3 2D_Annotation4

Start Adobe Acrobat After Publishing. Align. Possible Values Stretch Fit to Left/Top Fit to Center/Top Fit to Right/Top Fit to Left/Center Fit to Center/Center Fit to Right/Center Fit to Left/Bottom Fit to Center/Bottom Fit to Right/Bottom 0 1 2 3 4 5 6 7 8 9

p3_xfdf_filename p3_attach_filename p3_js_doc_filename p3_js_page_filename p3_js_cntx_filename p3_use_watermark p3_watermark_text p3_use_md_password p3_md_password p3_use_op_password p3_op_password p3_enable_annots_rename md_title md_author md_subject md_keywords md_auto_title md_auto_subject md_auto_keywords

filename filename filename filename filename boolean string boolean password boolean password boolean string string string string boolean boolean boolean

XFDF File Name. Attachments. Doc Level JS. Page Level JS. 3D Level JS. Add Watermark with following text. Watermark Text. Password protect editing of PDF. Password. Password protect opening of PDF. Password. Enable PDF for Merging. Title. Author. Subject. Keywords. Auto-generate Title. Auto-generate Subject. Add Parts List to Keywords.

Version: 1.0 2011-12-13

PUBLIC

115 / 222

Import/Export Settings

6.22 Tagged_Image_File_Format_ExportOptions

Parameter Name fileformat grayscale multipage compression

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Always in greyscale. Save multipage. Compression. Possible Values LZW Deflate CCITTFAX3 CCITTFAX4 0 1 2 3

savecolormgntinfo

boolean

Save ICC color managemet info.

6.23 AutoCAD_Drawing_Object_ExportOptions

Parameter Name fileformat FileVersion

Parameter Type None Provided integer

Parameter Description No Description Provided. Output Version. Possible Values AutoCAD 2007 AutoCAD 2004 AutoCAD 2000 AutoCAD R14 AutoCAD R13 AutoCAD R11/R12 0 1 2 3 4 5

6.24 Portable_Network_Graphics_ExportOptions

Parameter Name fileformat INTERLACE

Parameter Type None Provided boolean

Parameter Description No Description Provided. Interlaced.

Version: 1.0 2011-12-13

PUBLIC

116 / 222

Import/Export Settings

6.25 Universal_3D_export_ExportOptions

Parameter Name fileformat AcrobatVersionCompatibility

Parameter Type None Provided integer

Parameter Description No Description Provided. File format. Possible Values U3D ECMA 1st Edition U3D ECMA 3rd Edition 1792 2048

MeshCompression TextureJPG

boolean integer

Mesh compression. Texture compression type. Possible Values PNG JPEG 0 1

Normals DefaultCamera NonUnique SkinBones FixBoneHierarchy MetadataAsXML CompressionPreset

boolean boolean boolean boolean boolean boolean integer

Normals. Default camera. Append data to non-unique names. Skin and bones. Fix bone hierarchy. Metadata. Compression preset. Possible Values Custom Game CAD 0 1 2

MeshVertexQuality MeshNormalQuality MeshDiffuseQuality MeshTexcoordQuality TextureCompressionQuality

integer integer integer integer integer

Vertices. Normals. Vertex colors. Texture coordinates. JPEG quality.

6.26 JPEG_2000_JP2_ExportOptions

Parameter Name fileformat lossy targetpercentage

Parameter Type None Provided boolean integer

Parameter Description No Description Provided. Lossy compression. Percentage file size.

Version: 1.0 2011-12-13

PUBLIC

117 / 222

Import/Export Settings

6.27 Maya_Binary_Scene_ExportOptions

Parameter Name fileformat XAxes

Parameter Type None Provided integer

Parameter Description No Description Provided. Up axis in Maya. Possible Values Y Z 1 0

exp_opt_maximum_vertices_in_polygon XDoubleSided XBlinn

integer boolean integer

Maximum vertices in polygon. Mark surfaces as double sided. Material type. Possible Values Phong Blinn 0 1

XSkins exp_opt_tessellate_nurbs opt_maya_version

boolean boolean integer

Export skins. Tessellate NURBS. Maya version. Possible Values None -1

6.28 Maya_Interchange_File_Format_ExportOptions

Parameter Name fileformat opt_maya_version

Parameter Type None Provided integer

Parameter Description No Description Provided. Maya version. Possible Values None -1

6.29 Stereolithography_File_ExportOptions

Parameter Name fileformat ascii

Parameter Type None Provided boolean

Parameter Description No Description Provided. ASCII mode.

Version: 1.0 2011-12-13

PUBLIC

118 / 222

Import/Export Settings

6.30 Adobe_Portable_Document_3D_ExportOptions

Parameter Name fileformat

p1_internal_template_filename

Parameter Type None Provided

string

Parameter Description No Description Provided.

Template. Possible Values 3D Architecture Walkthrough and Views 3D Basic Landscape Letter Template 3D Basic Portrait Letter Template 3D Basic Views Landscape Letter Template 3D Basic Views Portrait Letter Template 3D BOM Basic Views Landscape Letter 3D BOM Basic Views Portrait Letter 3D BOM Simple Letter Landscape Template 3D BOM Simple Letter Portrait Template 3D Catia v5 PMI Template 3D JT PMI Template 3D Procedures Steps BOM Template 3D Simple Animation Template 3D Steps BOM List Template 3D Steps Parts List Template 3D Steps Portrait Template 3D Steps Simple Template 2D 4 Tab Views Architecture_Walkthrough_Views_Templat e.xml Basic_Horiz_Letter_3D_Template.xml Basic_Vert_Letter_3D_Template.xml Basic_Views_Horiz_Letter_3D_Template.x ml Basic_Views_Vert_Letter_3D_Template.x ml BOM_Basic_Views_Landscape_Template _v1.0.xml BOM_Basic_Views_Portrait_Template_v1. 0.xml BOM_Simple_Landscape_Template_v1.0. xml BOM_Simple_Portrait_Template_v1.0.xml

Catia_PMI_Template_v1.0.xml JT_PMI_Template_v2.0.xml Procedures_Steps_BOM_Template_v1.0.x ml Simple_Animation_Template.xml Steps_BOM_Template_v1.0.xml Steps_Parts_Template_v1.0.xml Steps_Simple_Portrait_Template_1.0.xml Steps_Simple_Template.xml 4_Tab_2D_Views_v1.0.xml

Version: 1.0 2011-12-13

PUBLIC

119 / 222

Import/Export Settings
Parameter Name Parameter Type Parameter Description
2D ANSI Size A Landscape 11 X 8.5 2D ANSI Size A Portrait 8.5 X 11 2D ANSI Size A Portrait 8.5 X 11 with Title Block 2D ANSI Size B Landscape 17 X 11 2D ANSI Size B Landscape 17 X 11 with Title Block 2D ANSI Size B Portrait 11 X 17 2D ANSI Size C Landscape 22 X 17 2D ANSI Size C Portrait 17 X 22 2D ANSI Size D Landscape 34 X 22 2D ANSI Size D Portrait 22 X 34 2D ANSI Size E Landscape 44 X 34 2D ANSI Size E Portrait 34 X 44 2D Arch Size A Landscape 12 X 9 2D Arch Size A Portrait 9 X 12 2D Arch Size B Landscape 18 X 12 2D Arch Size B Portrait 12 X 18 2D Arch Size C Landscape 24 X 18 2D Arch Size C Portrait 18 X 24 2D Arch Size D Landscape 36 X 24 2D Arch Size D Portrait 24 X 36 2D Arch Size E Landscape 48 X 36 2D Arch Size E Portrait 36 X 48 2D Basic Landscape Letter Template 2D Basic Portrait Letter Template 2D ISOSize A0 Landscape 1189 X 841 ANSI_Size_A_Landscape_11_X_8.5_Tem plate.xml ANSI_Size_A_Portrait_8.5_X_11_Templat e.xml ANSI_Size_A_Portrait_TB_Template.xml

ANSI_Size_B_Landscape_17_X_11_Tem plate.xml ANSI_Size_B_Landscape_TB_Template.x ml ANSI_Size_B_Portrait_11_X_17_Templat e.xml ANSI_Size_C_Landscape_22_X_17_Tem plate.xml ANSI_Size_C_Portrait_17_X_22_Templat e.xml ANSI_Size_D_Landscape_34_X_22_Tem plate.xml ANSI_Size_D_Portrait_22_X_34_Templat e.xml ANSI_Size_E_Landscape_44_X_34_Tem plate.xml ANSI_Size_E_Portrait_34_X_44_Templat e.xml Arch_Size_A_Landscape_12_X_9_Templ ate.xml Arch_Size_A_Portrait_9_X_12_Template. xml Arch_Size_B_Landscape_18_X_12_Temp late.xml Arch_Size_B_Portrait_12_X_18_Template .xml Arch_Size_C_Landscape_24_X_18_Temp late.xml Arch_Size_C_Portrait_18_X_24_Template .xml Arch_Size_D_Landscape_36_X_24_Temp late.xml Arch_Size_D_Portrait_24_X_36_Template .xml Arch_Size_E_Landscape_48_X_36_Temp late.xml Arch_Size_E_Portrait_36_X_48_Template .xml Basic_Horiz_Letter_2D_Template.xml Basic_Vert_Letter_2D_Template.xml ISO_Size_A0_Landscape_1189_X_841_T emplate..xml

Version: 1.0 2011-12-13

PUBLIC

120 / 222

Import/Export Settings
Parameter Name Parameter Type Parameter Description
2D ISOSize A0 Portrait 841 X 1189 2D ISOSize A1 Landscape 841 X 594 2D ISOSize A1 Portrait 594 X 841 2D ISOSize A2 Landscape 594 X 420 2D ISOSize A2 Portrait 420 X 594 2D ISOSize A3 Landscape 420 X 297 2D ISOSize A3 Portrait 297 X 420 2D ISOSize A4 Landscape 297 X 210 2D ISOSize A4 Portrait 210 X 297 ISO_Size_A0_Portrait_841_X_1189_Tem plate..xml ISO_Size_A1_Landscape_841_X_594_Te mplate..xml ISO_Size_A1_Portrait_594_X_841_Templ ate..xml ISO_Size_A2_Landscape_594_X_420_Te mplate..xml ISO_Size_A2_Portrait_420_X_594_Templ ate..xml ISO_Size_A3_Landscape_420_X_297_Te mplate..xml ISO_Size_A3_Portrait_297_X_420_Templ ate..xml ISO_Size_A4_Landscape_297_X_210_Te mplate..xml ISO_Size_A4_Portrait_210_X_297_Templ ate..xml

p1_use_external_template p1_external_template_filen ame p1_annot_place_title

boolean filename string

Use External Template. External Template. 3D Model or 2D Image Target. Possible Values 3D_Annotation1 3D_Annotation2 3D_Annotation3 3D_Annotation4 2D_Annotation1 2D_Annotation2 2D_Annotation3 2D_Annotation4 3D_Annotation1 3D_Annotation2 3D_Annotation3 3D_Annotation4 2D_Annotation1 2D_Annotation2 2D_Annotation3 2D_Annotation4

p1_run_acrobat p2_poster_render_idx

boolean integer

Start Adobe Acrobat After Publishing. Preview Image. Possible Values Raster Image via Software Z-Buffer Render External Raster Image External Vector File (in .PDF) Vector Image via Illustration Module Raster Image via DirectX-9 Render 0 2 3 4 5

p2_external_image_filena me

filename

External File.

Version: 1.0 2011-12-13

PUBLIC

121 / 222

Import/Export Settings
Parameter Name p2_texture_quality Parameter Type float Parameter Description Texture Quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% p2_store_normals p2_store_metadata p2_vectorize_callouts boolean boolean integer Save Normals. Store metadata. Vectorize Callouts. Possible Values Standard Vector Raster p2_use_bkgnd p2_use_bkgnd_ext p2_bkgnd_filename p2_annot3d_auto_activate p2_annot3d_show_3d_tool bar p2_annot3d_store_camera s p2_annot3d_store_modelvi ews p2_callouts_2_pmi p2_mini_java p2_2d_image_creator_inde x boolean boolean filename boolean boolean boolean boolean boolean boolean integer Publish Current 3D Scene Background Image. Publish External 3D Scene Background Image. External File. Activate 3D Model. Show Toolbar of 3D Model. Save Cameras to Adobe Acrobat. Save Model Views to Adobe Acrobat. Mark All Callouts as PMI objects. Minimize Java Code Generation. Image Format. Possible Values Raster Image via Software Z-Buffer Render Vector Image via 2D PDF Module Vector Image via Illustration Module Raster Image via DirectX-9 Render p3_xfdf_filename p3_attach_filename p3_js_doc_filename p3_js_page_filename filename filename filename filename XFDF File Name. Attachments. Doc Level JS. Page Level JS. 0 2 3 5 0 1 2 10.0 20.0 30.0 40.0 50.0 60.0 70.0 80.0 90.0 100.0

Version: 1.0 2011-12-13

PUBLIC

122 / 222

Import/Export Settings
Parameter Name p3_js_cntx_filename p3_use_watermark p3_watermark_text p3_use_md_password p3_md_password p3_use_op_password p3_op_password p3_enable_annots_rename md_title md_author md_subject md_keywords md_auto_title md_auto_subject md_auto_keywords zb_aa Parameter Type filename boolean string boolean password boolean password boolean string string string string boolean boolean boolean integer Parameter Description 3D Level JS. Add Watermark with following text. Watermark Text. Password protect editing of PDF. Password. Password protect opening of PDF. Password. Enable PDF for Merging. Title. Author. Subject. Keywords. Auto-generate Title. Auto-generate Subject. Add Parts List to Keywords. Antialiasing. Possible Values None Adaptive 2x2 3x3 4x4 5x5 6x6 7x7 8x8 zb_add_items rt_aa boolean integer Render additional items. Antialiasing. Possible Values None Adaptive 2x2 3x3 4x4 5x5 6x6 7x7 8x8 rt_dsides_poly rt_filter_tmaps boolean boolean Double-sided polygons. Filter texture maps. 0 1 2 3 4 5 6 7 8 0 1 2 3 4 5 6 7 8

Version: 1.0 2011-12-13

PUBLIC

123 / 222

Import/Export Settings
Parameter Name rt_rayt_refl rt_refr rt_shadows rt_soft_shadows rt_mt vo_line_thickness vo_bndr_thickness vo_tolerance_angle vo_calc_intersections vo_remove_hidden_lines vo_show_as_wireframe vo_use_objects_colors vo_special_color vo_place_bom Parameter Type boolean boolean boolean boolean boolean float float float boolean boolean boolean boolean integer integer Parameter Description Raytrace reflections. Refractions. Shadows. Soft shadows. Use multithreaded rendering. Line Thickness. Boundary Thickness. Tolerance Angle. Calculate Intersections. Remove Hidden Lines. Show as Wireframe. Use Objects Color. Line Color. BOM. Possible Values None Right Bottom 0 3 2

Version: 1.0 2011-12-13

PUBLIC

124 / 222

Import/Export Settings

6.31 Flex_Web_Application_ExportOptions

Parameter Name fileformat

template

Parameter Type None Provided

string

Parameter Description No Description Provided.

Template. Possible Values BOM_ImageFlow_Model_Views_And_ Portfolios.xml BOM_ImageFlow_Steps_And_Proced ures.xml BOM_Metadata_Model_Views_And_P ortfolios.xml BOM_Metadata_Steps_And_Procedur es.xml BOM_Model_Views_And_Portfolios.x ml BOM_Steps_And_Procedures.xml BOM_Steps_And_Procedures_w_Log o.xml Model_Views_And_Portfolios_Basic.x ml Steps_And_Procedures_Advanced.xm l Steps_And_Procedures_Basic.xml BOM_ImageFlow_Model_Views _And_Portfolios.xml BOM_ImageFlow_Steps_And_P rocedures.xml BOM_Metadata_Model_Views_ And_Portfolios.xml BOM_Metadata_Steps_And_Pro cedures.xml BOM_Model_Views_And_Portfol ios.xml BOM_Steps_And_Procedures.x ml BOM_Steps_And_Procedures_ w_Logo.xml Model_Views_And_Portfolios_B asic.xml Steps_And_Procedures_Advanc ed.xml Steps_And_Procedures_Basic.x ml

use_external_templ ate external_template preview rh_compress rh_animation rh_q_points

boolean filename boolean boolean boolean integer

Use external template. External template. Open in browser/program. Compression. Export animation. Vertices quality. Possible Values 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

125 / 222

Import/Export Settings
Parameter Name rh_q_uv Parameter Type integer Parameter Description UV vertices quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) rh_q_normals integer Normals quality. Possible Values OFF 10% 20% 30% 40% 50% 60% 70% 80% 90% 100% (lossless) rh_protect integer File protection. Possible Values No Conversion Protected Read Only rh_measurements rh_viewports boolean boolean Disable measurements. Export viewports. 0 1 2 0 10 20 30 40 50 60 70 80 90 100 0 10 20 30 40 50 60 70 80 90 100

Version: 1.0 2011-12-13

PUBLIC

126 / 222

Import/Export Settings
Parameter Name rh_thm Parameter Type string Parameter Description
Thumbnail. Possible Values No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200 No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200

rh_encrypt rh_watermark_actio n

boolean integer

Password Encrypted. Watermark. Possible Values Preserve Add/Overwrite Remove 0 1 2

rh_watermark rh_7zip_Mode

string integer

Watermark file. Compression mode. Possible Values Very Fast Fast Normal Best -1 0 1 2

rh_7zip_DicSize

integer

Dictionary size. Possible Values 32 KB 64 KB 128 KB 256 KB 512 KB 1 MB 2 MB 4 MB 8 MB 16 MB 32 MB 64 MB 128 MB 15 16 17 18 19 20 21 22 23 24 25 26 27

Version: 1.0 2011-12-13

PUBLIC

127 / 222

Import/Export Settings
Parameter Name rh_export_safe_for m Parameter Type integer Parameter Description Saving solid objects. Possible Values Only solid Solid and mesh Only mesh AUTHOR TITLE DESCRIPTION string string string Author. Title. Description. 0 1 2

Version: 1.0 2011-12-13

PUBLIC

128 / 222

Import/Export Settings

6.32 JTPMI_Files_ExportOptions

Parameter Name fileformat FileExportType

Parameter Type None Provided integer

Parameter Description No Description Provided. Type. Possible Values Monolithic Per part Fully Shattered 0 1 2

CompressionSettings

integer

Compression type. Possible Values No compression Version 7.0 Version 8.0 Automatic Version 8.1 Version 8.2 Version 9.0 Version 9.1 Version 9.2 Version 9.3 Version 9.4 Version 9.5 0 1 2 3 4 5 6 7 8 9 10 11

ExportLODs ExportPMI

boolean boolean

Generate lower LODs. Export PMI.

Version: 1.0 2011-12-13

PUBLIC

129 / 222

Import/Export Settings

6.33 Google_SketchUp_Document_ExportOptions

Parameter Name fileformat polyline BackMaterial NoSmothEdgeVisible MergeCoplanarFaces OptimizePoints ExportVersion

Parameter Type None Provided boolean boolean boolean boolean boolean integer

Parameter Description No Description Provided. Export polylines. Create back material too. Corner edges are visible. Merge all the coplanar faces. Optimize points. File Version. Possible Values 3 4 5 6 7 8 3 4 5 6 7 8

6.34 Adobe_Portable_Document_2D_ExportOptions

Parameter Name fileformat ExportCompress ExportLaunchPDF ExportFonts

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Compress PDF. Open PDF after saving. Text and Fonts. Possible Values Geometry only Geometry with hidden text Embedded fonts 0 1 2

ExportFlatten ExportImagePPI ExportActiveViewOnly ExportIncludeHidden Monochrome ExportBitmapsOnly

boolean integer boolean boolean boolean boolean

Flatten Layers. Bitmap resolution (DPI). Export Active View only. Export Hidden Objects. Black and White. Export whole pages as bitmaps.

Version: 1.0 2011-12-13

PUBLIC

130 / 222

Import/Export Settings
Parameter Name ColorCompensate Parameter Type integer Parameter Description Color compensate for paper. Possible Values B&W Swap Darken Invert Color Invert Brightness IncludeViews integer Viewports to include. Possible Values Page layouts only All 0 1 0 1 2 3

6.35 Right_Hemisphere_Material_ExportOptions

Parameter Name fileformat compress protect defmat thm

Parameter Type None Provided boolean boolean boolean string

Parameter Description No Description Provided. Compression. File protection. Export default material. Thumbnail. Possible Values No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200 No thumbnail 32 X 32 48 X 48 64 X 64 72 X 72 80 X 80 90 X 90 100 X 100 120 X 120 128 X 128 150 X 150 180 X 180 200 X 200

Version: 1.0 2011-12-13

PUBLIC

131 / 222

Import/Export Settings

6.36 Computer_Graphics_Metafile_ExportOptions

Parameter Name fileformat Version

Parameter Type None Provided integer

Parameter Description No Description Provided. Version. Possible Values 1 (most compatible) 3 (best curves) 4 (Hotspots) 0 1 2

Precision

integer

Numeric precision. Possible Values 16 bit integer 32 bit floating point 32 bit fixed point Auto select 0 1 2 3

UseRLE XMLCompanion

boolean boolean

Encode raster images with RLE. XML Companion file.

6.37 AutoCAD_Drawing_Interchange_ExportOptions

Parameter Name fileformat FileFormat

Parameter Type None Provided integer

Parameter Description No Description Provided. Output Format. Possible Values AutoCAD DXF file AutoCAD DXF binary file 1 2

FileVersion

integer

Output Version. Possible Values AutoCAD 2007 AutoCAD 2004 AutoCAD 2000 AutoCAD R14 AutoCAD R13 AutoCAD R11/R12 0 1 2 3 4 5

Version: 1.0 2011-12-13

PUBLIC

132 / 222

Import/Export Settings

6.38 OpenEXR_Bitmap_ExportOptions

Parameter Name fileformat Compression

Parameter Type None Provided integer

Parameter Description No Description Provided. Compression type. Possible Values None Run-length encoding zlib single scan lines zlib 16 block scan lines Piz-based wavelet Lossy 24-bit float compression 0 1 2 3 4 5

LineOrder

integer

Line order. Possible Values Use lowest Y coordinate scan line Use highest Y coordinate scan line 0 1

6.39 JPEG_Image_ExportOptions

Parameter Name fileformat e_quality savecolormgntinfo

Parameter Type None Provided integer boolean

Parameter Description No Description Provided. Image quality. Save ICC color managemet info.

Version: 1.0 2011-12-13

PUBLIC

133 / 222

Import/Export Settings

6.40 Wavefront_Object_ExportOptions

Parameter Name fileformat e_compact e_mtl e_normals e_txt e_flatonly e_flip e_SubD e_maxpoly e_FixMaterials e_string_len e_digits_v e_digits_vn e_digits_vt

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean integer boolean integer integer integer integer

Parameter Description No Description Provided. Compact data. Create material file. Export vertex normals. Export texture coordinates. Triangulate non-flat polygons. Flip coordinate system. Create SubD control mesh. Max vertices in polygon. Replace material colors. Max string length before wrap. Vertices (v). Normals (vn). UVs (vt).

6.41 Caligari_trueSpace_Object_ExportOptions

Parameter Name fileformat ascii MoveAxis Rescale ScaleValue

Parameter Type None Provided boolean boolean boolean float

Parameter Description No Description Provided. ASCII mode. Move object axis to object centre. Rescale. Percent of workplace.

6.42 Right_Hemisphere_Binary_ImportOptions

Parameter Name fileformat i_IgnoreVP

Parameter Type None Provided boolean

Parameter Description No Description Provided. Use Current Viewport Settings.

Version: 1.0 2011-12-13

PUBLIC

134 / 222

Import/Export Settings

6.43 Autodesk_3D_Studio_ImportOptions

Parameter Name fileformat KeyFrame Animation FixBadParity

Parameter Type None Provided boolean boolean boolean

Parameter Description No Description Provided. Import keyframe data. Import animation. Repair mirror transformed objects.

6.44 CATIA5_Assembly_Files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible loadconstruction

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import construction geometry. Possible Values NO All except partbodies ALL 0 1 2

displayconstruction importconfigurationlevel

boolean integer

Display construction geometry. Import representations. Possible Values Default All 1 0

importmetadata collectmetadata importonlytoplevelmetadata partnaming

boolean boolean boolean integer

Import metadata. Collect metadata to geometry. Top level metadata only. Part naming. Possible Values Part name Instance name Part then instance Instance then part 0 1 2 3

importselectionset

boolean

Import selection sets.

Version: 1.0 2011-12-13

PUBLIC

135 / 222

Import/Export Settings
Parameter Name import2DSketch Parameter Type integer Parameter Description Import 2D sketch geometry. Possible Values No 2D sketch geometry Both 2D sketch wireframes and points Only 2D sketch wireframes Only 2D sketch points compacttree rulexmlfile importsolid tesslevel boolean filename boolean integer Compact scene tree. XML file for collapse rules. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined angulartolerance chordheighttolerance scaletessellationparameters float float integer Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled angulartoleranceceiling chordheighttoleranceceiling importpmi importhiddenpmi importmodelview importcapture realtimesectiongeometry initialviewwithpmi initialviewwithoutpmi importcoordinateaxis importsurfaces importpoints importplanes importwireframe wireframeontop float float boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean Angular tolerance cap. Chord height tolerance cap. Import PMI. Import hidden PMI. Import modelviews. Import captures. Create extra section geometry. Create Initial view with PMI. Create Initial view without PMI. Import axis systems. Import surfaces. Import points. Import planes. Import wireframes. Draw wireframes on top. 0 1 0 1 2 3 4 5 6 7 0 1 2 3

Version: 1.0 2011-12-13

PUBLIC

136 / 222

Import/Export Settings
Parameter Name tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ Parameter Type float float float float float float float float float Parameter Description X. Y. Z. X. Y. Z. X. Y. Z.

6.45 Visual_XML_ImportOptions

Parameter Name fileformat import_validate_xml import_load_child_model_views

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Validate XML. Load child model views.

6.46 DirectX_Model_ImportOptions

Parameter Name fileformat Animation Camera JoinMaterials JoinV JoinT RightHand UseBones OptimizeH FixAlpha

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean boolean

Parameter Description No Description Provided. Import animation data. Use DirectX camera position. Join equal materials. Optimize vertices. Optimize texture points. Flip coordinate system. Import skins. Optimize hierarchy. Treat fully transparent materials as opaque.

Version: 1.0 2011-12-13

PUBLIC

137 / 222

Import/Export Settings

6.47 Caligari_trueSpace_Scene_ImportOptions

Parameter Name fileformat JoinMaterials ReadAnim

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Join equal materials. Import animation.

6.48 Pro_ENGINEER_Drawing_files_ImportOptions

Parameter Name fileformat drawingbkcolor tesslevel

Parameter Type None Provided integer integer

Parameter Description No Description Provided. Drawing paper colour. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

surfacediscretization tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

float float float float float float float float float float

Curve discretization. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

138 / 222

Import/Export Settings

6.49 AutoCAD_Design_Web_Format_ImportOptions

Parameter Name fileformat DWFPagesToImport

Parameter Type None Provided integer

Parameter Description No Description Provided. Import pages. Possible Values All First 0 1

ShowPaperObject

integer

Show paper in 2D views. Possible Values Always Never By file 1 0 2

ImportTTFText

integer

Import TrueType fonts as. Possible Values Polygons Outlines Character primitives 1 2 3

ImportEdges

boolean

Import edges.

6.50 Open_Inventor_File_ImportOptions

Parameter Name fileformat i_Flip i_Collapse i_Optimize i_MeshOptimize i_GenUV i_tQuality i_tExtrude

Parameter Type None Provided boolean boolean boolean boolean boolean float float

Parameter Description No Description Provided. Flip coordinate system. Collapsing hierarchy. Optimize hierarchy. Optimize geometry. Create UVs. Text quality. Text extrude.

Version: 1.0 2011-12-13

PUBLIC

139 / 222

Import/Export Settings

6.51 Solid_Edge_Assembly_files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible importmetadata assemblyoveridecolor importsolid tesslevel

Parameter Type None Provided boolean boolean boolean boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import metadata. Apply assembly-level color. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importsurfaces importpoints importplanes importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import surfaces. Import points. Import planes. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

140 / 222

Import/Export Settings

6.52 N3ds_Max_File_ImportOptions

Parameter Name fileformat m2e_use_pivot m2e_convert_nurbs m2e_convert_patch m2e_use_skin m2e_use_morph m2e_wire_color_2_mtl m2e_conv_inst_2_uniq m2e_pass_metadata m2e_use_animation m2e_use_sampling m2e_sample_frames m2e_sample_vertex mpo_use_remote_server mpo_remote_server_name

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean integer boolean boolean string

Parameter Description No Description Provided. Apply pivot data to nodes. Convert NURBSes to meshes. Convert patches to meshes. Use skin modifiers. Use morph modifiers. Create materials for wire colors. Convert instances to unique. Import metadata. Import animation. Perform sampling. Sample any animation every frame. Use vertex animation. Use remote 3ds Max DCom server. Remote 3ds Max DCom server name.

6.53 MicroStation_CAD_Graphic_files_ImportOptions

Parameter Name fileformat group

Parameter Type None Provided integer

Parameter Description No Description Provided. Grouping. Possible Values Level Individual Element 0 1

loadhidden makehiddenvisible loadconstruction

boolean boolean boolean

Import hidden objects. Display hidden objects. Construction Geometry.

Version: 1.0 2011-12-13

PUBLIC

141 / 222

Import/Export Settings
Parameter Name tesslevel Parameter Type integer Parameter Description Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high importpmi importmodelview tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ boolean boolean float float float float float float float float float Import PMI. Import modelviews. X. Y. Z. X. Y. Z. X. Y. Z. 0 1 2 3 4 5 6

6.54 VRML_Worlds_ImportOptions

Parameter Name fileformat i_Flip i_Collapse i_Optimize i_MeshOptimize i_GenUV i_tQuality i_tExtrude

Parameter Type None Provided boolean boolean boolean boolean boolean float float

Parameter Description No Description Provided. Flip coordinate system. Collapsing hierarchy. Optimize hierarchy. Optimize geometry. Create UVs. Text quality. Text extrude.

Version: 1.0 2011-12-13

PUBLIC

142 / 222

Import/Export Settings

6.55 Visual_Design_Stream_ImportOptions

Parameter Name fileformat DeepVision SuppressBelowTopLevel LoadThreads

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Deep Vision. Suppress top level nodes. Stream geometry. Possible Values Separate thread Main thread for first frame Disabled 0 1 2

StreamMetadata PreloadIndexTables PreloadDataTables

boolean boolean integer

Stream metadata. Preload index tables. Preload data tables. Possible Values NO Metadata only Everything but nodes and geometry Everything but geometry Everything 0 1 2 3 4

VramStrategy

integer

Video RAM strategy. Possible Values Non-GPU GPU Overclocked GPU (not recommended) 0 1 2

VramSizeMB RamSizeMB TwoSidedLighting UseLODs replicateEnable replicateX replicateY replicateZ replicateSX replicateSY replicateSZ EmulateTextureMapping debugMinPixels debugLeafVisibleFrames

integer integer boolean boolean boolean integer integer integer float float float boolean integer integer

Video RAM size (MB). RAM size (MB). 2-sided lighting for back-facing triangles. Use LODs. Enable. X count. Y count. Z count. X scale. Y scale. Z scale. Emulate texture mapping [very slow]. Minimum number of pixels for visible mesh. Frames to treat leaf visible.
143 / 222

Version: 1.0 2011-12-13

PUBLIC

Import/Export Settings
Parameter Name kdTries kdMaxDepth kdMaxTriangles Parameter Type integer integer integer Parameter Description KD tries. KD max depth. KD max triangles in leaf.

6.56 LightWave_Scene_ImportOptions

Parameter Name fileformat joinmat Folders PromptForMissingFiles

Parameter Type None Provided boolean string boolean

Parameter Description No Description Provided. Optimize materials. Content folders. Prompt for missing files.

6.57 Rhinoceros_3D_Model_ImportOptions

Parameter Name fileformat RhinoImportSkipObjectsFromHiddenLayers RhinoImportSkipHiddenObjects RhinoImportPutCurvesInSingleGroup RhinoImportGroupObjectsInRhinoLayers RhinoImportSurfaceAlwaysDoubleSided RhinoImportSplitBrepFaces RhinoImportLights RhinoImportCameras RhinoImportMode

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean integer

Parameter Description No Description Provided. Skip objects in hidden layers. Skip hidden objects. Put all curves in single group. Group objects in RHINO layers. Surfaces always double sided. Split B-Rep faces into separate objects. Import lights. Import cameras. Import mode. Possible Values Polygonal Mesh Nurbs 0 1

RhinoImportCurves RhinoImportPoints RhinoImportPointSets

boolean boolean boolean

Import curves. Import points. Import pointsets.

Version: 1.0 2011-12-13

PUBLIC

144 / 222

Import/Export Settings

6.58 Autodesk_3D_Studio_Project_ImportOptions

Parameter Name fileformat KeyFrame Animation FixBadParity

Parameter Type None Provided boolean boolean boolean

Parameter Description No Description Provided. Import keyframe data. Import animation. Repair mirror transformed objects.

6.59 Autodesk_3D_Studio_Material_ImportOptions

Parameter Name fileformat KeyFrame Animation FixBadParity

Parameter Type None Provided boolean boolean boolean

Parameter Description No Description Provided. Import keyframe data. Import animation. Repair mirror transformed objects.

6.60 LightWave_3D_and_Binary_Object_ImportOptions

Parameter Name fileformat breakobject textures chkwrap readUView readSUBD

Parameter Type None Provided boolean boolean boolean boolean boolean

Parameter Description No Description Provided. Create sub-objects by material names. Create texture coordinates. Check wrapping. Import .uv files. Import SubDs.

Version: 1.0 2011-12-13

PUBLIC

145 / 222

Import/Export Settings

6.61 Pro_ENGINEER_Assembly_files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importpmi importsurfaces importpoints importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import PMI. Import surfaces. Import points. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

146 / 222

Import/Export Settings 6.62 OpenFlight_Scene_Description_Database_ImportOptions

Parameter Name fileformat i_lod i_normals

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Convert distance LOD to scene level LOD. Read per vertex normals.

6.63 Maya_ASCII_Scene_ImportOptions

Parameter Name fileformat ChangeAxes

Parameter Type None Provided integer

Parameter Description No Description Provided. Up axis in Maya. Possible Values Y Z 1 0

imp_opt_cameras SaveDefPerspCamera SaveLights SaveAnimation FrameSkip ReadNURBS opt_maya_version

boolean boolean boolean boolean integer boolean integer

Import cameras. Import perspective camera. Import lights. Import animation. Number of frames between samples. Tessellate NURBS. Maya version. Possible Values None -1

6.64 Gerber_File_ImportOptions

Parameter Name fileformat fliphorizontally flipvertically rotate90DegCW rotate90DegACW

Parameter Type None Provided boolean boolean boolean boolean

Parameter Description No Description Provided. Flip horizontally. Flip vertically. Rotate 90 degree CW. Rotate 90 degree ACW.

Version: 1.0 2011-12-13

PUBLIC

147 / 222

Import/Export Settings

6.65 Tagged_Image_File_Format_ImportOptions

Parameter Name fileformat applycolormgnt colorprofile

Parameter Type None Provided boolean integer

Parameter Description No Description Provided. Apply ICC color management. ICC Color Profile. Possible Values Default Monitor Profile sRGB IEC61966-2.1 Adobe RGB (1998) Apple RGB ColorMatch RGB 0 1 2 3 4

rendintent

integer

Rendering Intent. Possible Values Perceptual Relative Colorimetric Saturation Absolute Colorimetric 0 1 2 3

profilefolder

string

Color Profile Repository.

6.66 AutoCAD_Drawing_Object_ImportOptions

Parameter Name fileformat AllLayout

Parameter Type None Provided integer

Parameter Description No Description Provided. Import. Possible Values Active layout Model and layouts Model only 0 1 2

ForceToWireframe

integer

Viewport shading. Possible Values From file 2D wireframe 0 1

ImportHiddenLayers ImportLineTypes

boolean integer

Import hidden layers. Import line types. Possible Values Continuous lines Complex as geometry All as geometry 0 1 2

Version: 1.0 2011-12-13

PUBLIC

148 / 222

Import/Export Settings
Parameter Name ReplaceText ImportText Parameter Type boolean integer Parameter Description Replace text. Import text. Possible Values As polylines As polygons UseMaterialsForColors ModelShadeOverride boolean integer Use materials for colors. Model shading. Possible Values From file 2D wireframe Gouraud shaded EnableNamedView integer Use named view. Possible Values Never Only if no Paper-Space Layout exist Always EnableModelZoomExtent EnableModelDarkBackground ModelBackgroundColor tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ boolean boolean integer float float float float float float float float float Zoom to extents. Dark background palette. Background color. X. Y. Z. X. Y. Z. X. Y. Z. 0 1 2 0 1 2 0 1

Version: 1.0 2011-12-13

PUBLIC

149 / 222

Import/Export Settings

6.67 Parasolid_Part_and_Assembly_Files_ImportOptions

Parameter Name fileformat importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importsurfaces importpoints importplanes importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import surfaces. Import points. Import planes. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

150 / 222

Import/Export Settings

6.68 AutoCAD_Sheet_Set_File_ImportOptions

Parameter Name fileformat ForceToWireframe

Parameter Type None Provided integer

Parameter Description No Description Provided. Viewport shading. Possible Values From file 2D wireframe 0 1

ImportHiddenLayers ImportLineTypes

boolean integer

Import hidden layers. Import line types. Possible Values Continuous lines Complex as geometry All as geometry 0 1 2

ReplaceText ImportText

boolean integer

Replace text. Import text. Possible Values As polylines As polygons 0 1

UseMaterialsForColors

boolean

Use materials for colors.

6.69 Points_File_ImportOptions

Parameter Name fileformat import_as

Parameter Type None Provided integer

Parameter Description No Description Provided. Import as. Possible Values Pointset Mesh 0 1

import_as_mesh_if_colors

boolean

Import as mesh if colors are present.

Version: 1.0 2011-12-13

PUBLIC

151 / 222

Import/Export Settings

6.70 Maya_Binary_Scene_ImportOptions

Parameter Name fileformat ChangeAxes

Parameter Type None Provided integer

Parameter Description No Description Provided. Up axis in Maya. Possible Values Y Z 1 0

imp_opt_cameras SaveDefPerspCamera SaveLights SaveAnimation FrameSkip ReadNURBS opt_maya_version

boolean boolean boolean boolean integer boolean integer

Import cameras. Import perspective camera. Import lights. Import animation. Number of frames between samples. Tessellate NURBS. Maya version. Possible Values None -1

6.71 Maya_Interchange_File_Format_ImportOptions

Parameter Name fileformat opt_maya_version

Parameter Type None Provided integer

Parameter Description No Description Provided. Maya version. Possible Values None -1

6.72 Universal_3D_import_ImportOptions
Parameter Name fileformat LOD ParseMetaData ParseNonUnique LODLevels LODMinVertices LODMinVerticesCase2 LODMinFileVerticesForCase2 Parameter Type None Provided boolean boolean boolean integer integer integer integer Parameter Description No Description Provided. Import LOD. Parse metadata. Remove append data from names. Levels. Create LOD if mesh has minimum vertices. Create LOD if minimum vertices in file. Minimum vertices per mesh.
152 / 222

Version: 1.0 2011-12-13

PUBLIC

Import/Export Settings

6.73 CATIA4_Part_Files_ImportOptions

Parameter Name fileformat load2d3d

Parameter Type None Provided integer

Parameter Description No Description Provided. 2D/3D Loading. Possible Values Load both 2D and 3D Load 3D only Load 2D only 0 1 2

drawingbkcolor loadhidden makehiddenvisible importmetadata collapselevel doublesidedsurfaces importconfigurationlevel

integer boolean boolean boolean boolean boolean integer

Drawing. Import hidden objects. Display hidden objects. Import metadata. Collapse geometry. Double sided surfaces. Workspaces. Possible Values All Master Only 0 1

importsolid tesslevel

boolean integer

Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importpmi importcoordinateaxis importsurfaces importpoints importplanes

boolean boolean boolean boolean boolean

Import PMI. Import axis systems. Import surfaces. Import points. Import planes.

Version: 1.0 2011-12-13

PUBLIC

153 / 222

Import/Export Settings
Parameter Name importwireframe wireframeontop tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ Parameter Type boolean boolean float float float float float float float float float Parameter Description Import wireframes. Draw wireframes on top. X. Y. Z. X. Y. Z. X. Y. Z.

6.74 Collada_ImportOptions

Parameter Name fileformat joinequalpoint optimizematerial

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Join equal points. Remove duplicate material.

Version: 1.0 2011-12-13

PUBLIC

154 / 222

Import/Export Settings

6.75 Step_Part_and_Assembly_files_ImportOptions

Parameter Name fileformat importmetadata importpmi importsolid tesslevel

Parameter Type None Provided boolean boolean boolean integer

Parameter Description No Description Provided. Import metadata. Import PMI. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importsurfaces importpoints importplanes importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import surfaces. Import points. Import planes. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

155 / 222

Import/Export Settings

6.76 Pro_ENGINEER_Neutral_files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

float float float float float float float float float

X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

156 / 222

Import/Export Settings

6.77 SolidWorks_Drawing_files_ImportOptions

Parameter Name fileformat tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

Parameter Type None Provided float float float float float float float float float

Parameter Description No Description Provided. X. Y. Z. X. Y. Z. X. Y. Z.

6.78 Pro_ENGINEER_Part_files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

Version: 1.0 2011-12-13

PUBLIC

157 / 222

Import/Export Settings
Parameter Name importpmi importsurfaces importpoints importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ Parameter Type boolean boolean boolean boolean float float float float float float float float float Parameter Description Import PMI. Import surfaces. Import points. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

6.79 Protein_Data_Bank_ImportOptions

Parameter Name fileformat SphereSegements StickSegements ViewType

Parameter Type None Provided integer integer integer

Parameter Description No Description Provided. Sphere segments. Sticks segments. View. Possible Values Wire Balls and sticks Spacefill Backbone 0 1 2 3

ObjectsColor

integer

Color. Possible Values Monochrome By Atom By Residue By Chain Rainbow 0 1 2 3 4

Version: 1.0 2011-12-13

PUBLIC

158 / 222

Import/Export Settings

6.80 JTPMI_Files_ImportOptions

Parameter Name fileformat ImportMetadata LoadSolid

Parameter Type None Provided boolean integer

Parameter Description No Description Provided. Import metadata. Import splines, surfaces and solids. Possible Values NO YES 0 1

tesslevel

integer

Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

LoadLod

integer

Level of detail. Possible Values All Highest Medium 1 Medium 2 Medium 3 Lowest 0 2 3 4 5 1

CollapseSubnodes importpmi importhiddenpmi

boolean boolean boolean

Collapse subnodes. Import PMI. Import hidden PMI.

Version: 1.0 2011-12-13

PUBLIC

159 / 222

Import/Export Settings
Parameter Name LoadModelViews Parameter Type integer Parameter Description Load modelviews. Possible Values All Top-level Assembly Parts None tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ float float float float float float float float float X. Y. Z. X. Y. Z. X. Y. Z. 0 1 2 3 4

6.81 Inventor_Part_files_ImportOptions

Parameter Name fileformat approach

Parameter Type None Provided integer

Parameter Description No Description Provided. Approach. Possible Values Quick View (Inventor Tesselation) Load Inventor Solids 0 1

importmetadata importsolid tesslevel

boolean boolean integer

Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance

float

Angular tolerance.
160 / 222

Version: 1.0 2011-12-13

PUBLIC

Import/Export Settings
Parameter Name chordheighttolerance scaletessellationparameters Parameter Type float integer Parameter Description Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ float float float float float float float float float X. Y. Z. X. Y. Z. X. Y. Z. 0 1

6.82 Portable_Graymap_Heightfield_ImportOptions

Parameter Name fileformat kX kY kZ

Parameter Type None Provided float float float

Parameter Description No Description Provided. Scale X factor. Scale Z factor. Scale Y factor.

Version: 1.0 2011-12-13

PUBLIC

161 / 222

Import/Export Settings

6.83 NX_Parts_and_Assemblies_ImportOptions

Parameter Name fileformat load2d3d

Parameter Type None Provided integer

Parameter Description No Description Provided. 2D/3D Loading. Possible Values Load both 2D and 3D Load 3D only Load 2D only 0 1 2

drawingbkcolor loadhidden makehiddenvisible importmetadata importconfigurationlevel

integer boolean boolean boolean integer

Drawing paper colour. Import hidden objects. Display hidden objects. Import metadata. Import configuration. Possible Values All As Saved User defined 0 1 2

configurationname referencesetselect

string integer

User Specified Name. Reference Set. Possible Values As Saved Entire User Specified 0 1 2

referencesetname importsolid tesslevel

string boolean integer

User Specified Name. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1
162 / 222

Version: 1.0 2011-12-13

PUBLIC

Import/Export Settings
Parameter Name importpmi importmodelview importsurfaces importpoints importplanes importwireframe sheetbody tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ Parameter Type boolean boolean boolean boolean boolean boolean boolean float float float float float float float float float Parameter Description Import PMI. Import modelviews. Import surfaces. Import points. Import planes. Import wireframes. Import sheet bodies. X. Y. Z. X. Y. Z. X. Y. Z.

6.84 CATIA4_Assembly_Files_ImportOptions

Parameter Name fileformat load2d3d

Parameter Type None Provided integer

Parameter Description No Description Provided. 2D/3D Loading. Possible Values Load both 2D and 3D Load 3D only Load 2D only 0 1 2

drawingbkcolor loadhidden makehiddenvisible importmetadata collapselevel doublesidedsurfaces importsolid

integer boolean boolean boolean boolean boolean boolean

Drawing. Import hidden objects. Display hidden objects. Import metadata. Collapse geometry. Double sided surfaces. Import splines, surfaces and solids.

Version: 1.0 2011-12-13

PUBLIC

163 / 222

Import/Export Settings
Parameter Name tesslevel Parameter Type integer Parameter Description Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined angulartolerance chordheighttolerance scaletessellationparameters float float integer Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled importpmi importcoordinateaxis importsurfaces importpoints importplanes importwireframe wireframeontop tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ boolean boolean boolean boolean boolean boolean boolean float float float float float float float float float Import PMI. Import axis systems. Import surfaces. Import points. Import planes. Import wireframes. Draw wireframes on top. X. Y. Z. X. Y. Z. X. Y. Z. 0 1 0 1 2 3 4 5 6 7

Version: 1.0 2011-12-13

PUBLIC

164 / 222

Import/Export Settings

6.85 Google_SketchUp_Document_ImportOptions

Parameter Name fileformat createEdgesFace LinesSeparateHierarchy LinesRenderOrder useSketchUpTesselate createDefaultMaterial createUVW createBackFaces

Parameter Type None Provided boolean boolean integer boolean boolean boolean integer

Parameter Description No Description Provided. Outline faces. Import lines into separate hierarchy. Lines render order. SketchUp tessellation. Create default SketchUp material. Create UVW texture coordinates. Create back faces. Possible Values NO as separate node in same node 0 1 2

6.86 SolidWorks_Part_files_ImportOptions

Parameter Name fileformat approach

Parameter Type None Provided integer

Parameter Description No Description Provided. Approach. Possible Values Quick View (Solidworks Tesselation) Load Solidworks Solids 0 1

loadhidden makehiddenvisible importmetadata importconfigurationlevel

boolean boolean boolean integer

Import hidden objects. Display hidden objects. Import metadata. Import configuration. Possible Values All As Saved User defined 0 1 2

configurationname importpmi importsolid

string boolean boolean

User Specified Name. Import PMI. Import splines, surfaces and solids.

Version: 1.0 2011-12-13

PUBLIC

165 / 222

Import/Export Settings
Parameter Name tesslevel Parameter Type integer Parameter Description Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined angulartolerance chordheighttolerance scaletessellationparameters float float integer Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ float float float float float float float float float X. Y. Z. X. Y. Z. X. Y. Z. 0 1 0 1 2 3 4 5 6 7

6.87 Bundled_RH___RHB_files_ImportOptions

Parameter Name fileformat fillhole ActivateModelview

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Not translated. Activate Model View.

Version: 1.0 2011-12-13

PUBLIC

166 / 222

Import/Export Settings

6.88 Bundled_RH___RHB_files_ImportOptions

Parameter Name fileformat fillhole ActivateModelview

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Not translated. Activate Model View.

6.89 AutoCAD_Drawing_Interchange_ImportOptions

Parameter Name fileformat AllLayout

Parameter Type None Provided integer

Parameter Description No Description Provided. Import. Possible Values Active layout Model and layouts Model only 0 1 2

ForceToWireframe

integer

Viewport shading. Possible Values From file 2D wireframe 0 1

ImportHiddenLayers ImportLineTypes

boolean integer

Import hidden layers. Import line types. Possible Values Continuous lines Complex as geometry All as geometry 0 1 2

ReplaceText ImportText

boolean integer

Replace text. Import text. Possible Values As polylines As polygons 0 1

UseMaterialsForColors ModelShadeOverride

boolean integer

Use materials for colors. Model shading. Possible Values From file 2D wireframe Gouraud shaded 0 1 2

EnableModelZoomExtent EnableModelDarkBackground

boolean boolean

Zoom to extents. Dark background palette.

Version: 1.0 2011-12-13

PUBLIC

167 / 222

Import/Export Settings
Parameter Name tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ Parameter Type float float float float float float float float float Parameter Description X. Y. Z. X. Y. Z. X. Y. Z.

6.90 CATIA5_Drawing_files_ImportOptions

Parameter Name fileformat drawingbkcolor tesslevel

Parameter Type None Provided integer integer

Parameter Description No Description Provided. Drawing paper colour. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

surfacediscretization tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

float float float float float float float float float float

Curve discretization. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

168 / 222

Import/Export Settings

6.91 Inventor_Assembly_files_ImportOptions

Parameter Name fileformat approach

Parameter Type None Provided integer

Parameter Description No Description Provided. Approach. Possible Values Quick View (Inventor Tesselation) Load Inventor Solids 0 1

importmetadata importsolid tesslevel

boolean boolean integer

Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

float float float float float float float float float

X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

169 / 222

Import/Export Settings

6.92 Adobe_Portable_Document_ImportOptions

Parameter Name fileformat smooth_text smooth_lines smooth_images output_dpi

Parameter Type None Provided boolean boolean boolean integer

Parameter Description No Description Provided. Smooth Text. Smooth Lines. Smooth Images. Output DPI. Possible Values 60 96 150 300 60 96 150 300

6.93 CATIA5_Part_files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible loadconstruction

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import construction geometry. Possible Values NO All except partbodies ALL 0 1 2

displayconstruction importmetadata collectmetadata importselectionset import2DSketch

boolean boolean boolean boolean integer

Display construction geometry. Import metadata. Collect metadata to geometry. Import selection sets. Import 2D sketch geometry. Possible Values No 2D sketch geometry Both 2D sketch wireframes and points Only 2D sketch wireframes Only 2D sketch points 0 1 2 3

compacttree rulexmlfile importsolid

boolean filename boolean

Compact scene tree. XML file for collapse rules. Import splines, surfaces and solids.
170 / 222

Version: 1.0 2011-12-13

PUBLIC

Import/Export Settings
Parameter Name tesslevel Parameter Type integer Parameter Description Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined angulartolerance chordheighttolerance scaletessellationparameters float float integer Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled angulartoleranceceiling chordheighttoleranceceiling importpmi importhiddenpmi importmodelview importcapture realtimesectiongeometry initialviewwithpmi initialviewwithoutpmi importcoordinateaxis importsurfaces importpoints importplanes importwireframe wireframeontop tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ float float boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean float float float float float float float float float Angular tolerance cap. Chord height tolerance cap. Import PMI. Import hidden PMI. Import modelviews. Import captures. Create extra section geometry. Create Initial view with PMI. Create Initial view without PMI. Import axis systems. Import surfaces. Import points. Import planes. Import wireframes. Draw wireframes on top. X. Y. Z. X. Y. Z. X. Y. Z. 0 1 0 1 2 3 4 5 6 7

Version: 1.0 2011-12-13

PUBLIC

171 / 222

Import/Export Settings

6.94 Solid_Edge_Part_files_ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean boolean boolean integer

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importsurfaces importpoints importplanes importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import surfaces. Import points. Import planes. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

172 / 222

Import/Export Settings

6.95 Iges_Part_and_Assembly_files_ImportOptions

Parameter Name fileformat importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importsurfaces importpoints importplanes importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import surfaces. Import points. Import planes. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

173 / 222

Import/Export Settings 6.96 CATIA_Graphical_Representation_Files_CGR__ImportOptions

Parameter Name fileformat loadhidden makehiddenvisible importmetadata collectmetadata importsurfaces importpoints importwireframe wireframeontop tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

Parameter Type None Provided boolean boolean boolean boolean boolean boolean boolean boolean float float float float float float float float float

Parameter Description No Description Provided. Import hidden objects. Display hidden objects. Import metadata. Collect metadata to geometry. Import surfaces. Import points. Import wireframes. Draw wireframes on top. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

174 / 222

Import/Export Settings

6.97 JPEG_Image_ImportOptions

Parameter Name fileformat applycolormgnt colorprofile

Parameter Type None Provided boolean integer

Parameter Description No Description Provided. Apply ICC color management. ICC Color Profile. Possible Values Default Monitor Profile sRGB IEC61966-2.1 Adobe RGB (1998) Apple RGB ColorMatch RGB 0 1 2 3 4

rendintent

integer

Rendering Intent. Possible Values Perceptual Relative Colorimetric Saturation Absolute Colorimetric 0 1 2 3

profilefolder

string

Color Profile Repository.

6.98 Wavefront_Object_ImportOptions

Parameter Name fileformat l_mtl l_flip

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Import material file. Flip coordinate system.

Version: 1.0 2011-12-13

PUBLIC

175 / 222

Import/Export Settings

6.99 ACIS_Part_and_Assembly_files_ImportOptions

Parameter Name fileformat importmetadata importsolid tesslevel

Parameter Type None Provided boolean boolean integer

Parameter Description No Description Provided. Import metadata. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance scaletessellationparameters

float float integer

Angular tolerance. Chord height tolerance. Chord height behavior. Possible Values Absolute Scaled 0 1

importsurfaces importpoints importplanes importwireframe tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ

boolean boolean boolean boolean float float float float float float float float float

Import surfaces. Import points. Import planes. Import wireframes. X. Y. Z. X. Y. Z. X. Y. Z.

Version: 1.0 2011-12-13

PUBLIC

176 / 222

Import/Export Settings

6.100 Caligari_trueSpace_Object_ImportOptions

Parameter Name fileformat JoinMaterials ReadAnim

Parameter Type None Provided boolean boolean

Parameter Description No Description Provided. Join equal materials. Import animation.

6.101 SolidWorks_Assembly_files_ImportOptions

Parameter Name fileformat approach

Parameter Type None Provided integer

Parameter Description No Description Provided. Approach. Possible Values Quick View (Solidworks Tesselation) Load Solidworks Solids 0 1

loadhidden makehiddenvisible importmetadata importconfigurationlevel

boolean boolean boolean integer

Import hidden objects. Display hidden objects. Import metadata. Import configuration. Possible Values All As Saved User defined 0 1 2

configurationname importpmi importsolid tesslevel

string boolean boolean integer

User Specified Name. Import PMI. Import splines, surfaces and solids. Tessellation Level. Possible Values Very low Low Medium Low Medium Medium High High Very high User defined 0 1 2 3 4 5 6 7

angulartolerance chordheighttolerance

float float

Angular tolerance. Chord height tolerance.

177 / 222

Version: 1.0 2011-12-13

PUBLIC

Import/Export Settings
Parameter Name scaletessellationparameters Parameter Type integer Parameter Description Chord height behavior. Possible Values Absolute Scaled tm__RX tm__RY tm__RZ tm__SX tm__SY tm__SZ tm__PX tm__PY tm__PZ float float float float float float float float float X. Y. Z. X. Y. Z. X. Y. Z. 0 1

Version: 1.0 2011-12-13

PUBLIC

178 / 222

Metadata

Metadata

7.1

filemetadata_extract

Extracts Microsoft Office or XMP metadata from the specified file.

Parameter Name filename outfilename Parameter Type filename filename Parameter Description Full path to the file with metadata. Full path to the output XML file.

7.2

filemetadata_extractmsoffice

Extracts Microsoft Office metadata from file specified.

Parameter Name filename outfilename Parameter Type filename filename Parameter Description Full path to the MS office file. Full path to the output XML file.

7.3

filemetadata_extractxmp

Extracts XMP metadata from the file specified.

Parameter Name filename outfilename Parameter Type filename filename Parameter Description Full path to the file containing XMP metadata. Full path to the output XML file.

Version: 1.0 2011-12-13

PUBLIC

179 / 222

Modules

Modules

8.1

ApplyModifier

Parameter Name Modifier

Parameter Type integer

Parameter Description No Description Provided. Possible Values e3_mod_axisdir e3_mod_bend e3_mod_mirror e3_mod_noise e3_mod_wave e3_mod_skew e3_mod_inflate e3_mod_stretch e3_mod_taper e3_mod_twist e3_mod_ripple e3_mod_spline 101 102 109 114 115 117 120 124 122 124 136 163

8.2

bomfactory

Creates an xml file for given CAD file.

Parameter Name input_file_name output_xml_file export_directory file_type_guid absolute_path Parameter Type filename filename string string boolean Parameter Description Input File Name. Output File Name. Output Directory. File Type GUID. Absolute path.

Version: 1.0 2011-12-13

PUBLIC

180 / 222

Modules

8.3

Clean_Scene

Cleans the scene and removes unused objects.

Parameter Name Remove_Unused_Animations Remove_Empty_Nodes Remove_Unused_Materials Remove_Model_Views Remove_Unused_Layers Remove_Metadata Remove_Notes_And_Etc Remove_Mesh_Dupes Remove_EnvMaps_And_Backplates Merge_Equal_Materials Remove_Unused_Hidden_Cameras Parameter Type boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean boolean Parameter Description No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. 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 xmlpath removewithchild removeemptynodes Parameter Type filename boolean boolean Parameter Description The input file xml file. Remove the node even if it has children. Remove the node if it is empty.

8.6

cm_renametoplevelnode

Renames the top level node in the scene.

Parameter Name new_name Parameter Type string Parameter Description New name for the top level node.

Version: 1.0 2011-12-13

PUBLIC

181 / 222

Modules

8.7

cm_setaxissystemcolors

Sets the axis system colors.

Parameter Name XR XG XB YR YG YB ZR ZG ZB Parameter Type integer integer integer integer integer integer integer integer integer Parameter Description X axis Red value. X axis Green value. X axis Blue value. Y axis Red value. Y axis Green value. Y axis Blue value. Z axis Red value. Z axis Green value. Z axis Blue value.

8.8

cm_setmetadataunit

Resets the metadata value to scene unit.

Parameter Name xmlpath Parameter Type filename Parameter Description The input file xml file for unit conversion.

8.9

cm_setpmialwaysontop

Sets PMI always on top.

Parameter Name alwaysontop Parameter Type boolean Parameter Description Set always on top status.

8.10 cm_setpmibillboarding
Sets PMI billboarding.
Parameter Name billboarding Parameter Type integer Parameter Description Set billboarding status. Possible Values None Full Flip Label 0 1 2

Version: 1.0 2011-12-13

PUBLIC

182 / 222

Modules

8.11 cm_setpmilinecolor
Sets PMI line color.
Parameter Name leaderlineR leaderlineG leaderlineB Parameter Type integer integer integer Parameter Description Red value for leader lines. Green value for leader lines. Blue value for leader lines.

8.12 cm_setpmitextcolor
Sets PMI text color.
Parameter Name TextR TextG TextB Parameter Type integer integer integer Parameter Description Red value for texts. Green value for texts. Blue value for texts.

8.13 cm_setpointcolor_style
Sets points color and style.
Parameter Name pointColorR pointColorG pointColorB pointStyle Parameter Type integer integer integer integer Parameter Description Red value for points. Green value for points. Blue value for points. Point style. Possible Values Dot Square Star Plus Cross Circle Rhomb 0 1 2 3 4 5 6

Version: 1.0 2011-12-13

PUBLIC

183 / 222

Modules

8.14 cm_wireframe
Puts wireframe on top.
Parameter Name putwireframesontop Parameter Type boolean Parameter Description Put wireframes on top.

8.15 cm_wireframe_color
Sets wireframe color.
Parameter Name wireframeColorR wireframeColorG wireframeColorB Parameter Type integer integer integer Parameter Description Red value for wireframes. Green value for wireframes. Blue value for wireframes.

8.16 convertaitopsd
Converts an .ai file into .pdf.
Parameter Name input_ai_file output_psd_file dpi Parameter Type filename filename float Parameter Description Input .ai file name. Output .psd file name. Target DPI.

8.17 CreateDVIS
Creates DVIS data.
Parameter Name dvis_filename Parameter Type filename Parameter Description Path to .dvis file.

8.18 ct_clippingplane_crosssection
Cross sectioning with clipping plane.

Version: 1.0 2011-12-13

PUBLIC

184 / 222

Modules

8.19 ct_color_objects
Applies different colors to adjacent objects.
Parameter Name ColorSchemeXmlFile colors_count color_0 color_1 color_2 color_3 color_4 color_5 color_6 color_7 color_8 color_9 ObjectColorMode Parameter Type filename integer integer integer integer integer integer integer integer integer integer integer integer Parameter Description Color schema xml filename. Colors count. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. No Description Provided. Simple cylic or XML schema. Possible Values Simple Cyclic XML Schema 0 1

8.20 ct_converttodoublesided
Doubles the number of faces of all objects in the model.

Version: 1.0 2011-12-13

PUBLIC

185 / 222

Modules

8.21 ct_explodeobjects
Breaks out all the objects from the model.
Parameter Name movement_precision duration parallel num_stages mode Parameter Type float float boolean integer integer Parameter Description Movement precision: best: 0, fastest: 10. Duration of the animation. Explode parallel to the axes. Number of stages for explode animation. Explode mode. Possible Values All axes XY axes XZ axes YZ axes sequences smart_axis group_type boolean boolean integer 0 1 2 3

Create separate animation for each stage. Try to find best axis. Object group mode. Possible Values Distance Size 0 1

inverse create_layers

boolean boolean

Object grouping direct or inverse. Create new layer for each stage.

8.22 ct_healmodel_advanced
Repairs faces, cracks, geometry, and duplicated edges using advanced settings.
Parameter Name skip_hidden_meshes create_new_meshes output_one_mesh join_vertices join_edges_enable join_edges Parameter Type boolean boolean boolean float boolean float Parameter Description True: to skip hidden meshes. True: to create new meshes instead reusing existing. Combine meshes. Join vertices threshold. True: to join vertices with edges. Join vertices with edges threshold.

8.23 ct_invertfaces
Inverts all faces.
Version: 1.0 2011-12-13

PUBLIC

186 / 222

Modules

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 tolerance Parameter Type float Parameter Description Tolerance between points to join.

8.27 ct_randomizeobjects
Randomizes all object points.
Parameter Name tolerance units_or_percentage Parameter Type float integer Parameter Description Amount of distortion. Distortion mode. Possible Values percentage units 0 1

Version: 1.0 2011-12-13

PUBLIC

187 / 222

Modules

8.28 ct_realight
Creates realight effect to a model.
Parameter Name store_vertex_colors store_texture_maps rays_per_sample brightness map_generation Parameter Type integer integer integer float integer Parameter Description Store ambient occlusion as vertex colors. Store ambient occlusion texture maps. The number of per vertex or per sub-pixel surface samples. Level of brightness of the ambient occlusion. Source from which maps are generated. Possible Values Existing materials Existing diffuse materials outcome integer Manner in which maps are generated. Possible Values Replace diffuse map Merge into diffuse map Add new light map samples prefilter noise blur map_size integer integer float integer integer The number of per sub-pixel surface samples. Applies color bleed around the polygon groups. Applies white noise to the texture map. Applies Gaussian blur to the texture map. 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. The width of the maps in pixels. The height of the maps in pixels. The maximum dimension of the largest map. Rounds up the maximum width and height values to the closest power of two. Saves the texture maps in the internal application memory. The prefix to append to the new map names. The location in which to save the maps.
188 / 222

0 1

0 1 2

width height max_dimension round_size_power2

integer integer integer integer

save_internal_image prefix path

integer string string

Version: 1.0 2011-12-13

PUBLIC

Modules
Parameter Name format Parameter Type integer Parameter Description The format in which to save the maps. Possible Values JPEG image (.jpg) Layered Image Format (.LiF) PNG Image (.png) PPM Image (.ppm) TARGA Image (.tga) TIFF Image (.tif) Windows Bitmap (.bmp) virtual_ground_plane integer When set to 1, use a virtual ground plane to calculate the illumination. The distance between the model and the ground plane. The percentage size of the ground plane compared to the size of the model. When set to 1, ambient occlusion will be calculated saparately for eacj part. Number of the UV channel to use. Ambient occlusion map mode. Possible Values Modulate Replace Additive ray_length float 0 1 2 0 1 2 3 4 5 6

distance size

float float

calc_by_part

integer

channel_number map_mode

integer integer

Limit the test ray length. When set to 0, infinite ray will be used.

Version: 1.0 2011-12-13

PUBLIC

189 / 222

Modules

8.29 ct_reducemodel_advanced
Reduces the number of polygons in a model using advanced settings.
Parameter Name keep_percent skip_hidden_meshes create_new_meshes normalize_meshes Parameter Type float boolean boolean integer Parameter Description Percentage of polys to keep. True: to skip hidden meshes. True: to create new meshes instead reusing existing. Set to 1 or 2 on very small scenes (bbox less than 1E-3) or for big and thin parts. Possible Values Off On Auto enable_postfix postfix enable_join_vertices join_vertices enable_join_normals join_normals enable_join_uv join_uv enable_join_colors join_colors influence_normals enable_influence_uv influence_uv enable_influence_materials influence_materials enable_influence_colors influence_colors boolean string boolean float boolean float boolean float boolean float float boolean float boolean float boolean float 0 1 2

True: enable postfix on reduced models names. Postfix for reduced models names. True: enable join vertices. Percent of longest bbox diagonal. True: enable join normals. Tolerance for join normals. True: enable join uv. Tolerance for join uv. True: enable join colors. Tolerance for join colors. Normals influence. True: enable influence uv. Uvs influence. True: enable influence materials. Materials influence. True: enable influence colors. Colors influence.

Version: 1.0 2011-12-13

PUBLIC

190 / 222

Modules

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 keep_metadata Parameter Type boolean Parameter Description No Description Provided.

8.34 ct_remove_invisible_polygons
Removes internal polygons from the scene.
Parameter Name quality Parameter Type integer Parameter Description Can not be negative. Higher values means higher quality.

Version: 1.0 2011-12-13

PUBLIC

191 / 222

Modules

8.35 ct_removeinternalparts
Hides or deletes internal objects in the model.
Parameter Name process_hide method Parameter Type boolean integer Parameter Description True: process hidden objects. No Description Provided. Possible Values Hide Select Hide and select Delete quality process_transparent integer boolean 0 1 2 3

1=max speed, 3=max quality. True: take transparency of an object into account.

8.36 ct_removesmallparts
Removes small objects from the model.
Parameter Name percentage units used_type Parameter Type float float integer Parameter Description Percentage from scenes bbox of an object min size (0 - 100). Object min size in scene's units. Type of value - percentage of scene bbox or absolute units. Possible Values Percentage Units 0 1

8.37 ct_separatemesh
Separates meshes.

Version: 1.0 2011-12-13

PUBLIC

192 / 222

Modules

8.38 ct_unifynormals
Aligns all surface normals in the same direction.
Parameter Name highlight_color process_hide method Parameter Type integer boolean integer Parameter Description Used if process method set to highlight. True: to process hidden object. Action for suspicious nodes. Possible Values Do nothing Select Highlight Make double-sided quality polygons integer boolean 0 1 2 3

1=max speed, 5=max quality. True: to apply algorithm to polygons.

8.39 ct_uvmapping
Creates uvs and assigns to all the objects in the scene.
Parameter Name mapper Parameter Type integer Parameter Description The type of UV mapping to apply to the selected objects. Possible Values VAMP Cube Rigid packer integer 0 1 2

The method of packing the UVs. Possible Values Clump Rectangular Simple 0 1 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. The spacing between the packed UVs. If set to 'true', preserves the UV orientation of the UVs.

spacing preserve_orientation

float integer

Version: 1.0 2011-12-13

PUBLIC

193 / 222

Modules
Parameter Name fill_space Parameter Type integer Parameter Description 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. 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. If set to '1', keeps mesh elements together when mapping; '2', keeps mesh Part IDs together when mapping. The method of relaxing the UVs. Possible Values None Knead Even Knead Aligned Knead Hybrid Relax relax_iterations uvchannel texturescale use_texture_size integer integer boolean boolean 0 1 2 3 4

pack_per_material

integer

map_per_element

integer

relaxer

integer

Number of relax iterations to perform for the 'Relax' relaxer. UV Channel to generate mapping to. Disable texture scaling. Enable scaling of the UV coordinates according to the textire size. Texture size in U direction. Texture size in V direction. Texture units. Possible Values Generic Millimeters Centimeters Meters Kilometers Inches Feet Miles Points Picas 0 0.001 0.01 1.0 1000 0.0254 0.3048 1609.344 0.000352 0.00423
194 / 222

texture_size_u texture_size_v texture_units

float float float

Version: 1.0 2011-12-13

PUBLIC

Modules

8.40 dgnhierarchyxml
Creates an xml file for given Microstation file.
Parameter Name input_file_name Parameter Type filename Parameter Description The name of the Microstation assembly file that is used to generate the .xml file. The name of the .xml file. The directory in which to save additional output files for this operation. File Type GUID. Absolute path.

output_xml_file export_directory

filename string

file_type_guid absolute_path

string boolean

8.41 ill_advancedsettings
Sets advanced parameters.
Parameter Name hide_back-facing_geometry Parameter Type boolean Parameter Description 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. If set to 'true', rendering is performed in multiple threads. You need to have a multithreaded processor to use this feature. 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'. If set to 'true', XML companion file is created. This parameter is only applied if file_type parameter is set to '.cgm'. 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 Version 4/WebCGM 0 1

multithreading

boolean

multiple_layers

boolean

cgm_companion_file

boolean

cgm_version

integer

Version: 1.0 2011-12-13

PUBLIC

195 / 222

Modules
Parameter Name thicknthin_method Parameter Type integer Parameter Description Used to select the thick'n'thinning method. Possible Values Complete Pop line Silhouette raster_vector_file integer 0 1 2

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 Render Software Zbuffer Render Raytracer Flat color fill 0 1 2 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. If set to 'true', different edge types may be joined into a single polyline. If the angle between two adjacent edges if more than 'min_join_angle', then they may be joined into a single polyline. If set to 'true', shared boundary edges are approximated. This is effective for source scenes where geometry has cracks. 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. Used to select if lines should be broken at intersections. This is effective for later manual filtering. Number of pixels used for contour processing. Possible Values Low Medium High 0 1 2
196 / 222

join_different_types min_join_angle

boolean float

filter_approximate_boundary

boolean

line_filtering_tolerance

float

filter_break_intersections

boolean

contour_detection_accuracy

integer

Version: 1.0 2011-12-13

PUBLIC

Modules
Parameter Name contour_detection_match_original rational_approximation_tolerance Parameter Type boolean double Parameter Description Try to match to contours from original geometry. Determines the tolerance of converting rational curves to nonrational. Only for scenes with Solids. Only for .svg and .ai formats. Determines the tolerance of converting rational curves into polylines. Only for scenes with Solids. All formats except .svg and .ai. Used to select if voxel visibility detection should be used instead of polygon detection. Only for scenes with Solids. Used to select if fills and hotspot regions should be approximated with splines. If set to 'true', rendering will take into account Part ID information. If set to 'true', callout's font size will be same as in the callout settings, not taking into account viewport scaling. If set to 'true', lines will be ordered by their Z value. Otherwise lines are grouped by objects. If set to 'true', Illustrate will try to remove overlapping lines to produce smaller file. If set to 'true', Illustrate will try to convert lines to splines. Determines the tolerance for converting lines to splines.

curve_tesselation_tolerance

double

voxel_visibility_detection

boolean

fit_splines_on_regions

boolean

use_part_id lock_font_size

boolean boolean

order_lines_by_z

boolean

reduce_lines

boolean

reduce_splines reduce_splines_tolerance

boolean float

Version: 1.0 2011-12-13

PUBLIC

197 / 222

Modules

8.42 ill_render
Creates an illustration of the current scene and saves to file.
Parameter Name file file_type Parameter Type filename integer Parameter Description The name and location to save the output file. Used to select the format in which you want to save the scene. Possible Values .ai .dxf .rh .cgm binary .swf .svg .tif .eps tolerance_angle line_thickness float float 0 1 2 3 4 5 6 7

The tolerance angle for all rendered outlines. The width for the lines of the rendered image in pixels for .tiff format and in 'paper_units' for all other formats. The width for the boundary lines of the rendered image in pixels for .tiff format and in 'paper_units' for all other formats. If set to 'true', draws lines along all face-face intersections of the rendered scene. If set to 'true', removes lines that are hidden by the geometry in the rendered image. If set to 'true', shows the rendered image as a wire frame, all edges are treated as outline edges. 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 cm mm points picas 0 1 2 3 4
198 / 222

boundary_thickness

float

calculate_intersections

boolean

remove_hidden_lines

boolean

show_as_wireframe

boolean

paper_units

integer

Version: 1.0 2011-12-13

PUBLIC

Modules
Parameter Name paper_size_width Parameter Type float Parameter Description Width for the printed image in pixels for .tiff and in 'paper_units' for all other formats. Height for the printed image in pixels for .tiff and in 'paper_units' for all other formats. 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. 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. 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. Used to select the color for rendered image lines. This parameter is only applied if the object_color parameter is set to 'false'. Used to select a color for the background if you are saving to the .swf, .cgm or .svg format. 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 Text file XML file Bottom Right dpi float 0 1 4 2 3

paper_size_height

float

virtual_window_width

integer

virtual_window_height

integer

object_colour

boolean

line_colour

integer

background_colour

integer

include_bom

integer

The resolution of the illustration in dpi.

Version: 1.0 2011-12-13

PUBLIC

199 / 222

Modules

8.43 jtassociatepmi
Processes PMI associations on reconstructed assembly.

8.44 jthierarchyxml
Creates an xml file for given OpenJT file.
Parameter Name input_file_name output_xml_file export_directory Parameter Type filename filename string Parameter Description The name of the JT assembly file that is used to generate the .xml file. The name of the .xml file. 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 input_file_name output_xml_file export_directory file_type_guid absolute_path Parameter Type filename filename string string boolean Parameter Description Input File Name. Output File Name. Output Directory. File Type GUID. Absolute path.

Version: 1.0 2011-12-13

PUBLIC

200 / 222

Modules

8.46 pdf_2d_picturing
Inserts a simple 2d image into .pdf a document.
Parameter Name src_filename dst_filename target_place_title image_filename xfdf_filename Parameter Type filename filename string string string Parameter Description The source template filename. The OUT document filename. Title of annotation, whe must be placed 2D. The image to inserting filename. This file can have some data (in XFDF form), that will be imported into pdf. If set to 'true', annots, fields and etc will be renamed (ready for documents merge). Align of 2D image. Possible Values Stretch Fit to Left/Top Fit to Center/Top Fit to Right/Top Fit to Left/Center Fit to Center/Center Fit to Right/Center Fit to Left/Bottom Fit to Center/Bottom Fit to Right/Bottom 0 1 2 3 4 5 6 7 8 9

enable_for_merging

boolean

N2d_image_align

integer

8.47 pdf_2d_picturing_serial
Inserts a list of 2d images into .a pdf document.
Parameter Name src_filename dst_filename images_filenames_list xfdf_filename Parameter Type filename filename string string Parameter Description The source template filename. The OUT document filename. The list of filenames of images to inserting. This file can have some data (in XFDF form), that will be imported into pdf. If set to 'true', annots, fields and etc will be renamed (ready for documents merge).

enable_for_merging

boolean

Version: 1.0 2011-12-13

PUBLIC

201 / 222

Modules

8.48 pdf_merge
Performs merging of .pdf documents into one.
Parameter Name source_filenames result_filename Parameter Type string filename Parameter Description A lot of source filenames, delimited by ; or , . Result filename.

8.49 pdf_print_all_metadata
Prints all Metadata into .a pdf document.
Parameter Name output_filename template_filename node_annot child_annot name_annot data_annot area_annot parent_name Parameter Type filename filename string string string string string string Parameter Description The name with which to save the exported .pdf file. The filename of the PDF template. Name of annot, used for node name. Name of annot, used for node name. Name of annot, used for metadata name. Name of annot, used for metadata value. Name of annot, used for area in template. Regular expression, used as parentname pattern, if empty - all parents will included. Regular expression, used as nodename pattern, if empty - all child will included, but parent_name can't be empty. Regular expression, used as childname pattern, if empty - all child will included. Recursive collecting from founded node for it's child. Use only child, that don't have any geometry.

node_name

string

child_name

string

include_child exclude_geometry

boolean boolean

Version: 1.0 2011-12-13

PUBLIC

202 / 222

Modules

8.50 pdf_print_metadata
Prints Metadata into a .pdf document (like XFDF method, use entries from template).
Parameter Name output_filename template_filename node_name blocks_per_page Parameter Type filename filename string integer Parameter Description The name with which to save the exported .pdf file. The filename of the PDF template. Used as node-name pattern. Count of blocks per page.

8.51 pdf_protect
Performs a protection process on a .pdf document.
Parameter Name src_filename dst_filename use_md_password md_password_text use_op_password op_password_text use_watermark watermark_text doc_right_print doc_right_edit doc_right_copy doc_right_edit_notes doc_right_fill_n_sign Parameter Type filename filename boolean string boolean string boolean string boolean boolean boolean boolean boolean Parameter Description The IN document filename. The OUT document filename. Password protect editing of PDF. Password for modification. Enable for commenting in Adobe Reader. Password for opening. Add Watermark with following text. Watermark. Allow PRINT of document rights. Allow EDIT of document rights. Allow COPY of document rights. Allow EDIT_NOTES of document rights. Allow FILL_AND_SIGN of document rights.

Version: 1.0 2011-12-13

PUBLIC

203 / 222

Modules

8.52 pdf_xfdf_integrate
Applies .xfdf to a .pdf document.
Parameter Name src_filename dst_filename xfdf_filename Parameter Type filename filename string Parameter Description The IN document filename. The OUT document filename. This file can have some data (in XFDF form), that will be imported into pdf. If set to 'true', annots, fields and etc will be renamed (ready for documents merge).

enable_for_merging

boolean

8.53 pmi_settings
Sets global settings for a scene with PMI.
Parameter Name always_on_top Parameter Type boolean Parameter Description If set to 'true', draws the markup and markup leaders on top of all the objects in the scene. Used to select the color of the markup leaders. Used to select the vector text color.

leader_color text_color

integer integer

8.54 pmi_visibility
Controls visibility of various PMI types.
Parameter Name show_text_markups show_rich_text_markups show_gdt_markups show_dimension_markups show_roughness_markups show_welding_markups affect_only_markups_in_active_viewport Parameter Type boolean boolean boolean boolean boolean boolean boolean Parameter Description Display Text Markups. Display Rich Text Markups. Display GDT Markups. Display Dimension Markups. Display Roughness Markups. Display Welding Markups. Apply changes only to markups in active viewport.

Version: 1.0 2011-12-13

PUBLIC

204 / 222

Modules

8.55 regenerate_scene_thumbnails
Generates thumbnails for scene step, model and detail views.
Parameter Name regenerate_model_view_thumbnails regenerate_step_view_thumbnails regenerate_detail_view_thumbnails Parameter Type boolean boolean boolean Parameter Description Regenerate model view thumbnails. Regenerate step view thumbnails. Regenerate detail view thumbnails.

8.56 remove_vzxml_hierarchy_cache
Removes VzXml specific hierarchy cache from the scene.
Parameter Name keep_all_metadata_as_selector_metadata keep_selector_ds_ids keep_selector_external_ids keep_all_metadata_as_entity_metadata Parameter Type boolean boolean boolean boolean Parameter Description Copy metadata from VzXml hierarchy to scene nodes. Keep VzXml hierarchy selector ds ids on scene nodes. Keep VzXml hierarchy selector external ids on scene nodes. 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 queryfile Parameter Type filename Parameter Description Query file path.

8.58 RunQuery
Runs a query on the specified scene.
Parameter Name query Parameter Type string Parameter Description Query text.

Version: 1.0 2011-12-13

PUBLIC

205 / 222

Modules

8.59 setsceneunits
Sets scene units.
Parameter Name multiplier units Parameter Type double integer Parameter Description Unit Multiplier. Default scene units. Possible Values Generic units MilliMeters Centimeters Meters KiloMeters Inches Feet Miles Points Picas rescale ExcludePoints boolean boolean Scale for conversion. Exclude points from unit conversion. 0 1 2 3 4 5 6 7 8 9

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.

Version: 1.0 2011-12-13

PUBLIC

206 / 222

Repository

Repository

9.1

ro_audit_addrecord

Adds an audit record for an asset.

Parameter Name assetid auditmessage Parameter Type integer string Parameter Description Asset ID to add audit record for. Audit Message.

9.2

ro_asset_removeexternalsystemid

Removes any associated external system id from a specific asset version.

Parameter Name assetid assetversion Parameter Type integer string Parameter Description Asset Id. 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 partnertype partnerid partnerversion partnerrevision projectname Parameter Type string string string string string Parameter Description Partner system name. Partner Id. Partner system version (optional). Partner system revision (optional). Project name.

Version: 1.0 2011-12-13

PUBLIC

207 / 222

Repository

9.4

ro_asset_getdetailsbyexternalsystemid

Gets the details of an asset specified by external system id.

Parameter Name partnersystem partnerid partnerversion partnerrevision projectid projectname assetid assetversion processstatus assettype assetfile deepserverfolder Parameter Type string string string string integer string integer integer string string string string Parameter Description The External System Name to look up. The External System ID to look up. The External System Version to look up. The External System Revision to look up. The ID of the Project to perform the lookup in. The name of the project to perform the lookup in. The Asset ID if found. The Asset version if found. Processing status (Unused). The Asset type. The Asset file name. 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 assetid ancestorinstancecount ancestorinstanceids Parameter Type integer integer collectionparameter Parameter Description The child asset id. The number of ancestor asset instances found. The list of all the ancestor asset instance IDs.

Version: 1.0 2011-12-13

PUBLIC

208 / 222

Repository

9.6

ro_asset_getancestorassetids

Gets the asset IDs of all ancestors of the specified asset.

Parameter Name assetid ancestorassetcount ancestorassetids Parameter Type integer integer collectionparameter Parameter Description The child asset ID to look up ancestors for. The number of ancestor assets found. The list of all the ancestor asset IDs.

9.7

ro_asset_getexternalsystemid

Gets the external system id for an asset version.

Parameter Name assetid assetversion partnerid externalsystemid externalsystemversion externalsystemrevision Parameter Type integer string string string string string Parameter Description The asset ID. The asset version. The External System Name of the asset, if any. The External System ID of the asset, if any. The External System Version of the asset, if any. 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 assetid parentassetcount parentassetids Parameter Type integer integer collectionparameter Parameter Description The asset ID. The number of parent assets found. The list of all parent asset IDs.

Version: 1.0 2011-12-13

PUBLIC

209 / 222

Repository

9.9

ro_asset_getderivativesforversion

Gets the list of all existing derivatives for a specified asset.

Parameter Name assetid assetversion Parameter Type integer string Parameter Description The asset ID to list derivatives for. If specified, the asset version to list derivatives for, otherwise, the current version. If specified, only derivatives with the specified file extension will be listed. The details of the matching derivatives.

extension derivatives

string collectionparameter

9.10 ro_asset_setexternalsystemid
Sets the external system ID for a specific asset version.
Parameter Name assetid assetversion partnersystem partnerid partnerversion partnerrevision Parameter Type integer string string string string string Parameter Description The asset ID. The asset version. The external system name. The external system ID. The external system version. The external system revision.

9.11 ro_manifest_convertversion
Converts between different versions of file upload manifests.
Parameter Name source sourceversion destination destinationversion Parameter Type filename string filename string Parameter Description The source manifest file to convert. The version of the source manifest file ('V1', or 'V2'). The destination file to place the converted manifest into. The version of the destination manifest file ('V1', or 'V2').

Version: 1.0 2011-12-13

PUBLIC

210 / 222

Repository

9.12 ro_entitydatabag_deletevalue
Deletes an item from the entity data bag.
Parameter Name entityid entitytype name Parameter Type integer string string Parameter Description ID of the entity. Type of the entity. 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 absoluteinstanceid outputfilepath addtocache absoluteinstancename Parameter Type integer filename boolean string Parameter Description The ID of the absolute instance to download. The file to save the downloaded absolute instance to. Whether or not to add the output to the download cache. 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 assetid assetversion outputfilepath addtocache assetname Parameter Type integer integer filename boolean string Parameter Description The asset ID of the asset to download. The version of the asset to download (Optional). The file to save the downloaded asset to. Whether or not to add the output to the download cache. The name of the downloaded asset.

Version: 1.0 2011-12-13

PUBLIC

211 / 222

Repository

9.15 ro_asset_downloadoriginalfile
Gets the current version of an asset, and stores it in a specified file system location.
Parameter Name location assetid filename Parameter Type string integer filename Parameter Description The path of a filesystem folder to save the file to. The asset ID to retrieve. 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 project_id externalsystem_name externalsystem_uid asset_id Parameter Type integer string string integer Parameter Description The project ID of the project to look in. The external system name. The external system uid. 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 assetid assetversion masterderivativeid masterderivativename derivativefilename origfileid origfilename origfullpath assettype toplevel Parameter Type integer integer integer string string integer string string string boolean Parameter Description Asset ID. Asset Version. Master Derivative ID. Master Derivative Name. Master Derivative File Name. Original File ID. Original File Name. Original File full path uploaded from. Asset Type. Whether asset was uploaded as top level.

Version: 1.0 2011-12-13

PUBLIC

212 / 222

Repository

9.18 ro_file_scanforassetbuildinfo
Gets the file processing information to process the specified file as an asset.
Parameter Name filename derivativeprocesshint Parameter Type filename string Parameter Description The file to analyze. 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). Whether a plugin file type is required or not (Default: false). The human readable name of the file type that was selected to process this file. The file type ID, or 0 if no matching file type in the database. The GUID of the plugin that should be used to process this file. The MIME type that should be used when this file is downloaded. The asset types that can be used when storing this file as an asset (comma-delimited list). The name of the process that should be used to create the master derivative for this asset. Whether originals should be stored for this asset. The thumbnail generator that should be used to generate thumbnails for this asset ('DeepServer', 'OperatingSystem', or 'None').

requireplugin filetypename

boolean string

filetypeid pluginguid mimetype assettypes

integer string string string

derivativeprocess

string

storeoriginals thumbnailgenerator

boolean string

9.19 ro_job_getcreatedassetversions
Gets the asset versions created by a particular job.
Parameter Name jobid versions Parameter Type string collectionparameter Parameter Description The job ID. Collection of the asset versions created by the job, if any.

Version: 1.0 2011-12-13

PUBLIC

213 / 222

Repository

9.20 ro_derivative_download
Gets a derivative or a thumbnail for a derivative, saving it to the specified file system location.
Parameter Name location Parameter Type string Parameter Description The location to save file to. The filename is determined from derivative name. The ID of the derivative to retrieve. The fully qualified path of the saved file.

derivativeid filename

integer filename

9.21 ro_derivative_getdetails
Gets information about a specified derivative.
Parameter Name derivativeid assetid assetversion derivativetypeid derivativefilename Parameter Type integer integer integer integer string Parameter Description The Derivative ID to look up details for. Asset ID. Asset Version. Derivative Type ID. Derivative filename.

9.22 ro_derivative_getstream
Gets a derivative or a thumbnail for a derivative into a stream in the process.
Parameter Name derivativeid thumbnail writemode stream filename Parameter Type integer boolean boolean stream filename Parameter Description The derivative ID to get the stream for. Whether to return a stream for the derivative, or its thumbnail. Whether the stream should be writable or not. The derivative or thumbnail stream. The file name stored in the database for the derivative.

Version: 1.0 2011-12-13

PUBLIC

214 / 222

Repository

9.23 ro_entitydatabag_getvalue
Gets an item from the entity data bag.
Parameter Name entityid entitytype name value Parameter Type integer string string string Parameter Description ID of the entity. Type of the entity. Name of the data property to get. The property value.

9.24

ro_absoluteinstance_getabsoluteinstancescreatedbyjob

Gets the top-level absolute instances created by a particular job.

Parameter Name jobid instances Parameter Type string collectionparameter Parameter Description The job ID. 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 externalsystem externalsystemid externalsystemversion externalsystemrevison projectid assetid assetversion Parameter Type string string string string integer integer integer Parameter Description External partner name. External partner ID. External partner version. External partner revision. Project ID. Asset ID. Asset version.

9.26 ro_asset_getmasterderivativeid
Gets the master derivative ID for a given asset ID.
Parameter Name assetid masterderivativeid Parameter Type integer integer Parameter Description The Asset ID. The Master Derivative ID, if any.

Version: 1.0 2011-12-13

PUBLIC

215 / 222

Repository

9.27 ro_file_download
Downloads the file with the specified ID and saves it to a file system file.
Parameter Name fileid filename Parameter Type integer filename Parameter Description The ID of the file to retrieve. 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 pluginguid filename assettypeid filetypeid mimetype Parameter Type string filename integer integer string Parameter Description The plugin GUID. The file name of the file to perform the lookup for. The asset type ID to use as a hint for the file type lookup. (Optional). The ID of the original file type, or 0 if no match found. 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 viewid viewname Parameter Type integer string Parameter Description View ID. View name.

9.30 ro_job_getproperty
Gets the value of the job property with the specified name.
Parameter Name jobid propertyname propertyvalue Parameter Type integer string string Parameter Description The job ID. The name of the job property to get the value for. The job property value.

Version: 1.0 2011-12-13

PUBLIC

216 / 222

Repository

9.31 ro_job_setproperty
Sets the value of a job property.
Parameter Name propertyname jobid propertyvalue Parameter Type string integer string Parameter Description The name of the job property to set value for. The job ID. The property value to set.

9.32 ro_asset_setmetadatavalue
Adds or updates metadata on a specified asset.
Parameter Name assetid category categoryname Parameter Type integer integer string Parameter Description The asset ID to apply the metadata changes to. The Category ID (Either category ID or name must be provided). The Category name (Either category ID or name must be provided). The field name of the metadata value to set. The metadata field value to set. The Node ID to set metadata for (Optional). The Node path on which metadata is being set (Optional).

name value subnodeid subnodepath

string string string string

9.33 ro_entitydatabag_setvalue
Sets the value of an item in the entity databag.
Parameter Name entityid entitytype name value Parameter Type integer string string string Parameter Description The ID of the entity. The type of the entity. The name of the property to set. The value to set.

Version: 1.0 2011-12-13

PUBLIC

217 / 222

Scriptable Operations

10 Scriptable Operations

10.1 script_execute
Executes a script block.
Parameter Name script sandbox Parameter Type scriptblock boolean Parameter Description The script block to execute. Whether or not to run the script in a sandbox.

Version: 1.0 2011-12-13

PUBLIC

218 / 222

SOAP Web

11 SOAP Web

11.1 webservice_methodinvoke
Calls a method on an external application web service.
Parameter Name assemblyname typename methodname endpoint Parameter Type string string string string Parameter Description The generated Web Method Proxy assembly. The type of the Web Service proxy. The name of the web method or operation. The Web Service Endpoint.

11.2 webservice_operationgenerator
Creates operations to communicate with external application web services.
Parameter Name wsdllocation username password toolboxgroup prefix Parameter Type string string string string string Parameter Description The location of the wsdl, typically a URL. Username for accessing the wsdl. Password for accessing the wsdl. The toolbox group to add the operation to. A prefix that is added to the Operation name to ensure uniqueness. Used when multiple web services have methods of the same name. This is the location of the strong name key file that is used when generating Web Service proxy DLL files. The names of all operations that have been generated. A log of operations, parameters and errors generated.

strongnamekeyfile

string

operations messages

collectionparameter collectionparameter

Version: 1.0 2011-12-13

PUBLIC

219 / 222

SQL Database

12 SQL Database

12.1 database_executecommand
Runs a SQL server stored procedure and returns the results.
Parameter Name connectionstring Parameter Type string Parameter Description Input parameter, the connection string. eg. 'Data Source={servername}; Integrated Security=SSPI; Initial Catalog={databasename;}'. Input parameter, the maximum number of seconds to wait for a command to execute. (0=infinite). Input parameter, The name of the stored procedure to execute. e.g. 'spGetAssetId'. Output parameter, The results of the executed stored procedure.

commandtimeout

integer

command

string

dataset

db_dataset

Version: 1.0 2011-12-13

PUBLIC

220 / 222

Triggers

13 Triggers

13.1 filetrigger
A trigger that includes a file parameter.
Parameter Name context filename Parameter Type contextparameter filename Parameter Description The task context. Location of the file to process.

13.2 generictrigger
A generic trigger that only includes the task context.
Parameter Name context Parameter Type contextparameter Parameter Description The task context.

13.3 simpletrigger
Trigger that supports name/value pair parameters.
Parameter Name context request response Parameter Type contextparameter xmi_simpletrigger xmo_simpletrigger Parameter Description The task context. The input parameter. The output parameter.

13.4 conversiontrigger
A trigger used by conversion server processes.
Parameter Name context filename outputfolder Parameter Type contextparameter filename string Parameter Description The task context. The input file name. The output folder path.

Version: 1.0 2011-12-13

PUBLIC

221 / 222