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