################
Package Contents
################

Package Hierarchy
=================

.. only:: not spatial

	* <hoops_visualize_hps root directory>
			* *bin* (dynamic build resources, sandboxes)
			* *documentation*
			* *fonts*
			* *include*
			* *lib* (static build resources)
			* *packages* (build resources for Hololens)
			* *samples*
				* *<gui>_sandbox*
				* *code*
				* *data* (sample models, images)
				* *cc_exchange* (Windows only)
				* *mfc_sandbox* (Windows only)
				* *qt_sandbox*
				* *wpf_sandbox* (Windows only)
			* *tools* (includes OOC executable for point cloud processing and CodeGen diagnostic tool for troubleshooting)

.. only:: spatial

	* <hoops_visualize_hps root directory>
			* *bin* (dynamic build resources, sandboxes)
			* *documentation*
			* *fonts*
			* *include*
			* *lib* (static build resources)
			* *packages* (build resources for Hololens)
			* *samples*
				* *<gui>_sandbox*
				* *code*
				* *data* (sample models, images)
				* *mfc_sandbox* (Windows only)
				* *qt_sandbox*
				* *wpf_sandbox* (Windows only)
			* *tools* (includes OOC executable for point cloud processing and CodeGen diagnostic tool for troubleshooting)


Library Descriptions
====================

The following C++ libraries are provided with HOOPS Visualize. You only need to include those libraries that your application uses:

.. only:: not spatial

	.. list-table::
		:header-rows: 1
		
		* - Library name
		  - Description
		  - Required?
		* - hps_core
		  - Core Graphics
		  - always
		* - hps_sprk
		  - Supporting classes
		  - when using view hierarchy, or any module listed below
		* - hps_sprk_ops
		  - Standard operators
		  - when using operators
		* - hps_sprk_dwg
		  - Visualize-DWG interface module
		  - when working with DWG files
		* - hps_sprk_exchange
		  - Visualize-Exchange interface module
		  - when using HOOPS Exchange
		* - hps_sprk_exchange_parasolid
		  - Exchange-Parasolid interface module
		  - if using Visualize with Exchange-Parasolid bridge
		* - hps_sprk_hca
		  - HOOPS Communicator Access library
		  - if using Visualize with Communicator Access
		* - hps_sprk_html
		  - HTML export module
		  - when using HTML export functionality
		* - hps_sprk_ooc
		  - Out-of-core module
		  - when using out-of-core functionality
		* - hps_sprk_parasolid
		  - Visualize-Parasolid interface module
		  - when using Parasolid
		* - hps_sprk_publish
		  - Visualize-Publish interface module
		  - when using HOOPS Publish
		* - hps_sprk_sketchup
		  - Visualize-Sketchup interface module
		  - if working with Sketchup models
		  
.. only:: spatial

	.. list-table::
		:header-rows: 1
		
		* - Library name
		  - Description
		  - Required?
		* - hps_core
		  - Core Graphics
		  - always
		* - hps_sprk
		  - Supporting classes
		  - when using view hierarchy, or any module listed below
		* - hps_sprk_ops
		  - Standard operators
		  - when using operators
		* - hps_sprk_dwg
		  - Visualize-DWG interface module
		  - when working with DWG files
		* - hps_sprk_html
		  - HTML export module
		  - when using HTML export functionality
		* - hps_sprk_ooc
		  - Out-of-core module
		  - when using out-of-core functionality
		* - hps_sprk_sketchup
		  - Visualize-Sketchup interface module
		  - if working with Sketchup models


The following libraries are only necessary when using the C# API. Please note that when using C#, the corresponding C++ library is also required.

.. only:: not spatial

	.. list-table::
		:header-rows: 1
		
		* - Library name
		  - Description
		  - Required?
		* - hps_cs_sprk
		  - Supporting classes
		  - when using view hierarchy, or any module listed below
		* - hps_cs_sprk_ops
		  - Standard operator interface
		  - if using C# with operators
		* - hps_cs_sprk_dwg
		  - Visualize-DWG interface module
		  - if using C# with DWG files
		* - hps_cs_sprk_exchange
		  - Exchange interface module
		  - if using C# with Exchange
		* - hps_cs_sprk_exchange_parasolid
		  - Exchange-Parasolid interface module
		  - if using C# with Exchange-Parasolid bridge
		* - hps_cs_sprk_hca
		  - HOOPS Communicator Access library
		  - if using C# with HOOPS Communicator Access
		* - hps_cs_sprk_html
		  - HTML export module
		  - if using C# with HTML output
		* - hps_cs_sprk_ooc
		  - Out-of-core module
		  - if using C# with the out-of-core functionality
		* - hps_cs_sprk_parasolid
		  - Visualize-Parasolid interface module
		  - if using C# with Parasolid
		* - hps_cs_sprk_publish
		  - Visualize-Publish interface module
		  - if using C# with Publish
		* - hps_cs_sprk_sketchup
		  - Visualize-Sketchup interface module
		  - if using C# with Sketchup models			  


.. only:: spatial

	.. list-table::
		:header-rows: 1
		
		* - Library name
		  - Description
		  - Required?
		* - hps_cs_sprk
		  - Supporting classes
		  - when using view hierarchy, or any module listed below
		* - hps_cs_sprk_ops
		  - Standard operator interface
		  - if using C# with operators
		* - hps_cs_sprk_dwg
		  - Visualize-DWG interface module
		  - if using C# with DWG files
		* - hps_cs_sprk_html
		  - HTML export module
		  - if using C# with HTML output
		* - hps_cs_sprk_ooc
		  - Out-of-core module
		  - if using C# with the out-of-core functionality
		* - hps_cs_sprk_sketchup
		  - Visualize-Sketchup interface module
		  - if using C# with Sketchup models	
		  
		  
Miscellaneous Libraries

.. list-table::
	:header-rows: 1
	
	* - Library name
	  - Description
	  - Required?
	* - hps_cpp_cs_bridge
	  - sample projects module
	  - when running the sample projects
	* - hps_directx11
	  - DirectX drive
	  - if using DirectX
	* - hps_opengl2_mesa
	  - OpenGL Mesa driver
	  - if using OpenGL Mesa


