Converter Command Line Options

HOOPS Converter is a stand-alone application named converter, which is located in the bin directory of the HOOPS Communicator package. The application accepts the following command-line options:

Option	Description
--add_exchange_ids	Deprecated - use export_exchange_ids.
--always_substitute_font	If set, the font provided to –substitution_font will be used for all PMI text. If True but substitution_font is not set, the first font available on the system will be used. Default: False.
--background_color	An RGB triplet which defines the window background color for the image and 3D PDF export. Example: (‘1.0,0.0,0.0’). Default: Black
--configuration	Name of the configuration to load. Or if ‘load_all_configurations’ is used, tells the one that will be active
--debug_flags	A bit field value which allows you to set currently unpublished options. Please note, any options here are not guaranteed to be supported from release to release. Please do not use this option unless specifically advised by the Tech Soft 3D support group.
--decode_obfuscated_license	Decodes an obfuscated license key
--drawings_mode	Controls what to import from drawing files. 0=only 3D, 1=only drawings, 2=Both 3D and drawings. Default: 1.
--export_exchange_ids	If set, then exchange ids will be computed and exported. Default: False.
--force_capping	If set, forces capping meshes to be created even if source data contains non-manifold geometry.
--generate_LODs	If set, then low, medium and high LOD (Level Of Detail) per brep body. Default: False
--help	Print help message
--ifc_import_openings	If set, then opening elements in the CAD File will be imported. Default: false
--ifc_import_relationships	If set, then relationships set in an IFC CAD file will be imported. Default: true
--import_hidden_objects	If set, then hidden objects in the CAD File will be imported. Default: False
--import_pmi	If set, then PMI will be imported. Default: True
--input	Name of input file to convert.
--input_html_template_file	The name of the HTML file that is used as a template for the exported self contained HTML document. This template file must contain a specific string to receive the model data. Please refer to the Monolithic HTML Export page for additional details.
--input_pdf_template_file	The name of the pdf file that is used as a template for the exported PDF. In order to export the 3d model to the PDF this file needs to contain a Button Field labeled My3DWindow1 which will be replaced with the 3D Model.
--input_texture_directories	Directories (comma separated) to look for textures.
--input_xml_batch_file	The name of a file which contains a series of command line options that should be executed in succession. If you are using this approach then the only other option you provide is a license key. A sample file called sample_batch.xml is included in the authoring->converter->example directory.
--input_xml_shattered	Name of shattered XML File describing an assembly hierarchy indexing individual part-level SC models.
--jt_level_of_detail	0=Low, 1=Medium, 2=High. Default: High
--license	Your license key (required if ‘license_file’ not specified). Note: HOOPS Converter will not function without a license key.
--license_file	Path to a text file containing your license key (required if ‘license’ not specified). The file should contain only your license key (no quotation marks should be used). Note: HOOPS Converter will not function without a license key.
--load_all_configurations	If set, will load all the available configurations
--modify_pdf_text_field_list	List of key value pairs for modifying text fields in the supplied PDF template separated by $$ (e.g. Filename$$Part.CatPart$$FileType$$CatiaModel)
--multi_process_assembly_loading	Deprecated - This feature will be removed in a future release. Number of processes used to load native CAD assemblies (will work for CatiaV5, NX, ProE, SolidWorks and JT file formats). Default: 1
--output_3mf	Name of output 3MF file.
--output_configurations	Name of output configuration file. If you provide a configuration filename, Converter will create a file which lists all the product configurations in the input file.
--output_dependencies	Name of output dependencies file.
--output_directory	Path to output directory.
--output_hsf	Name of output HSF file.
--output_html	Name of output HTML file.
--output_jt	Name of output JT file.
--output_logfile	If provided, name of the log file where HOOPS Converter will write error and warning messages. In addition, all messages will be sent to stdout and stderr. Message format: [02/20/2013 14-04-38-205 D:097890 PID:1252 M:415MB R:0]INFO: Parsing PRC done. date and time, D: time passed since beginning of last block in milliseconds (blocks are indented), PID: process ID, M: current memory consumption (in MB), R: current sequence (only applies to batch conversion), message type (INFO, WARNING, or ERROR), optional error code - used for internal diagnostic purposes, message text
--output_measurement	Name of output measurement data file.
--output_model_info	Name of the output model info file. If you provide an model info filename, Converter will create a file which provides general information about the conversion process of the input file. A useful debugging tool.
--output_pdf	Name of output PDF file.
--output_png	Name of output PNG file.
--output_png_resolution	Resolution of PNG image (default resolution is 640x480).
--output_prc	Name of output PRC file.
--output_sc	Full path of SC Model to generate. Warning: This option will recursively delete all existing files in the target directory.
--output_sc_master	Full path of SC Model generated from shattered XML Input File.
--output_scs	Full path of SCS file to generate.
--output_step	Name of output STEP file.
--output_stl	Name of output STL file.
--output_xml_assemblytree	Name of Assembly tree xml file associated with the imported model.
--output_xml_BOM	Name of output XML BOM file.
--output_xt	Name of output XT file.
--png_camera_explicit	Explicitly sets the camera to be used for image export. The values are set in a comma-separated list as follows: positionX,positionY,positionZ, targetX,targetY,targetZ, upX,upY,upZ, cameraFieldX,cameraFieldY,projection. All values except ‘projection’ are floats. Only comma characters should separate the values passed in (no spaces). The ‘projection’ field can have a value of ‘orthographic’ or ‘perspective’.
--png_camera_standard	Sets the camera for image export to be a preset camera view. Supported options consist of Iso or a combination of the following: Front, Back, Top, Bottom, Right, and Left. Names are case insensitive. Examples: TopBackRight, Bottom, LeftTop. Converter now supports generating images based on the HC 2015 camera presets. Supported values are: iso2015, none2015, xy, yx, xz, zx, yz, zy
--png_export_pmi	Controls whether or not the exported PNG contains PMI. Default: True
--png_fit_world_exact	Fits the camera for image export tightly around the scene’s geometry.
--png_hidden_line	Fits the camera for image export tightly around the scene’s geometry.
--png_lighting_mode	0 = HC 2015 lighting, 1 = HC 2016 and newer. Default: 1.
--png_rendering_mode	Sets the rendering mode used when exporting a PNG thumbnail. Supported options consist of ‘ShadedWithLines’, ‘Shaded’, or ‘HiddenLine’. Default: ShadedWithLines
--png_transparent_background	Render PNG images with a transparent background. Default: false
--prc_brep_compression	0 = Off, 1 = 0.001mm, 2 = 0.01mm, 3 = 0.1mm. Default: Off
--prc_font_directories	List of directories separated by ‘ ‘ that contain additional fonts. Example:’C:fonts C:otherfonts’
--prc_remove_brep	This will remove the BREP from the PRC and PDF export. This may be important to protect intellectual property. Default: False.
--prc_tessellation_compression	If set, then a lossless algorithm is applied to reduce the size of the 3D stream inside the PDF/PRC document. Default: False.
--prepare_shattered_parts	Specifies a directory to put shattered parts models into. If set, then an individual part level SC model will be created per part.
--prepare_shattered_scs_parts	Specifies a directory to put shattered parts models into. If set, then an individual part level SCS files will be created per part.
--prepare_shattered_xml	If set, then the XML file needed to build master assembly file from shattered data, will be created.
--read_attributes	If set, then the attributes of the model will be imported. Default: True.
--read_geometry	If set, then the geometry of the model will be imported alongside the tessellation. Default: True. Note: If –sc_export_measurement is set to True, then –read_geometry will be forced to True.
--read_wireframes	If set, then wireframe geometry will be imported. Default: True.
--revit_physical_properties	If set, physical properties from the revit file will be read. Reading the physical properties might negatively impact performance. 0 = Not computed, 1 = Computed during reading process, stored as attributes. Default: 0
--sc_compress_models	Deprecated - Use sc_create_scz and sc_compress_scz. Setting sc_compress_models to True is the equivalent of setting both sc_create_scz and sc_compress_scz to True.
--sc_compress_scz	If set, then generated .scz files will be compressed. Default: True
--sc_editable	If True, then the model will be editable. Currently, only SCZ output is affected. Default: False for uncompressed SCZ output, True otherwise
--sc_compression_strategy	Sets compression strategy that will be used to compress large meshes and images. 0=Fast, 1=Default, 2=Strong. Default: 1
--sc_compute_bounding_boxes	Define nodes where bounding boxes are computed. Values: All/Leaves/None Default: None.
--sc_compute_lines	If set, then triangle edges matching certain criteria will be added to the model as lines. Note: that setting this forces sc_discard_lines to True. Default: False
--sc_compute_lines_min_triangle_angle	The minimum angle in degrees between two adjacent triangle normals that will trigger a line to be added for the connecting edge. [0,180]. 0 will add every line, 180 will add no lines. Default: 50.0
--sc_compute_lines_max_polyline_angle	The maximum angle in degrees between two adjacent lines that will cause the lines to join into a single polyline. [0,180]. 0 will connect no lines, 180 will connect every adjacent line. Default: 40.0
--sc_compute_lines_add_non_adjacent	If set, a line will be added for each triangle edge that is not shared by any other adjacent triangle. Default: True
--sc_compute_lines_split_faces	If set, and sc_compute_lines is enabled, each face of the mesh may be split into new faces that fit within the added lines. Default: True
--sc_create_scz	If set, then generated SC models will be .scz files. Default: False
--sc_default_pmi_color	Set a default color for PMIs. Only if sc_force_black_lines is false. Example:’1.0,1.0,1.0’
--sc_discard_lines	If set, all existing lines will be removed from the model. Default: False
--sc_discard_normals	If True, vertex normals will not be included in SC output. This can greatly reduce memory usage. Default: True for STL input, False otherwise
--sc_export_assemblytree	If set, then the assembly tree will be generated. Default: True
--sc_export_attributes	If set, then user attributes will be part of the assembly tree. Default: False
--sc_export_full_path	If set, the originalFileName will contain the full path. Default: False
--sc_export_materials	If set, then material information will be part of the assembly tree. Default: False
--sc_export_matrices	If set, then matrix information will be part of the assembly tree. Default: True
--sc_export_measurement	If set, then measurement data will be computed and exported. Only applies if the source data includes a B-rep definition, or if compute-lines is enabled. Default: True. Note: If –sc_export_measurement is set to True, then –read_geometry will be forced to True.
--sc_merge_attribute_value_name	If set, then merge the name of an attribute with the name of its value. Default: True.
--sc_export_physical_properties	If set, then physical properties will be computed and exported. Only applies if the source data includes a B-rep definition. Default: True.
--sc_export_pmi	If set, then PMI will get exported. Default: True
--sc_export_views	If set, then views will get exported. Default: True
--sc_force_black_lines	If True, then all lines in the model will be forced to black. Default: True
--sc_logging	If set, then SC actions will do logging. Default: False
--sc_shattered_parts_directory	Specifies a directory containing shattered parts. If not provided the parent directory of –output_sc_master will be assumed.
--sc_working_directory	A path for a SC workspace
--search_directories	List of directories separated by ‘ ‘ that contain external files. Example:’C:external C:otherexternals’
--step_export_format	0=StepAP203, 1=StepAP214, 2=StepAP242. Default: StepAP242
--stl_ascii	If set, then then an ASCII version of the STL will be generated. Default: False
--substitution_font	Name of the font to use when a CAD file refers to a font that cannot be found. If set, and always_substitute_font is False, the set font only applies to text that does not have its PRC-specified font available on the system. Default: null
--tessellation_quality	Input: 0=Extra Low, 1=Low, 2=Medium, 3=High, 4=Extra High. Default: Medium. Note: This option is only applicable to formats that contain BRep and has no effect on files containing only tessellation (e.g. STL, FBX, 3MF, PRC or X_T that only contain tessellation, etc).
--xml_settings	Provides the path to the XML settings file

Error Codes

Error code	Value	Description
Success	0	The conversion was successful.
Generic Failure	1 << 0 (1)	The conversion failed with a generic failure.
Model Load Failure	1 << 1 (2)	Failure to load model.
Invalid License	1 << 2 (4)	Provided license is invalid.
Initialization Failure	1 << 3 (8)	Failed to initialize required components, probably HOOPS Exchange or HOOPS Vizualize.
No Input	1 << 4 (16)	No input file was provided.
SC Master Output Failure	1 << 5 (32)	Failed to output SC master model.
PNG Output Failure	1 << 6 (64)	Failed to output PNG.
HSF Output Failure	1 << 7 (128)	Failed to output HSF.
PRC Output Failure	1 << 8 (256)	Failed to output PRC.
STEP Output Failure	1 << 9 (512)	Failed to output STEP.
STL Output Failure	1 << 10 (1024)	Failed to output STL.
XT Output Failure	1 << 11 (2048)	Failed to output XT.
3MF Output Failure	1 << 12 (4096)	Failed to output 3MF.
JT Output Failure	1 << 13 (8192)	Failed to output JT.
PDF Output Failure	1 << 14 (16384)	Failed to output PDF.
SC Output Failure	1 << 15 (32768)	Failed to output SC.
XML Output Failure	1 << 16 (65536)	Failed to output XML.
HTML Output Failure	1 << 17 (131072)	Failed to output HTML.
Dependencies Output Failure	1 << 18 (262144)	Failed to output dependencies.
XML BOM Output Failure	1 << 19 (524288)	Failed to output XML BOM.
Config File Output Failure	1 << 20 (1048576)	Failed to output config file.
Shattered Output Failure	1 << 21 (2097152)	Failed to output shattered model.

In case of a failed conversion, additional information regarding the nature of the error can be obtained from the log file.