Quickstart
This guide outlines the steps to kickstart your journey with HOOPS Envision for Desktop. It begins with instructions on installing and configuring your license. Next, you’ll learn how to seamlessly integrate the viewer into your preferred UI toolkit, creating a basic application. We’ll then walk you through importing your data into HOOPS Envision for Desktop and progressing to implement additional features.
Installing HOOPS Envision
HOOPS Envision for Desktop is packaged as a .zip archive for Windows and a .tar.gz archive for Linux.
After unzipping the compressed files, you will get the following structure in the installation folder:
- DotNetLibraries: Libraries for the .NET version of HOOPS Envision (debug and release).
- Examples: Example programs for Qt, wxWidgets, WinForms, WPF, MFC and Win32.
- include: Include files for C++ users.
- lib: Libs and DLLs for C++ users (debug and release).
- PlatformIntegration: Source code (C++) helper classes for Qt and wxWidgets users.
- Tutorials: Tutorials presented in this documentation with Tutorial Runners for Qt, MFC and wxWidgets.
- License: Dummy license files. Replace with your own.
- Python: Python modules and example scripts.
- ThirdParty: Third party dependencies.
- DataProviderFramework: Framework for writing data providers
- ResultCalculatorFramework: Framework for writing result calculators
- DataProviderPlugins: Ready to use data provider plugins
License System
HOOPS Envision for Desktop is a licensed software system. In order to use HOOPS Envision for Desktop within your application you will need a valid license. See License System for more information.
Getting Data into HOOPS Envision
There are many ways to get your data into HOOPS Envision for Desktop depending on the nature of the data and the need for your application.
FEA and CFD Data
If you have analysis data (FEA, CFD, etc. with elements and results) you should use the cee::ug::UnstructGridModel. Here there are many
ways of getting your data into HOOPS Envision for Desktop.
- Use the Import CAE Component
If you want to load files from commercial FEA and CFD simulation software systems you can use thecee::imp::cae::DataSourceCae. Please note that this component requires a separate feature in the license key and has additional cost of use. - Create Your Own Data Reader
By deriving fromcee::ug::DataReaderand using thecee::ug::DataSourceReaderyou can easily create a data source that supports your own data. You will then leverage the advanced data management and just-in-time loading of your data, so you can just focus on creating the user interface. See the tutorial UnstructGrid: Create a Custom DataReader to Add Support for Your File Format for an example on how to do this. - Use VTFx Files
If you are able to save your data to VTFx (Envision file format) you can use the built-in data sourcecee::ug::DataSourceVTFxto read your data. - Use a Data Provider
A Data Provider is a plugin for providing CAE data to applications built with Envision SDKs. Use an existing Data Provider to get your data into HOOPS Envision, see Data Provider Plugins. To create a new Data Provider, see the topic Data Provider Framework. - Create by Hand
Finally, you can always build the data model by hand, adding the parts, elements, nodes, results etc. using code. You will then need to make sure that the required data is present before it can be visualized. See the UnstructGrid: Simple Model with Two Triangles and UnstructGrid: A Simple Model with Results tutorials for examples on how to do this.
Geometry Data
If you have geometry based data, you should use the cee::geo::GeometryModel. The Geometry model offers a data
model for geometries containing a large number of parts (grouping of elements, typically with different attributes).
The Geometry model is specifically designed for efficient handling of complex geometries. Here you will need to populate
the model with data and effects manually.
We provide several tutorial for creating geometries:
- Geometry: Create a Geometry Model
- Geometry: Create a Geometry Model with Texture
- Geometry: Create a Geometry Model with Geometric Primitives
Finally, please note that you can combine the different models in a view to create a rich visualization. A view can have as many models as you like of any type.
Sharing Data from HOOPS Envision
Based the Envision VTFx file format, your simulation data can be easily shared using Ceetron Cloud, the Report component and our free viewers.
Ceetron Cloud
With Envision it is easy to add cloud export support to your application. With a single click of a button the users can share the 3D model they are currently showing in your app with the rest of the world. The model can be shown in any modern web browser without installing any software or plug-in.
Envision Viewers
The Export component adds easy sharing of simulation results using the Envision VTFx format. With a few lines of code, you can export exactly what you have on the screen to a compact file that can be shown on almost any platform.
Adding Features to Your Application
The Tutorials and Topics are good places to look for specific information on how to implement a given feature. The Examples entry gives more direct access to the code for easy overview and copy/paste.
A good starting point for FEA type data is the DemoApps provided for Qt and .NET. These are more complete apps that showcase one way of using HOOPS Envision for Desktop.
You find these in the Examples/Qt/QtDemoApp and Examples/WinForms/WinFormsDemoApp folders in the distribution.