Update of title page of documentation (overview)
[occt.git] / dox / overview / overview.md
1 \feffOverview {#mainpage}
2 ========
3
4 @tableofcontents
5
6 @htmlonly<center>@endhtmlonly 
7 @figure{/resources/occt_logo.png}
8 @htmlonly</center>@endhtmlonly
9
10 @section OCCT_OVW_SECTION_1 Welcome
11
12 Welcome to Open CASCADE Technology (OCCT), a software development platform 
13 providing services for 3D surface and solid modeling, CAD data exchange, and 
14 visualization. Most of OCCT functionality is available in the form of C++ 
15 libraries. OCCT can be best applied in development of software dealing with 3D 
16 modeling (CAD), manufacturing / measuring (CAM) or numerical simulation (CAE).
17
18 @section OCCT_OVW_SECTION_2 Copyrights
19
20 Open CASCADE Technology and all materials, including this documentation, is 
21 Copyright (c) 1999-2017 by OPEN CASCADE S.A.S. All rights reserved.
22
23 @htmlonly<center>@endhtmlonly
24 https://www.opencascade.com
25 @figure{/resources/occ_logo.png}
26 @htmlonly</center>@endhtmlonly
27
28  License
29 --------
30
31 Open CASCADE Technology is free software; you can redistribute it and / or 
32 modify it under the terms of the 
33 @ref license_lgpl_21 "GNU Lesser General Public License (LGPL) version 2.1", 
34 with additional @ref occt_lgpl_exception "exception".
35
36 Alternatively, Open CASCADE Technology may be used under the terms of Open 
37 CASCADE commercial license or contractual agreement.
38
39 Note that Open CASCADE Technology is provided on an "AS IS" basis, WITHOUT 
40 WARRANTY OF ANY KIND. The entire risk related to any use of the OCCT code and 
41 materials is on you. See the @ref occt_public_license "license" text for formal 
42 disclaimer.
43
44  Trademark information
45 ----------------------
46
47 You are hereby informed that all software is a property of its respective authors and is protected by 
48 international and domestic laws on intellectual property and trademarks. 
49 Should you need further information, please directly contact the authors.
50
51 **CAS.CADE** and **Open CASCADE** are registered trademarks of 
52 OPEN CASCADE S.A.S.
53
54 **Linux** is a registered trademark of Linus Torvalds.
55
56 **Windows** is a registered trademark of Microsoft Corporation in the United States and other countries.
57
58 **Mac** and the Mac logo are trademarks of Apple Inc., registered in the U.S. and other countries.
59
60  Acknowledgments
61 -----------------
62
63 The following parties are acknowledged for producing tools which are used within 
64 Open CASCADE Technology libraries or for release preparation.
65
66 You are hereby informed that all rights to the software listed below belong to its respective 
67 authors and such software may not be freely available and/or be free of charge for any kind 
68 of use or purpose. We strongly recommend that you carefully read the license of these products 
69 and, in case you need any further information, directly contact their authors.
70
71 **Qt** is a cross-platform application framework that is widely used for developing application software 
72 with graphical user interface (GUI). Qt is free and open source software distributed under 
73 the terms of the GNU Lesser General Public License. In OCCT Qt is used for programming samples. 
74 If you need further information on Qt, please, refer to Qt Homepage (https://www.qt.io/)
75
76 **Tcl** is a high-level programming language. Tk is a graphical user interface (GUI) toolkit, 
77 with buttons, menus, listboxes, scrollbars, and so on. Taken together Tcl and Tk provide a solution 
78 to develop cross-platform graphical user interfaces with a native look and feel. Tcl/Tk is under copyright by 
79 Scriptics Corp., Sun Microsystems, and other companies. However, Tcl/Tk is an open source, and 
80 the copyright allows you to use, modify, and redistribute Tcl/Tk for any purpose, without an 
81 explicit license agreement and without paying any license fees or royalties. 
82 To use Tcl/Tk, please refer to the Licensing Terms (https://www.tcl.tk/software/tcltk/license.html).
83
84 **GL2PS** is developed by Christophe Geuzaine and others. It is optionally used by OCCT to
85 export content of OpenGL scene to vector graphics formats (PS, PDF, EMF, SVG). 
86 The library is licensed under GL2PS license (http://www.geuz.org/gl2ps/COPYING.GL2PS).
87
88 **FreeType 2** is developed by Antoine Leca, David Turner, Werner Lemberg and others. 
89 It is a software font engine that is designed to be small, efficient, highly customizable and 
90 portable while capable of producing high-quality output (glyph images). This product 
91 can be used in graphic libraries, display servers, font conversion tools, 
92 text image generation tools, and many other products.
93 FreeType 2 is released under two open-source licenses: BSD-like FreeType License and the GPL (https://www.freetype.org/license.html).
94
95 **Intel(R) Threading Building Blocks (TBB)** offers a rich and complete approach to expressing parallelism in a C++ program. 
96 It is a library that helps you to take advantage of multi-core processor performance without having to be a threading expert. 
97 Threading Building Blocks is not just a threads-replacement library. It represents a higher-level, task-based parallelism that 
98 abstracts platform details and threading mechanisms for scalability and performance. 
99 TBB version 2017 is available under Apache 2.0 license, while older versions 
100 until 4.4 are available under GPLv2 license with the runtime exception (https://www.threadingbuildingblocks.org).
101
102 **OpenGL** is an industry standard API for 3D graphics used by OCCT for 
103 implementation of 3D viewer. OpenGL specification is developed by the
104 Khronos group, https://www.khronos.org/opengl/. OCCT code includes header 
105 file *glext.h* obtained from Khronos web site.
106
107 **VTK** -- The **Visualization Toolkit (VTK)** is an open-source, freely available software system for 3D computer graphics, image processing and visualization. OCCT VIS component provides adaptation functionality for visualization of OCCT topological shapes by means of VTK library. If you need further information on VTK, please, refer to VTK Homepage http://www.vtk.org/.
108
109 **Doxygen** developed by Dimitri van Heesch is open source documentation system for 
110 C++, C, Java, Objective-C, Python, IDL, PHP and C#. This product is used in Open CASCADE Technology 
111 for automatic creation of Technical Documentation from C++ header files. 
112 If you need further information on Doxygen, please refer to https://www.stack.nl/~dimitri/doxygen/index.html.
113
114 **Graphviz** is open source graph visualization software developed by John Ellson, Emden Gansner, Yifan Hu and Arif Bilgin. 
115 Graph visualization is representiation of structured information as diagrams of abstract graphs and networks. 
116 This product is used together with Doxygen in Open CASCADE Technology for automatic creation of Technical Documentation 
117 (generation of dependency graphs). Current versions of Graphviz are licensed on an open source 
118 basis under The Eclipse Public License (EPL) (http://www.graphviz.org/License.php).
119
120 **Inno Setup** is a free script-driven installation system created in CodeGear Delphi by Jordan Russell. 
121 In OCCT Inno Setup is used to create Installation Wizard on Windows. 
122 It is licensed under Inno Setup License (http://www.jrsoftware.org/files/is/license.txt).
123
124 **FreeImage** is an Open Source library supporting popular graphics image formats, such as PNG, BMP, JPEG, TIFF, 
125 and others used by multimedia applications. This library is developed by HervĂ© Drolon and Floris van den Berg. 
126 FreeImage is easy to use, fast, multithreading safe, compatible with all 32-bit or 64-bit versions of Windows, 
127 and cross-platform (works both with Linux and Mac OS X). FreeImage is optionally used by OCCT to work
128 with images, on conditions of the FreeImage Public License (FIPL) (http://freeimage.sourceforge.net/freeimage-license.txt).
129
130 **CMake** is an open-source, cross-platform family of tools designed to build, test and package software. CMake is used to control the software compilation process using simple platform and compiler independent configuration files, and generate native makefiles and workspaces that can be used in the compiler environment of your choice. 
131 OCCT uses CMake as a build system. CMake is available under BSD 3-Clause license. See more at https://cmake.org/
132
133 **Cotire** (compile time reducer) is a CMake module that speeds up the build process of CMake based build systems 
134 by fully automating techniques as precompiled header usage and single compilation unit builds for C and C++.
135 Cotire is included in OCCT repository and used optionally by OCCT CMake scripts to accelerate builds by use of precompiled headers.
136 Cotire is licensed under the MIT license (https://github.com/sakra/cotire/blob/master/license).
137
138 **FFmpeg** is an Open Source framework supporting various image, video and audio codecs.
139 FFmpeg is optionally used by OCCT for video recording, on LGPL conditions (https://www.ffmpeg.org/legal.html).
140
141 **MikTEX** is up-to-date implementation of TeX/LaTeX and related programs for Windows. It is used 
142 for generation of User and Developer Guides in PDF format. See https://miktex.org for information
143 on this tool.
144
145 Adobe Systems, Inc. provides **Adobe Reader**, which can be used to view files in Portable Document Format (PDF). 
146
147 @section OCCT_OVW_SECTION_3 Documentation
148
149 OCCT documentation is provided in several forms:
150
151 - This overview provides general description of OCCT structure, functionality, modules, and features. 
152   It is available in HTML format (generated by Doxygen) and includes User and Developer Guides.
153   The sources of this documentation are contained in **dox** subdirectory of OCCT sources 
154   (plain text format is used, with mixed MarkDown / Doxygen syntax mark-up).
155
156 - User and Developer Guides describing in details OCCT modules and development tools are also available in 
157   Adobe Portable Document Format (PDF). To read this format, you need Adobe Acrobat Reader, 
158   which is a freeware and can be downloaded from the Adobe site. 
159
160 - Full reference documentation covering all OCCT classes generated automatically by Doxygen 
161   software is provided in HTML format. 
162   Reference documentation is presented in **Modules --> Toolkits --> Packages --> Classes** 
163   logic structure with cross-references to all OCCT classes and complete in-browser search by all classes.
164
165 See @ref occt_dev_guides__documentation "OCCT Documentation Guide" for details on OCCT documentation system.
166
167 **Generation of HTML documentation**
168
169 To generate HTML documentation from sources contained in *dox* subdirectory, 
170 you need to have Tcl and Doxygen 1.8.5 (or above) installed on your system.
171
172 Use script **gendoc** (batch file on Windows, shell script on Linux / Mac OSX) to generate documentation.
173
174 To generate Overview documentation:
175
176     cmd> gendoc -overview
177
178 To generate Reference manual:
179
180     cmd> gendoc -refman
181
182 Run this command without arguments to get help on supported options.
183
184 @section OCCT_OVW_SECTION_5 Requirements
185
186 Open CASCADE Technology is designed to be highly portable and is known to 
187 work on wide range of platforms. 
188 Current version is officially certified on Windows (IA-32 and x86-64), 
189 Linux (x86-64), OS X / macOS (x86-64), Android (armv7 and x86), and 
190 iOS (armv7, arm64) platforms. 
191
192 The tables below describe the recommended software configurations
193 for which OCCT is certified to work.
194
195 @subsection overview_req_cpp C++ Compiler / IDE
196
197 | OS        | Compiler |
198 | --------- | ----------- |
199 | Windows   | Microsoft Visual Studio: 2010 SP1<sup>1</sup>, 2012 Update 4, 2013 Update 5, 2015, 2017 <br> Intel C++ Composer XE 2013 SP1 <br> GCC 4.3+ (Mingw-w64)|
200 | Linux     | GNU gcc 4.3+ <br> LLVM CLang 3.6+ |
201 | OS X      | XCode 6 or newer |
202 | Android   | NDK r10, GNU gcc 4.8 or newer |
203
204 1) VC++ 10 64-bit is used for regular testing and for building 
205   binary package of official release of OCCT on Windows.
206
207 @subsection overview_req_libs Third-party libraries
208
209 | Component | Requirement |
210 | --------- | ----------- |
211 | Graphic library | OpenGL 3.3+, OpenGL ES 2.0+ <br> Direct3D 9 |
212 | Qt (for samples and demos) | Desktop: Qt 4.8.6+ https://www.qt.io/download/ <br> Android: Qt 5.3.2+ https://www.qt.io/download/ |
213 | TCL (for testing tools)    | Tcl/Tk 8.6.3+ https://www.tcl.tk/software/tcltk/download.html <br> or ActiveTcl 8.6 https://www.activestate.com/activetcl/downloads (for Windows)| 
214 | Freetype (for text rendering) | FreeType 2.4.11-2.5.5 https://sourceforge.net/projects/freetype/files/ |
215 | FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.17.0+ https://sourceforge.net/projects/freeimage/files |
216 | FFmpeg (optional, for video recording) | FFmpeg 3.1+ https://www.ffmpeg.org/download.html |
217 | gl2ps (optional, for export contents of OCCT viewer to vector formats) | gl2ps-1.3.8+  http://geuz.org/gl2ps/ |
218 | Intel TBB (optional, for multithreaded algorithms) | TBB 4.x or 5.x https://www.threadingbuildingblocks.org/ |
219 | VTK (for VTK Integration Services | VTK 6.1+ http://www.vtk.org/download/ |
220 | Doxygen (optional for building documentation) | Doxygen 1.8.5+ https://www.stack.nl/~dimitri/doxygen/download.html |
221
222 @subsection overview_req_hw Hardware
223
224 | Component | Requirement |
225 | --------- | ----------- |
226 | Minimum memory    | 512 MB, 1 GB recommended |
227 | Free disk space (complete installation) | 600 MB approx. |
228
229 On desktop, 3D viewer for optimal performance requires graphics processing unit (GPU) supporting OpenGL 3.3 or above. 
230 Ray tracing requires OpenGL 4.0+ or OpenGL 3.3+ with *GL_ARB_texture_buffer_object_rgb32* extension.
231 Textures within ray tracing will be available only when *GL_ARB_bindless_texture extension* is provided by driver.
232
233 On mobile platforms, OpenGL ES 2.0+ is required for 3D viewer (OpenGL ES 3.1+ is recommended).
234 The ray tracing is not yet available on mobile platforms.
235 Some old hardware might be unable to execute complex GLSL programs (e.g. with high number of light sources, clipping planes).
236
237 OCCT 3D Viewer, in general, supports wide range of graphics hardware - from very old to new.
238 Therefore, if you observe some unexpected visual issues - first check for OpenGL driver update (or firmware update in case of mobile platforms);
239 but beware that driver update might also come with new bugs.
240 Don't forget to report these bugs to vendors.
241
242 @section OCCT_OVW_SECTION_4 Installation
243
244 In most cases you need to rebuild OCCT on your platform (OS, compiler) before
245 using it in your project, to ensure binary compatibility.
246 See @ref occt_dev_guides__building for instructions on
247 building OCCT from sources on supported platforms.
248
249 @subsection OCCT_OVW_SECTION_4_1 Using Windows installer
250
251 On Windows Open CASCADE Technology can be installed with binaries precompiled by 
252 Visual C++ 2010 with installation procedure.
253
254 **Recommendation:**
255
256 If you have a previous version of OCCT installed on your station, 
257 and you do not plan to use it along with the new version, you might want to uninstall 
258 the previous version (using Control Panel, Add/Remove Programs) before 
259 the installation of this new version, to avoid possible problems 
260 (conflict of system variables, paths, etc).
261
262 **Attention:** For full installation OCCT requires approximately 650 Mb of disk space, 
263 but during the installation process you will need 1,2 Gb of free disk space.
264
265 OCCT installation with reference documentation requires 1,4 Gb on disk.
266
267   * Download the OCCT installer from OPEN CASCADE web site using the link. you have been provided
268   * Launch the installer and follow the instructions.
269
270 The includes and binaries of third-party libraries necessary for building and launching 
271 OCCT are included into binary distribution (built with Visual C++ 2010). 
272 When the installation is complete, you will find the directories for 3rd party products 
273 (some might be absent in case of custom installation) and the main **OCCT** directory:
274
275 @figure{/overview/images/overview_3rdparty.png}
276
277 The contents of the OCCT-7.0.0 directory (called further "OCCT root", or $CASROOT) are as follows:
278
279 @figure{/overview/images/overview_installation.png, "The directory tree"}
280
281   * **adm**   This folder contains administration files, which allow rebuilding OCCT;
282   * **adm/cmake**  This folder contains files of CMake building procedure;
283   * **adm/msvc**  This folder contains Visual Studio projects for Visual C++  2005, 2008, 2010, 2012 and 2013 which allow rebuilding OCCT under Windows platform in 32 and 64-bit mode;
284   * **data**  This folder contains CAD files in different formats, which can be used to test the OCCT functionality;
285   * **doc**  This folder contains OCCT documentation in HTML and PDF format;
286   * **dox**  This folder contains sources of OCCT documentation in plain text (MarkDown) format;
287   * **inc**  This folder contains copies of all OCCT header files;
288   * **samples**  This folder contains sample applications.
289   * **src**  This folder contains OCCT source files. They are organized in folders, one per development unit;
290   * **tests**  This folder contains scripts for OCCT testing.
291   * **win64/vc10**  This folder contains executable and library files built in optimize mode for Windows platform by Visual C++  2010;
292
293 @section OCCT_OVW_SECTION_4_2 Environment Variables
294
295 To run any Open CASCADE Technology application you need to set the environment variables.
296
297 ### On Windows
298
299 You can define the environment variables with env.bat script located in the 
300 $CASROOT folder. This script accepts two arguments to be used: 
301 the version of Visual Studio (vc8 -- vc12) and the architecture (win32 or win64).
302
303 The additional environment settings necessary for compiling OCCT libraries and samples 
304 by Microsoft Visual Studio can be set using script custom.bat located in the same folder. 
305 You might need to edit this script to correct the paths to third-party libraries 
306 if they are installed on your system in a non-default location.
307
308 Script msvc.bat can be used with the same arguments for immediate launch of Visual Studio for (re)compiling OCCT.
309
310 ### On Unix
311
312
313   If OCCT was built by Code::Blocks, you can define the environment variables with env_cbp.sh or custom_cbp.sh script.
314
315   If OCCT was built by Automake, you can define the environment variables with env_amk.sh or custom_amk.sh script.
316
317 The scripts are located in the OCCT root folder.
318
319  
320 ### Description of system variables:
321
322   * **CASROOT** is used to define the root directory of Open CASCADE Technology;
323   * **PATH** is required to define the path to OCCT binaries and 3rdparty folder;
324   * **LD_LIBRARY_PATH** is required to define the path to OCCT libraries (on UNIX platforms only);
325   * **MMGT_OPT** (optional) if set to 1, the memory manager performs optimizations as described below; if set to 2, 
326     Intel (R) TBB optimized memory manager is used; if 0 (default), every memory block is allocated 
327     in C memory heap directly (via malloc() and free() functions). 
328     In the latter case, all other options starting with *MMGT*, except MMGT_CLEAR, are ignored;
329   * **MMGT_CLEAR** (optional) if set to 1 (default), every allocated memory block is cleared by zeros; 
330     if set to 0, memory block is returned as it is;
331   * **MMGT_CELLSIZE** (optional) defines the maximal size of blocks allocated in large pools of memory. Default is 200;
332   * **MMGT_NBPAGES** (optional) defines the size of memory chunks allocated for small blocks in pages 
333     (operating-system dependent). Default is 10000;
334   * **MMGT_THRESHOLD** (optional) defines the maximal size of blocks that are recycled internally 
335     instead of being returned to the heap. Default is 40000;
336   * **MMGT_MMAP** (optional) when set to 1 (default), large memory blocks are allocated using 
337     memory mapping functions of the operating system; if set to 0, 
338     they will be allocated in the C heap by malloc();
339   * **CSF_LANGUAGE** (optional) defines default language of messages;
340   * **CSF_DEBUG** (optional, Windows only): if defined then a diagnostic message is displayed in case of an exception;
341   * **CSF_DEBUG_BOP** (optional): if defined then it should specify directory where diagnostic data on problems occured in Boolean operations will be saved;
342   * **CSF_MDTVTexturesDirectory** defines the directory for available textures when using texture mapping;
343   * **CSF_ShadersDirectory** (optional) defines the directory for GLSL programs for Ray Tracing renderer (embedded resources are used when variable is undefined);
344   * **CSF_SHMessage** (optional) defines the path to the messages file for *ShapeHealing*;
345   * **CSF_XSMessage** (optional) defines the path to the messages file for **STEP** and **IGES** translators;
346   * **CSF_StandardDefaults**, **CSF_StandardLiteDefaults*, **CSF_XCAFDefaults**, and **CSF_PluginDefaults** define paths to directory where configuration files for OCAF persistence are located (required for open/save operations with OCAF documents);
347   * **CSF_IGESDefaults** and **CSF_STEPDefaults** (optional) define paths to directory where resource files of **IGES** and **STEP** translators are located;
348   * **CSF_XmlOcafResource** is required in order to set the path to **XSD** resources, which defines XML grammar.
349   * **CSF_MIGRATION_TYPES** is required in order to read documents that contain old data types, such as *TDataStd_Shape*;
350
351 @section OCCT_OVW_SECTION_7 Getting Started
352
353 @subsection OCCT_OVW_SECTION_7_1 Draw Test Harness
354
355 Draw is a command interpreter based on TCL and a graphical system used for testing and demonstrating OCCT modeling libraries.
356
357 Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
358
359 @figure{/overview/images/overview_draw.png}
360
361 Scripts can be written to customize Draw and perform tests. 
362 New types of objects and new commands can be added using C++ programming language.
363
364 Draw contains:
365
366   * A command interpreter based on TCL command language.
367   * A 2D an 3D graphic viewer with support of operations such as zoom, pan, rotation and full-screen views.
368   * An optional set of geometric commands to create and modify curves and surfaces and to use OCCT geometry algorithms.
369   * A set of topological commands to create and modify BRep shapes and to use OCCT topology algorithms.
370   * A set of graphic commands for view and display operations including Mesh Visualization Service.
371   * A set of Application framework commands for handling of files and attributes.
372   * A set of Data Exchange commands for translation of files from various formats (IGES,STEP) into OCCT shapes.
373   * A set of Shape Healing commands: check of overlapping edges, approximation of a shape to BSpline, etc.  
374
375 You can add new custom test harness commands to Draw in order to test 
376 or demonstrate a new functionality, which you are developing.
377
378 Currently DRAW Test Harness is a single executable called *DRAWEXE*.
379
380 Commands grouped in toolkits can be loaded at run-time thereby implementing dynamically loaded plug-ins. 
381 Thus you can work only with the commands that suit your needs adding 
382 the commands dynamically without leaving the Test Harness session.
383
384 Declaration of available plug-ins is done through special resource file(s). 
385 The *pload* command loads the plug-in in accordance with 
386 the specified resource file and activates the commands implemented in the plug-in.
387
388 The whole process of using the plug-in mechanism as well as the instructions for extending Test Harness is described in the @ref occt_user_guides__test_harness.
389
390 Draw Test Harness provides an environment for OCCT automated testing system. 
391 Please, consult its @ref occt_dev_guides__tests "Automated Testing System" for details.
392
393 Remarks:
394
395 * The DRAWEXE executable is delivered with the installation procedure on Windows platform only.
396 * To start it, launch DRAWEXE executable from Open CASCADE Technology/Draw Test Harness item of the Start\\Programs menu.
397
398 @subsection OCCT_OVW_SECTION_7_2 Experimenting with Draw Test Harness
399
400  Running Draw
401 ------------
402
403 **On Linux:**
404
405 1. If OCCT was built by Code::Blocks  use <i>$CASROOT/draw_cbp.sh</i> file to launch *DRAWEXE* executable;
406 2. If OCCT was built by Automake    use <i>$CASROOT/draw_amk.sh</i> file to launch *DRAWEXE* executable;
407
408 Draw[1]> prompt appears in the command window
409
410 Type *pload ALL*
411
412 **On Windows:**
413
414 Launch Draw executable from Open CASCADE Technology\\Test Harness\\Draw Test Harness 
415 item of the Start\\Programs menu or Use <i>$CASROOT\\draw.bat</i> file to launch *DRAWEXE* executable.
416
417 Draw[1]> prompt appears in the command window
418
419 Type pload ALL
420
421 **Creating your first geometric objects**
422
423 1. In the command window, type *axo* to create an axonometric view
424 2. Type *box b -10 -10 -10 20 20 20* to create a cube *b* of size 20, parallel to the X Y Z axis and centered on the origin. The cube will be displayed in the axonometric view in wireframe mode.
425 3. Type *fit* to fill the viewer with the cube
426 4. Type *pcylinder c 2 30* to create a cylinder *c* of radius 2 and height 30. The cylinder will be displayed in addition to the cube
427
428 **Manipulating the view**
429
430 1. Type *clear* to erase the view
431 2. Type *donly c* to display the cylinder only
432 3. Type *donly b* to display the cube only
433 4. Type *hlr hlr b* to display the cube in the hidden line removal mode
434
435 **Running demonstration files**
436
437 1. Type *cd ../..* to return to the root directory
438 2. Type *cd samples/tcl* to reach the *DrawResources* directory
439 3. Type *source \<demo_file\>* to run the demonstration file provided with Open CASCADE. The following demonstration files are available:
440   * DataExchangeDemo.tcl: demonstrates sample sequence of operations with writing and reading IGES file
441   * ModelingDemo.tcl: demonstrates creation of simple shape and displaying it in HLR mode
442   * VisualizationDemo.tcl: demonstrates use of 3d viewer
443   * cad.tcl: creates solid shape looking like abbreviation "CAD"
444   * bottle.tcl: creates bottle as in OCCT Tutorial
445   * drill.tcl: creates twist drill bit shape
446   * cutter.tcl: creates milling cutter shape
447   * xde.tcl: demonstrates creation of simple assembly in XDE
448   * materials.tcl: demonstrates visual properties of materials supported by 3d viewer
449   * raytrace.tcl: demonstrates use of ray tracing display in 3d viewer
450   * dimensions.tcl: demonstrates use of dimensions, clipping, and capping in 3d viewer
451
452 **Getting Help**
453
454 1. Type *help* to see all available commands
455 2. Type *help \<command_name\>* to find out the arguments for a given command
456
457 @subsection OCCT_OVW_SECTION_7_3 Programming Samples
458
459 @subsubsection OCCT_OVW_SECTION_7_3_1 MFC 
460
461 Visual C++ programming samples containing 10 Visual C++ projects 
462 illustrating how to use a particular module or functionality.
463
464 The list of MFC samples:
465
466   * Geometry
467   * Modeling
468   * Viewer2d
469   * Viewer3d
470   * ImportExport
471   * Ocaf
472   * Triangulation
473   * HLR
474   * Animation
475   * Convert
476
477 @figure{/overview/images/overview_mvc.png}
478
479 **Remarks:**
480
481   * MFC samples are available only on Windows platform;
482   * To start a sample use Open CASCADE Technology\\Samples\\Mfc\\ item of the Start\\Programs menu;
483   * Read carefully readme.txt to learn about launching and compilation options.
484
485 See \subpage samples_mfc_standard "Readme" for details.
486
487 @subsubsection OCCT_OVW_SECTION_7_3_2 Qt
488
489 OCCT contains three samples based on Qt application framework
490
491  Import Export
492 -------------
493
494  Import Export programming sample contains 3D Viewer and Import / Export functionality.
495
496 @figure{/overview/images/overview_qt.png}
497
498  Tutorial
499 ---------
500
501 The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object. 
502 The purpose of the tutorial is not to explain all OCCT classes but 
503 to help start thinking in terms of the Open CASCADE Technology.
504
505 This tutorial assumes that  the user has experience in using and setting up C++. 
506 From the viewpoint of programming, Open CASCADE Technology is designed 
507 to enhance user's C++ tools with high performance modeling classes, methods and functions. 
508 The combination of these resources allows creating substantial applications.
509
510 **See also:** @ref occt__tutorial "OCCT Tutorial" 
511
512 **Remarks:**
513
514   * Qt samples are available on all supported platforms;
515   * To start a sample on Windows use Open CASCADE Technology\\Samples\\Qt\\ item of the Start\\Programs menu.
516
517 @subsubsection OCCT_OVW_SECTION_7_3_3 C#
518
519 C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality into .NET applications (using Windows Forms and WPF front ends).
520
521 @figure{/overview/images/overview_c__ie.png}
522
523 Import:
524
525   * BRep
526   * Iges
527   * Step
528
529 Export: 
530
531   * Brep
532   * Iges
533   * Step
534   * Stl
535   * Vrml
536
537 See \subpage samples_csharp_occt "C# sample Readme" for details.
538
539 There is also another C# example with the same functionality, which demonstrates the integration of Direct3D Viewer into .NET applications using WPF front end.
540
541 See \subpage samples_csharp_direct3d "Direct3D C# sample Readme" for details.
542
543 @subsubsection OCCT_OVW_SECTION_7_3_4 Android
544
545 There are two samples are representing usage OCCT framework on Android mobile platform. They represent an OCCT-based 3D-viewer with CAD import support in formats BREP, STEP and IGES: jniviewer (java) and AndroidQt (qt+qml)
546
547 jniviewer
548 @figure{/overview/images/samples_java_android_occt.jpg}
549 Java -- See \subpage samples_java_android_occt "Android Java sample Readme" for details.
550
551 AndroidQt
552 @figure{/overview/images/samples_qml_android_occt.jpg}
553 Qt -- See \subpage samples_qml_android_occt "Android Qt sample Readme" for details.
554
555 @subsubsection OCCT_OVW_SECTION_7_3_5 iOS
556
557 There is a sample demonstrating usage of OCCT on iOS with Apple UIKit framework.
558
559 @figure{/overview/images/sample_ios_uikit.png}
560
561 See \subpage occt_samples_ios_uikit "iOS sample Readme" for details.