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