0033661: Data Exchange, Step Import - Tessellated GDTs are not imported
[occt.git] / samples / qt / OCCTOverview / ReadMe.md
CommitLineData
3ea347e5 1Qt: OCCT Overview (C++|Qt Widgets) {#samples_qt_overview}
a2176e65 2==========
3
3ea347e5 4The Overview Qt application provides code snippets for basic usage of C++ API of various OCCT functionality.
5The samples are organized in several categories according to relevant module of OCCT:
6
7 * Geometry
8 * Topology
9 * Triangulation
10 * DataExchange
11 * OCAF
12 * Viewer 2d
13 * Viewer 3d
14
15Each sample presents geometry view, C++ code fragment and sample output window.
16This sample is described in the @ref samples__novice_guide "Novice guide" for new users.
17
18@figure{sample_overview_qt.png}
19
a2176e65 201. Contents
21-----------------------
22
23The directory <i> samples/qt/OCCTOverview </i> contains the folders and files of the Qt OCCT Overview application:
24
25* Files **OCCTOverview.pro** and **OCCTOverview0.pro** are Qt project files.
26* File **genproj.bat** to denerate MS Visual Studio project.
27* File **msvc.bat** to run MS Visual Studio project.
28* File **make.sh** to build of the application on Linux.
a110c4a3 29* Files **run.bat** and **run.sh** to run the application.
a2176e65 30* Files **env.bat** and **custom.bat** are called from *genproj.bat*, *msvc.bat*, *run.bat*.
31 File *custom.bat* should be defined by user to provide paths to QT directory and OCCT installation directory (see *custom.bat.template*).
32* **src** and **res** directories provide source and resources files.
33
34The directory <i> samples/OCCTOverview/code </i> contains the source code of samples.
35
362. How to build Qt OCCT Overview application
37---------------------------------
38
39* Edit custom.bat file. It is necessary to define following variables:
40 * **QTDIR** path to where Qt is installed
41 * **CASROOT** path to where Open CASCADE binaries are installed.
42
43* Build the application:
44
45 * On Windows:
46 * Generate project files: `> genproj.bat vc141 win64 Debug`
47 * Launch MS Visual Studio: `> msvc.bat vc141 win64 Debug`
48 * Build the application using MS Visual Studio.
49
50 * On Linux: Launch building of the application by make.sh script
51
523. Running the application
53--------------------------
54
55* On Windows:
56~~~~
57 > run.bat vc141 win64 Debug
58~~~~
59
60* On Linux:
61~~~~
62 > run.sh
63~~~~
64
654. How to use the OCCT Overview application:
66---------------------------------
67
a110c4a3 68* To select a samples category use the *Category* menu.
a2176e65 69* To run concrete sample using the menu to the right of the category menu.
a110c4a3 70* See the source code in the *Sample code* window. Сopy the code if needed.
71* See the sample output in the *Output* window if it exist.
a2176e65 72* Zoom, pan and rotate a geometry in the mail window using the mouse.
73
74See hints how to use the mouse in down hints panel.