Actual source code: petscdraw.h
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: */
7: #include petsc.h
9: extern int PETSC_DRAW_COOKIE;
11: /*E
12: PetscDrawType - String with the name of a PetscDraw
14: Level: beginner
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
27: Level: beginner
29: Concepts: graphics
31: .seealso: PetscDrawCreate(), PetscDrawSetType(), PetscDrawType
32: S*/
33: typedef struct _p_PetscDraw* PetscDraw;
35: extern PetscFList PetscDrawList;
36: EXTERN int PetscDrawRegisterAll(char *);
37: EXTERN int PetscDrawRegisterDestroy(void);
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);
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
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
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
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
99: EXTERN int PetscDrawOpenNull(MPI_Comm,PetscDraw *);
100: EXTERN int PetscDrawDestroy(PetscDraw);
101: EXTERN int PetscDrawIsNull(PetscDraw,PetscTruth*);
103: EXTERN int PetscDrawGetPopup(PetscDraw,PetscDraw*);
104: EXTERN int PetscDrawCheckResizedWindow(PetscDraw);
105: EXTERN int PetscDrawResizeWindow(PetscDraw,int,int);
107: EXTERN int PetscDrawScalePopup(PetscDraw,PetscReal min,PetscReal max);
109: EXTERN int PetscDrawLine(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal,int);
110: EXTERN int PetscDrawLineSetWidth(PetscDraw,PetscReal);
111: EXTERN int PetscDrawLineGetWidth(PetscDraw,PetscReal*);
113: EXTERN int PetscDrawPoint(PetscDraw,PetscReal,PetscReal,int);
114: EXTERN int PetscDrawPointSetSize(PetscDraw,PetscReal);
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 *);
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*);
127: EXTERN int PetscDrawSetViewPort(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
128: EXTERN int PetscDrawSplitViewPort(PetscDraw);
130: EXTERN int PetscDrawSetCoordinates(PetscDraw,PetscReal,PetscReal,PetscReal,PetscReal);
131: EXTERN int PetscDrawGetCoordinates(PetscDraw,PetscReal*,PetscReal*,PetscReal*,PetscReal*);
133: EXTERN int PetscDrawSetTitle(PetscDraw,char *);
134: EXTERN int PetscDrawAppendTitle(PetscDraw,char *);
135: EXTERN int PetscDrawGetTitle(PetscDraw,char **);
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);
148: EXTERN int PetscDrawGetSingleton(PetscDraw,PetscDraw*);
149: EXTERN int PetscDrawRestoreSingleton(PetscDraw,PetscDraw*);
151: /*E
152: PetscDrawButton - Used to determine which button was pressed
154: Level: intermediate
156: .seealso: PetscDrawGetMouseButton(), PetscDrawSynchronizedGetMouseButton()
157: E*/
158: typedef enum {BUTTON_NONE,BUTTON_LEFT,BUTTON_CENTER,BUTTON_RIGHT,BUTTON_LEFT_SHIFT,BUTTON_CENTER_SHIFT,BUTTON_RIGHT_SHIFT} PetscDrawButton;
160: EXTERN int PetscDrawGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
161: EXTERN int PetscDrawSynchronizedGetMouseButton(PetscDraw,PetscDrawButton *,PetscReal*,PetscReal *,PetscReal *,PetscReal *);
163: EXTERN int PetscDrawZoom(PetscDraw,int (*)(PetscDraw,void *),void *);
165: /*S
166: PetscDrawViewPorts - Subwindows in a PetscDraw object
168: Level: intermediate
170: Concepts: graphics
172: .seealso: PetscDrawViewPortsCreate(), PetscDrawViewPortsSet()
173: S*/
174: typedef struct {
175: int nports;
176: PetscReal *xl,*xr,*yl,*yr;
177: PetscDraw draw;
178: } PetscDrawViewPorts;
179: EXTERN int PetscDrawViewPortsCreate(PetscDraw,int,PetscDrawViewPorts**);
180: EXTERN int PetscDrawViewPortsDestroy(PetscDrawViewPorts*);
181: EXTERN int PetscDrawViewPortsSet(PetscDrawViewPorts*,int);
183: /*S
184: PetscDrawAxis - Manages X-Y axis
186: Level: advanced
188: Concepts: graphics, axis
190: .seealso: PetscDrawAxisCreate(), PetscDrawAxisSetLimits(), PetscDrawAxisSetColors(), PetscDrawAxisSetLabels()
191: S*/
192: typedef struct _p_DrawAxis* PetscDrawAxis;
194: extern int DRAWAXIS_COOKIE;
196: EXTERN int PetscDrawAxisCreate(PetscDraw,PetscDrawAxis *);
197: EXTERN int PetscDrawAxisDestroy(PetscDrawAxis);
198: EXTERN int PetscDrawAxisDraw(PetscDrawAxis);
199: EXTERN int PetscDrawAxisSetLimits(PetscDrawAxis,PetscReal,PetscReal,PetscReal,PetscReal);
200: EXTERN int PetscDrawAxisSetColors(PetscDrawAxis,int,int,int);
201: EXTERN int PetscDrawAxisSetLabels(PetscDrawAxis,char*,char*,char*);
203: /*S
204: PetscDrawLG - Manages drawing x-y plots
206: Level: advanced
208: Concepts: graphics, axis
210: .seealso: PetscDrawAxisCreate(), PetscDrawLGCreate(), PetscDrawLGAddPoint()
211: S*/
212: typedef struct _p_DrawLG* PetscDrawLG;
214: extern int DRAWLG_COOKIE;
216: EXTERN int PetscDrawLGCreate(PetscDraw,int,PetscDrawLG *);
217: EXTERN int PetscDrawLGDestroy(PetscDrawLG);
218: EXTERN int PetscDrawLGAddPoint(PetscDrawLG,PetscReal*,PetscReal*);
219: EXTERN int PetscDrawLGAddPoints(PetscDrawLG,int,PetscReal**,PetscReal**);
220: EXTERN int PetscDrawLGDraw(PetscDrawLG);
221: EXTERN int PetscDrawLGPrint(PetscDrawLG);
222: EXTERN int PetscDrawLGReset(PetscDrawLG);
223: EXTERN int PetscDrawLGSetDimension(PetscDrawLG,int);
224: EXTERN int PetscDrawLGGetAxis(PetscDrawLG,PetscDrawAxis *);
225: EXTERN int PetscDrawLGGetDraw(PetscDrawLG,PetscDraw *);
226: EXTERN int PetscDrawLGIndicateDataPoints(PetscDrawLG);
227: EXTERN int PetscDrawLGSetLimits(PetscDrawLG,PetscReal,PetscReal,PetscReal,PetscReal);
229: /*S
230: PetscDrawSP - Manages drawing scatter plots
232: Level: advanced
234: Concepts: graphics, scatter plots
236: .seealso: PetscDrawSPCreate()
237: S*/
238: typedef struct _p_DrawSP* PetscDrawSP;
240: extern int DRAWSP_COOKIE;
242: EXTERN int PetscDrawSPCreate(PetscDraw,int,PetscDrawSP *);
243: EXTERN int PetscDrawSPDestroy(PetscDrawSP);
244: EXTERN int PetscDrawSPAddPoint(PetscDrawSP,PetscReal*,PetscReal*);
245: EXTERN int PetscDrawSPAddPoints(PetscDrawSP,int,PetscReal**,PetscReal**);
246: EXTERN int PetscDrawSPDraw(PetscDrawSP);
247: EXTERN int PetscDrawSPReset(PetscDrawSP);
248: EXTERN int PetscDrawSPSetDimension(PetscDrawSP,int);
249: EXTERN int PetscDrawSPGetAxis(PetscDrawSP,PetscDrawAxis *);
250: EXTERN int PetscDrawSPGetDraw(PetscDrawSP,PetscDraw *);
251: EXTERN int PetscDrawSPSetLimits(PetscDrawSP,PetscReal,PetscReal,PetscReal,PetscReal);
253: /*S
254: PetscDrawHG - Manages drawing histograms
256: Level: advanced
258: Concepts: graphics, histograms
260: .seealso: PetscDrawHGCreate()
261: S*/
262: typedef struct _p_DrawHG* PetscDrawHG;
264: extern int DRAWHG_COOKIE;
266: EXTERN int PetscDrawHGCreate(PetscDraw,int,PetscDrawHG *);
267: EXTERN int PetscDrawHGDestroy(PetscDrawHG);
268: EXTERN int PetscDrawHGAddValue(PetscDrawHG,PetscReal);
269: EXTERN int PetscDrawHGDraw(PetscDrawHG);
270: EXTERN int PetscDrawHGPrint(PetscDrawHG);
271: EXTERN int PetscDrawHGReset(PetscDrawHG);
272: EXTERN int PetscDrawHGGetAxis(PetscDrawHG,PetscDrawAxis *);
273: EXTERN int PetscDrawHGGetDraw(PetscDrawHG,PetscDraw *);
274: EXTERN int PetscDrawHGSetLimits(PetscDrawHG,PetscReal,PetscReal,int,int);
275: EXTERN int PetscDrawHGSetNumberBins(PetscDrawHG,int);
276: EXTERN int PetscDrawHGSetColor(PetscDrawHG,int);
277: EXTERN int PetscDrawHGCalcStats(PetscDrawHG, PetscTruth);
278: EXTERN int PetscDrawHGIntegerBins(PetscDrawHG, PetscTruth);
280: /*
281: PetscViewer routines that allow you to access underlying PetscDraw objects
282: */
283: EXTERN int PetscViewerDrawGetDraw(PetscViewer,int,PetscDraw*);
284: EXTERN int PetscViewerDrawGetDrawLG(PetscViewer,int,PetscDrawLG*);
285: EXTERN int PetscViewerDrawGetDrawAxis(PetscViewer,int,PetscDrawAxis*);
287: EXTERN int PetscDrawUtilitySetCmapHue(unsigned char *,unsigned char *,unsigned char *,int);
288: EXTERN int PetscDrawUtilitySetGamma(PetscReal);
290: /* Mesh management routines */
291: typedef struct _p_DrawMesh* PetscDrawMesh;
292: int PetscDrawMeshCreate(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,
293: int,int,int,int,int,int,int,int,int,int,int,int,int,PetscReal *,int);
294: int PetscDrawMeshCreateSimple(PetscDrawMesh *,PetscReal *,PetscReal *,PetscReal *,int,int,int,int,PetscReal *,int);
295: int PetscDrawMeshDestroy(PetscDrawMesh *);
300: #endif