Mercurial > octave
view scripts/plot/util/zoom.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2014-2022 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 {} {} zoom ## @deftypefnx {} {} zoom (@var{factor}) ## @deftypefnx {} {} zoom on ## @deftypefnx {} {} zoom off ## @deftypefnx {} {} zoom xon ## @deftypefnx {} {} zoom yon ## @deftypefnx {} {} zoom out ## @deftypefnx {} {} zoom reset ## @deftypefnx {} {} zoom (@var{hfig}, @var{option}) ## Zoom the current axes object or control the interactive zoom mode of a ## figure in the GUI. ## ## Given a numeric argument greater than zero, zoom by the given factor. If ## the zoom factor is greater than one, zoom in on the plot. If the factor ## is less than one, zoom out. If the zoom factor is a two- or three-element ## vector, then the elements specify the zoom factors for the x, y, and z ## axes respectively. ## ## Given the option @qcode{"on"} or @qcode{"off"}, set the interactive zoom ## mode on or off. ## ## With no arguments, toggle the current zoom mode on or off. ## ## Given the option @qcode{"xon"} or @qcode{"yon"}, enable zoom mode for the ## x or y-axis only. ## ## Given the option @qcode{"out"}, zoom to the initial zoom setting. ## ## Given the option @qcode{"reset"}, store the current zoom setting so that ## @code{zoom out} will return to this zoom level. ## ## 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{pan, rotate3d} ## @end deftypefn ## Eventually we need to also support these features: ## @deftypefnx {} {zoom_object_handle =} zoom (@var{hfig}) function zoom (hfig, option) ## FIXME: Presumably should implement this for Matlab compatibility. if (nargin == 1 && nargout > 0 && isfigure (hfig)) error ("zoom: syntax 'handle = zoom (hfig)' not implemented"); endif if (nargin == 0) hfig = gcf (); else if (nargin == 1) option = hfig; hfig = gcf (); else if (! isfigure (hfig)) error ("zoom: invalid figure handle HFIG"); endif endif endif if (nargin == 0) zm = get (hfig, "__zoom_mode__"); if (strcmp (zm.Enable, "on")) zm.Enable = "off"; else zm.Enable = "on"; endif set (hfig, "__zoom_mode__", zm); update_mouse_mode (hfig, zm.Enable); else if (isnumeric (option)) factor = option; switch (numel (factor)) case 2 xfactor = factor(1); yfactor = factor(2); case 1 xfactor = yfactor = factor; otherwise error ("zoom: FACTOR must be a 1- or 2-element vector"); endswitch if (xfactor <= 0 || yfactor <= 0) error ("zoom: FACTOR must be greater than 0"); elseif (xfactor == 1 && yfactor == 1) return; endif cax = get (hfig, "currentaxes"); if (! isempty (cax)) if (xfactor != 1) if (yfactor != 1) mode = "both"; else mode = "horizontal"; endif else if (yfactor != 1) mode = "vertical"; endif endif __zoom__ (cax, mode, factor); endif elseif (ischar (option)) switch (option) case {"on", "off", "xon", "yon"} zm = get (hfig, "__zoom_mode__"); switch (option) case {"on", "off"} zm.Enable = option; zm.Motion = "both"; case "xon" zm.Enable = "on"; zm.Motion = "horizontal"; case "yon" zm.Enable = "on"; zm.Motion = "vertical"; endswitch set (hfig, "__zoom_mode__", zm); update_mouse_mode (hfig, option); case "out" cax = get (hfig, "currentaxes"); if (! isempty (cax)) __zoom__ (cax, "out"); endif case "reset" cax = get (hfig, "currentaxes"); if (! isempty (cax)) __zoom__ (cax, "reset"); endif otherwise error ("zoom: unrecognized OPTION '%s'", option); endswitch else error ("zoom: OPTION must be a number or a string"); endif 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"? pan (hfig, "off"); rotate3d (hfig, "off"); set (hfig, "__mouse_mode__", "zoom"); endif endfunction %!demo %! clf; %! sombrero (); %! title ("zoom() demo #1"); %! pause (1); %! ## zoom in by a factor of 2 %! zoom (2); %! pause (1); %! ## return to original zoom level %! zoom out; %! pause (1); %! ## zoom in by a factor of 2 %! zoom (2); %! pause (1); %! ## set this zoom level as the "initial zoom level" %! ## and zoom in some more %! zoom reset; %! zoom (2); %! pause (1); %! ## return to zoom level set by last call to "zoom reset" %! zoom out;