octave_packages/m/plot/quiver.m

   1 ## Copyright (C) 2007-2012 David Bateman
   2 ##
   3 ## This file is part of Octave.
   4 ##
   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.
   9 ##
  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.
  14 ##
  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/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} quiver (@var{u}, @var{v})
  21 ## @deftypefnx {Function File} {} quiver (@var{x}, @var{y}, @var{u}, @var{v})
  22 ## @deftypefnx {Function File} {} quiver (@dots{}, @var{s})
  23 ## @deftypefnx {Function File} {} quiver (@dots{}, @var{style})
  24 ## @deftypefnx {Function File} {} quiver (@dots{}, 'filled')
  25 ## @deftypefnx {Function File} {} quiver (@var{h}, @dots{})
  26 ## @deftypefnx {Function File} {@var{h} =} quiver (@dots{})
  27 ##
  28 ## Plot the @code{(@var{u}, @var{v})} components of a vector field in
  29 ## an @code{(@var{x}, @var{y})} meshgrid.  If the grid is uniform, you can
  30 ## specify @var{x} and @var{y} as vectors.
  31 ##
  32 ## If @var{x} and @var{y} are undefined they are assumed to be
  33 ## @code{(1:@var{m}, 1:@var{n})} where @code{[@var{m}, @var{n}] =
  34 ## size(@var{u})}.
  35 ##
  36 ## The variable @var{s} is a scalar defining a scaling factor to use for
  37 ## the arrows of the field relative to the mesh spacing.  A value of 0
  38 ## disables all scaling.  The default value is 1.
  39 ##
  40 ## The style to use for the plot can be defined with a line style @var{style}
  41 ## in a similar manner to the line styles used with the @code{plot} command.
  42 ## If a marker is specified then markers at the grid points of the vectors are
  43 ## printed rather than arrows.  If the argument 'filled' is given then the
  44 ## markers as filled.
  45 ##
  46 ## The optional return value @var{h} is a graphics handle to a quiver object.
  47 ## A quiver object regroups the components of the quiver plot (body, arrow,
  48 ## and marker), and allows them to be changed together.
  49 ##
  50 ## @example
  51 ## @group
  52 ## [x, y] = meshgrid (1:2:20);
  53 ## h = quiver (x, y, sin (2*pi*x/10), sin (2*pi*y/10));
  54 ## set (h, "maxheadsize", 0.33);
  55 ## @end group
  56 ## @end example
  57 ##
  58 ## @seealso{plot}
  59 ## @end deftypefn
  60
  61 function retval = quiver (varargin)
  62
  63   [h, varargin, nargin] = __plt_get_axis_arg__ ("quiver", varargin{:});
  64
  65   if (nargin < 2)
  66     print_usage ();
  67   else
  68     oldh = gca ();
  69     unwind_protect
  70       axes (h);
  71       newplot ();
  72       tmp = __quiver__ (h, 0, varargin{:});
  73     unwind_protect_cleanup
  74       axes (oldh);
  75     end_unwind_protect
  76   endif
  77
  78   if (nargout > 0)
  79     retval = tmp;
  80   endif
  81
  82 endfunction
  83
  84
  85 %!demo
  86 %! clf
  87 %! [x,y] = meshgrid (1:2:20);
  88 %! h = quiver (x,y, sin (2*pi*x/10), sin (2*pi*y/10));
  89 %! set (h, "maxheadsize", 0.33);
  90
  91 %!demo
  92 %! clf
  93 %! axis ("equal");
  94 %! x = linspace (0,3,80);
  95 %! y = sin (2*pi*x);
  96 %! theta = 2*pi*x + pi/2;
  97 %! quiver (x, y, sin (theta)/10, cos (theta)/10);
  98 %! hold on; plot(x,y,"r"); hold off;
  99