1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
########################################################################
##
## Copyright (C) 2014-2024 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## This file is part of Octave.
##
## Octave is free software: you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation, either version 3 of the License, or
## (at your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING. If not, see
## <https://www.gnu.org/licenses/>.
##
########################################################################
## -*- texinfo -*-
## @deftypefn {} {} pan
## @deftypefnx {} {} pan on
## @deftypefnx {} {} pan off
## @deftypefnx {} {} pan xon
## @deftypefnx {} {} pan yon
## @deftypefnx {} {} pan (@var{hfig}, @var{option})
## Control the interactive panning mode of a figure in the GUI.
##
## Given the option @qcode{"on"} or @qcode{"off"}, set the interactive
## pan mode on or off.
##
## With no arguments, toggle the current pan mode on or off.
##
## Given the option @qcode{"xon"} or @qcode{"yon"}, enable pan mode
## for the x or y axis only.
##
## If the first argument @var{hfig} is a figure, then operate on the given
## figure rather than the current figure as returned by @code{gcf}.
##
## @seealso{rotate3d, zoom}
## @end deftypefn
function pan (hfig, option)
## FIXME: Presumably should implement this for Matlab compatibility.
if (nargin == 1 && nargout > 0 && isfigure (hfig))
error ("pan: syntax 'handle = pan (hfig)' not implemented");
endif
if (nargin == 0)
hfig = gcf ();
else
if (nargin == 1)
option = hfig;
hfig = gcf ();
else
if (! isfigure (hfig))
error ("pan: invalid figure handle HFIG");
endif
endif
if (! ischar (option))
error ("pan: OPTION must be a string");
endif
endif
if (nargin == 0)
pm = get (hfig, "__pan_mode__");
if (strcmp (pm.Enable, "on"))
pm.Enable = "off";
else
pm.Enable = "on";
endif
set (hfig, "__pan_mode__", pm);
update_mouse_mode (hfig, pm.Enable);
else
switch (option)
case {"on", "off", "xon", "yon"}
pm = get (hfig, "__pan_mode__");
switch (option)
case {"on", "off"}
pm.Enable = option;
pm.Motion = "both";
case "xon"
pm.Enable = "on";
pm.Motion = "horizontal";
case "yon"
pm.Enable = "on";
pm.Motion = "vertical";
endswitch
set (hfig, "__pan_mode__", pm);
update_mouse_mode (hfig, option);
otherwise
error ("pan: unrecognized OPTION '%s'", option);
endswitch
endif
endfunction
function update_mouse_mode (hfig, arg)
if (strcmp (arg, "off"))
set (hfig, "__mouse_mode__", "none");
else
## FIXME: Is there a better way other than calling these functions
## to set the other mouse mode Enable fields to "off"?
rotate3d (hfig, "off");
zoom (hfig, "off");
set (hfig, "__mouse_mode__", "pan");
endif
endfunction
|
