1PLCALC_WORLD(3plplot)             PLplot API             PLCALC_WORLD(3plplot)
2
3
4

NAME

6       plcalc_world  -  Calculate  world  coordinates and corresponding window
7       index from relative device coordinates
8

SYNOPSIS

10       plcalc_world(rx, ry, wx, wy, window)
11

DESCRIPTION

13       Calculate world coordinates, wx and wy, and corresponding window  index
14       from relative device coordinates, rx and ry.
15
16       Redacted form: General: plcalc_world(rx, ry, wx, wy, window)
17
18
19       This function is used in example 31.
20

ARGUMENTS

22       rx (PLFLT(3plplot), input)
23              Input relative device coordinate (0.0-1.0) for the x coordinate.
24
25       ry (PLFLT(3plplot), input)
26              Input relative device coordinate (0.0-1.0) for the y coordinate.
27
28       wx (PLFLT_NC_SCALAR(3plplot), output)
29              Returned  value  of  the x world coordinate corresponding to the
30              relative device coordinates rx and ry.
31
32       wy (PLFLT_NC_SCALAR(3plplot), output)
33              Returned value of the y world coordinate  corresponding  to  the
34              relative device coordinates rx and ry.
35
36       window (PLINT_NC_SCALAR(3plplot), output)
37              Returned value of the last defined window index that corresponds
38              to the input relative device coordinates (and the returned world
39              coordinates).   To give some background on the window index, for
40              each page the initial window index is set to zero, and each time
41              plwind(3plplot)  is  called  within  the  page, world and device
42              coordinates are stored for the window and the  window  index  is
43              incremented.   Thus,  for a simple page layout with non-overlap‐
44              ping viewports and one window per viewport,  window  corresponds
45              to  the  viewport index (in the order which the viewport/windows
46              were created) of the only viewport/window  corresponding  to  rx
47              and  ry.  However, for more complicated layouts with potentially
48              overlapping viewports and possibly more than one window (set  of
49              world  coordinates)  per  viewport, window and the corresponding
50              output world coordinates corresponds to the last window  created
51              that fulfills the criterion that the relative device coordinates
52              are inside it.  Finally, in all cases where the  input  relative
53              device  coordinates are not inside any viewport/window, then the
54              returned value of the last defined window index is set to -1.
55
56

AUTHORS

58       Many developers (who  are  credited  at  http://plplot.org/credits.php)
59       have contributed to PLplot over its long history.
60

SEE ALSO

62       PLplot documentation at http://plplot.org/documentation.php.
63
64
65
66                                September, 2020          PLCALC_WORLD(3plplot)
Impressum