annotate scripts/plot/patch.m @ 6988:c7484dcadd4d

[project @ 2007-10-09 19:58:32 by dbateman]
author dbateman
date Tue, 09 Oct 2007 19:59:51 +0000
parents 76e3d985ae56
children 93c65f2a5668
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6807
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2005 John W. Eaton
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
2 ##
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
4 ##
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
9 ##
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
14 ##
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
18 ## 02110-1301, USA.
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
19
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
21 ## @deftypefn {Function File} {} patch ()
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
22 ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{c})
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
23 ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{c}, @var{opts})
6988
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
24 ## @deftypefnx {Function File} {} patch (@var{h}, @dots{})
6895
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6807
diff changeset
25 ## Create patch object from @var{x} and @var{y} with color @var{c} and
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6807
diff changeset
26 ## insert in the current axes object. Return handle to patch object.
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6807
diff changeset
27 ##
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6807
diff changeset
28 ## For a uniform colored patch, @var{c} can be given as an RGB vector,
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6807
diff changeset
29 ## scalar value referring to the current colormap, or string value (for
76e3d985ae56 [project @ 2007-09-13 18:22:38 by jwe]
jwe
parents: 6807
diff changeset
30 ## example, "r" or "red").
6807
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
31 ## @end deftypefn
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
32
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
33 ## Author: jwe
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
34
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
35 function h = patch (varargin)
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
36
6988
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
37 if (isscalar (varargin{1}) && ishandle (varargin{1}))
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
38 h = varargin {1};
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
39 if (! strcmp (get (h, "type"), "axes"))
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
40 error ("patch: expecting first argument to be an axes object");
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
41 endif
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
42 oldh = gca ();
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
43 unwind_protect
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
44 axes (h);
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
45 tmp = __patch__ (h, varargin{:});
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
46 unwind_protect_cleanup
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
47 axes (oldh);
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
48 end_unwind_protect
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
49 else
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
50 tmp = __patch__ (gca (), varargin{:});
c7484dcadd4d [project @ 2007-10-09 19:58:32 by dbateman]
dbateman
parents: 6895
diff changeset
51 endif
6807
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
52
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
53 if (nargout > 0)
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
54 h = tmp;
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
55 endif
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
56
0089a504fdd6 [project @ 2007-08-10 17:34:59 by jwe]
jwe
parents:
diff changeset
57 endfunction