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