Mercurial > hg > octave-lyh

comparison scripts/plot/patch.m @ 17126:eaab03308c0b

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links. * doc/interpreter/plot.txi: Add @findex entries that were in xlim.m * scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m, scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axes.m, scripts/plot/axis.m, scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m, scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m, scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/closereq.m, scripts/plot/colorbar.m, scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m, scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m, scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m, scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m, scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m, scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m, scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m, scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m, scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m, scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m, scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m, scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m, scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m, scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m, scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m, scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m, scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m, scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m, scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m, scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m, scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m, scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m, scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m, scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m, scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m, scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m, scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m, scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m, scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m, scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m, scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m, scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m, scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m, scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m, scripts/plot/zlim.m: Rewrite docstrings for most plot functions. Emphasize clarity, use common "voice", and increase density of seealso links.
author Rik <rik@octave.org>
date Wed, 31 Jul 2013 13:53:30 -0700
parents 854cfc72c64f
children df4c4b7708a4
comparison
equal deleted inserted replaced
17125:d4549655b92e 17126:eaab03308c0b
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} patch () 20 ## @deftypefn {Function File} {} patch ()
21 ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{c}) 21 ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{c})
22 ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{z}, @var{c}) 22 ## @deftypefnx {Function File} {} patch (@var{x}, @var{y}, @var{z}, @var{c})
23 ## @deftypefnx {Function File} {} patch (@var{fv}) 23 ## @deftypefnx {Function File} {} patch (@var{fv})
24 ## @deftypefnx {Function File} {} patch ("Faces", @var{f}, "Vertices", @var{v}, @dots{}) 24 ## @deftypefnx {Function File} {} patch ("Faces", @var{faces}, "Vertices", @var{verts}, @dots{})
25 ## @deftypefnx {Function File} {} patch (@dots{}, @var{prop}, @var{val}) 25 ## @deftypefnx {Function File} {} patch (@dots{}, @var{prop}, @var{val}, @dots{})
26 ## @deftypefnx {Function File} {} patch (@var{h}, @dots{}) 26 ## @deftypefnx {Function File} {} patch (@var{hax}, @dots{})
27 ## @deftypefnx {Function File} {@var{h} =} patch (@dots{}) 27 ## @deftypefnx {Function File} {@var{h} =} patch (@dots{})
28 ## Create patch object from @var{x} and @var{y} with color @var{c} and 28 ## Create patch object in the current axes with vertices at locations
29 ## insert in the current axes object. Return handle to patch object. 29 ## (@var{x}, @var{y}) and of color @var{c}.
30 ## 30 ##
31 ## For a uniform colored patch, @var{c} can be given as an RGB vector, 31 ## If the vertices are matrices of size @nospell{MxN} then each polygon patch
32 ## scalar value referring to the current colormap, or string value (for 32 ## has M vertices and a total of N polygons will be created. If some polygons
33 ## example, "r" or "red"). 33 ## do not have M vertices use NaN to represent "no vertex". If the @var{z}
34 ## 34 ## input is present then 3-D patches will be created.
35 ## If passed a structure @var{fv} contain the fields "vertices", "faces" 35 ##
36 ## and optionally "facevertexcdata", create the patch based on these 36 ## The color argument @var{c} can take many forms. To create polygons
37 ## properties. 37 ## which all share a single color use a string value (e.g., "r" for
38 ## red), a scalar value which is scaled by @code{caxis} and indexed into the
39 ## current colormap, or a 3-element RGB vector with the precise TrueColor.
40 ##
41 ## If @var{c} is a vector of length N then the ith polygon will have a color
42 ## determined by scaling entry @var{c}(i) according to @code{caxis} and then
43 ## indexing into the current colormap. More complicated coloring situations
44 ## require directly manipulating patch property/value pairs.
45 ##
46 ## Instead of specifying polygons by matrices @var{x} and @var{y}, it is
47 ## possible to present a unique list of vertices and then a list of polygon
48 ## faces created from those vertices. In this case the "Vertices" matrix will
49 ## be an @nospell{Nx2} (2-D patch) or @nospell{Nx3} (3-D path). The
50 ## @nospell{MxN} "Faces" matrix describes M polygons having N vertices---each
51 ## row describes a single polygon and each column entry is an index into the
52 ## "Vertices" matrix to identify a vertex. The patch object can be created by
53 ## directly passing the property/value pairs "Vertices"/@var{verts},
54 ## "Faces"/@var{faces} as inputs.
55 ##
56 ## A third input form is to create a structure @var{fv} with the fields
57 ## "vertices", "faces", and optionally "facevertexcdata".
58 ##
59 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
60 ## rather than the current axes returned by @code{gca}.
38 ## 61 ##
39 ## The optional return value @var{h} is a graphics handle to the created patch 62 ## The optional return value @var{h} is a graphics handle to the created patch
40 ## object. 63 ## object.
41 ## @seealso{fill} 64 ##
65 ## Implementation Note: Patches are highly configurable objects. To truly
66 ## customize them requires setting patch properties directly. Useful patch
67 ## properties are: "cdata", "edgecolor", "facecolor", "faces",
68 ## "facevertexcdata",
69 ##
70 ## @seealso{fill, get, set}
42 ## @end deftypefn 71 ## @end deftypefn
43 72
44 ## Author: jwe 73 ## Author: jwe
45 74
46 function retval = patch (varargin) 75 function h = patch (varargin)
47 76
48 [hax, varargin] = __plt_get_axis_arg__ ("patch", varargin{:}); 77 [hax, varargin] = __plt_get_axis_arg__ ("patch", varargin{:});
49 78
50 if (isempty (hax)) 79 if (isempty (hax))
51 hax = gca (); 80 hax = gca ();
56 if (failed) 85 if (failed)
57 print_usage (); 86 print_usage ();
58 endif 87 endif
59 88
60 if (nargout > 0) 89 if (nargout > 0)
61 retval = htmp; 90 h = htmp;
62 endif 91 endif
63 92
64 endfunction 93 endfunction
65 94
66 95