Distributing Your Application

When distributing any application built against HOOPS Exchange or HOOPS Publish, you will need to distribute HOOPS binaries as well. In general you should deploy all HOOPS binaries excluding those that you have identified as unnecessary for your build.

For instance, if you provide users with U3D support you will want to distribute your application with u3dstep30.dll.

Please see the section for the platform you're interested in:

Distributing your application for Windows

On Windows, in order to run an application built against HOOPS Exchange, the execution environment must have the MSVC Redistributables for the following versions:

HOOPS Exchange and Publish on Windows is a modular distribution. Apart from mandatory core binaries, you may remove any unnecessary libraries for your deployment.

Whatever your distribution is, it should include all core binaries:

  • A3DLIBS.dll
  • TfFontMgr.dll
  • TfKernel.dll
  • TFKGEOM.dll
  • TFUGEOM.dll

Resources

The resource folder is required for any application using HOOPS Publish. Moreover, the font file resource/Font/MyriadCAD.otf is used by both HOOPS Exchange and HOOPS Publish and thus is required.

Parasolid

  • hepb.dll and psbodyshop.dll are necessary if you wish to export a Parasolid model to an open Parasolid session.
  • HEPBMP.dll is used for multi-process Parasolid translation through the A3DRepresentationItemsTranslateToPkPartsMultiProcess function.

Readers

This list groups all binaries required for each reader:

  • 3DXML
    • r3dxmlstep30.dll
    • Xvlstep30.dll
  • 3MF
    • 3mfstep30.dll
  • ACIS
    • satstep31.dll
  • Autodesk 3DS
    • aistep30.dll
    • dccstep30.dll
  • CATIA V4
    • catstep30.dll
  • CATIA V5
    • cgrstep30.dll
    • cv5step30.dll
  • Creo
    • prostep30.dll
  • CGR
    • cgrstep30.dll
  • COLLADA
    • aistep30.dll
  • DWF
    • a3dpostergeneration.dll
    • dwfstep30.dll
  • DWG
    • OdBrepModeler_22.9_14.dll
    • OdConstraints_22.9_14.dll
    • TD_AcisBuilder_22.9_14.dll
    • TD_Alloc_22.9_14.dll
    • TD_Br_22.9_14.dll
    • TD_BrepBuilderFiller_22.9_14.dll
    • TD_BrepBuilder_22.9_14.dll
    • TD_BrepRenderer_22.9_14.dll
    • TD_DbCore_22.9_14.dll
    • TD_DbRoot_22.9_14.dll
    • TD_Db_22.9_14.dll
    • TD_Ge_22.9_14.dll
    • TD_Gi_22.9_14.dll
    • TD_Gs_22.9_14.dll
    • TD_Root_22.9_14.dll
    • TD_SpatialIndex_22.9_14.dll
    • TD_Zlib.dll
    • dwgstep30.dll
    • libBuffer.dll
    • oless.dll
    • tbb.dll
    • tinyxml.dll

All *.tx files except TB_*.tx (see below)

  • FBX
    • aistep30.dll
  • GLTF
    • glstep30.dll
  • HSF
    • a3dpostergeneration.dll
  • I-deas
    • Ideasstep30.dll
  • IFC
    • stepstep30.dll
  • JT
    • JTstep30.dll
  • IGES
    • igestep30.dll
  • Inventor
    • invstep30.dll
  • Navisworks
    • nwstep30.dll
  • NX
    • ugstep30.dll
  • OBJ
    • aistep30.dll
    • dccstep30.dll
  • PDF
    • pdfstep30.dll
  • Revit
    • OdBrepModeler_22.9_14.dll
    • OdConstraints_22.9_14.dll
    • TD_AcisBuilder_22.9_14.dll
    • TD_Alloc_22.9_14.dll
    • TD_Br_22.9_14.dll
    • TD_BrepBuilderFiller_22.9_14.dll
    • TD_BrepBuilder_22.9_14.dll
    • TD_BrepRenderer_22.9_14.dll
    • TD_DbCore_22.9_14.dll
    • TD_DbRoot_22.9_14.dll
    • TD_Db_22.9_14.dll
    • TD_Ge_22.9_14.dll
    • TD_Gi_22.9_14.dll
    • TD_Gs_22.9_14.dll
    • TD_Root_22.9_14.dll
    • TD_SpatialIndex_22.9_14.dll
    • TD_Zlib.dll
    • rvtstep30.dll
    • libBuffer.dll
    • oless.dll
    • tbb.dll
    • tinyxml.dll

All *.tx files (see below)

  • Rhino
    • rdmstep30.dll
  • Solid Edge
    • sestep30.dll
  • SolidWorks
    • slwstep30.dll
  • STEP
    • stepstep30.dll
  • STEP XML
    • stepxmlstep30.dll
  • STL
    • stlstep30.dll
  • U3D
    • u3dstep30.dll
  • VDA
    • Vdastep30.dll
  • WRML
    • wrlstep30.dll
  • XT
    • xtstep30.dll

*.TX Files

These files are required by DWG and Revit readers:

  • ACCAMERA_22.9_14.tx
  • ATEXT_22.9_14.tx
  • AcIdViewObj_22.9_14.tx
  • AcMPolygonObj15_22.9_14.tx
  • ISM_22.9_14.tx
  • ModelerGeometry_22.9_14.tx
  • OdOleSsItemHandler_22.9_14.tx
  • RText_22.9_14.tx
  • RasterProcessor_22.9_14.tx
  • RecomputeDimBlock_22.9_14.tx
  • RxRasterServices_22.9_14.tx
  • SCENEOE_22.9_14.tx
  • TD_DbEntities_22.9_14.tx
  • TD_DbIO_22.9_14.tx
  • TD_TfCore_22.9_14.tx
  • ThreadPool_22.9_14.tx
  • WipeOut_22.9_14.tx

Revit needs additionnal files:

  • All TB_*.tx files:
    • TB_Analytical_22.9_14.tx
    • TB_Architecture_22.9_14.tx
    • TB_Base_22.9_14.tx
    • TB_Common_22.9_14.tx
    • TB_Database_22.9_14.tx
    • TB_Essential_22.9_14.tx
    • TB_ExLabelUtils_22.9_14.tx
    • TB_Family_22.9_14.tx
    • TB_Format2011Classes_22.9_14.tx
    • TB_Format2011Readers_22.9_14.tx
    • TB_Format2012Classes_22.9_14.tx
    • TB_Format2012Readers_22.9_14.tx
    • TB_Format2013Classes_22.9_14.tx
    • TB_Format2013Readers_22.9_14.tx
    • TB_Format2014Classes_22.9_14.tx
    • TB_Format2014Readers_22.9_14.tx
    • TB_Format2015Classes_22.9_14.tx
    • TB_Format2015Readers_22.9_14.tx
    • TB_Format2016Classes_22.9_14.tx
    • TB_Format2016Readers_22.9_14.tx
    • TB_Format2017Classes_22.9_14.tx
    • TB_Format2017Readers_22.9_14.tx
    • TB_Format2018Classes_22.9_14.tx
    • TB_Format2018Readers_22.9_14.tx
    • TB_Format2019Classes_22.9_14.tx
    • TB_Format2019Readers_22.9_14.tx
    • TB_Format2020Classes_22.9_14.tx
    • TB_Format2020Readers_22.9_14.tx
    • TB_Format2021Classes_22.9_14.tx
    • TB_Format2021Readers_22.9_14.tx
    • TB_Format2022Classes_22.9_14.tx
    • TB_Format2022Readers_22.9_14.tx
    • TB_Format2022Writers_22.9_14.tx
    • TB_FormatCommonClasses_22.9_14.tx
    • TB_FormatCommonReaders_22.9_14.tx
    • TB_GeometryUtils_22.9_14.tx
    • TB_Geometry_22.9_14.tx
    • TB_HostObj_22.9_14.tx
    • TB_LoaderBase_22.9_14.tx
    • TB_Loader_22.9_14.tx
    • TB_MEP_22.9_14.tx
    • TB_Main_22.9_14.tx
    • TB_ModelerGeometry_22.9_14.tx
    • TB_Rebar_22.9_14.tx
    • TB_StairsRamp_22.9_14.tx
    • TB_Structural_22.9_14.tx
    • TD_AssetXMLParser_22.9_14.tx
  • Checksum.txt
  • All CSV/*.csv files:
    • AreaSpaceTypes.csv
    • BuiltInCategories.csv
    • BuiltInCircuitNamingSchemes.csv
    • BuiltInParameterGroups.csv
    • BuiltInParameters.csv
    • CableTrayShapeTypes.csv
    • ColorSchemeMessages.csv
    • CurveElemNameTypes.csv
    • FamilyNames.csv
    • OmniClasses.csv
    • ParameterTypes.csv
    • ParameterValues.csv
    • PipeJointTypes.csv
    • Specs.csv
    • Symbols.csv
    • SystemTypes.csv
    • Units.csv

Writers

This list details which binaries are required for each writer:

  • 3MF
    • w3mf.dll
  • FBX
    • aistep30.dll
  • IGES
    • wiges.dll
  • JT
    • wjt.dll
  • OBJ
    • aistep30.dll
  • SAT
    • wsat.dll
  • STEP
    • wstp.dll
  • STL
    • wstl.dll
  • U3D
    • wu3d.dll
  • VRML
    • wwrl.dll
  • XT
    • hepb.dll
    • wxt.dll

TableToPDF

TableToPDF is a free add-on to HOOPS Publish, dedicated to the creation of tables in PDF documents.

TableToPDF uses third-party libraries that require LGPL conformance for distribution. TableToPDF can be downloaded from the TableToPDF download page. TableToPDF binaries have to be redistributed in the same folder as HOOPS Publish binaries.

Distributing your application for Linux

On Linux, HOOPS Exchange is distributed under one shared object file, libA3DLIBS-VERSION.so (and a symbolic link to it: libA3DLIBS.so).

The Linux distribution is provided in two versions, one version with support for DWG and Revit, and another version without support for DWG and Revit.

Parasolid

  • hepb.so and libpsbodyshop.so are necessary if you wish to export a Parasolid model to an open Parasolid session.
  • HEPBMP.so is used for multi-process Parasolid translation through the A3DRepresentationItemsTranslateToPkPartsMultiProcess function.
    • Please ensure the file attributes for HEPBMP.so are set with execute permission.

DWG and Revit

If you deploy the binaries with DWG and Revit support, you must include the following files:

  • libOdBrepModeler.so
  • libOdConstraints.so
  • libTD_AcisBuilder.so
  • libTD_Alloc.so
  • libTD_Br.so
  • libTD_BrepBuilder.so
  • libTD_BrepBuilderFiller.so
  • libTD_BrepRenderer.so
  • libTD_Db.so
  • libTD_DbCore.so
  • libTD_DbRoot.so
  • libTD_Ge.so
  • libTD_Gi.so
  • libTD_Gs.so
  • libTD_Root.so
  • libTD_SpatialIndex.so
  • libTD_Zlib.so
  • liblibBuffer.so
  • liblibcrypto.so
  • liboless.so
  • libstdc++.so.6
  • libtbb.so.2
  • libtinyxml.so
  • All *.tx files except TB_*.tx:
    • ACCAMERA.tx
    • ATEXT.tx
    • AcIdViewObj.tx
    • AcMPolygonObj15.tx
    • ISM.tx
    • ModelerGeometry.tx
    • OdOleSsItemHandler.tx
    • RText.tx
    • RasterProcessor.tx
    • RecomputeDimBlock.tx
    • RxRasterServices.tx
    • SCENEOE.tx
    • TD_DbEntities.tx
    • TD_DbIO.tx
    • TD_FtFontEngine.tx
    • TD_TfCore.tx
    • ThreadPool.tx
    • WipeOut.tx
    • adinit.dat

Revit needs additionnal files:

  • All TB_*.tx files:
    • TB_Analytical.tx
    • TB_Architecture.tx
    • TB_Base.tx
    • TB_Common.tx
    • TB_Database.tx
    • TB_Essential.tx
    • TB_ExLabelUtils.tx
    • TB_ExportUtils.tx
    • TB_Family.tx
    • TB_Format2011Classes.tx
    • TB_Format2011Readers.tx
    • TB_Format2012Classes.tx
    • TB_Format2012Readers.tx
    • TB_Format2013Classes.tx
    • TB_Format2013Readers.tx
    • TB_Format2014Classes.tx
    • TB_Format2014Readers.tx
    • TB_Format2015Classes.tx
    • TB_Format2015Readers.tx
    • TB_Format2016Classes.tx
    • TB_Format2016Readers.tx
    • TB_Format2017Classes.tx
    • TB_Format2017Readers.tx
    • TB_Format2018Classes.tx
    • TB_Format2018Readers.tx
    • TB_Format2019Classes.tx
    • TB_Format2019Readers.tx
    • TB_Format2020Classes.tx
    • TB_Format2020Readers.tx
    • TB_Format2021Classes.tx
    • TB_Format2021Readers.tx
    • TB_Format2022Classes.tx
    • TB_Format2022Readers.tx
    • TB_Format2022Writers.tx
    • TB_FormatCommonClasses.tx
    • TB_FormatCommonReaders.tx
    • TB_Geometry.tx
    • TB_GeometryUtils.tx
    • TB_HostObj.tx
    • TB_Loader.tx
    • TB_LoaderBase.tx
    • TB_MEP.tx
    • TB_Main.tx
    • TB_ModelerGeometry.tx
    • TB_Rebar.tx
    • TB_StairsRamp.tx
    • TB_Structural.tx
    • TD_AssetXMLParser.tx
  • Checksum.txt
  • All CSV/*.csv files:
    • AreaSpaceTypes.csv
    • BuiltInCategories.csv
    • BuiltInCircuitNamingSchemes.csv
    • BuiltInParameterGroups.csv
    • BuiltInParameters.csv
    • CableTrayShapeTypes.csv
    • ColorSchemeMessages.csv
    • CurveElemNameTypes.csv
    • FamilyNames.csv
    • OmniClasses.csv
    • ParameterTypes.csv
    • ParameterValues.csv
    • PipeJointTypes.csv
    • Specs.csv
    • Symbols.csv
    • SystemTypes.csv
    • Units.csv

TableToPDF

TableToPDF is a free add-on to HOOPS Publish, dedicated to the creation of tables in PDF documents.

TableToPDF uses third-party libraries that require LGPL conformance for distribution. TableToPDF can be downloaded from the TableToPDF download page. TableToPDF binaries must be redistributed in the same folder as HOOPS Publish binaries.

Distributing your application for macOS

On macOS, HOOPS Exchange is distributed in one dynamic library file, libA3DLIBS-VERSION.dylib (and a symbolic link to it: libA3DLIBS.dylib).

Distributing your application for Android

On Android, HOOPS Exchange is distributed in one dynamic library file, libA3DLIBS-VERSION.so (and a symbolic link to it: libA3DLIBS.so).

Distributing your application for iOS

HOOPS Exchange for iOS is provided as a static library. Thus no binary is required to be distributed with your application.

top_level:2