xref: /petsc/include/petscdraw.h (revision ca44d042d6f86ecc01fa7a52a5213a5161f95f53)
1 /* $Id: petscdraw.h,v 1.71 2000/05/08 15:09:50 balay 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 DRAW_COOKIE PETSC_COOKIE+6
10 
11 /* types of draw contexts */
12 #define DRAW_X    "x"
13 #define DRAW_NULL "null"
14 #define DRAW_PS   "ps"
15 
16 typedef struct _p_Draw* Draw;
17 
18 typedef char* DrawType;
19 extern FList DrawList;
20 EXTERN int DrawRegisterAll(char *);
21 EXTERN int DrawRegisterDestroy(void);
22 
23 EXTERN int DrawRegister(char*,char*,char*,int(*)(Draw));
24 #if defined(PETSC_USE_DYNAMIC_LIBRARIES)
25 #define DrawRegisterDynamic(a,b,c,d) DrawRegister(a,b,c,0)
26 #else
27 #define DrawRegisterDynamic(a,b,c,d) DrawRegister(a,b,c,d)
28 #endif
29 EXTERN int DrawGetType(Draw,DrawType*);
30 EXTERN int DrawSetType(Draw,DrawType);
31 EXTERN int DrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,Draw*);
32 EXTERN int DrawSetFromOptions(Draw);
33 
34 /*
35    Number of basic colors in the draw routines, the others are used
36    for a uniform colormap.
37 */
38 #define DRAW_BASIC_COLORS 32
39 
40 #define DRAW_ROTATE          -1         /* will rotate through the colors, start with 2 */
41 #define DRAW_WHITE            0
42 #define DRAW_BLACK            1
43 #define DRAW_RED              2
44 #define DRAW_GREEN            3
45 #define DRAW_CYAN             4
46 #define DRAW_BLUE             5
47 #define DRAW_MAGENTA          6
48 #define DRAW_AQUAMARINE       7
49 #define DRAW_FORESTGREEN      8
50 #define DRAW_ORANGE           9
51 #define DRAW_VIOLET          10
52 #define DRAW_BROWN           11
53 #define DRAW_PINK            12
54 #define DRAW_CORAL           13
55 #define DRAW_GRAY            14
56 #define DRAW_YELLOW          15
57 
58 #define DRAW_GOLD            16
59 #define DRAW_LIGHTPINK       17
60 #define DRAW_MEDIUMTURQUOISE 18
61 #define DRAW_KHAKI           19
62 #define DRAW_DIMGRAY         20
63 #define DRAW_YELLOWGREEN     21
64 #define DRAW_SKYBLUE         22
65 #define DRAW_DARKGREEN       23
66 #define DRAW_NAVYBLUE        24
67 #define DRAW_SANDYBROWN      25
68 #define DRAW_CADETBLUE       26
69 #define DRAW_POWDERBLUE      27
70 #define DRAW_DEEPPINK        28
71 #define DRAW_THISTLE         29
72 #define DRAW_LIMEGREEN       30
73 #define DRAW_LAVENDERBLUSH   31
74 
75 
76 EXTERN int DrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,Draw*);
77 EXTERN int DrawOpenPS(MPI_Comm,char *,Draw *);
78 #define DRAW_FULL_SIZE    -3
79 #define DRAW_HALF_SIZE    -4
80 #define DRAW_THIRD_SIZE   -5
81 #define DRAW_QUARTER_SIZE -6
82 
83 EXTERN int DrawOpenNull(MPI_Comm,Draw *);
84 EXTERN int DrawDestroy(Draw);
85 EXTERN int DrawIsNull(Draw,PetscTruth*);
86 
87 EXTERN int DrawGetPopup(Draw,Draw*);
88 EXTERN int DrawCheckResizedWindow(Draw);
89 EXTERN int DrawResizeWindow(Draw,int,int);
90 
91 EXTERN int DrawScalePopup(Draw,double min,double max);
92 
93 EXTERN int DrawLine(Draw,double,double,double,double,int);
94 EXTERN int DrawLineSetWidth(Draw,double);
95 EXTERN int DrawLineGetWidth(Draw,double*);
96 
97 EXTERN int DrawPoint(Draw,double,double,int);
98 EXTERN int DrawPointSetSize(Draw,double);
99 
100 EXTERN int DrawRectangle(Draw,double,double,double,double,int,int,int,int);
101 EXTERN int DrawTriangle(Draw,double,double,double,double,double,double,int,int,int);
102 EXTERN int DrawTensorContourPatch(Draw,int,int,double*,double*,double,double,Scalar*);
103 EXTERN int DrawTensorContour(Draw,int,int,const double[],const double[],Scalar *);
104 
105 EXTERN int DrawString(Draw,double,double,int,char*);
106 EXTERN int DrawStringVertical(Draw,double,double,int,char*);
107 EXTERN int DrawStringSetSize(Draw,double,double);
108 EXTERN int DrawStringGetSize(Draw,double*,double*);
109 
110 EXTERN int DrawSetViewPort(Draw,double,double,double,double);
111 EXTERN int DrawSplitViewPort(Draw);
112 
113 EXTERN int DrawSetCoordinates(Draw,double,double,double,double);
114 EXTERN int DrawGetCoordinates(Draw,double*,double*,double*,double*);
115 
116 EXTERN int DrawSetTitle(Draw,char *);
117 EXTERN int DrawAppendTitle(Draw,char *);
118 EXTERN int DrawGetTitle(Draw,char **);
119 
120 EXTERN int DrawSetPause(Draw,int);
121 EXTERN int DrawGetPause(Draw,int*);
122 EXTERN int DrawPause(Draw);
123 EXTERN int DrawSetDoubleBuffer(Draw);
124 EXTERN int DrawFlush(Draw);
125 EXTERN int DrawSynchronizedFlush(Draw);
126 EXTERN int DrawClear(Draw);
127 EXTERN int DrawSynchronizedClear(Draw);
128 EXTERN int DrawBOP(Draw);
129 EXTERN int DrawEOP(Draw);
130 
131 EXTERN int DrawGetSingleton(Draw,Draw*);
132 EXTERN int DrawRestoreSingleton(Draw,Draw*);
133 
134 typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT } DrawButton;
135 EXTERN int DrawGetMouseButton(Draw,DrawButton *,double*,double *,double *,double *);
136 EXTERN int DrawSynchronizedGetMouseButton(Draw,DrawButton *,double*,double *,double *,double *);
137 
138 EXTERN int DrawZoom(Draw,int (*)(Draw,void *),void *);
139 
140 /*   Allows one to maintain a subset of viewports for a single window */
141 typedef struct {
142   int    nports;
143   double *xl,*xr,*yl,*yr;
144   Draw   draw;
145 } DrawViewPorts;
146 EXTERN int DrawViewPortsCreate(Draw,int,DrawViewPorts**);
147 EXTERN int DrawViewPortsDestroy(DrawViewPorts*);
148 EXTERN int DrawViewPortsSet(DrawViewPorts*,int);
149 
150 /*
151     Routines for drawing X-Y axises in a Draw object
152 */
153 typedef struct _p_DrawAxis* DrawAxis;
154 #define DRAWAXIS_COOKIE PETSC_COOKIE+16
155 EXTERN int DrawAxisCreate(Draw,DrawAxis *);
156 EXTERN int DrawAxisDestroy(DrawAxis);
157 EXTERN int DrawAxisDraw(DrawAxis);
158 EXTERN int DrawAxisSetLimits(DrawAxis,double,double,double,double);
159 EXTERN int DrawAxisSetColors(DrawAxis,int,int,int);
160 EXTERN int DrawAxisSetLabels(DrawAxis,char*,char*,char*);
161 
162 /*
163     Routines to draw line curves in X-Y space
164 */
165 typedef struct _p_DrawLG*   DrawLG;
166 #define DRAWLG_COOKIE PETSC_COOKIE+7
167 EXTERN int DrawLGCreate(Draw,int,DrawLG *);
168 EXTERN int DrawLGDestroy(DrawLG);
169 EXTERN int DrawLGAddPoint(DrawLG,double*,double*);
170 EXTERN int DrawLGAddPoints(DrawLG,int,double**,double**);
171 EXTERN int DrawLGDraw(DrawLG);
172 EXTERN int DrawLGReset(DrawLG);
173 EXTERN int DrawLGSetDimension(DrawLG,int);
174 EXTERN int DrawLGGetAxis(DrawLG,DrawAxis *);
175 EXTERN int DrawLGGetDraw(DrawLG,Draw *);
176 EXTERN int DrawLGIndicateDataPoints(DrawLG);
177 EXTERN int DrawLGSetLimits(DrawLG,double,double,double,double);
178 
179 /*
180     Routines to draw scatter plots in complex space
181 */
182 typedef struct _p_DrawSP*   DrawSP;
183 #define DRAWSP_COOKIE PETSC_COOKIE+27
184 EXTERN int DrawSPCreate(Draw,int,DrawSP *);
185 EXTERN int DrawSPDestroy(DrawSP);
186 EXTERN int DrawSPAddPoint(DrawSP,double*,double*);
187 EXTERN int DrawSPAddPoints(DrawSP,int,double**,double**);
188 EXTERN int DrawSPDraw(DrawSP);
189 EXTERN int DrawSPReset(DrawSP);
190 EXTERN int DrawSPSetDimension(DrawSP,int);
191 EXTERN int DrawSPGetAxis(DrawSP,DrawAxis *);
192 EXTERN int DrawSPGetDraw(DrawSP,Draw *);
193 EXTERN int DrawSPSetLimits(DrawSP,double,double,double,double);
194 
195 /*
196     Routines to draw histograms
197 */
198 typedef struct _p_DrawHG*   DrawHG;
199 #define DRAWHG_COOKIE PETSC_COOKIE+15
200 EXTERN int DrawHGCreate(Draw,int,DrawHG *);
201 EXTERN int DrawHGDestroy(DrawHG);
202 EXTERN int DrawHGAddValue(DrawHG,double);
203 EXTERN int DrawHGDraw(DrawHG);
204 EXTERN int DrawHGReset(DrawHG);
205 EXTERN int DrawHGGetAxis(DrawHG,DrawAxis *);
206 EXTERN int DrawHGGetDraw(DrawHG,Draw *);
207 EXTERN int DrawHGSetLimits(DrawHG,double,double,int,int);
208 EXTERN int DrawHGSetNumberBins(DrawHG,int);
209 EXTERN int DrawHGSetColor(DrawHG,int);
210 
211 /*
212     Viewer routines that allow you to access underlying Draw objects
213 */
214 EXTERN int ViewerDrawGetDraw(Viewer,int,Draw*);
215 EXTERN int ViewerDrawGetDrawLG(Viewer,int,DrawLG*);
216 EXTERN int ViewerDrawGetDrawAxis(Viewer,int,DrawAxis*);
217 
218 EXTERN int DrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
219 EXTERN int DrawUtilitySetGamma(double);
220 
221 /* Mesh management routines */
222 typedef struct _p_DrawMesh* DrawMesh;
223 int DrawMeshCreate(DrawMesh *,
224 		    double *,double *,double *,
225 		    int,int,int,int,int,int,int,int,int,
226 		    int,int,int,int,double *,int);
227 int DrawMeshCreateSimple(DrawMesh *,double *,double *,double *,
228 			  int,int,int,int,double *,int);
229 int DrawMeshDestroy(DrawMesh *);
230 
231 
232 
233 
234 #endif
235 
236 
237 
238 
239 
240