1 ## Copyright (C) 2007-2012 David Bateman
3 ## This file is part of Octave.
5 ## Octave is free software; you can redistribute it and/or modify it
6 ## under the terms of the GNU General Public License as published by
7 ## the Free Software Foundation; either version 3 of the License, or (at
8 ## your option) any later version.
10 ## Octave is distributed in the hope that it will be useful, but
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 ## General Public License for more details.
15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>.
20 ## @deftypefn {Function File} {@var{zl} =} zlim ()
21 ## @deftypefnx {Function File} {} zlim (@var{zl})
22 ## @deftypefnx {Function File} {@var{m} =} zlim ('mode')
23 ## @deftypefnx {Function File} {} zlim (@var{m})
24 ## @deftypefnx {Function File} {} zlim (@var{h}, @dots{})
25 ## Get or set the limits of the z-axis of the current plot. Called without
26 ## arguments @code{zlim} returns the z-axis limits of the current plot.
27 ## If passed a two element vector @var{zl}, the limits of the z-axis are set
30 ## The current mode for calculation of the z-axis can be returned with a
31 ## call @code{zlim ('mode')}, and can be either 'auto' or 'manual'. The
32 ## current plotting mode can be set by passing either 'auto' or 'manual'
35 ## If passed a handle as the first argument, then operate on this handle
36 ## rather than the current axes handle.
37 ## @seealso{xlim, ylim, set, get, gca}
40 function retval = zlim (varargin)
41 ret = __axes_limits__ ("zlim", varargin{:});
52 %! title ("zlim is [0.2, 0.8]");
53 %! assert (zlim (), [0.2, 0.8]);
59 %! title ("zlim is auto");
60 %! assert (zlim ("mode"), "auto");
64 %! plot3 ([0,1], [0,1], [0,1]);
66 %! title ("zlim is [0.2, 0.8]");
67 %! assert (zlim (), [0.2, 0.8]);
71 %! plot3 ([0,1], [0,1], [0,1]);
73 %! title ("zlim is auto");
74 %! assert (zlim ("mode"), "auto");
77 %! hf = figure ("visible", "off");
80 %! plot3 ([0,1], [0,1], [0,1]);
82 %! assert (get (gca, "zlim"), limz, eps);
83 %! assert (zlim ("mode"), "manual");
84 %! unwind_protect_cleanup
89 %! hf = figure ("visible", "off");
91 %! plot3 ([0,1], [0,1], [0, 1.1]);
92 %! assert (get (gca, "zlim"), [0, 1.4], eps);
93 %! assert (zlim ("mode"), "auto");
94 %! unwind_protect_cleanup