Integration of OCCT 6.5.0 from SVN
[occt.git] / samples / mfc / occtdemo / readme.txt
1 ========================================================================
2        Sample Open Cascade Demo Presentation Application
3 ========================================================================
4
5
6 This application is a one from a set of applications intended to show 
7 some features of Open Cascade.
8 You can see how a particular feature is realized in the source code.
9 The WNT implementation uses Microsoft Foundation Classes.
10
11 /////////////////////////////////////////////////////////////////////////////
12 Summary of what you will find in each of the files that
13 make up this application.
14 Below the string <Project> should be substituted by the name of the
15 particular project downloaded by you.
16
17 <Project>/
18     This folder contains source files specific to this project.
19
20 <Project>.dsp
21     This file (the project file) contains information at the project level
22     and is used to build a project.
23
24 <Project>/<Project>_Presentation.h, <Project>/<Project>_Presentation.cpp
25     These files contain the project presentation class <Project>_Presentation,
26                 which inherits OCCDemo_Presentation and determines the samples and
27                 the behaviour of all samples in the presentation. 
28                 <Project>_Presentation.cpp contains also the initialisation of the
29                 pointer OCCDemo_Presentation::Current with the new object of type
30     <Project>_Presentation.
31
32 Common/
33     This folder contains source files common to all possibly downloaded
34                 projects.
35
36 Common/OCCDemo_Presentation.h, Common/OCCDemo_Presentation.cpp
37     These files contain the abstract class OCCDemo_Presentation which is
38                 the base for all project presentation classes. It serves as a link 
39                 between a platform independent project class and the platform dependent
40                 classes responsible for drawing objects on the screen (mainly 
41     COCCDemoDoc class). OCCDemo_Presentation class contains static field 
42                 Current which points to a particular object of type <Project>_Presentation. 
43                 This pointer is initialized where <Project>_Presentation is implemented, 
44                 and is used by the class COCCDemoDoc.
45
46 Common/WNT/OCCDemo.h, Common/WNT/OCCDemo.cpp
47     These files contain the main application class COCCDemoApp.
48
49 Common/WNT/MainFrm.h, Common/WNT/MainFrm.cpp
50     These files contain the frame class CMainFrame, which is derived from
51     CFrameWnd and controls all SDI frame features.
52
53 Common/WNT/OCCDemoDoc.h, Common/WNT/OCCDemoDoc.cpp
54     These files contain COCCDemoDoc class which inherits CDocument. It
55                 controls the sequence of samples using the pointer
56                 OCCDemo_Presentation::Current. It also contains the objects of types
57                 AIS_InteractiveContext and V3d_Viewer to store and manipulate the 
58                 drawable objects. It also manipulates by the object of type CResultDialog
59                 in which the source code and results of samples are shown.
60
61 Common/WNT/OCCDemoView.h, Common/WNT/OCCDemoView.cpp
62     These files contain COCCDemoView class which inherits CView. It processes
63                 all mouse and keyboard events dedicated to the 3d View.
64
65 Common/WNT/ResultDialog.h, Common/WNT/ResultDialog.cpp
66     These files contain the class CResultDialog which is used to show
67     the source code and results of samples.
68
69 Common/WNT/StdAfx.h, Common/WNT/StdAfx.cpp
70     These files are used to build a precompiled header (PCH) file
71     named <Project>.pch and a precompiled types file named StdAfx.obj.
72
73 Common/WNT/Resource.h
74     This is the standard header file, which defines new resource IDs.
75     Microsoft Visual C++ reads and updates this file.
76
77 Common/WNT/OCCDemo.rc
78     This is a listing of all of the Microsoft Windows resources that the
79     program uses. It includes the icons and bitmaps that are stored
80     in the RES subdirectory.
81
82 Common/WNT/res/OCCDemo.ico
83     This is an icon file, which is used as the application's icon.  This
84     icon is included by the main resource file OCCDemo.rc.
85
86 Common/WNT/res/OCCDemo.rc2
87     This file might contain resources that are not edited by Microsoft 
88                 Visual C++. Really it is empty.
89
90 Common/WNT/res/Toolbar.bmp, Common/WNT/res/Toolbar1.bmp
91     These files contain bitmaps used to create tiled images for the toolbars.
92
93 Common/ISession/ISession_Curve.h, Common/ISession/ISession_Curve.cpp
94     These files define the class ISession_Curve which is derived from
95                 AIS_InteractiveObject. It is intended to display Curves directly
96                 (not via Edges) in the AIS_Interactive_Context.
97
98 Common/ISession/ISession_Surface.h, Common/ISession/ISession_Surface.cpp
99     These files define the class ISession_Surface which is derived from
100                 AIS_InteractiveObject. It is intended to display Surfaces directly
101                 (not via Faces) in the AIS_Interactive_Context.