xref: /petsc/src/sys/classes/draw/interface/dline.c (revision e8e8640d1cb9a3a2f50c0c0d7b26e5c4d521e2e4)

/*
       Provides the calling sequences for all the basic PetscDraw routines.
*/
#include <petsc/private/drawimpl.h> /*I "petscdraw.h" I*/

/*@
  PetscDrawGetBoundingBox - Gets the bounding box of all `PetscDrawStringBoxed()` commands

  Not Collective

  Input Parameter:
. draw - the drawing context

  Output Parameters:
+ xl - horizontal coordinate of lower left corner of bounding box
. yl - vertical coordinate of lower left corner of bounding box
. xr - horizontal coordinate of upper right corner of bounding box
- yr - vertical coordinate of upper right corner of bounding box

  Level: intermediate

.seealso: `PetscDraw`, `PetscDrawPushCurrentPoint()`, `PetscDrawPopCurrentPoint()`, `PetscDrawSetCurrentPoint()`
@*/
PetscErrorCode PetscDrawGetBoundingBox(PetscDraw draw, PetscReal *xl, PetscReal *yl, PetscReal *xr, PetscReal *yr)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  if (xl) PetscAssertPointer(xl, 2);
  if (yl) PetscAssertPointer(yl, 3);
  if (xr) PetscAssertPointer(xr, 4);
  if (yr) PetscAssertPointer(yr, 5);
  if (xl) *xl = draw->boundbox_xl;
  if (yl) *yl = draw->boundbox_yl;
  if (xr) *xr = draw->boundbox_xr;
  if (yr) *yr = draw->boundbox_yr;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawGetCurrentPoint - Gets the current draw point, some codes use this point to determine where to draw next

  Not Collective

  Input Parameter:
. draw - the drawing context

  Output Parameters:
+ x - horizontal coordinate of the current point
- y - vertical coordinate of the current point

  Level: intermediate

.seealso: `PetscDraw`, `PetscDrawPushCurrentPoint()`, `PetscDrawPopCurrentPoint()`, `PetscDrawSetCurrentPoint()`
@*/
PetscErrorCode PetscDrawGetCurrentPoint(PetscDraw draw, PetscReal *x, PetscReal *y)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscAssertPointer(x, 2);
  PetscAssertPointer(y, 3);
  *x = draw->currentpoint_x[draw->currentpoint];
  *y = draw->currentpoint_y[draw->currentpoint];
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawSetCurrentPoint - Sets the current draw point, some codes use this point to determine where to draw next

  Not Collective

  Input Parameters:
+ draw - the drawing context
. x    - horizontal coordinate of the current point
- y    - vertical coordinate of the current point

  Level: intermediate

.seealso: `PetscDraw`, `PetscDrawPushCurrentPoint()`, `PetscDrawPopCurrentPoint()`, `PetscDrawGetCurrentPoint()`
@*/
PetscErrorCode PetscDrawSetCurrentPoint(PetscDraw draw, PetscReal x, PetscReal y)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  draw->currentpoint_x[draw->currentpoint] = x;
  draw->currentpoint_y[draw->currentpoint] = y;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawPushCurrentPoint - Pushes a new current draw point, retaining the old one, some codes use this point to determine where to draw next

  Not Collective

  Input Parameters:
+ draw - the drawing context
. x    - horizontal coordinate of the current point
- y    - vertical coordinate of the current point

  Level: intermediate

.seealso: `PetscDraw`, `PetscDrawPopCurrentPoint()`, `PetscDrawGetCurrentPoint()`
@*/
PetscErrorCode PetscDrawPushCurrentPoint(PetscDraw draw, PetscReal x, PetscReal y)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscCheck(draw->currentpoint <= 19, PETSC_COMM_SELF, PETSC_ERR_SUP, "You have pushed too many current points");
  draw->currentpoint_x[++draw->currentpoint] = x;
  draw->currentpoint_y[draw->currentpoint]   = y;
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawPopCurrentPoint - Pops a current draw point (discarding it)

  Not Collective

  Input Parameter:
. draw - the drawing context

  Level: intermediate

.seealso: `PetscDraw`, `PetscDrawPushCurrentPoint()`, `PetscDrawSetCurrentPoint()`, `PetscDrawGetCurrentPoint()`
@*/
PetscErrorCode PetscDrawPopCurrentPoint(PetscDraw draw)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscCheck(draw->currentpoint-- > 0, PETSC_COMM_SELF, PETSC_ERR_SUP, "You have popped too many current points");
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawLine - draws a line onto a drawable.

  Not Collective

  Input Parameters:
+ draw - the drawing context
. xl   - horizontal coordinate of first end point
. yl   - vertical coordinate of first end point
. xr   - horizontal coordinate of second end point
. yr   - vertical coordinate of second end point
- cl   - the colors of the endpoints

  Level: beginner

.seealso: `PetscDraw`, `PetscDrawArrow()`, `PetscDrawLineSetWidth()`, `PetscDrawLineGetWidth()`, `PetscDrawRectangle()`, `PetscDrawTriangle()`, `PetscDrawEllipse()`,
          `PetscDrawMarker()`, `PetscDrawPoint()`
@*/
PetscErrorCode PetscDrawLine(PetscDraw draw, PetscReal xl, PetscReal yl, PetscReal xr, PetscReal yr, int cl)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscUseTypeMethod(draw, line, xl, yl, xr, yr, cl);
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawArrow - draws a line with arrow head at end if the line is long enough

  Not Collective

  Input Parameters:
+ draw - the drawing context
. xl   - horizontal coordinate of first end point
. yl   - vertical coordinate of first end point
. xr   - horizontal coordinate of second end point
. yr   - vertical coordinate of second end point
- cl   - the colors of the endpoints

  Level: beginner

.seealso: `PetscDraw`, `PetscDrawLine()`, `PetscDrawLineSetWidth()`, `PetscDrawLineGetWidth()`, `PetscDrawRectangle()`, `PetscDrawTriangle()`, `PetscDrawEllipse()`,
          `PetscDrawMarker()`, `PetscDrawPoint()`
@*/
PetscErrorCode PetscDrawArrow(PetscDraw draw, PetscReal xl, PetscReal yl, PetscReal xr, PetscReal yr, int cl)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscUseTypeMethod(draw, arrow, xl, yl, xr, yr, cl);
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawLineSetWidth - Sets the line width for future draws.  The width is
  relative to the user coordinates of the window; 0.0 denotes the natural
  width; 1.0 denotes the entire viewport.

  Not Collective

  Input Parameters:
+ draw  - the drawing context
- width - the width in user coordinates

  Level: advanced

.seealso: `PetscDraw`, `PetscDrawLineGetWidth()`, `PetscDrawLine()`, `PetscDrawArrow()`
@*/
PetscErrorCode PetscDrawLineSetWidth(PetscDraw draw, PetscReal width)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscTryTypeMethod(draw, linesetwidth, width);
  PetscFunctionReturn(PETSC_SUCCESS);
}

/*@
  PetscDrawLineGetWidth - Gets the line width for future draws.  The width is
  relative to the user coordinates of the window; 0.0 denotes the natural
  width; 1.0 denotes the interior viewport.

  Not Collective

  Input Parameter:
. draw - the drawing context

  Output Parameter:
. width - the width in user coordinates

  Level: advanced

  Note:
  Not currently implemented.

.seealso: `PetscDraw`, `PetscDrawLineSetWidth()`, `PetscDrawLine()`, `PetscDrawArrow()`
@*/
PetscErrorCode PetscDrawLineGetWidth(PetscDraw draw, PetscReal *width)
{
  PetscFunctionBegin;
  PetscValidHeaderSpecific(draw, PETSC_DRAW_CLASSID, 1);
  PetscAssertPointer(width, 2);
  PetscUseTypeMethod(draw, linegetwidth, width);
  PetscFunctionReturn(PETSC_SUCCESS);
}