0032137: Coding Rules - merge redundant .lxx files into header files within Package gp
[occt.git] / samples / CSharp / ReadMe.md
1 OCCT CSharp sample {#samples_csharp_occt}
2 ================== 
3         
4 This sample demonstrates how to use OCCT libraries in <b>.Net</b> application
5 written using **CSharp** and **Windows Forms** or **Windows Presentation Foundation** (WPF).
6
7 The connection between .Net and OCCT (C++) level is provided by proxy library
8 **OCCProxy**, written in C++/CLI. The proxy library contains a single *ref* class
9 encapsulating OCCT viewer and providing the functionality to manipulate this viewer
10 and to import / export OCCT shapes from / to several supported CAD file formats (IGES, STEP, BREP). 
11
12 The sample implements two approaches to the development of a user interface with C#.
13 Both applications provide the same functionality as the standard OCCT Import/Export sample.
14 The first project is called *IE_WinForms* and uses Windows Forms for GUI.
15 The second application is called *IE_WPF_WinForms* and uses Windows Presentation Foundation.
16
17 Note a few important details:
18
19 - OCCT template class *NCollection_Haft* is used to encapsulate C++ class into a field of *ref* class; 
20   
21 - It is necessary to explicitly set the target platform for  C# assemblies to *x86*
22   in project **Properties - Build** to work consistently on 64-bit systems with OCCT libraries built in 32-bit mode;
23   
24 - this sample demonstrates indirect method of wrapping C++ to C# using a manually
25   created proxy library. There is an alternative method of wrapping individual
26   OCCT classes to C# equivalents to make their full API available to a C# user
27   and to let the code be programmed on C# level similarly to C++ one. See the description
28   of **OCCT C# Wrapper** in **Advanced Samples and Tools** at 
29   http://www.opencascade.org/support/products/advsamples
30
31 - in WPF sample, **WinForms** control is used to encapsulate OCC viewer since WPF 
32   does not provide the necessary interface to embed OpenGl view. Other possible
33   solution could be to render OpenGl scene in an off-screen buffer and to map it
34   to WPF control as an image. That approach would allow using all WPF features to
35   control the OCCT viewer.
36
37 Run *msvc.bat* to start MS Visual Studio for building the sample.
38 Note that project files are provided only for VS 2010, you can open them in
39 newer versions of Visual Studio the using automatic converter.
40
41 After conversion check option **Target framework** in the properties of C# projects 
42 (tab **Application**) to make sure that it corresponds to the version set in
43 the properties of C++ projects (e.g. <b>.Net Framework 4.0</b> for VS 2010).
44
45 Run *run_winforms.bat* or *run_wpf.bat* to launch the corresponding sample.
46
47 Note that all batch scripts use the configuration defined in OCCT *custom.bat* file
48 as default; you can provide arguments specifying VS version, bitness, and mode
49 to override these settings, e.g.:
50
51         > msvc.bat vc10 win64 Debug