Commit | Line | Data |
---|---|---|
0a6d9742 VS |
1 | Tutorials and Samples {#samples} |
2 | ===================== | |
3 | ||
4 | Tutorial: Modelling a Bottle | |
5 | ---------------------------- | |
6 | The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object. | |
7 | The purpose of the tutorial is not to explain all OCCT classes but | |
8 | to help start thinking in terms of the Open CASCADE Technology. | |
9 | ||
10 | This tutorial assumes that the user has experience in using and setting up C++. | |
11 | From the viewpoint of programming, Open CASCADE Technology is designed | |
12 | to enhance user's C++ tools with high performance modeling classes, methods and functions. | |
13 | The combination of these resources allows creating substantial applications. | |
14 | ||
15 | Read more about @subpage occt__tutorial | |
16 | ||
17 | MFC | |
18 | --------- | |
19 | ||
20 | Visual C++ programming samples containing 10 Visual C++ projects | |
21 | illustrating how to use a particular module or functionality. | |
22 | ||
23 | The list of MFC samples: | |
24 | ||
25 | * Geometry | |
26 | * Modeling | |
27 | * Viewer2d | |
28 | * Viewer3d | |
29 | * ImportExport | |
30 | * Ocaf | |
31 | * Triangulation | |
32 | * HLR | |
33 | * Animation | |
34 | * Convert | |
35 | ||
36 | @figure{/samples/images/samples_mvc.png} | |
37 | ||
38 | **Remarks:** | |
39 | ||
40 | * MFC samples are available only on Windows platform; | |
41 | * To start a sample use Open CASCADE Technology\\Samples\\Mfc\\ item of the Start\\Programs menu; | |
42 | * Read carefully readme.txt to learn about launching and compilation options. | |
43 | ||
44 | See @subpage samples_mfc_standard "Readme" for details. | |
45 | ||
46 | Qt | |
47 | --- | |
48 | ||
a2176e65 | 49 | OCCT includes several samples based on Qt application framework. |
50 | These samples are available on all supported desktop platforms. | |
51 | ||
52 | To start a sample on Windows use Open CASCADE Technology\\Samples\\Qt\\ item of the Start\\Programs menu. | |
0a6d9742 VS |
53 | |
54 | Import Export | |
55 | ------------- | |
56 | ||
57 | Import Export programming sample contains 3D Viewer and Import / Export functionality. | |
58 | ||
59 | @figure{/samples/images/samples_qt.png} | |
60 | ||
61 | Tutorial | |
62 | --------- | |
63 | ||
64 | The Qt programming tutorial teaches how to use Open CASCADE Technology services to model a 3D object. | |
65 | The purpose of the tutorial is not to explain all OCCT classes but | |
66 | to help start thinking in terms of the Open CASCADE Technology. | |
67 | ||
68 | This tutorial assumes that the user has experience in using and setting up C++. | |
69 | From the viewpoint of programming, Open CASCADE Technology is designed | |
70 | to enhance user's C++ tools with high performance modeling classes, methods and functions. | |
71 | The combination of these resources allows creating substantial applications. | |
72 | ||
73 | **See also:** @ref occt__tutorial "OCCT Tutorial" | |
74 | ||
a2176e65 | 75 | Overview |
76 | --------- | |
77 | ||
78 | The Qt application providing samples for basic usage of C++ API of various OCCT functionality. | |
79 | ||
80 | The samples are organized in several categories according to relevant module of OCCT: | |
81 | ||
82 | * Geometry | |
83 | * Topology, | |
84 | * Triangulation | |
85 | * DataExchange | |
86 | * OCAF | |
87 | * Viewer 2d | |
88 | * Viewer 3d | |
89 | ||
90 | Each sample presents geometry view, C++ code fragment and sample output window. | |
91 | ||
92 | @figure{/samples/images/sample_overview_qt.png} | |
93 | ||
94 | See \subpage samples_qt_overview "Readme" for details. | |
95 | ||
0a6d9742 VS |
96 | C# |
97 | --- | |
98 | ||
99 | C# sample demonstrates integration of OCCT 3D Viewer and Import / Export functionality into .NET applications (using Windows Forms and WPF front ends). | |
100 | ||
101 | @figure{/samples/images/samples_c__ie.png} | |
102 | ||
103 | Import: | |
104 | ||
105 | * BRep | |
106 | * Iges | |
107 | * Step | |
108 | ||
109 | Export: | |
110 | ||
111 | * Brep | |
112 | * Iges | |
113 | * Step | |
114 | * Stl | |
115 | * Vrml | |
116 | ||
117 | See @subpage samples_csharp_occt "C# sample Readme" for details. | |
118 | ||
119 | There is also another C# example with the same functionality, which demonstrates the integration of Direct3D Viewer into .NET applications using WPF front end. | |
120 | ||
121 | See @subpage samples_csharp_direct3d "Direct3D C# sample Readme" for details. | |
122 | ||
123 | Android | |
124 | --------- | |
125 | ||
126 | 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) | |
127 | ||
128 | jniviewer | |
129 | @figure{/samples/images/samples_java_android_occt.jpg} | |
130 | Java -- See @subpage samples_java_android_occt "Android Java sample Readme" for details. | |
131 | ||
132 | AndroidQt | |
133 | @figure{/samples/images/samples_qml_android_occt.jpg} | |
134 | Qt -- See \subpage samples_qml_android_occt "Android Qt sample Readme" for details. | |
135 | ||
136 | iOS | |
137 | --- | |
138 | ||
139 | There is a sample demonstrating usage of OCCT on iOS with Apple UIKit framework. | |
140 | ||
141 | @figure{/samples/images/sample_ios_uikit.png} | |
142 | ||
143 | See @subpage occt_samples_ios_uikit "iOS sample Readme" for details. | |
144 | ||
145 | Web | |
146 | --------- | |
147 | ||
148 | WebGL Viewer sample demonstrating usage of OCCT 3D Viewer in Web browser with Emscripten SDK can be found in `samples/webgl`. | |
149 | ||
150 | @figure{/samples/images/sample_webgl.png} | |
151 | ||
152 | See @subpage occt_samples_webgl "WebGL sample Readme" for details. | |
153 | ||
154 | OCAF Usage Sample | |
155 | ------------------ | |
156 | ||
157 | The provided set of samples dedicates to get initial knowledge about typical actions with OCAF services. It may be | |
158 | useful for newcomers. | |
159 | ||
160 | Read more about @subpage samples__ocaf | |
161 | ||
162 | OCAF Function Mechanism Usage | |
163 | ----------------------------- | |
164 | ||
165 | This simple example dedicates to the usage of "Function Mechanism" of OCCT Application Framework. It represents a "nail" | |
166 | composed by a cone and two cylinders of different radius and height. | |
167 | ||
168 | Read more about @subpage samples__ocaf_func | |
169 | ||
170 | Draw Demo Scripts | |
171 | ------------------ | |
172 | ||
173 | A set of demo scripts demonsrates using OCCT functionality from DRAW. These scripts can be also considered as a | |
174 | tutorials on tcl usage within Draw. | |
175 | ||
176 | Read more about @subpage samples__draw_scripts |