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