xref: /petsc/include/petscdraw.h (revision 4b27c08ac4c7fe27d83aaa07ba0dc5abca4ca6c8)
1 /* $Id: petscdraw.h,v 1.79 2001/09/07 20:07:55 bsmith Exp $ */
2 /*
3   Interface to the PETSc graphics (currently only support for X-windows
4 */
5 #if !defined(__PETSCDRAW_H)
6 #define __PETSCDRAW_H
7 #include "petsc.h"
8 
9 extern int PETSC_DRAW_COOKIE;
10 
11 /*E
12     PetscDrawType - String with the name of a PetscDraw
13 
14    Level: beginner
15 
16 .seealso: PetscDrawSetType(), PetscDraw, PetscViewer
17 E*/
18 typedef char* PetscDrawType;
19 #define PETSC_DRAW_X     "x"
20 #define PETSC_DRAW_NULL  "null"
21 #define PETSC_DRAW_PS    "ps"
22 #define PETSC_DRAW_WIN32 "win32"
23 
24 /*S
25      PetscDraw - Abstract PETSc object for graphics
26 
27    Level: beginner
28 
29   Concepts: graphics
30 
31 .seealso:  PetscDrawCreate(), PetscDrawSetType(), PetscDrawType
32 S*/
33 typedef struct _p_PetscDraw* PetscDraw;
34 
35 extern PetscFList PetscDrawList;
36 EXTERN int PetscDrawRegisterAll(char *);
37 EXTERN int PetscDrawRegisterDestroy(void);
38 
39 EXTERN int PetscDrawRegister(char*,char*,char*,int(*)(PetscDraw));
40 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
41 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,0)
42 #else
43 #define PetscDrawRegisterDynamic(a,b,c,d) PetscDrawRegister(a,b,c,d)
44 #endif
45 EXTERN int PetscDrawGetType(PetscDraw,PetscDrawType*);
46 EXTERN int PetscDrawSetType(PetscDraw,PetscDrawType);
47 EXTERN int PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
48 EXTERN int PetscDrawSetFromOptions(PetscDraw);
49 
50 /*
51    Number of basic colors in the draw routines, the others are used
52    for a uniform colormap.
53 */
54 #define PETSC_DRAW_BASIC_COLORS 33
55 
56 #define PETSC_DRAW_ROTATE          -1         /* will rotate through the colors, start with 2 */
57 #define PETSC_DRAW_WHITE            0
58 #define PETSC_DRAW_BLACK            1
59 #define PETSC_DRAW_RED              2
60 #define PETSC_DRAW_GREEN            3
61 #define PETSC_DRAW_CYAN             4
62 #define PETSC_DRAW_BLUE             5
63 #define PETSC_DRAW_MAGENTA          6
64 #define PETSC_DRAW_AQUAMARINE       7
65 #define PETSC_DRAW_FORESTGREEN      8
66 #define PETSC_DRAW_ORANGE           9
67 #define PETSC_DRAW_VIOLET          10
68 #define PETSC_DRAW_BROWN           11
69 #define PETSC_DRAW_PINK            12
70 #define PETSC_DRAW_CORAL           13
71 #define PETSC_DRAW_GRAY            14
72 #define PETSC_DRAW_YELLOW          15
73 
74 #define PETSC_DRAW_GOLD            16
75 #define PETSC_DRAW_LIGHTPINK       17
76 #define PETSC_DRAW_MEDIUMTURQUOISE 18
77 #define PETSC_DRAW_KHAKI           19
78 #define PETSC_DRAW_DIMGRAY         20
79 #define PETSC_DRAW_YELLOWGREEN     21
80 #define PETSC_DRAW_SKYBLUE         22
81 #define PETSC_DRAW_DARKGREEN       23
82 #define PETSC_DRAW_NAVYBLUE        24
83 #define PETSC_DRAW_SANDYBROWN      25
84 #define PETSC_DRAW_CADETBLUE       26
85 #define PETSC_DRAW_POWDERBLUE      27
86 #define PETSC_DRAW_DEEPPINK        28
87 #define PETSC_DRAW_THISTLE         29
88 #define PETSC_DRAW_LIMEGREEN       30
89 #define PETSC_DRAW_LAVENDERBLUSH   31
90 #define PETSC_DRAW_PLUM            32
91 
92 EXTERN int PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
93 EXTERN int PetscDrawOpenPS(MPI_Comm,char *,PetscDraw *);
94 #define PETSC_DRAW_FULL_SIZE    -3
95 #define PETSC_DRAW_HALF_SIZE    -4
96 #define PETSC_DRAW_THIRD_SIZE   -5
97 #define PETSC_DRAW_QUARTER_SIZE -6
98 
99 EXTERN int PetscDrawOpenNull(MPI_Comm,PetscDraw *);
100 EXTERN int PetscDrawDestroy(PetscDraw);
101 EXTERN int PetscDrawIsNull(PetscDraw,PetscTruth*);
102 
103 EXTERN int PetscDrawGetPopup(PetscDraw,PetscDraw*);
104 EXTERN int PetscDrawCheckResizedWindow(PetscDraw);
105 EXTERN int PetscDrawResizeWindow(PetscDraw,int,int);
106 
107 EXTERN int PetscDrawScalePopup(PetscDraw,PetscReal min,PetscReal max);
108 
109 EXTERN int PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
110 EXTERN int PetscDrawLineSetWidth(PetscDraw,PetscReal);
111 EXTERN int PetscDrawLineGetWidth(PetscDraw,PetscReal*);
112 
113 EXTERN int PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
114 EXTERN int PetscDrawPointSetSize(PetscDraw,PetscReal);
115 
116 EXTERN int PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int);
117 EXTERN int PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int);
118 EXTERN int PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
119 EXTERN int PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*);
120 EXTERN int PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *);
121 
122 EXTERN int PetscDrawString(PetscDraw,PetscReal,PetscReal,int,char*);
123 EXTERN int PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,char*);
124 EXTERN int PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
125 EXTERN int PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);
126 
127 EXTERN int PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
128 EXTERN int PetscDrawSplitViewPort(PetscDraw);
129 
130 EXTERN int PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
131 EXTERN int PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
132 
133 EXTERN int PetscDrawSetTitle(PetscDraw,char *);
134 EXTERN int PetscDrawAppendTitle(PetscDraw,char *);
135 EXTERN int PetscDrawGetTitle(PetscDraw,char **);
136 
137 EXTERN int PetscDrawSetPause(PetscDraw,int);
138 EXTERN int PetscDrawGetPause(PetscDraw,int*);
139 EXTERN int PetscDrawPause(PetscDraw);
140 EXTERN int PetscDrawSetDoubleBuffer(PetscDraw);
141 EXTERN int PetscDrawFlush(PetscDraw);
142 EXTERN int PetscDrawSynchronizedFlush(PetscDraw);
143 EXTERN int PetscDrawClear(PetscDraw);
144 EXTERN int PetscDrawSynchronizedClear(PetscDraw);
145 EXTERN int PetscDrawBOP(PetscDraw);
146 EXTERN int PetscDrawEOP(PetscDraw);
147 
148 EXTERN int PetscDrawSetDisplay(PetscDraw,char*);
149 #define PetscDrawSetFilename(a,b) PetscDrawSetDisplay(a,b)
150 
151 EXTERN int PetscDrawGetSingleton(PetscDraw,PetscDraw*);
152 EXTERN int PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
153 
154 /*E
155     PetscDrawButton - Used to determine which button was pressed
156 
157    Level: intermediate
158 
159 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
160 E*/
161 typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT,BUTTON_LEFT_SHIFT,BUTTON_CENTER_SHIFT,BUTTON_RIGHT_SHIFT} PetscDrawButton;
162 
163 EXTERN int PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
164 EXTERN int PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
165 
166 EXTERN int PetscDrawZoom(PetscDraw,int (*)(PetscDraw,void *),void *);
167 
168 /*S
169      PetscDrawViewPorts - Subwindows in a PetscDraw object
170 
171    Level: intermediate
172 
173   Concepts: graphics
174 
175 .seealso:  PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
176 S*/
177 typedef struct {
178   int       nports;
179   PetscReal    *xl,*xr,*yl,*yr;
180   PetscDraw draw;
181 } PetscDrawViewPorts;
182 EXTERN int PetscDrawViewPortsCreate(PetscDraw,int,PetscDrawViewPorts**);
183 EXTERN int PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
184 EXTERN int PetscDrawViewPortsSet(PetscDrawViewPorts*,int);
185 
186 /*S
187      PetscDrawAxis - Manages X-Y axis
188 
189    Level: advanced
190 
191   Concepts: graphics, axis
192 
193 .seealso:  PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
194 S*/
195 typedef struct _p_DrawAxis* PetscDrawAxis;
196 
197 extern int DRAWAXIS_COOKIE;
198 
199 EXTERN int PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
200 EXTERN int PetscDrawAxisDestroy(PetscDrawAxis);
201 EXTERN int PetscDrawAxisDraw(PetscDrawAxis);
202 EXTERN int PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
203 EXTERN int PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscTruth);
204 EXTERN int PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
205 EXTERN int PetscDrawAxisSetLabels(PetscDrawAxis,char*,char*,char*);
206 
207 /*S
208      PetscDrawLG - Manages drawing x-y plots
209 
210    Level: advanced
211 
212   Concepts: graphics, axis
213 
214 .seealso:  PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
215 S*/
216 typedef struct _p_DrawLG*   PetscDrawLG;
217 
218 extern int DRAWLG_COOKIE;
219 
220 EXTERN int PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
221 EXTERN int PetscDrawLGDestroy(PetscDrawLG);
222 EXTERN int PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
223 EXTERN int PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
224 EXTERN int PetscDrawLGDraw(PetscDrawLG);
225 EXTERN int PetscDrawLGPrint(PetscDrawLG);
226 EXTERN int PetscDrawLGReset(PetscDrawLG);
227 EXTERN int PetscDrawLGSetDimension(PetscDrawLG,int);
228 EXTERN int PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
229 EXTERN int PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
230 EXTERN int PetscDrawLGIndicateDataPoints(PetscDrawLG);
231 EXTERN int PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
232 
233 /*S
234      PetscDrawSP - Manages drawing scatter plots
235 
236    Level: advanced
237 
238   Concepts: graphics, scatter plots
239 
240 .seealso:  PetscDrawSPCreate()
241 S*/
242 typedef struct _p_DrawSP*   PetscDrawSP;
243 
244 extern int DRAWSP_COOKIE;
245 
246 EXTERN int PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
247 EXTERN int PetscDrawSPDestroy(PetscDrawSP);
248 EXTERN int PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
249 EXTERN int PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
250 EXTERN int PetscDrawSPDraw(PetscDrawSP);
251 EXTERN int PetscDrawSPReset(PetscDrawSP);
252 EXTERN int PetscDrawSPSetDimension(PetscDrawSP,int);
253 EXTERN int PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
254 EXTERN int PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
255 EXTERN int PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
256 
257 /*S
258      PetscDrawHG - Manages drawing histograms
259 
260    Level: advanced
261 
262   Concepts: graphics, histograms
263 
264 .seealso:  PetscDrawHGCreate()
265 S*/
266 typedef struct _p_DrawHG*   PetscDrawHG;
267 
268 extern int DRAWHG_COOKIE;
269 
270 EXTERN int PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
271 EXTERN int PetscDrawHGDestroy(PetscDrawHG);
272 EXTERN int PetscDrawHGAddValue(PetscDrawHG,PetscReal);
273 EXTERN int PetscDrawHGDraw(PetscDrawHG);
274 EXTERN int PetscDrawHGPrint(PetscDrawHG);
275 EXTERN int PetscDrawHGReset(PetscDrawHG);
276 EXTERN int PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
277 EXTERN int PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
278 EXTERN int PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
279 EXTERN int PetscDrawHGSetNumberBins(PetscDrawHG,int);
280 EXTERN int PetscDrawHGSetColor(PetscDrawHG,int);
281 EXTERN int PetscDrawHGCalcStats(PetscDrawHG, PetscTruth);
282 EXTERN int PetscDrawHGIntegerBins(PetscDrawHG, PetscTruth);
283 
284 /*
285     PetscViewer routines that allow you to access underlying PetscDraw objects
286 */
287 EXTERN int PetscViewerDrawGetDraw(PetscViewer,int,PetscDraw*);
288 EXTERN int PetscViewerDrawGetDrawLG(PetscViewer,int,PetscDrawLG*);
289 EXTERN int PetscViewerDrawGetDrawAxis(PetscViewer,int,PetscDrawAxis*);
290 
291 EXTERN int PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
292 EXTERN int PetscDrawUtilitySetGamma(PetscReal);
293 
294 /* Mesh management routines */
295 typedef struct _p_DrawMesh* PetscDrawMesh;
296 int PetscDrawMeshCreate(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,
297 		        int,int,int,int,int,int,int,int,int,int,int,int,int,PetscReal *,int);
298 int PetscDrawMeshCreateSimple(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,int,int,int,int,PetscReal *,int);
299 int PetscDrawMeshDestroy(PetscDrawMesh *);
300 
301 
302 
303 
304 #endif
305 
306 
307 
308 
309 
310