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