Mercurial > octave-antonio
changeset 20073:3b90259f17f3
Document that ginput() is intended for 2-D plots (bug #44427).
* ginput.m: Update docstring with implementation note about ginput
being used for 2-D plots.
| author | Rik <rik@octave.org> |
|---|---|
| date | Sat, 11 Apr 2015 10:16:23 -0700 |
| parents | 8e42898f4d73 |
| children | ad1a2c03992b |
| files | scripts/plot/util/ginput.m |
| diffstat | 1 files changed, 4 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/scripts/plot/util/ginput.m Sat Apr 11 08:30:20 2015 -0700 +++ b/scripts/plot/util/ginput.m Sat Apr 11 10:16:23 2015 -0700 @@ -30,6 +30,10 @@ ## was clicked in the units of the current axes. The return value @var{button} ## is 1, 2, or 3 for the left, middle, or right button. If a key is pressed ## the ASCII value is returned in @var{button}. +## +## Implementation Note: @code{ginput} is intenteded for 2-D plots. For 3-D +## plots see the @var{currentpoint} property of the current axes which can be +## transformed with knowledge of the current @code{view} into data units. ## @seealso{gtext, waitforbuttonpress} ## @end deftypefn