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