xref: /petsc/include/petscdraw.h (revision 87828ca270d8140797fd4271705413c4ecfcb535)
1 /* $Id: petscdraw.h,v 1.76 2001/04/10 19:34:12 bsmith Exp bsmith $ */
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 #define PETSC_DRAW_COOKIE PETSC_COOKIE+6
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 PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscScalar*);
119 EXTERN int PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscScalar *);
120 
121 EXTERN int PetscDrawString(PetscDraw,PetscReal,PetscReal,int,char*);
122 EXTERN int PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,char*);
123 EXTERN int PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
124 EXTERN int PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);
125 
126 EXTERN int PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
127 EXTERN int PetscDrawSplitViewPort(PetscDraw);
128 
129 EXTERN int PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
130 EXTERN int PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
131 
132 EXTERN int PetscDrawSetTitle(PetscDraw,char *);
133 EXTERN int PetscDrawAppendTitle(PetscDraw,char *);
134 EXTERN int PetscDrawGetTitle(PetscDraw,char **);
135 
136 EXTERN int PetscDrawSetPause(PetscDraw,int);
137 EXTERN int PetscDrawGetPause(PetscDraw,int*);
138 EXTERN int PetscDrawPause(PetscDraw);
139 EXTERN int PetscDrawSetPetscRealBuffer(PetscDraw);
140 EXTERN int PetscDrawFlush(PetscDraw);
141 EXTERN int PetscDrawSynchronizedFlush(PetscDraw);
142 EXTERN int PetscDrawClear(PetscDraw);
143 EXTERN int PetscDrawSynchronizedClear(PetscDraw);
144 EXTERN int PetscDrawBOP(PetscDraw);
145 EXTERN int PetscDrawEOP(PetscDraw);
146 
147 EXTERN int PetscDrawGetSingleton(PetscDraw,PetscDraw*);
148 EXTERN int PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
149 
150 /*E
151     PetscDrawButton - Used to determine which button was pressed
152 
153    Level: intermediate
154 
155 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
156 E*/
157 typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT } PetscDrawButton;
158 
159 EXTERN int PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
160 EXTERN int PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
161 
162 EXTERN int PetscDrawZoom(PetscDraw,int (*)(PetscDraw,void *),void *);
163 
164 /*S
165      PetscDrawViewPorts - Subwindows in a PetscDraw object
166 
167    Level: intermediate
168 
169   Concepts: graphics
170 
171 .seealso:  PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
172 S*/
173 typedef struct {
174   int       nports;
175   PetscReal    *xl,*xr,*yl,*yr;
176   PetscDraw draw;
177 } PetscDrawViewPorts;
178 EXTERN int PetscDrawViewPortsCreate(PetscDraw,int,PetscDrawViewPorts**);
179 EXTERN int PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
180 EXTERN int PetscDrawViewPortsSet(PetscDrawViewPorts*,int);
181 
182 /*S
183      PetscDrawAxis - Manages X-Y axis
184 
185    Level: advanced
186 
187   Concepts: graphics, axis
188 
189 .seealso:  PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
190 S*/
191 typedef struct _p_DrawAxis* PetscDrawAxis;
192 
193 #define DRAWAXIS_COOKIE PETSC_COOKIE+16
194 EXTERN int PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
195 EXTERN int PetscDrawAxisDestroy(PetscDrawAxis);
196 EXTERN int PetscDrawAxisDraw(PetscDrawAxis);
197 EXTERN int PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
198 EXTERN int PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
199 EXTERN int PetscDrawAxisSetLabels(PetscDrawAxis,char*,char*,char*);
200 
201 /*S
202      PetscDrawLG - Manages drawing x-y plots
203 
204    Level: advanced
205 
206   Concepts: graphics, axis
207 
208 .seealso:  PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
209 S*/
210 typedef struct _p_DrawLG*   PetscDrawLG;
211 
212 #define DRAWLG_COOKIE PETSC_COOKIE+7
213 EXTERN int PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
214 EXTERN int PetscDrawLGDestroy(PetscDrawLG);
215 EXTERN int PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
216 EXTERN int PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
217 EXTERN int PetscDrawLGDraw(PetscDrawLG);
218 EXTERN int PetscDrawLGReset(PetscDrawLG);
219 EXTERN int PetscDrawLGSetDimension(PetscDrawLG,int);
220 EXTERN int PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
221 EXTERN int PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
222 EXTERN int PetscDrawLGIndicateDataPoints(PetscDrawLG);
223 EXTERN int PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
224 
225 /*S
226      PetscDrawSP - Manages drawing scatter plots
227 
228    Level: advanced
229 
230   Concepts: graphics, scatter plots
231 
232 .seealso:  PetscDrawSPCreate()
233 S*/
234 typedef struct _p_DrawSP*   PetscDrawSP;
235 
236 #define DRAWSP_COOKIE PETSC_COOKIE+27
237 EXTERN int PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
238 EXTERN int PetscDrawSPDestroy(PetscDrawSP);
239 EXTERN int PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
240 EXTERN int PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
241 EXTERN int PetscDrawSPDraw(PetscDrawSP);
242 EXTERN int PetscDrawSPReset(PetscDrawSP);
243 EXTERN int PetscDrawSPSetDimension(PetscDrawSP,int);
244 EXTERN int PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
245 EXTERN int PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
246 EXTERN int PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
247 
248 /*S
249      PetscDrawHG - Manages drawing histograms
250 
251    Level: advanced
252 
253   Concepts: graphics, histograms
254 
255 .seealso:  PetscDrawHGCreate()
256 S*/
257 typedef struct _p_DrawHG*   PetscDrawHG;
258 
259 #define DRAWHG_COOKIE PETSC_COOKIE+15
260 EXTERN int PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
261 EXTERN int PetscDrawHGDestroy(PetscDrawHG);
262 EXTERN int PetscDrawHGAddValue(PetscDrawHG,PetscReal);
263 EXTERN int PetscDrawHGDraw(PetscDrawHG);
264 EXTERN int PetscDrawHGReset(PetscDrawHG);
265 EXTERN int PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
266 EXTERN int PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
267 EXTERN int PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
268 EXTERN int PetscDrawHGSetNumberBins(PetscDrawHG,int);
269 EXTERN int PetscDrawHGSetColor(PetscDrawHG,int);
270 
271 /*
272     PetscViewer routines that allow you to access underlying PetscDraw objects
273 */
274 EXTERN int PetscViewerDrawGetDraw(PetscViewer,int,PetscDraw*);
275 EXTERN int PetscViewerDrawGetDrawLG(PetscViewer,int,PetscDrawLG*);
276 EXTERN int PetscViewerDrawGetDrawAxis(PetscViewer,int,PetscDrawAxis*);
277 
278 EXTERN int PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
279 EXTERN int PetscDrawUtilitySetGamma(PetscReal);
280 
281 /* Mesh management routines */
282 typedef struct _p_DrawMesh* PetscDrawMesh;
283 int PetscDrawMeshCreate(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,
284 		        int,int,int,int,int,int,int,int,int,int,int,int,int,PetscReal *,int);
285 int PetscDrawMeshCreateSimple(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,int,int,int,int,PetscReal *,int);
286 int PetscDrawMeshDestroy(PetscDrawMesh *);
287 
288 
289 
290 
291 #endif
292 
293 
294 
295 
296 
297