1 2 /* 3 Provides the calling sequences for all the basic PetscDraw routines. 4 */ 5 #include <petsc/private/drawimpl.h> /*I "petscdraw.h" I*/ 6 7 /*@ 8 PetscDrawGetBoundingBox - Gets the bounding box of all PetscDrawStringBoxed() commands 9 10 Not collective 11 12 Input Parameter: 13 . draw - the drawing context 14 15 Output Parameters: 16 . xl,yl,xr,yr - coordinates of lower left and upper right corners of bounding box 17 18 Level: intermediate 19 20 .seealso: PetscDrawPushCurrentPoint(), PetscDrawPopCurrentPoint(), PetscDrawSetCurrentPoint() 21 @*/ 22 PetscErrorCode PetscDrawGetBoundingBox(PetscDraw draw,PetscReal *xl,PetscReal *yl,PetscReal *xr,PetscReal *yr) 23 { 24 PetscFunctionBegin; 25 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 26 if (xl) PetscValidRealPointer(xl,2); 27 if (yl) PetscValidRealPointer(yl,3); 28 if (xr) PetscValidRealPointer(xr,4); 29 if (yr) PetscValidRealPointer(yr,5); 30 if (xl) *xl = draw->boundbox_xl; 31 if (yl) *yl = draw->boundbox_yl; 32 if (xr) *xr = draw->boundbox_xr; 33 if (yr) *yr = draw->boundbox_yr; 34 PetscFunctionReturn(0); 35 } 36 37 /*@ 38 PetscDrawGetCurrentPoint - Gets the current draw point, some codes use this point to determine where to draw next 39 40 Not collective 41 42 Input Parameter: 43 . draw - the drawing context 44 45 Output Parameters: 46 . x,y - the current point 47 48 Level: intermediate 49 50 .seealso: PetscDrawPushCurrentPoint(), PetscDrawPopCurrentPoint(), PetscDrawSetCurrentPoint() 51 @*/ 52 PetscErrorCode PetscDrawGetCurrentPoint(PetscDraw draw,PetscReal *x,PetscReal *y) 53 { 54 PetscFunctionBegin; 55 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 56 PetscValidRealPointer(x,2); 57 PetscValidRealPointer(y,3); 58 *x = draw->currentpoint_x[draw->currentpoint]; 59 *y = draw->currentpoint_y[draw->currentpoint]; 60 PetscFunctionReturn(0); 61 } 62 63 /*@ 64 PetscDrawSetCurrentPoint - Sets the current draw point, some codes use this point to determine where to draw next 65 66 Not collective 67 68 Input Parameters: 69 + draw - the drawing context 70 - x,y - the location of the current point 71 72 Level: intermediate 73 74 .seealso: PetscDrawPushCurrentPoint(), PetscDrawPopCurrentPoint(), PetscDrawGetCurrentPoint() 75 @*/ 76 PetscErrorCode PetscDrawSetCurrentPoint(PetscDraw draw,PetscReal x,PetscReal y) 77 { 78 PetscFunctionBegin; 79 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 80 draw->currentpoint_x[draw->currentpoint] = x; 81 draw->currentpoint_y[draw->currentpoint] = y; 82 PetscFunctionReturn(0); 83 } 84 85 /*@ 86 PetscDrawPushCurrentPoint - Pushes a new current draw point, retaining the old one, some codes use this point to determine where to draw next 87 88 Not collective 89 90 Input Parameters: 91 + draw - the drawing context 92 - x,y - the location of the current point 93 94 Level: intermediate 95 96 .seealso: PetscDrawPushCurrentPoint(), PetscDrawPopCurrentPoint(), PetscDrawGetCurrentPoint() 97 @*/ 98 PetscErrorCode PetscDrawPushCurrentPoint(PetscDraw draw,PetscReal x,PetscReal y) 99 { 100 PetscFunctionBegin; 101 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 102 if (draw->currentpoint > 19) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You have pushed too many current points"); 103 draw->currentpoint_x[++draw->currentpoint] = x; 104 draw->currentpoint_y[draw->currentpoint] = y; 105 PetscFunctionReturn(0); 106 } 107 108 /*@ 109 PetscDrawPopCurrentPoint - Pops a current draw point (discarding it) 110 111 Not collective 112 113 Input Parameter: 114 . draw - the drawing context 115 116 Level: intermediate 117 118 .seealso: PetscDrawPushCurrentPoint(), PetscDrawSetCurrentPoint(), PetscDrawGetCurrentPoint() 119 @*/ 120 PetscErrorCode PetscDrawPopCurrentPoint(PetscDraw draw) 121 { 122 PetscFunctionBegin; 123 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 124 if (draw->currentpoint-- == 0) SETERRQ(PETSC_COMM_SELF,PETSC_ERR_SUP,"You have popped too many current points"); 125 PetscFunctionReturn(0); 126 } 127 128 /*@ 129 PetscDrawLine - PetscDraws a line onto a drawable. 130 131 Not collective 132 133 Input Parameters: 134 + draw - the drawing context 135 . xl,yl,xr,yr - the coordinates of the line endpoints 136 - cl - the colors of the endpoints 137 138 Level: beginner 139 140 .seealso: PetscDrawArrow(), PetscDrawLineSetWidth(), PetscDrawLineGetWidth(), PetscDrawRectangle(), PetscDrawTriangle(), PetscDrawEllipse(), 141 PetscDrawMarker(), PetscDrawPoint() 142 143 @*/ 144 PetscErrorCode PetscDrawLine(PetscDraw draw,PetscReal xl,PetscReal yl,PetscReal xr,PetscReal yr,int cl) 145 { 146 PetscErrorCode ierr; 147 148 PetscFunctionBegin; 149 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 150 if (!draw->ops->line) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"This draw type %s does not support drawing lines",((PetscObject)draw)->type_name); 151 ierr = (*draw->ops->line)(draw,xl,yl,xr,yr,cl);CHKERRQ(ierr); 152 PetscFunctionReturn(0); 153 } 154 155 /*@ 156 PetscDrawArrow - PetscDraws a line with arrow head at end if the line is long enough 157 158 Not collective 159 160 Input Parameters: 161 + draw - the drawing context 162 . xl,yl,xr,yr - the coordinates of the line endpoints 163 - cl - the colors of the endpoints 164 165 Level: beginner 166 167 .seealso: PetscDrawLine(), PetscDrawLineSetWidth(), PetscDrawLineGetWidth(), PetscDrawRectangle(), PetscDrawTriangle(), PetscDrawEllipse(), 168 PetscDrawMarker(), PetscDrawPoint() 169 170 @*/ 171 PetscErrorCode PetscDrawArrow(PetscDraw draw,PetscReal xl,PetscReal yl,PetscReal xr,PetscReal yr,int cl) 172 { 173 PetscErrorCode ierr; 174 175 PetscFunctionBegin; 176 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 177 if (!draw->ops->arrow) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"This draw type %s does not support drawing arrows",((PetscObject)draw)->type_name); 178 ierr = (*draw->ops->arrow)(draw,xl,yl,xr,yr,cl);CHKERRQ(ierr); 179 PetscFunctionReturn(0); 180 } 181 182 /*@ 183 PetscDrawLineSetWidth - Sets the line width for future draws. The width is 184 relative to the user coordinates of the window; 0.0 denotes the natural 185 width; 1.0 denotes the entire viewport. 186 187 Not collective 188 189 Input Parameters: 190 + draw - the drawing context 191 - width - the width in user coordinates 192 193 Level: advanced 194 195 .seealso: PetscDrawLineGetWidth(), PetscDrawLine(), PetscDrawArrow() 196 @*/ 197 PetscErrorCode PetscDrawLineSetWidth(PetscDraw draw,PetscReal width) 198 { 199 PetscErrorCode ierr; 200 201 PetscFunctionBegin; 202 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 203 if (draw->ops->linesetwidth) { 204 ierr = (*draw->ops->linesetwidth)(draw,width);CHKERRQ(ierr); 205 } 206 PetscFunctionReturn(0); 207 } 208 209 /*@ 210 PetscDrawLineGetWidth - Gets the line width for future draws. The width is 211 relative to the user coordinates of the window; 0.0 denotes the natural 212 width; 1.0 denotes the interior viewport. 213 214 Not collective 215 216 Input Parameter: 217 . draw - the drawing context 218 219 Output Parameter: 220 . width - the width in user coordinates 221 222 Level: advanced 223 224 Notes: 225 Not currently implemented. 226 227 .seealso: PetscDrawLineSetWidth(), PetscDrawLine(), PetscDrawArrow() 228 @*/ 229 PetscErrorCode PetscDrawLineGetWidth(PetscDraw draw,PetscReal *width) 230 { 231 PetscErrorCode ierr; 232 233 PetscFunctionBegin; 234 PetscValidHeaderSpecific(draw,PETSC_DRAW_CLASSID,1); 235 PetscValidRealPointer(width,2); 236 if (!draw->ops->linegetwidth) SETERRQ1(PETSC_COMM_SELF,PETSC_ERR_SUP,"This draw type %s does not support getting line width",((PetscObject)draw)->type_name); 237 ierr = (*draw->ops->linegetwidth)(draw,width);CHKERRQ(ierr); 238 PetscFunctionReturn(0); 239 } 240 241