xref: /petsc/include/petscdraw.h (revision b00a91154f763f12aa55f3d53a3f2776f15f49e3)
1 /*
2   Interface to the PETSc graphics (currently only support for X-windows
3 */
4 #if !defined(__PETSCDRAW_H)
5 #define __PETSCDRAW_H
6 #include <petscsys.h>
7 #include <petscdrawtypes.h>
8 
9 PETSC_EXTERN PetscClassId PETSC_DRAW_CLASSID;
10 
11 /*J
12     PetscDrawType - String with the name of a PetscDraw
13 
14    Level: beginner
15 
16 .seealso: PetscDrawSetType(), PetscDraw, PetscViewer, PetscDrawCreate()
17 J*/
18 typedef const char* PetscDrawType;
19 #define PETSC_DRAW_X          "x"
20 #define PETSC_DRAW_GLUT       "glut"
21 #define PETSC_DRAW_OPENGLES   "opengles"
22 #define PETSC_DRAW_NULL       "null"
23 #define PETSC_DRAW_WIN32      "win32"
24 #define PETSC_DRAW_TIKZ       "tikz"
25 
26 PETSC_EXTERN PetscFunctionList PetscDrawList;
27 PETSC_EXTERN PetscErrorCode PetscDrawRegisterAll(void);
28 PETSC_EXTERN PetscErrorCode PetscDrawInitializePackage(void);
29 PETSC_EXTERN PetscErrorCode PetscDrawRegister(const char[],PetscErrorCode(*)(PetscDraw));
30 
31 PETSC_EXTERN PetscErrorCode PetscDrawGetType(PetscDraw,PetscDrawType*);
32 PETSC_EXTERN PetscErrorCode PetscDrawSetType(PetscDraw,PetscDrawType);
33 PETSC_EXTERN PetscErrorCode PetscDrawCreate(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
34 PETSC_EXTERN PetscErrorCode PetscDrawSetFromOptions(PetscDraw);
35 PETSC_EXTERN PetscErrorCode PetscDrawSetSave(PetscDraw,const char*,PetscBool);
36 PETSC_EXTERN PetscErrorCode PetscDrawSetSaveFinalImage(PetscDraw,const char*);
37 PETSC_EXTERN PetscErrorCode PetscDrawView(PetscDraw,PetscViewer);
38 
39 /*
40    Number of basic colors in the draw routines, the others are used
41    for a uniform colormap.
42 */
43 #define PETSC_DRAW_BASIC_COLORS 33
44 
45 #define PETSC_DRAW_ROTATE          -1         /* will rotate through the colors, start with 2 */
46 #define PETSC_DRAW_WHITE            0
47 #define PETSC_DRAW_BLACK            1
48 #define PETSC_DRAW_RED              2
49 #define PETSC_DRAW_GREEN            3
50 #define PETSC_DRAW_CYAN             4
51 #define PETSC_DRAW_BLUE             5
52 #define PETSC_DRAW_MAGENTA          6
53 #define PETSC_DRAW_AQUAMARINE       7
54 #define PETSC_DRAW_FORESTGREEN      8
55 #define PETSC_DRAW_ORANGE           9
56 #define PETSC_DRAW_VIOLET          10
57 #define PETSC_DRAW_BROWN           11
58 #define PETSC_DRAW_PINK            12
59 #define PETSC_DRAW_CORAL           13
60 #define PETSC_DRAW_GRAY            14
61 #define PETSC_DRAW_YELLOW          15
62 
63 #define PETSC_DRAW_GOLD            16
64 #define PETSC_DRAW_LIGHTPINK       17
65 #define PETSC_DRAW_MEDIUMTURQUOISE 18
66 #define PETSC_DRAW_KHAKI           19
67 #define PETSC_DRAW_DIMGRAY         20
68 #define PETSC_DRAW_YELLOWGREEN     21
69 #define PETSC_DRAW_SKYBLUE         22
70 #define PETSC_DRAW_DARKGREEN       23
71 #define PETSC_DRAW_NAVYBLUE        24
72 #define PETSC_DRAW_SANDYBROWN      25
73 #define PETSC_DRAW_CADETBLUE       26
74 #define PETSC_DRAW_POWDERBLUE      27
75 #define PETSC_DRAW_DEEPPINK        28
76 #define PETSC_DRAW_THISTLE         29
77 #define PETSC_DRAW_LIMEGREEN       30
78 #define PETSC_DRAW_LAVENDERBLUSH   31
79 #define PETSC_DRAW_PLUM            32
80 
81 PETSC_EXTERN PetscErrorCode PetscDrawOpenX(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
82 PETSC_EXTERN PetscErrorCode PetscDrawOpenGLUT(MPI_Comm,const char[],const char[],int,int,int,int,PetscDraw*);
83 
84 #define PETSC_DRAW_FULL_SIZE    -3
85 #define PETSC_DRAW_HALF_SIZE    -4
86 #define PETSC_DRAW_THIRD_SIZE   -5
87 #define PETSC_DRAW_QUARTER_SIZE -6
88 
89 PETSC_EXTERN PetscErrorCode PetscDrawOpenNull(MPI_Comm,PetscDraw *);
90 PETSC_EXTERN PetscErrorCode PetscDrawDestroy(PetscDraw*);
91 PETSC_EXTERN PetscErrorCode PetscDrawIsNull(PetscDraw,PetscBool *);
92 
93 PETSC_EXTERN PetscErrorCode PetscDrawGetPopup(PetscDraw,PetscDraw*);
94 PETSC_EXTERN PetscErrorCode PetscDrawCheckResizedWindow(PetscDraw);
95 PETSC_EXTERN PetscErrorCode PetscDrawResizeWindow(PetscDraw,int,int);
96 
97 PETSC_EXTERN PetscErrorCode PetscDrawScalePopup(PetscDraw,PetscReal,PetscReal);
98 
99 PETSC_EXTERN PetscErrorCode PetscDrawPixelToCoordinate(PetscDraw,PetscInt,PetscInt,PetscReal*,PetscReal*);
100 PETSC_EXTERN PetscErrorCode PetscDrawCoordinateToPixel(PetscDraw,PetscReal,PetscReal,PetscInt*,PetscInt*);
101 
102 PETSC_EXTERN PetscErrorCode PetscDrawIndicatorFunction(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,PetscErrorCode (*)(void*,PetscReal,PetscReal,PetscBool*),void*);
103 
104 PETSC_EXTERN PetscErrorCode PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
105 PETSC_EXTERN PetscErrorCode PetscDrawArrow(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
106 PETSC_EXTERN PetscErrorCode PetscDrawLineSetWidth(PetscDraw,PetscReal);
107 PETSC_EXTERN PetscErrorCode PetscDrawLineGetWidth(PetscDraw,PetscReal*);
108 
109 PETSC_EXTERN PetscErrorCode PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
110 PETSC_EXTERN PetscErrorCode PetscDrawPointPixel(PetscDraw,PetscInt,PetscInt,int);
111 PETSC_EXTERN PetscErrorCode PetscDrawPointSetSize(PetscDraw,PetscReal);
112 
113 PETSC_EXTERN PetscErrorCode PetscDrawRectangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int,int);
114 PETSC_EXTERN PetscErrorCode PetscDrawTriangle(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,PetscReal,int,int,int);
115 PETSC_EXTERN PetscErrorCode PetscDrawEllipse(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
116 PETSC_EXTERN PetscErrorCode PetscDrawTensorContourPatch(PetscDraw,int,int,PetscReal*,PetscReal*,PetscReal,PetscReal,PetscReal*);
117 PETSC_EXTERN PetscErrorCode PetscDrawTensorContour(PetscDraw,int,int,const PetscReal[],const PetscReal[],PetscReal *);
118 
119 PETSC_EXTERN PetscErrorCode PetscDrawString(PetscDraw,PetscReal,PetscReal,int,const char[]);
120 PETSC_EXTERN PetscErrorCode PetscDrawBoxedString(PetscDraw,PetscReal,PetscReal,int,int,const char[],PetscReal*,PetscReal*);
121 PETSC_EXTERN PetscErrorCode PetscDrawBoxedStringSize(PetscDraw,const char[],PetscReal*,PetscReal*);
122 PETSC_EXTERN PetscErrorCode PetscDrawStringVertical(PetscDraw,PetscReal,PetscReal,int,const char[]);
123 PETSC_EXTERN PetscErrorCode PetscDrawStringSetSize(PetscDraw,PetscReal,PetscReal);
124 PETSC_EXTERN PetscErrorCode PetscDrawStringGetSize(PetscDraw,PetscReal*,PetscReal*);
125 
126 PETSC_EXTERN PetscErrorCode PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
127 PETSC_EXTERN PetscErrorCode PetscDrawGetViewPort(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
128 PETSC_EXTERN PetscErrorCode PetscDrawSplitViewPort(PetscDraw);
129 
130 PETSC_EXTERN PetscErrorCode PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
131 PETSC_EXTERN PetscErrorCode PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
132 
133 PETSC_EXTERN PetscErrorCode PetscDrawSetTitle(PetscDraw,const char[]);
134 PETSC_EXTERN PetscErrorCode PetscDrawAppendTitle(PetscDraw,const char[]);
135 PETSC_EXTERN PetscErrorCode PetscDrawGetTitle(PetscDraw,char **);
136 
137 PETSC_EXTERN PetscErrorCode PetscDrawSetPause(PetscDraw,PetscReal);
138 PETSC_EXTERN PetscErrorCode PetscDrawGetPause(PetscDraw,PetscReal*);
139 PETSC_EXTERN PetscErrorCode PetscDrawPause(PetscDraw);
140 PETSC_EXTERN PetscErrorCode PetscDrawSetDoubleBuffer(PetscDraw);
141 PETSC_EXTERN PetscErrorCode PetscDrawFlush(PetscDraw);
142 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedFlush(PetscDraw);
143 PETSC_EXTERN PetscErrorCode PetscDrawClear(PetscDraw);
144 PETSC_EXTERN PetscErrorCode PetscDrawSave(PetscDraw);
145 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedClear(PetscDraw);
146 PETSC_EXTERN PetscErrorCode PetscDrawBOP(PetscDraw);
147 PETSC_EXTERN PetscErrorCode PetscDrawEOP(PetscDraw);
148 
149 PETSC_EXTERN PetscErrorCode PetscDrawSetDisplay(PetscDraw,const char[]);
150 PETSC_EXTERN PetscErrorCode PetscDrawGetSingleton(PetscDraw,PetscDraw*);
151 PETSC_EXTERN PetscErrorCode PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
152 
153 PETSC_EXTERN PetscErrorCode PetscDrawGetCurrentPoint(PetscDraw,PetscReal*,PetscReal*);
154 PETSC_EXTERN PetscErrorCode PetscDrawSetCurrentPoint(PetscDraw,PetscReal,PetscReal);
155 PETSC_EXTERN PetscErrorCode PetscDrawPushCurrentPoint(PetscDraw,PetscReal,PetscReal);
156 PETSC_EXTERN PetscErrorCode PetscDrawPopCurrentPoint(PetscDraw);
157 PETSC_EXTERN PetscErrorCode PetscDrawGetBoundingBox(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
158 
159 /*E
160     PetscDrawButton - Used to determine which button was pressed
161 
162    Level: intermediate
163 
164 .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
165 E*/
166 typedef enum {PETSC_BUTTON_NONE,PETSC_BUTTON_LEFT,PETSC_BUTTON_CENTER,PETSC_BUTTON_RIGHT,PETSC_BUTTON_LEFT_SHIFT,PETSC_BUTTON_CENTER_SHIFT,PETSC_BUTTON_RIGHT_SHIFT} PetscDrawButton;
167 
168 PETSC_EXTERN PetscErrorCode PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
169 PETSC_EXTERN PetscErrorCode PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
170 
171 PETSC_EXTERN PetscErrorCode PetscDrawZoom(PetscDraw,PetscErrorCode (*)(PetscDraw,void *),void *);
172 
173 /*S
174      PetscDrawViewPorts - Subwindows in a PetscDraw object
175 
176    Level: intermediate
177 
178   Concepts: graphics
179 
180 .seealso:  PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
181 S*/
182 typedef struct {
183   PetscInt  nports;
184   PetscReal *xl;
185   PetscReal *xr;
186   PetscReal *yl;
187   PetscReal *yr;
188   PetscDraw draw;
189   PetscReal port_xl,port_yl,port_xr,port_yr;   /* original port of parent PetscDraw */
190 
191 } PetscDrawViewPorts;
192 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreate(PetscDraw,PetscInt,PetscDrawViewPorts**);
193 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsCreateRect(PetscDraw,PetscInt,PetscInt,PetscDrawViewPorts**);
194 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
195 PETSC_EXTERN PetscErrorCode PetscDrawViewPortsSet(PetscDrawViewPorts*,PetscInt);
196 
197 PETSC_EXTERN PetscClassId PETSC_DRAWAXIS_CLASSID;
198 
199 PETSC_EXTERN PetscErrorCode PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
200 PETSC_EXTERN PetscErrorCode PetscDrawAxisDestroy(PetscDrawAxis*);
201 PETSC_EXTERN PetscErrorCode PetscDrawAxisDraw(PetscDrawAxis);
202 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
203 PETSC_EXTERN PetscErrorCode PetscDrawAxisGetLimits(PetscDrawAxis,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
204 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetHoldLimits(PetscDrawAxis,PetscBool );
205 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
206 PETSC_EXTERN PetscErrorCode PetscDrawAxisSetLabels(PetscDrawAxis,const char[],const char[],const char[]);
207 
208 PETSC_EXTERN PetscClassId PETSC_DRAWLG_CLASSID;
209 
210 PETSC_EXTERN PetscErrorCode PetscDrawLGCreate(PetscDraw,PetscInt,PetscDrawLG *);
211 PETSC_EXTERN PetscErrorCode PetscDrawLGDestroy(PetscDrawLG*);
212 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoint(PetscDrawLG,const PetscReal*,const PetscReal*);
213 PETSC_EXTERN PetscErrorCode PetscDrawLGAddCommonPoint(PetscDrawLG,const PetscReal,const PetscReal*);
214 PETSC_EXTERN PetscErrorCode PetscDrawLGAddPoints(PetscDrawLG,PetscInt,PetscReal**,PetscReal**);
215 PETSC_EXTERN PetscErrorCode PetscDrawLGDraw(PetscDrawLG);
216 PETSC_EXTERN PetscErrorCode PetscDrawLGView(PetscDrawLG,PetscViewer);
217 PETSC_EXTERN PetscErrorCode PetscDrawLGReset(PetscDrawLG);
218 PETSC_EXTERN PetscErrorCode PetscDrawLGSetDimension(PetscDrawLG,PetscInt);
219 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDimension(PetscDrawLG,PetscInt*);
220 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLegend(PetscDrawLG,const char *const*);
221 PETSC_EXTERN PetscErrorCode PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
222 PETSC_EXTERN PetscErrorCode PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
223 PETSC_EXTERN PetscErrorCode PetscDrawLGIndicateDataPoints(PetscDrawLG,PetscBool);
224 PETSC_EXTERN PetscErrorCode PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
225 PETSC_EXTERN PetscErrorCode PetscDrawLGSetColors(PetscDrawLG,const int*);
226 PETSC_EXTERN PetscErrorCode PetscDrawLGSetFromOptions(PetscDrawLG);
227 
228 PETSC_EXTERN PetscClassId PETSC_DRAWSP_CLASSID;
229 
230 PETSC_EXTERN PetscErrorCode PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
231 PETSC_EXTERN PetscErrorCode PetscDrawSPDestroy(PetscDrawSP*);
232 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
233 PETSC_EXTERN PetscErrorCode PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
234 PETSC_EXTERN PetscErrorCode PetscDrawSPDraw(PetscDrawSP,PetscBool);
235 PETSC_EXTERN PetscErrorCode PetscDrawSPReset(PetscDrawSP);
236 PETSC_EXTERN PetscErrorCode PetscDrawSPSetDimension(PetscDrawSP,int);
237 PETSC_EXTERN PetscErrorCode PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
238 PETSC_EXTERN PetscErrorCode PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
239 PETSC_EXTERN PetscErrorCode PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
240 PETSC_EXTERN PetscErrorCode PetscDrawLGSPDraw(PetscDrawLG,PetscDrawSP);
241 
242 PETSC_EXTERN PetscClassId PETSC_DRAWHG_CLASSID;
243 
244 PETSC_EXTERN PetscErrorCode PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
245 PETSC_EXTERN PetscErrorCode PetscDrawHGDestroy(PetscDrawHG*);
246 PETSC_EXTERN PetscErrorCode PetscDrawHGAddValue(PetscDrawHG,PetscReal);
247 PETSC_EXTERN PetscErrorCode PetscDrawHGDraw(PetscDrawHG);
248 PETSC_EXTERN PetscErrorCode PetscDrawHGView(PetscDrawHG,PetscViewer);
249 PETSC_EXTERN PetscErrorCode PetscDrawHGReset(PetscDrawHG);
250 PETSC_EXTERN PetscErrorCode PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
251 PETSC_EXTERN PetscErrorCode PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
252 PETSC_EXTERN PetscErrorCode PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
253 PETSC_EXTERN PetscErrorCode PetscDrawHGSetNumberBins(PetscDrawHG,int);
254 PETSC_EXTERN PetscErrorCode PetscDrawHGSetColor(PetscDrawHG,int);
255 PETSC_EXTERN PetscErrorCode PetscDrawHGCalcStats(PetscDrawHG, PetscBool );
256 PETSC_EXTERN PetscErrorCode PetscDrawHGIntegerBins(PetscDrawHG, PetscBool );
257 
258 /*
259     PetscViewer routines that allow you to access underlying PetscDraw objects
260 */
261 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDraw(PetscViewer,PetscInt,PetscDraw*);
262 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseAdd(PetscViewer,PetscInt);
263 PETSC_EXTERN PetscErrorCode PetscViewerDrawBaseSet(PetscViewer,PetscInt);
264 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawLG(PetscViewer,PetscInt,PetscDrawLG*);
265 PETSC_EXTERN PetscErrorCode PetscViewerDrawGetDrawAxis(PetscViewer,PetscInt,PetscDrawAxis*);
266 
267 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
268 PETSC_EXTERN PetscErrorCode PetscDrawUtilitySetGamma(PetscReal);
269 
270 #endif
271