Package Description

After installing HOOPS Communicator, the following high-level directories will be created:

  • 3rd_party - Contains a Node installation used by various scripts in the HOOPS Communicator package.

  • authoring - All the components related to authoring of data which can be used by the Web Viewer.

    • converter - Binaries and samples for the HOOPS Converter component. Samples are located in the example folder.

    • libconverter - Libraries for using HOOPS Converter as a library in your application. For a sample implementation, see the converter directory listed previously, and navigate to authoring/converter/example/sample_projects. For more details see the Converter Library Overview guide.

      • bin - This directory contains the libconverter.dll for each supported platform.
      • include - This directory contains the libconverter.h header file.

    • libsc - Libraries and samples for the Stream Cache library. C++/Java libraries and samples are included in the package - see this page for more information.

      • examples - All provided examples for the Stream Cache API.
      • lib - This directory contains the sc.lib for each supported platform.
      • include - This directory contains the sc_store.h header file for the Stream Cache API.
      • java - This directory contains the scj.jar file for the Stream Cache API.
      • javabin - This directory contains the sc_java.dll for each supported platform.

  • documentation - Documentation for HOOPS Communicator.

  • quick_start - Samples used to evaluate HOOPS Communicator, including a shell script that starts a simple development server, allowing you to view the WebViewer samples accessed via index.html. Also included is a shell script for drag-and-drop file conversion with HOOPS Converter.

  • server - All the components related to getting the authoring components working on your server back end, including integration samples.

    • bin/<platform> - Contains sc_server.dll
    • lib/<platform> - Contains sc_server.lib
    • include - Contains sc_server.h

  • tutorials - Libraries used alongside the Tutorials section of the documentation as a guide through several common enginnering workflows associated with the HOOPS Communicator concepts.

    • basic_app - Tutorial focused on building a minimal application with HOOPS Communicator.
    • server_tutorial - Tutorial covering creating, connecting to, and monitoring the Communicator Streaming Service.

  • web_viewer - HOOPS Web Viewer application.

    • demo-app
    • deprecated - Deprecated files used in previous versions of HOOPS Web Viewer
    • examples - Examples that can be viewed when the quick_start server is running. These examples are visible on the localhost, e.g., http://localhost:11180/example_name.html
    • types
    • hoops_web_viewer.mjs
    • engine-wasm.js
    • engine.wasm