update packages

[CreaPhase.git] / octave_packages / m / plot / view.m

diff --git a/octave_packages/m/plot/view.m b/octave_packages/m/plot/view.m
new file mode 100644 (file)
index 0000000..849a7c6
--- /dev/null
+++ b/octave_packages/m/plot/view.m
@@ -0,0 +1,124 @@
+## Copyright (C) 2007-2012 John W. Eaton
+##
+## 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
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Function File} {[@var{azimuth}, @var{elevation}] =} view ()
+## @deftypefnx {Function File} {} view (@var{azimuth}, @var{elevation})
+## @deftypefnx {Function File} {} view ([@var{azimuth} @var{elevation}])
+## @deftypefnx {Function File} {} view ([@var{x} @var{y} @var{z}])
+## @deftypefnx {Function File} {} view (@var{dims})
+## @deftypefnx {Function File} {} view (@var{ax}, @dots{})
+## Query or set the viewpoint for the current axes.  The parameters
+## @var{azimuth} and @var{elevation} can be given as two arguments or as
+## 2-element vector.
+## The viewpoint can also be given with Cartesian coordinates @var{x},
+## @var{y}, and @var{z}.
+## The call @code{view (2)} sets the viewpoint to @var{azimuth} = 0
+## and @var{elevation} = 90, which is the default for 2-D graphs.
+## The call @code{view (3)} sets the viewpoint to @var{azimuth} = -37.5
+## and @var{elevation} = 30, which is the default for 3-D graphs.
+## If @var{ax} is given, the viewpoint is set for this axes, otherwise
+## it is set for the current axes.
+## @end deftypefn
+
+## Author: jwe
+
+function [azimuth, elevation] = view (varargin)
+
+  if (nargin < 4)
+    if (nargin == 0)
+      args = {get(gca (), "view")};
+    else
+      ax = varargin{1};
+      if (ishandle (ax) && strcmp (get (ax, "type"), "axes"))
+        args = varargin(2:end);
+      else
+        ax = gca;
+        args = varargin;
+      endif
+    endif
+    if (length (args) == 1)
+      x = args{1};
+      if (length (x) == 2)
+        az = x(1);
+        el = x(2);
+      elseif (length (x) == 3)
+        [az, el] = cart2sph (x(1), x(2), x(3));
+        az *= 180/pi;
+        az += 90;
+        el *= 180/pi;
+      elseif (x == 2)
+        az = 0;
+        el = 90;
+      elseif (x == 3)
+        az = -37.5;
+        el = 30;
+      else
+        print_usage ();
+      endif
+    elseif (length (args) == 2)
+      az = args{1};
+      el = args{2};
+    endif
+
+    if (nargin > 0)
+      set (ax, "view", [az, el]);
+    endif
+
+    if (nargout == 1)
+      error ("view: T = view () not implemented");
+    endif
+
+    if (nargout == 2)
+      azimuth = az;
+      elevation = el;
+    endif
+  else
+    print_usage ();
+  endif
+
+endfunction
+
+%!test
+%! hf = figure ("visible", "off");
+%! unwind_protect
+%!   plot3 ([0,1], [0,1], [0,1]);
+%!   [az, el] = view;
+%!   assert ([az, el], [-37.5, 30], eps);
+%!   view (2);
+%!   [az, el] = view;
+%!   assert ([az, el], [0, 90], eps);
+%!   view ([1 1 0]);
+%!   [az, el] = view;
+%!   assert ([az, el], [135, 0], eps);
+%! unwind_protect_cleanup
+%!   close (hf);
+%! end_unwind_protect
+
+%!test
+%! hf = figure ("visible", "off");
+%! unwind_protect
+%!   line;
+%!   [az, el] = view;
+%!   assert ([az, el], [0, 90], eps);
+%!   view (3);
+%!   [az, el] = view;
+%!   assert ([az, el], [-37.5, 30], eps);
+%! unwind_protect_cleanup
+%!   close (hf);
+%! end_unwind_protect