0024305: New option in BRepOffsetAPI_MakePipeShell algorithm: the swept shell with...
[occt.git] / dox / overview / Overview.md
765b3e07 1Overview {#mainpage}
e5bd0d98 4@tableofcontents
765b3e07 5
e5bd0d98 6@section OCCT_OVW_SECTION_1 Welcome
765b3e07 7
e5bd0d98 8Welcome to Open CASCADE Technology (OCCT), a collection
9of C++ libraries providing services for 3D surface and solid modeling, CAD data
10exchange, and visualization. OCCT can be best applied in development of
11software dealing with 3D modeling (CAD), manufacturing / measuring (CAM) or
12numerical simulation (CAE).
765b3e07 13
e5bd0d98 14@htmlonly<center>@endhtmlonly
765b3e07 16@image html /resources/occt_logo.png
17@image latex /resources/occt_logo.png
765b3e07 18@htmlonly</center>@endhtmlonly
20@section OCCT_OVW_SECTION_2 Copyrights
22Copyright(c) 2001-2013 by OPEN CASCADE S.A.S. All rights reserved.
e5bd0d98 24@htmlonly<center>@endhtmlonly
26@image html /resources/occ_logo.png
27@image latex /resources/occ_logo.png
765b3e07 30 Trademark information
33You are hereby informed that all software is a property of its respective authors and is protected by
34international and domestic laws on intellectual property and trademarks.
35Should you need further information, please directly contact the authors.
37CAS.CADE and Open CASCADE are registered trademarks of OPEN CASCADE S.A.S.
e5bd0d98 39 Acknowledgements
765b3e07 40------------------
42The following parties are acknowledged for producing tools which are used within
43Open CASCADE Technology libraries or for release preparation.
45You are hereby informed that all rights to the software listed below belong to its respective
46authors and such software may not be freely available and/or be free of charge for any kind
47of use or purpose. We strongly recommend that you carefully read the license of these products
48and, in case you need any further information, directly contact their authors.
50**Qt** is a cross-platform application framework that is widely used for developing application software
51with graphical user interface (GUI). Qt is free and open source software distributed under
52the terms of the GNU Lesser General Public License. In OCCT Qt is used for programming samples.
e5bd0d98 53If you need further information on Qt, please, refer to Qt Homepage (http://qt.digia.com).
765b3e07 54
55**Tcl** is a high-level programming language. Tk is a graphical user interface (GUI) toolkit,
56with buttons, menus, listboxes, scrollbars, and so on. Taken together Tcl and Tk provide a solution
57to develop cross-platform graphical user interfaces with a native look and feel. Tcl/Tk is under copyright by
58Scriptics Corp., Sun Microsystems, and other companies. However, Tcl/Tk is an open source, and
59the copyright allows you to use, modify, and redistribute Tcl/Tk for any purpose, without an
60explicit license agreement and without paying any license fees or royalties.
61To use Tcl/Tk, please refer to the Licensing Terms (http://www.tcl.tk/software/tcltk/license.html).
63**Robert Boehne** has developed **GNU Autoconf**, **Automake** and **Libtool** scripts and makefiles
64for the Open CASCADE project http://sourceforge.net/projects/autoopencas/,
65which became an initial groundwork for the build scripts based on respective GNU tools
66(autoconf, automake and libtool) in Open CASCADE Technology version 4.0.
67These scripts are now maintained by the OPEN CASCADE company.
e5bd0d98 69**GL2PS** is developed by Christophe Geuzaine and others. It is optionally used by OCCT to
70export content of OpenGL scene to vector graphics formats (PS, PDF, EMF, SVG).
765b3e07 71The library is licensed under GL2PS LICENSE http://www.geuz.org/gl2ps/COPYING.GL2PS Version 2, November 2003.
73**FreeType 2** is developed by Antoine Leca, David Turner, Werner Lemberg and others.
74It is a software font engine that is designed to be small, efficient, highly customizable and
75portable while capable of producing high-quality output (glyph images). This product
76can be used in graphic libraries, display servers, font conversion tools,
77text image generation tools, and many other products.
79FreeType 2 is released under two open-source licenses: BSD-like FreeType License and the GPL.
81**Intel(R) Threading Building Blocks (TBB)** offers a rich and complete approach to expressing parallelism in a C++ program.
82It is a library that helps you to take advantage of multi-core processor performance without having to be a threading expert.
83Threading Building Blocks is not just a threads-replacement library. It represents a higher-level, task-based parallelism that
84abstracts platform details and threading mechanisms for scalability and performance.
85TBB is available under GPLv2 license with the runtime exception.
e5bd0d98 87Open CASCADE Technology WOK module on Windows also makes use of LGPL-licensed C routines **regexp**
88and **getopt**, taken from GNU C library.
765b3e07 89
e5bd0d98 90**Doxygen** developed by Dimitri van Heesch is open source documentation system for
765b3e07 91C++, C, Java, Objective-C, Python, IDL, PHP and C#. This product is used in Open CASCADE Technology
92for automatic creation of Technical Documentation from C++ header files.
93If you need further information on Doxygen, please refer to http://www.stack.nl/~dimitri/doxygen/index.html.
95**Graphviz** is open source graph visualization software developed by John Ellson, Emden Gansner, Yifan Hu and Arif Bilgin.
96Graph visualization is representiation of structured information as diagrams of abstract graphs and networks.
97This product is used together with Doxygen in Open CASCADE Technology for automatic creation of Technical Documentation
98(generation of dependency graphs). Current versions of Graphviz are licensed on an open source
e5bd0d98 99basis under The Eclipse Public License (EPL) (http://www.graphviz.org/License.php).
765b3e07 100
101**Inno Setup** is a free script-driven installation system created in CodeGear Delphi by Jordan Russell.
102In OCCT Inno Setup is used to create Installation Wizard on Windows.
103It is licensed under Inno Setup License (http://www.jrsoftware.org/files/is/license.txt).
e5bd0d98 105**FreeImage** is an Open Source library supporting popular graphics image formats, such as PNG, BMP, JPEG, TIFF,
765b3e07 106and others used by multimedia applications. This library is developed by Hervé Drolon and Floris van den Berg.
107FreeImage is easy to use, fast, multithreading safe, compatible with all 32-bit or 64-bit versions of Windows,
e5bd0d98 108and cross-platform (works both with Linux and Mac OS X). FreeImage is optionally used by OCCT to work
109with images, on conditions of the FreeImage Public License (FIPL) (http://freeimage.sourceforge.net/freeimage-license.txt).
765b3e07 110
e5bd0d98 111**MikTEX** is up-to-date implementation of TeX/LaTeX and related programs for Windows. It is used
112for generation of User and Developer Guides in PDF format. See http://miktex.org for information
113on this tool.
765b3e07 114
e5bd0d98 115Adobe Systems, Inc. provides **Adobe Reader**, which can be used to view files in Portable Document Format (PDF).
765b3e07 116
117**Linux** is a registered trademark of Linus Torvalds.
119**Windows** is a registered trademark of Microsoft Corporation in the United States and other countries.
121**Mac** and the Mac logo are trademarks of Apple Inc., registered in the U.S. and other countries.
e5bd0d98 123@section OCCT_OVW_SECTION_3 Documentation
765b3e07 124
e5bd0d98 125OCCT documentation is provided in several forms:
765b3e07 126
e5bd0d98 127- This overview provides general description of OCCT structure, functionality, modules, and features.
128 It is available in HTML format (generated by Doxygen) and includes User and Developer Guides.
129 The sources of this documentation are contained in **dox** subdirectory of OCCT sources
130 (plain text format is used, with mixed MarkDown / Doxygen syntax mark-up).
765b3e07 131
e5bd0d98 132- User and Developer Guides describing in details OCCT modules and development tools are also available in
133 Adobe Portable Document Format (PDF). To read this format, you need Adobe Acrobat Reader,
134 which is a freeware and can be downloaded from the Adobe site.
765b3e07 135
e5bd0d98 136- Full reference documentation covering all OCCT classes generated automatically by Doxygen
137 software is provided in HTML format, in a separate package.
138 Reference documentation is presented in **Modules --> Toolkits --> Packages --> Classes**
139 logic structure with cross-references to all OCCT classes and complete in-browser search by all classes.
765b3e07 140
e5bd0d98 141See @ref dev_guides__documentation "OCCT Documentation Guide" for details on OCCT documentation system.
765b3e07 142
e5bd0d98 143**Generation of HTML documentation**
765b3e07 144
e5bd0d98 145To generate HTML documentation from sources contained in *dox* subdirectory,
146you need to have Tcl and Doxygen 1.8.4 (or above) installed on your system.
148In Tcl prompt, cd to OCCT root folder and run
150 tclsh> source dox/start.tcl
152On Windows you can also run batch script **gendoc.bat**.
155**Generation of reference documentation**
157Reference documentation can be generated with help of WOK tool that
158is available for download from www.opencascade.org and dev.opencascade.org sites.
765b3e07 159
e5bd0d98 162 * Doxygen version 1.8.4 or higher
765b3e07 163 * Graphviz version 2.28.0 or higher
165Run WOK (cd \<WOK_INSTALL_DIR\>/site folder):
167* Using WOK TCL shell:
168 > wok_tclsh.sh
170* Using Emacs editor:
171 > wok_emacs.sh
173In the WOK prompt, step into your workbench:
e5bd0d98 175 > wokcd <your workbench>
765b3e07 176
177In your workbench, use **wgendoc** command with –h argument to get information about arguments of **wgendoc** command:
e5bd0d98 179 > wgendoc -h
765b3e07 180
e5bd0d98 181then run **wgendoc** command with required arguments, for instance:
765b3e07 182
e5bd0d98 183 > wgendoc -output=d:/occt/doc {-m=Draw Visualization}
765b3e07 184
185@section OCCT_OVW_SECTION_5 Requirements
62afa5c9 187Open CASCADE Technology is designed to be highly portable and is known to
188work on wide range of platforms (UNIX, Linux, Windows, Mac OS X).
189Current version is officially certified on Windows (IA-32 and x86-64),
190Linux (x86-64) and MAC OS X (x86-64) platforms.
192The tables below describe the recommended hardware and software configurations
193for which OCCT is certified to work.
195@subsection OCCT_OVW_SECTION_5_1 Linux
197| Operating System | Mandriva 2010, CentOS 5.5, CentOS 6.3, Fedora 17, Fedora 18, Ubuntu-1304, Debian 6.0\* |
198| ----- | ----- |
199| Minimum memory | 512 MB, 1 GB recommended |
200| Free disk space (complete installation) | 600 MB approx. |
201| Video card | See \ref overview_req_graphics |
202| Graphic library | OpenGL 1.1+ (OpenGL 2.1+ is recommended)|
203| C++ | GNU gcc 4.0. - 4.7.3. |
204| TCL (for testing tools) | Tcltk 8.5 or 8.6 http://www.tcl.tk/software/tcltk/8.6.html |
205| Qt (for demonstration tools) | Qt 4.6.2 http://qt.nokia.com/downloads |
206| Freetype (for text rendering) | freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ |
207| FreeImage (optional, for support of common 2D graphic formats) | FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files |
208| gl2ps (optional, for export contents of OCCT viewer to vector graphic files) | gl2ps-1.3.8 http://geuz.org/gl2ps/ |
209| Intel TBB (optional, for multithreaded algorithms) | TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ |
210| OpenCL (optional, for ray tracing visualization core | OpenCL 1.1+ http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/ |
212* Debian 60 64 bit is a platform used for regular testing of contributions
214@subsection OCCT_OVW_SECTION_5_2 Windows
216| Operating System | Windows 8 / 7 SP1 / Vista SP2 / XP SP3 |
217| ----- | ----- |
218| Minimum memory | 512 MB, 1 GB recommended |
219| Free disk space (complete installation) | 600 MB approx. |
220| Video card | See \ref overview_req_graphics |
221| Graphic library | OpenGL 1.1+ (OpenGL 2.1+ is recommended)|
222| C++ | Microsoft Visual Studio: 2005 SP1, 2008 SP1\*, 2010 SP1, 2012 Update 3, 2013 <br>Intel C++ Composer XE 2013 SP1 |
223| TCL (for testing tools) | ActiveTcl 8.5 or 8.6 http://www.activestate.com/activetcl/downloads |
224| Qt (for demonstration tools) | Qt 4.6.2 http://qt.nokia.com/downloads |
225| Freetype (OCCT Text rendering) | freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ |
226| FreeImage (Support of common graphic formats) | FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files |
227| gl2ps (Export contents of OCCT viewer to vector graphic file) | gl2ps-1.3.8 http://geuz.org/gl2ps/ |
228| Intel TBB (optional tool for multithreaded algorithms) | TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ |
229| OpenCL (optional for providing ray tracing visualization core | OpenCL 1.1+ http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/ |
231* VC++ 9 32-bit is used for certification of contributions and for building
232 binary package of official release of OCCT on Windows.
765b3e07 233
234@subsection OCCT_OVW_SECTION_5_3 MAC OS X
62afa5c9 236| Operating System | Mac OS X 10.9 Mavericks / 10.8 Mountain Lion / 10.7 Lion / 10.6.8 Snow Leopard |
237| ----- | ----- |
238| Minimum memory | 512 MB, 1 GB recommended |
239| Free disk space (complete installation) | 600 MB approx. |
240| Video card | See \ref overview_req_graphics |
241| Graphic library | OpenGL 1.1+ (OpenGL 2.1+ is recommended)|
242| C++ | XCode 3.2 or newer (4.x is recommended) |
243| Qt (for demonstration tools) | Qt 4.6.2 http://qt.nokia.com/downloads |
244| Freetype (OCCT Text rendering) | freetype-2.4.11 http://sourceforge.net/projects/freetype/files/ |
245| FreeImage (Support of common graphic formats) | FreeImage 3.15.4 http://sourceforge.net/projects/freeimage/files |
246| gl2ps (Export contents of OCCT viewer to vector graphic file) | gl2ps-1.3.8 http://geuz.org/gl2ps/ |
247| Intel TBB (optional tool for multithreaded algorithms) | TBB 3.x or 4.x http://www.threadingbuildingblocks.org/ |
248| OpenCL (optional for providing ray tracing visualization core | OpenCL 1.1+ http://developer.amd.com/tools-and-sdks/heterogeneous-computing/amd-accelerated-parallel-processing-app-sdk/downloads/ |
250@subsection overview_req_graphics Graphic cards
252For 3d viewer, graphic card or software implementation supporting OpenGL 1.1
253or above is required. OpenGL 2.1+ is highly recommended.
254For ray tracing, hardware implementation of OpenCL 1.1+ is required.
256The following table lists graphic cards tested to work with OCCT.
258| Graphic card | Driver/GL/GLSL/CL version | OS | OpenGL (fixed pipeline) | OpenGL (shaders) | OpenCL (ray tracing |
259| ---- | ---- | ---- | :----: | :----: | :----: |
260| NVIDIA GeForce GT 630M | Driver 311.44, GL 4.3.0, GLSL 4.30 | Windows 7 64 bit | OK | OK | OK |
261| Intel(R) HD Graphics 3000 | GL 3.1.0, GLSL 1.40 | Windows 7 64 bit | OK | OK | none |
262| RadeOn 9600 | GL 2.1.8454, GLSL 1.20 | | OK | bad | none |
263| Mesa 7.8.2 Windows GDI Driver\* | GL 2.1, GLSL version 1.20 | Mac OS X 10.6 / OS X 10.9 | OK | artifacts | none |
264| GeForce 320 | | Mac OS X 10.6 / OS X 10.9 | OK | OK | OK |
265| Apple software OpenGL | | Mac OS X 10.6 / OS X 10.9 | OK | OK | OK |
267* Mesa implementation of OpenGL is used for certification testing of OCCT
765b3e07 268
269@section OCCT_OVW_SECTION_4 Installation
e5bd0d98 271In most cases you need to rebuild OCCT on your platform (OS, compiler) before
272using it in your project, to ensure binary compatibility.
273See @ref dev_guides__building for instructions on
274building OCCT from sources on supported platforms.
765b3e07 275
e5bd0d98 276@subsection OCCT_OVW_SECTION_4_1 Using Windows installer
765b3e07 277
e5bd0d98 278On Windows Open CASCADE Technology can be installed with binaries precompiled by
279Visual C++ 2008 with installation procedure.
765b3e07 280
283If you have a previous version of OCCT installed on your station,
284and you do not plan to use it along with the new version, you might want to uninstall
285the previous version (using Control Panel, Add/Remove Programs) before
286the installation of this new version, to avoid possible problems
287(conflict of system variables, paths, etc).
289**Attention:** For full installation OCCT requires approximately 650 Mb of disk space,
290but during the installation process you will need 1,2 Gb of free disk space.
292OCCT installation with reference documentation requires 1,4 Gb on disk.
294 * Download the OCCT installer from OPEN CASCADE web site using the link. you have been provided
295 * Launch the installer and follow the instructions.
765b3e07 297The includes and binaries of third-party libraries necessary for building and launching
298OCCT are included into binary distribution (built with Visual C++ 2008).
e5bd0d98 299When the installation is complete, you will find the directories for 3rd party products
300(some might be absent in case of custom installation) and the main **OCCT** directory:
765b3e07 301
e5bd0d98 302@image html /overview/images/overview_3rdparty.png
303@image latex /overview/images/overview_3rdparty.png
765b3e07 304
e5bd0d98 305The contents of the OCCT-6.7.0 directory (called further "OCCT root", or $CASROOT) are as follows:
765b3e07 306
307@image html /overview/images/overview_installation.png "The directory tree"
308@image latex /overview/images/overview_installation.png "The directory tree"
765b3e07 310 * **adm** This folder contains administration files, which allow rebuilding OCCT;
311 * **adm/cmake** This folder contains files of CMake building procedure;
312 * **adm/msvc** This folder contains Visual Studio projects for Visual C++ 2005, 2008 and 2010, which allow rebuilding OCCT under Windows platform in 32 and 64-bit mode;
e5bd0d98 313 * **data** This folder contains CAD files in different formats, which can be used to test the OCCT functionality;
314 * **doc** This folder contains OCCT documentation in HTML and PDF format;
315 * **dox** This folder contains sources of OCCT documentation in plain text (MarkDown) format;
765b3e07 316 * **drv** This folder contains source files generated by WOK (private header files and instantiations of generic classes);
317 * **inc** This folder contains all OCCT header files;
318 * **samples** This folder contains sample applications.
319 * **src** This folder contains OCCT source files. They are organized in folders, one per development unit;
320 * **tests** This folder contains scripts for OCCT testing.
321 * **win32/vc9** This folder contains executable and library files built in optimize mode for Windows platform by Visual C++ 2008;
e5bd0d98 323@section OCCT_OVW_SECTION_4_2 Environment Variables
765b3e07 324
325To run any Open CASCADE Technology application you need to set the environment variables.
327### On Windows
765b3e07 329You can define the environment variables with env.bat script located in the
e5bd0d98 330$CASROOT folder. This script accepts two arguments to be used:
331the version of Visual Studio (vc8 - vc12) and the architecture (win32 or win64).
765b3e07 332
333The additional environment settings necessary for compiling OCCT libraries and samples
334by Microsoft Visual Studio can be set using script custom.bat located in the same folder.
335You might need to edit this script to correct the paths to third-party libraries
336if they are installed on your system in a non-default location.
338Script msvc.bat can be used with the same arguments for immediate launch of Visual Studio for (re)compiling OCCT.
340### On Unix
343 If OCCT was built by Code::Blocks, you can define the environment variables with env_cbp.sh or custom_cbp.sh script.
345 If OCCT was built by Automake, you can define the environment variables with env_amk.sh or custom_amk.sh script.
e5bd0d98 347The scripts are located in the OCCT root folder.
765b3e07 348
350### Description of system variables:
353 * **CASROOT** is used to define the root directory of Open CASCADE Technology;
354 * **PATH** is required to define the path to OCCT binaries and 3rdparty folder;
355 * **LD_LIBRARY_PATH** is required to define the path to OCCT libraries (on UNIX platforms only);
e5bd0d98 356 * **MMGT_OPT** (optional) if set to 1, the memory manager performs optimizations as described below; if set to 2,
357 Intel (R) TBB optimized memory manager is used; if 0 (default), every memory block is allocated
358 in C memory heap directly (via malloc() and free() functions).
359 In the latter case, all other options except MMGT_CLEAR and MMGT_REENTRANT are ignored;
360 * **MMGT_CLEAR** (optional) if set to 1 (default), every allocated memory block is cleared by zeros;
361 if set to 0, memory block is returned as it is;
362 * **MMGT_CELLSIZE** (optional) defines the maximal size of blocks allocated in large pools of memory. Default is 200;
363 * **MMGT_NBPAGES** (optional) defines the size of memory chunks allocated for small blocks in pages
364 (operating-system dependent). Default is 10000;
365 * **MMGT_THRESHOLD** (optional) defines the maximal size of blocks that are recycled internally
366 instead of being returned to the heap. Default is 40000;
367 * **MMGT_MMAP** (optional) when set to 1 (default), large memory blocks are allocated using
368 memory mapping functions of the operating system; if set to 0,
369 they will be allocated in the C heap by malloc();
765b3e07 370 * **CSF_LANGUAGE** is required to define the default language of messages;
e5bd0d98 371 * **CSF_DEBUG** (optional, Windows only): if defined then a diagnostic message is displayed in case of an exception;
62afa5c9 372 * **CSF_DEBUG_BOP** (optional): if defined then it should specify directory where diagnostic data on problems occured in Boolean operations will be saved;
765b3e07 373 * **CSF_MDTVTexturesDirectory** defines the directory for available textures when using texture mapping;
e5bd0d98 374 * **CSF_UnitsDefinition** and **CSF_UnitsLexicon** should define paths to resource files Lexi_Expr.dat and Units.dat, respectively, required for support of measurement units;
765b3e07 375 * **CSF_SHMessage** is required in order to define the path to the messages file for *ShapeHealing*;
376 * **CSF_XSMessage** is required in order to define the path to the messages file for **STEP** and **IGES** translators;
e5bd0d98 377 * **CSF_StandardDefaults** and **CSF_PluginDefaults** are required in order to maintain CASCADE Persistence mechanism to make possible any open/save operations with OCAF documents;
765b3e07 378 * **CSF_StandardLiteDefaults** is required in order to maintain *OCCT Persistence mechanism* to make possible any open/save operations with Lite OCAF documents;
379 * **CSF_XCAFDefaults** any open/save operations for **XDE** documents;
765b3e07 380 * **CSF_IGESDefaults** and **CSF_STEPDefaults** are required for **IGES** and **STEP** translators correspondingly in order to define the path to the resource files;
381 * **CSF_XmlOcafResource** is required in order to set the path to **XSD** resources, which defines XML grammar.
e5bd0d98 382 * **CSF_MIGRATION_TYPES** is required in order to read documents that contain old data types, such as *TDataStd_Shape*;
383 * **TCLLIBPATH**, **TCL_LIBRARY**, **TK_LIBRARY** and **TIX_LIBRARY** are required to allow work with **DRAW** and **WOK**.
765b3e07 384
385@section OCCT_OVW_SECTION_7 Getting Started
765b3e07 387@subsection OCCT_OVW_SECTION_7_1 Draw Test Harness
389Draw is a command interpreter based on TCL and a graphical system used for testing and demonstrating OCCT modeling libraries.
391Draw can be used interactively to create, display and modify objects such as curves, surfaces and topological shapes.
393@image html /overview/images/overview_draw.png
394@image latex /overview/images/overview_draw.png
396Scripts can be written to customize Draw and perform tests.
397New types of objects and new commands can be added using C++ programming language.
399Draw contains:
401 * A command interpreter based on TCL command language.
402 * A 2D an 3D graphic viewer with support of operations such as zoom, pan, rotation and full-screen views.
403 * An optional set of geometric commands to create and modify curves and surfaces and to use OCCT geometry algorithms.
404 * A set of topological commands to create and modify BRep shapes and to use OCCT topology algorithms.
405 * A set of graphic commands for view and display operations including Mesh Visualization Service.
406 * A set of Application framework commands for handling of files and attributes.
407 * A set of Data Exchange commands for translation of files from various formats (IGES,STEP) into OCCT shapes.
408 * A set of Shape Healing commands: check of overlapping edges, approximation of a shape to BSpline, etc.
410You can add new custom test harness commands to Draw in order to test
411or demonstrate a new functionality, which you are developing.
413Currently DRAW Test Harness is a single executable called DRAWEXE.
415Commands grouped in toolkits can be loaded at run-time thereby implementing dynamically loaded plug-ins.
416Thus you can work only with the commands that suit your needs adding
417the commands dynamically without leaving the Test Harness session.
419Declaration of available plug-ins is done through special resource file(s).
420The pload command loads the plug-in in accordance with
421the specified resource file and activates the commands implemented in the plug-in.
423The whole process of using the plug-in mechanism as well as the instructions for extending Test Harness is described in the
e5bd0d98 424@ref user_guides__test_harness.
765b3e07 425
e5bd0d98 426Draw Test Harness provides an environment for OCCT automated testing system.
427Please, consult its @ref dev_guides__tests "Automated Testing System" for details.
765b3e07 428
431* The DRAWEXE executable is delivered with the installation procedure on Windows platform only.
e5bd0d98 432* To start it, launch DRAWEXE executable from Open CASCADE Technology/Draw Test Harness item of the Start\\Programs menu.
765b3e07 433
434@subsection OCCT_OVW_SECTION_7_2 Experimenting with Draw Test Harness
436 Running Draw
439**On Linux:**
4411. If OCCT was built by Code::Blocks * use $CASROOT/draw_cbp.sh file to launch DRAWEXE executable;
4422. If OCCT was built by Automake * use $CASROOT/draw_amk.sh file to launch DRAWEXE executable;
444Draw[1]> prompt appears in the command window
446Type pload ALL
448**On Windows:**
450Launch Draw executable from Open CASCADE Technology\\Test Harness\\Draw Test Harness
451item of the Start\\Programs menu or Use $CASROOT\\draw.bat file to launch DRAWEXE executable.
453Draw[1]> prompt appears in the command window
455Type pload ALL
457**Creating your first geometric objects**
4591. In the command window, type axo to create an axonometric view
4602. Type box b -10 -10 -10 20 20 20 to create a cube b of size 20,
461 parallel to the X Y Z axis and centered on the origin.
462 The cube will be displayed in the axonometric view in wireframe mode
4633. Type fit to fill the viewer with the cube
4644. Type pcylinder c 2 30 to create a cylinder c of radius 2 and height 30.
465 The cylinder will be displayed in addition to the cube
467**Manipulating the view**
4691. Type clear to erase the view
4702. Type donly c to display the cylinder only
4713. Type donly b to display the cube only
4724. Type hlr hlr b to display the cube in the hidden line removal mode
474**Running demonstration files**
e5bd0d98 4761. Type cd ../.. to return to the root directory
4772. Type cd src/DrawResources to reach the DrawResources directory
765b3e07 4783. Type source "Available Demo File" to run the demonstration provided with Open CASCADE
4794. The following demonstration files are available:
480 * DataExchangeDemo.tcl
481 * ModelingDemo.tcl
482 * OCAFDemo.tcl
483 * VisualizationDemo.tcl
485**Getting Help**
4871. Type help to see all available commands
4882. Type help command-name to find out the arguments for a given command
490@subsection OCCT_OVW_SECTION_7_3 Programming Samples
492@subsubsection OCCT_OVW_SECTION_7_3_1 MFC
494Visual C++ programming samples containing 10 Visual C++ projects
495illustrating how to use a particular module or functionality.
497The list of MFC samples:
499 * Geometry
500 * Modeling
501 * Viewer2d
502 * Viewer3d
503 * ImportExport
504 * Ocaf
505 * Triangulation
506 * HLR
507 * Animation
508 * Convert
510@image html /overview/images/overview_mvc.png
511@image latex /overview/images/overview_mvc.png
515 * MFC samples are available only on Windows platform;
516 * To start a sample use Open CASCADE Technology\\Samples\\Mfc\\ item of the Start\\Programs menu;
517 * Read carefully readme.txt to learn about launching and compilation options.
519@subsubsection OCCT_OVW_SECTION_7_3_2 Qt
521OCCT contains three samples based on Qt application framework
523 Import Export
e5bd0d98 526 Import Export programming sample contains 3D Viewer and Import / Export functionality.
765b3e07 527
528@image html /overview/images/overview_qt.png
529@image latex /overview/images/overview_qt.png
531 Tutorial
534The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object.
535The purpose of the tutorial is not to explain all OCCT classes but
536to help start thinking in terms of the Open CASCADE Technology.
538This tutorial assumes that the user has experience in using and setting up C++.
539From the viewpoint of programming, Open CASCADE Technology is designed
540to enhance user's C++ tools with high performance modeling classes, methods and functions.
541The combination of these resources allows creating substantial applications.
e5bd0d98 543**See also:** @ref tutorial "OCCT Tutorial"
765b3e07 544
545 Voxel
548This is a demonstration application showing OCCT voxel models.
549It also includes a set of non-regression tests and other commands
550for testing this functionality (accessible only through TEST pre-processor definition).
e5bd0d98 552**See also:** Voxels User's guide (under construction)
765b3e07 553
556 * Qt samples are available on all supported platforms;
557 * To start a sample on Windows use Open CASCADE Technology\\Samples\\Qt\\ item of the Start\\Programs menu.
559@subsubsection OCCT_OVW_SECTION_7_3_3 C#
e5bd0d98 561C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality
562into .NET applications (using Windows Forms and WPF front ends).
765b3e07 563
564@image html /overview/images/overview_c__ie.png
565@image latex /overview/images/overview_c__ie.png
569 * BRep
570 * Iges
571 * Step
575 * Brep
576 * Iges
577 * Step
578 * Stl
579 * Vrml