/[escript]/trunk/doc/user/pyvisi.tex
ViewVC logotype

Annotation of /trunk/doc/user/pyvisi.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 999 - (hide annotations)
Tue Feb 27 08:12:37 2007 UTC (12 years, 11 months ago) by gross
File MIME type: application/x-tex
File size: 4045 byte(s)
start to put some pycad documentation into the users guide
1 gross 606 \chapter{The module \pyvisi}
2 jongui 879 \label{PYVISI CHAP}
3    
4 gross 999 \section{Introduction}
5 gross 606
6 jongui 879 \pyvisi provides an easy to use interface to the \VTK visualization
7 gross 999 tool.
8 gross 606
9 gross 999 \section{Rendering}
10     same word on rendering, off-line, on-line, how to rotate, zoom, close the window, ...
11    
12     \section{How to Make a Movie}
13    
14     \section{\pyvisi Classes}
15     \declaremodule{extension}{esys.pyvisi}
16     \modulesynopsis{A simple Python visualization interface for \VTK}
17    
18     In this section we give a brief overview over the important classes and their methods. Please
19     check the \ReferenceGuide on details.
20     %=====================================================================================
21     \subsection{Scene Classes}
22     \begin{classdesc}{Scene}{}
23     Displays a scene in which objects are to be rendered on.
24     \end{classdesc}
25    
26     \begin{classdesc}{Camera}{}
27     Controls the camera manipulation.
28     \end{classdesc}
29    
30     \begin{classdesc}{Light}{}
31     Controls the light manipulation.
32     \end{classdesc}
33    
34     %============================================================================================================
35     \subsection{Input Classes}
36    
37     \begin{classdesc}{Image}{}
38     Displays an image.
39     \end{classdesc}
40    
41     \begin{classdesc}{Text}{}
42     Shows some 2D text.
43     \end{classdesc}
44    
45     \begin{classdesc}{DataCollector}{}
46     Deals with the source of data for visualization.
47     \end{classdesc}
48    
49     %============================================================================================================
50     \subsection{Data Visualization}
51     \begin{classdesc}{Map}{}
52     Displays a scalar field using a domain surface.
53     \end{classdesc}
54    
55     \begin{classdesc}{MapOnPlaneCut}{}
56     Displays a scalar field using a domain surface cut on a plane.
57     \end{classdesc}
58    
59     \begin{classdesc}{MapOnPlaneClip}{}
60     Displays a scalar field using a domain surface clipped
61 jongui 961 on a plane.
62 gross 999 \end{classdesc}
63    
64     \begin{classdesc}{MapOnScalarClip}{}
65     Displays a scalar field using a domain surface clipped
66 jongui 961 using a scalar value.
67 gross 999 \end{classdesc}
68    
69     \begin{classdesc}{Velocity}{}
70     Displays a vector field using arrows.
71     \end{classdesc}
72    
73     \begin{classdesc}{VelocityOnPlaneCut}{}
74     Displays a vector field using arrows cut on a plane.
75     \end{classdesc}
76    
77     \begin{classdesc}{VelocityOnPlaneClip}{}
78     Displays a vector field using arrows clipped on a
79 jongui 961 plane.
80 gross 999 \end{classdesc}
81    
82     \begin{classdesc}{Ellipsoid}{}
83     Displays a tensor field using spheres.
84     \end{classdesc}
85    
86     \begin{classdesc}{EllipsoidOnPlaneCut}{}
87     Displays a tensor field using spheres cut on a
88 jongui 961 plane.
89 gross 999 \end{classdesc}
90    
91     \begin{classdesc}{EllipsoidOnPlaneClip}{}
92     Displays a tensor field using spheres clipped
93 jongui 961 on a plane.
94 gross 999 \end{classdesc}
95    
96 jongui 961
97 gross 999 \begin{classdesc}{Contour}{}
98     Shows a scalar field by contour surfaces.
99     \end{classdesc}
100    
101     \begin{classdesc}{ContourOnPlane}{}
102     Shows a scalar field by contour surfaces on
103 jongui 961 a given plane.
104 gross 999 \end{classdesc}
105    
106     \begin{classdesc}{ContourOnClip}{}
107     Shows a scalar field by contour surfaces on
108 jongui 961 a given clip.
109 gross 999 \end{classdesc}
110 jongui 961
111 gross 999 \begin{classdesc}{IsoSurface}{}
112     Shows a scalar field for a given value by
113 jongui 879 an isosurface.
114 gross 999 \end{classdesc}
115    
116     \begin{classdesc}{IsoSurfaceOnPlane}{}
117     Shows a scalar field for a given value by
118 jongui 879 an isosurfaceon a given plane.
119 gross 999 \end{classdesc}
120    
121     \begin{classdesc}{IsoSurfaceOnClip}{}
122     Shows a scalar field for a given vlaue by
123 jongui 879 an isosurface on a given clip.
124 gross 999 \end{classdesc}
125    
126     \begin{classdesc}{StreamLines}{}
127     Shows the path of particles in a vector field.
128     \end{classdesc}
129    
130     \begin{classdesc}{Carpet}{}
131     Shows a scalar field as plane deformated along
132 jongui 879 the plane normal.
133 gross 999 \end{classdesc}
134 gross 606
135 gross 999 \section{Geometry}
136     \begin{classdesc}{Position}{}
137     Defines the x,y and z coordinates rendered object.
138     \end{classdesc}
139    
140     \begin{classdesc}{Transform}{}
141     Defines the orientation of rendered object.
142     \end{classdesc}
143    
144     \begin{classdesc}{Plane}{}
145     Defines the cutting/clipping of rendered objects.
146     \end{classdesc}
147    
148    
149     \subsection{Beautification}
150     \begin{classdesc}{Style}{}
151     Defines the style of text.
152     \end{classdesc}
153    
154     \begin{classdesc}{BlueToRed}{}
155     Defines a map spectrum from blue to red.
156     \end{classdesc}
157    
158     \begin{classdesc}{RedToBlue}{}
159     Defines a map spectrum from red to blue.
160     \end{classdesc}
161    
162    

  ViewVC Help
Powered by ViewVC 1.1.26