Converter Application

The HOOPS Converter is a stand-alone application located in the bin directory of the product package.

Options come in the form --optname=VALUE or --optname VALUE where optname is one of the options listed in this page. When VALUE corresponds to a boolean value, it can either be any of true/True/1 or false/False/0.

The command-line interface accepts the following options.

Import/Export

IFC

JT

PNG

PRC

Revit

SC

STEP

STL

HTML

PDF

General

Deprecated

Command Line Options

--add_exchange_ids
Deprecated:Use --export_exchange_ids instead.
--always_substitute_font

If true, the font provided to --substitution_font is used for all PMI text. When set but --substitution_font is false, the first font available on the system is used.

If false, the font provided to --substitution_font is only used when the font set in the input CAD model is not available.

Default:false
Example:--always_substitute_font true.
See also:--substitution_font option.
--background_color

An RGB triplet which defines the window background color for the image and 3D PDF export. The provided color must be a comma-separated list of floating point values.

Example:Red: --background-color 1.0,0.0,0.0.
Default:“0,0,0” (Black).
--configuration

Name of the configuration to load. Or if --load_all_configurations is used, tells the one that is active

See also:
--debug_flags

A bit field value that allows you to set currently unpublished options. Please note that these options are not guaranteed to be supported in future releases. Use this option only when specifically provided by the Tech Soft 3D support group.

--decode_obfuscated_license

Decode an obfuscated license key and quit the program.

Default:false
--drawings_mode

Control what to import from drawing files. The value can be one of 0 (3D only), 1 (Drawings only) or 2 (both).

Default:1
Example:--drawings_mode 2
See also:HOOPS Communicator for BIM documentation.
--export_exchange_ids

If true, then exchange ids are computed and exported.

Default:false
--force_capping

If true, force capping meshes to be created even if source data contains non-manifold geometry.

Default:false
--generate_LODs

If true, Level of Details (LOD) versions of all Brep bodies are generated (low, medium and high).

--help

Print help message and quit immediately.

--ifc_import_openings

If true, opening elements in the CAD File are imported.

Default:false
--ifc_import_relationships

If true, relationships set in an IFC CAD file are imported.

Default:true
--import_hidden_objects

If true, hidden objects in the CAD file are imported.

Default:false
--import_pmi

If true, PMI is imported.

Defaut:true
See also:PMI documentation.
--input

Name of input file to convert.

The provided path can be absolute or relative to the current working directory.

Example:--input "C:\temp\Axle.CATPart
--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.

If no template is specified for an HTML export, the conversion fails.

See also:Monolithic HTML Export documentation.
--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 is replaced with the 3D Model.

If no template is specified for a PDF export, the conversion fails.

See also:--output_pdf
--input_texture_directories

A comma-separated list of directories to search for texture loading.

--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 need to provide is a license key. A sample file called sample_batch.xml is included in the authoring/converter/example directory.

See also:XML Batch Conversion documentation.
--input_xml_shattered

Name of shattered XML file describing an assembly hierarchy indexing individual part-level SC models.

See also:Creating a master SC model section.
--jt_level_of_detail

One of: 0 (Low), 1 (Medium) and 2 (High).

Default:2.
--license

Your license key.

You must set either --license or --license_file for HOOPS Converter to operate properly, otherwise, the program fails.

See also:
--license_file

Path to a text file containing your license key. The file must contain only the license key without quote or blanks.

You must set either --license or --license_file for HOOPS Converter to operate properly, otherwise, the program fails.

See also:
--load_all_configurations

If set, loads all the available configurations

See also:
--modify_pdf_text_field_list

List of key value pairs for modifying text fields in the supplied PDF template separated by $$.

Example:--modify_pdf_text_field_list=Filename$$Part.CatPart$$FileType$$CatiaModel
--output_3mf

Name of the output file for a 3MF output.

Example:--output_3mf C:/temp/output.3mf
--output_configurations

Name of the output configuration file.

If you provide a configuration filename, Converter creates a file which lists all the product configurations in the input file.

See also:
--output_dependencies

Name of the output dependencies file.

--output_directory

Path to output directory.

--output_hsf

Name of the output file for a HSF output.

Example:--output_hsf C:/temp/output.hsf
--output_html

Name of the output file for a HTML output.

Example:--output_html C:/temp/output.html
--output_jt

Name of the output file for a JT output.

Example:--output_jt C:/temp/output.jt
--output_logfile

Name of the log file where HOOPS Converter writes error and warning messages in addition, to using stdout and stderr for logging.

Message Format

The output message has the following format: [DATE TIME D:# PID:# M:# R:#]LEVEL CODE: Message.

  • DATE uses MM/DD/YYYY format.
  • TIME uses HH-MM-SS-MS format.
  • D: milliseconds passed since begining of last block (blocks are stacked).
  • PID: Process ID.
  • M: Current memory usage in Mb.
  • R: Current sequence. Only applied to batch conversions.
  • LEVEL: Log level. Can be one of INFO, WARNING or ERROR.
  • CODE: Optional internal error code for diagnostic purposes.

Example: [02/20/2013 14-04-38-205 D:097890 PID:1252 M:415MB R:0]INFO: Parsing PRC done

--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 creates a file which provides general information about the conversion process of the input file. This can be used as a debugging tool.

--output_pdf

Name of output PDF file.

See also:--input_pdf_template_file
--output_png

Name of output PNG file.

--output_png_resolution

Dimensions for the output PNG image. The argument must be formatted as WxH where W is the width and H the height in pixels.

Example:–output_png_resolution=240x240
Default:640x480
--output_prc

Name of output PRC file.

--output_sc

Full path of SC Model to generate.

Warning

This option recursively deletes all existing files in the target directory.

See also:
--output_sc_master

Full path of SC Model generated from shattered XML Input File.

See also:
--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.

See also:XML Assembly Tree documentation.
--output_xml_BOM

Name of output XML BOM file.

--output_xt

Name of output XT file.

--png_camera_explicit

Explicitly set 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 floating point numbers. Only the comma character , must separate the values passed in (no blanks).

The ‘projection’ field can be a either ‘orthographic’ or ‘perspective’.

Example:--png_camera_explicit "-100,50,-300,-100,50,0,0,1,0,1500,1500,orthographic"
--png_camera_standard

Sets the camera for image export to be a preset camera view.

The value can be any of the following:

Iso

Example:--png_camera_standard Iso

Orientation

The preset can be set and any combination of Front/Back, Top/Bottom and Left/Right.

Example:
  • --png_camera_standard TopBackRight
  • --png_camera_standard Bottom
  • --png_camera_standard LeftTop

Names are case insentitive.

HOOPS Communicator 2015 Camera Presets

Any of iso2015, none2015, xy, yx, xz, zx, yz, zy.

--png_export_pmi

Control whether or not the exported PNG contains PMI.

Default:true
--png_fit_world_exact

Fit the camera for image export tightly around the scene’s geometry.

Default:false
--png_lighting_mode

Set to 0 for HOOPS Communicator 2015 Lighting mode. Set to any other value for HOOPS Communicator 2016 and newer.

Default:1
--png_rendering_mode

Set the rendering mode used when exporting a PNG thumbnail.

Can be any of ShadedWithLines, Shaded, or HiddenLine.

Default:ShadedWithLines
--png_transparent_background

PNG is exported using a transparent background.

Default:false
--prc_brep_compression

Set the PRC Brep compression in _mm_. Can be any of:

  • 0: No compression
  • 1: 0.01mm
  • 2: 0.1mm

Note

If any unsupported value is set, the compression is disabled (0).

Default:0 (No compression)
--prc_font_directories

Space-separated lists of directories where additional fonts are searched for.

Example:--prc_font_directories="C:\fonts C:\otherfonts"
--prc_remove_brep

Remove the Brep from PRC and PDF exports. This may be important to protect intellectual property.

Default:false.
--prc_tessellation_compression

Apply a lossless algorithm to reduce the size of the 3D stream inside the PDF/PRC document.

Default:false
--prepare_shattered_parts

Specify a directory to put shattered parts models into.

When set to true, an individual part-level SC model is created per part.

See also:
--prepare_shattered_scs_parts

Specifies a directory to put shattered parts models into.

When set to true, an individual part level SCS files is created per part.

--prepare_shattered_xml

If set to true, the XML file needed to build master assembly file from shattered data, is created.

See also:
--read_attributes

Import model attributes.

Default:true.
See also:Metadata documentation.
--read_geometry

Import the geometry alongside the tessellation.

Default:true.

Note

--sc_export_measurement=true forces this option to true.

--read_wireframes

Import wireframe geometry.

Default:true
--revit_physical_properties

Read the physical properties from the input Revit file.

When set to 1, the physical properties are computed upon reading and stored as attributes. 0 disables the computation.

Default:0
--sc_compress_models
Deprecated:Use --sc_create_scz and --sc_compress_scz instead.

Setting this option to true is the same as setting both --sc_create_scz and --sc_compress_scz to true.

--sc_compress_scz

Compress output .scz files.

Default:

true.
See also:
--sc_editable

Set the output model as editable. This is only available for SCZ outputs.

Default:false for uncompressed SCZ output, true otherwise.
--sc_compression_strategy

Set compression strategy that is used to compress large meshes and images.

Can be any of 0 (Fast), 1 (Default), and 2 (Strong). Setting any other value defaults to 1.

Default:1
--sc_compute_bounding_boxes

Define nodes where bounding boxes are computed. Values: All/Leaves/None Default: None.

--sc_compute_lines

Add triangle edges to the model. Line edges are added based on the following criteria: --sc_compute_lines_min_triangle_angle, --sc_compute_lines_max_polyline_angle, --sc_compute_lines_add_non_adjacent and --sc_compute_lines_split_faces.

Note:This options forces --sc_discard_lines=true.
Default:false

Note

This feature is currently unsupported for shattered mode.

--sc_compute_lines_min_triangle_angle

Set the minimum angle in degrees between two triangle normals that adds a line to their connecting edge.

The expected value is a floating point number within the range [0.0 ; 180.0]. Setting to 0.0 adds everyline while 180.0 prevents any line to be added. Any other value is clamped within the range [0.0 ; 180.0].

Defaut:50.0.
--sc_compute_lines_max_polyline_angle

When --sc_compute_lines=true, set the maximum angle in degrees between two adjacent lines that causes the lines to join into a single polyline.

The expected value is a floating point number within the range [0.0 ; 180.0]. Setting to 0.0 never connects any line while 180.0 connects every line. Any other value is clamped within the range [0.0 ; 180.0].

Defaut:40.0.
--sc_compute_lines_add_non_adjacent

When true, a line is added for each triangle edge that is not shared by any other adjacent triangle.

Default:true
--sc_compute_lines_split_faces

When true, and --sc_compute_lines=true, each face of the mesh may be split into new faces that fit within the added lines.

Default:true
--sc_create_scz

Output SC models are written into .scz file.

Default:

false
See also:
--sc_default_pmi_color

Set a default color for PMIs. This option is ignored if --sc_force_black_lines=false.

Example:--sc_default_pmi_color="1.0,1.0,1.0"
--sc_discard_lines

Remove existing lines from the model.

Default:false
Note:This options is forced to true when --sc_compute_lines=true.
--sc_discard_normals

Do not include vertex normals in SC output. This can significantly reduce memory usage.

Default:true when the input CAD was an STL file, false otherwise.
--sc_export_assemblytree

Generate the assembly tree.

Default:true
See also:--sc_export_attributes option
--sc_export_attributes

Generate user attributes as part of the assembly tree.

Default:false
See also:--sc_export_assemblytree option
--sc_export_full_path

Set _originalFileName_ as full path.

Default:false
--sc_export_materials

Generate material information as part of the assembly tree.

Default:false
See also:--sc_export_assemblytree option
--sc_export_matrices

Generate matrix information as part of the assembly tree.

Default:true
See also:--sc_export_assemblytree option
--sc_export_measurement

Compute and export measurement data.

This only applies if the source data includes a Brep definition, or if --sc_compute_lines=true.

Default:true

Note

Setting this option to true forces --read_geometry=true.

--sc_merge_attribute_value_name

Merge the name of each attribute with the name of its value.

Default:true
--sc_export_physical_properties

Compute and export model’s physical properties. This is only applied if the source data includes a Brep definition.

Default:true
See also:Metadata
--sc_export_pmi

Export model’s PMI.

Default:true
See also:PMI
--sc_export_views

Export model’s views.

Default:true
--sc_force_black_lines

Forces all lines in the model to black color.

Default:true
--sc_logging

Enable SC actions logging.

Default:false
--sc_shattered_parts_directory

Specify a directory containing shattered parts.

If not provided, the parent directory of --output_sc_master is be assumed.

--sc_working_directory

Forces the working directory for the convereter running instance. When not set, defaults to the current working directory.

--search_directories

Space-separated lists of directories where additional external files are searched for.

Example:--converter --search_directories="C:\external C:\otherexternals"
--step_export_format

The STEP Application Protocol (AP) to export the model to. Can be any of 0 (StepAP203), 1 (StepAP214), or 2 (StepAP242). Any other input value is automatically replaced with 2.

Default:2
--stl_ascii

When --output_stl=true, set the STL output as ASCII STL.

Default:false.
--substitution_font

Name of a fallback font used when a CAD file refers to any font that cannot be found.

If set and when --always_substitute_font=false, the given font only applies to text that does not have its PRC-specified font available on the system.

If not set, there is no substitution font.

--tessellation_quality

Set the quality of computed tessellation:

  • 0: Extra Low
  • 1: Low
  • 2: Medium
  • 3: High
  • 4: Extra High
Default:2

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 Exchange or 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.