.. Sphinx Project Template documentation master file, created by
   sphinx-quickstart on Fri Dec 18 10:56:01 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.


|ProductDocName|
================

HOOPS Communicator is a powerful SDK for advanced web-based engineering applications, and represents the web-development component of the HOOPS Web Platform. Using HOOPS Communicator, you can build a web application that serves a 3D model in a web browser.

HOOPS Communicator can load a number of model formats natively. It is also interoperable with our model loading toolkit, HOOPS Exchange, which greatly increases the number of industry-standard formats that can be imported. It can also convert models from one format to another.

In this document, we provide tutorials, sample code, API documentation, and a written guide. Direct engineering support to get your application running and shipping quickly is also available.

If you are new to HOOPS Communicator, we recommend reading the Technical Overview for a taste of our product's capabilities. When you are ready to begin using the API, the Programming Guide is a good place to start.  

HOOPS Communicator works with Javascript and Typescript, and is supported on Windows, Mac, Linux, and mobile devices (see our Supported Platforms page for details).

.. toctree::
   :maxdepth: 1
   :caption: Getting Started
   :hidden:

   overview/technical-overview
   overview/quickstart
   overview/supported-formats
   overview/supported-platforms
   
   
.. toctree::
   :maxdepth: 1
   :caption: Tutorials
   :hidden:

   tutorials/environment-setup
   tutorials/basic-app/introduction
   tutorials/additive-manufacturing/intro
   tutorials/inventory-management/intro
   tutorials/product-configurator/intro
   tutorials/build-streaming-service/introduction

.. toctree::
   :maxdepth: 2
   :caption: Programming Guide
   :hidden:

   prog_guide/docker-support
   prog_guide/viewing/overview
   prog_guide/data_import/overview
   prog_guide/servers/overview
   prog_guide/mcad/overview
   prog_guide/bim/overview
   
.. toctree::
   :maxdepth: 1
   :caption: API References
   :hidden:

   Web Viewer API Reference <api_ref/viewing/index>
   Web Viewer Deprecated API <api_ref/viewing/deprecated>
   Data Import <api_ref/data_import/introduction>
   Servers <api_ref/servers/introduction>
   
.. toctree::
   :maxdepth: 1
   :caption: Additional Resources
   :hidden:
   
   Release Notes <release_notes/index> 
   Public Roadmap <https://techsoft3d.atlassian.net/wiki/spaces/KBHC/pages/1178830735/HOOPS+Communicator+Public+Roadmap>   
   overview/faqs
   overview/license   
   overview/acknowledgements
   overview/package-description
   Downloads <https://developer.techsoft3d.com/hoops/communicator/downloads/latest/>
   Archives <archives>


.. toctree::
   :maxdepth: 1
   :caption: Support
   :hidden:
   
   Developer Support <https://support.techsoft3d.com/>
   Knowledge Base <https://techsoft3d.atlassian.net/servicedesk/customer/portals>
   Community Forum <https://forum.techsoft3d.com/>
   contact_us


.. container:: linkbox-grid-container

   .. container:: linkbox

      .. rubric:: Getting Started
         :class: title

      .. container:: tagline

            Prerequisites and quickstart walkthrough for new developers

      * :doc:`Technical Overview <overview/technical-overview>`
      * :doc:`Quickstart <overview/quickstart>`


   .. container:: linkbox

      .. rubric:: Basic App
         :class: title

      .. container:: tagline

            Learn to build a basic application using HOOPS Web Viewer and HOOPS Server

      * :doc:`Setup your environment <tutorials/environment-setup>`
      * :doc:`Basic Application <tutorials/basic-app/introduction>`


   .. container:: linkbox

      .. rubric:: Platforms and Formats
         :class: title

      .. container:: tagline

            Information about supported platforms and file formats

      * :doc:`Supported Platforms <overview/supported-platforms>`
      * :doc:`Supported Formats <overview/supported-formats>`


   .. container:: linkbox

      .. rubric:: Programming Guide
         :class: title

      .. container:: tagline

            Complete guide to HOOPS Communicator concepts

      * :doc:`Viewing <prog_guide/viewing/overview>`
      * :doc:`Data Import <prog_guide/data_import/overview>`
      * :doc:`Servers <prog_guide/servers/overview>`
      * :doc:`HC for MCAD <prog_guide/mcad/overview>`
      * :doc:`HC for BIM <prog_guide/bim/overview>`
	  
	  
   .. container:: linkbox

      .. rubric:: API Reference
         :class: title

      .. container:: tagline

            Detailed information about the HOOPS Communicator APIs

      * :doc:`Web Viewer <api_ref/viewing/modules/Communicator>`
      * :doc:`Data Import <api_ref/data_import/introduction>`
      * :doc:`Servers <api_ref/servers/introduction>`
	  

	  
   .. container:: linkbox

      .. rubric:: Tutorials
         :class: title

      .. container:: tagline

            How to build real-world applications

      * :doc:`Setup your environment <tutorials/environment-setup>`
      * :doc:`Additive Manugacturing <tutorials/additive-manufacturing/intro>`
      * :doc:`Inventory Management <tutorials/inventory-management/intro>`
      * :doc:`Product Configurator <tutorials/product-configurator/intro>`
      * :doc:`Building a Streaming Service <tutorials/build-streaming-service/introduction>`

