annotate scripts/plot/draw/rectangle.m @ 17572:7bb76a22cde1

maint: Split scripts/plot directory into 4 pieces. scripts/gui : user-interface functions scripts/plot/appearance : functions controlling plot appearance scripts/plot/draw : plotting functions which produce graphs scripts/plot/util : low-level plotting functions and utilities. * scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk, scripts/gui/private/__file_filter__.m, scripts/gui/private/__fltk_file_filter__.m, scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m, scripts/gui/private/__uigetfile_fltk__.m, scripts/gui/private/__uiobject_split_args__.m, scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m, scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m, scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m, scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m, scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui * scripts/plot/appearance/__clabel__.m, scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m, scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m, scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m, scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m, scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m, scripts/plot/appearance/legend.m, scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m, scripts/plot/appearance/private/__axis_label__.m, scripts/plot/appearance/private/__axis_limits__.m, scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m, scripts/plot/appearance/text.m, scripts/plot/appearance/title.m, scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m, scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m, scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m: Moved from scripts/plot to subdir appearance. * scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m, scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m, scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m, scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m, scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m, scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m, scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m, scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m, scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m, scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m, scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m, scripts/plot/draw/feather.m, scripts/plot/draw/fill.m, scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m, scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m, scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m, scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m, scripts/plot/draw/pareto.m, scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m, scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m, scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m, scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m, scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m, scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m, scripts/plot/draw/private/__errcomm__.m, scripts/plot/draw/private/__errplot__.m, scripts/plot/draw/private/__ezplot__.m, scripts/plot/draw/private/__interp_cube__.m, scripts/plot/draw/private/__line__.m, scripts/plot/draw/private/__marching_cube__.m, scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m, scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m, scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m, scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m, scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m, scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m, scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m, scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m, scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m, scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m, scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m, scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m, scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m, scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m, scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m, scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m, scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m, scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw. * scripts/plot/util/__actual_axis_position__.m, scripts/plot/util/__default_plot_options__.m, scripts/plot/util/__gnuplot_drawnow__.m, scripts/plot/util/__next_line_color__.m, scripts/plot/util/__next_line_style__.m, scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m, scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m, scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m, scripts/plot/util/close.m, scripts/plot/util/closereq.m, scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m, scripts/plot/util/figure.m, scripts/plot/util/findall.m, scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m, scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m, scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m, scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m, scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m, scripts/plot/util/hold.m, scripts/plot/util/isaxes.m, scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m, scripts/plot/util/ishold.m, scripts/plot/util/isprop.m, scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m, scripts/plot/util/ndgrid.m, scripts/plot/util/newplot.m, scripts/plot/util/print.m, scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m, scripts/plot/util/private/__fltk_ginput__.m, scripts/plot/util/private/__fltk_print__.m, scripts/plot/util/private/__ghostscript__.m, scripts/plot/util/private/__gnuplot_get_var__.m, scripts/plot/util/private/__gnuplot_ginput__.m, scripts/plot/util/private/__gnuplot_has_feature__.m, scripts/plot/util/private/__gnuplot_has_terminal__.m, scripts/plot/util/private/__gnuplot_open_stream__.m, scripts/plot/util/private/__gnuplot_print__.m, scripts/plot/util/private/__gnuplot_version__.m, scripts/plot/util/private/__go_draw_axes__.m, scripts/plot/util/private/__go_draw_figure__.m, scripts/plot/util/private/__print_parse_opts__.m, scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m, scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m, scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m, scripts/plot/util/subplot.m: Moved from plot to subdir util. * etc/HACKING: Updated directory structure info. * scripts/Makefile.am, scripts/plot/appearance/module.mk, scripts/plot/draw/module.mk, scripts/plot/util/module.mk: Added new directories to build system.
author Rik <rik@octave.org>
date Fri, 04 Oct 2013 17:09:08 -0700
parents scripts/plot/rectangle.m@68bcac3c043a
children b43da3876b64
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14138
72c96de7a403 maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents: 14019
diff changeset
1 ## Copyright (C) 2012 David Bateman
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
2 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
3 ## This file is part of Octave.
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
4 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
8 ## your option) any later version.
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
9 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
13 ## General Public License for more details.
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
14 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
18
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
19 ## -*- texinfo -*-
12698
fb93b94dfc82 Add rectangle to new functions list in NEWS.
Rik <octave@nomad.inbox5.com>
parents: 12697
diff changeset
20 ## @deftypefn {Function File} {} rectangle ()
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
21 ## @deftypefnx {Function File} {} rectangle (@dots{}, "Position", @var{pos})
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
22 ## @deftypefnx {Function File} {} rectangle (@dots{}, "Curvature", @var{curv})
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
23 ## @deftypefnx {Function File} {} rectangle (@dots{}, "EdgeColor", @var{ec})
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
24 ## @deftypefnx {Function File} {} rectangle (@dots{}, "FaceColor", @var{fc})
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
25 ## @deftypefnx {Function File} {} rectangle (@var{hax}, @dots{})
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
26 ## @deftypefnx {Function File} {@var{h} =} rectangle (@dots{})
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
27 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
28 ## Draw a rectangular patch defined by @var{pos} and @var{curv}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
29 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
30 ## The variable @code{@var{pos}(1:2)} defines the lower left-hand corner of
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
31 ## the patch and @code{@var{pos}(3:4)} defines its width and height. By
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
32 ## default, the value of @var{pos} is @code{[0, 0, 1, 1]}.
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
33 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
34 ## The variable @var{curv} defines the curvature of the sides of the rectangle
12761
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12698
diff changeset
35 ## and may be a scalar or two-element vector with values between 0 and 1.
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12698
diff changeset
36 ## A value of 0 represents no curvature of the side, whereas a value of 1
13bcd62824a7 doc: Add documentation for gmres, rectangle to manual
Rik <octave@nomad.inbox5.com>
parents: 12698
diff changeset
37 ## means that the side is entirely curved into the arc of a circle.
13141
e81ddf9cacd5 maint: untabify and remove trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 12763
diff changeset
38 ## If @var{curv} is a two-element vector, then the first element is the
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
39 ## curvature along the x-axis of the patch and the second along y-axis.
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
40 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
41 ## If @var{curv} is a scalar, it represents the curvature of the shorter of the
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
42 ## two sides of the rectangle and the curvature of the other side is defined
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
43 ## by
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
44 ##
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
45 ## @example
12763
f511bfe00d14 maint: Periodic merge of stable to default
Rik <octave@nomad.inbox5.com>
parents: 12761
diff changeset
46 ## min (pos (1:2)) / max (pos (1:2)) * curv
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
47 ## @end example
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
48 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
49 ## Additional property/value pairs are passed to the underlying patch command.
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
50 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
51 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
52 ## rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
53 ##
14001
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
54 ## The optional return value @var{h} is a graphics handle to the created
5f0bb45e615c doc: Update documentation for functions returning a graphics handle h (Bug #34761)
Rik <octave@nomad.inbox5.com>
parents: 13141
diff changeset
55 ## rectangle object.
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
56 ## @end deftypefn
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17051
diff changeset
57 ## @seealso{patch, line, cylinder, ellipsoid, sphere}
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
58
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
59 function h = rectangle (varargin)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
60
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
61 [hax, varargin] = __plt_get_axis_arg__ ("rectangle", varargin{:});
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
62
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
63 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17211
diff changeset
64 if (! isempty (hax))
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
65 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
66 endif
17051
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
67 unwind_protect
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
68 hax = newplot (hax);
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
69
17126
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
70 htmp = __rectangle__ (hax, varargin{:});
17051
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
71 unwind_protect_cleanup
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
72 if (! isempty (oldfig))
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
73 set (0, "currentfigure", oldfig);
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
74 endif
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
75 end_unwind_protect
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
76
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
77 if (nargout > 0)
17051
3e1b24a2454a cylinder.m, ellipsoid.m, rectangle.m, sphere.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 14868
diff changeset
78 h = htmp;
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
79 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
80 endfunction
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
81
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
82 function hg = __rectangle__ (hax, varargin)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
83
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
84 iarg = 1;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
85 pos = [0, 0, 1, 1];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
86 curv2 = [0, 0];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
87 ec = [0, 0, 0];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
88 fc = "none";
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
89
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
90 while (iarg < length (varargin))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
91 arg = varargin{iarg};
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14245
diff changeset
92 if (ischar (arg))
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
93 if (strcmpi (arg, "position"))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
94 pos = varargin{iarg+1};
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
95 varargin(iarg:iarg+1) = [];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
96 if (!isvector (pos) || numel (pos) != 4)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
97 error ("rectangle: position must be a 4 element vector");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
98 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
99 elseif (strcmpi (arg, "curvature"))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
100 curv2 = varargin{iarg+1};
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
101 varargin(iarg:iarg+1) = [];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
102 if (!isnumeric (curv2) || (numel (curv2) != 1 && numel (curv2) != 2))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
103 error ("rectangle: curvature must be a 2 element vector or a scalar");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
104 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
105 if (any (curv2 < 0) || any (curv2 > 1))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
106 error ("rectangle: curvature values must be between 0 and 1");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
107 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
108 elseif (strcmpi (arg, "edgecolor"))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
109 ec = varargin{iarg+1};
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
110 varargin(iarg:iarg+1) = [];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
111 elseif (strcmpi (arg, "facecolor"))
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
112 fc = varargin{iarg+1};
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
113 varargin(iarg:iarg+1) = [];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
114 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
115 iarg ++;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
116 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
117 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
118 iarg ++;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
119 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
120 endwhile
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
121
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
122 if (numel (curv2) == 1)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
123 [a, ai] = min (pos (3 : 4));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
124 [b, bi] = max (pos (3 : 4));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
125 if (ai < bi)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
126 curv = [curv2, curv2 .* a ./ b];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
127 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
128 curv = [curv2 .* a ./ b, curv2];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
129 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
130 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
131 curv = curv2;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
132 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
133
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
134 if (all (curv) < 0.01)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
135 ## Special case : no curvature
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
136 x = [pos(1), pos(1) + pos(3), pos(1) + pos(3), pos(1), pos(1)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
137 y = [pos(2), pos(2), pos(2) + pos(4), pos(2) + pos(4), pos(2)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
138 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
139 p = pi / 2 * [0 : 15] / 15;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
140 c = curv .* pos(3 : 4) / 2;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
141 cx = c(1) * sin (p) - c(1);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
142 cy = c(2) * cos (p) - c(2);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
143 x = [pos(1) - fliplr(cx), pos(1) + pos(3) + cx, ...
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
144 pos(1) + pos(3) + fliplr(cx), pos(1) - cx, pos(1)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
145 y = [pos(2) - fliplr(cy), pos(2) - cy, pos(2) + pos(4) + fliplr(cy), ...
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
146 pos(2) + pos(4) + cy, pos(2) + c(2)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
147 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
148
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
149 hg = hggroup ();
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
150
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
151 h = patch ("xdata", x(:), "ydata", y(:), "facecolor", fc, "edgecolor", ec, ...
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
152 "parent", hg, varargin{:});
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
153
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
154 addproperty ("curvature", hg, "data", curv2);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
155 addproperty ("position", hg, "data", pos);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
156 addproperty ("edgecolor", hg, "patchedgecolor", get (h, "edgecolor"));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
157 addproperty ("linewidth", hg, "patchlinewidth", get (h, "linewidth"));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
158 addproperty ("linestyle", hg, "patchlinestyle", get (h, "linestyle"));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
159 addproperty ("facecolor", hg, "patchfacecolor", get (h, "facecolor"));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
160
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
161 addlistener (hg, "curvature", @update_data);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
162 addlistener (hg, "position", @update_data);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
163 addlistener (hg, "edgecolor", @update_props);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
164 addlistener (hg, "linewidth", @update_props);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
165 addlistener (hg, "linestyle", @update_props);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
166 addlistener (hg, "facecolor", @update_props);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
167 endfunction
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
168
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
169 function update_data (h, d)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
170 persistent recursion = false;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
171
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
172 ## Don't allow recursion
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
173 if (!recursion)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
174 unwind_protect
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
175 recursion = true;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
176
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
177 kids = get (h, "children");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
178 pos = get (h, "position");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
179 curv2 = get (h, "curvature");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
180
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
181 if (numel (curv2) == 1)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
182 [a, ai] = min (pos (3 : 4));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
183 [b, bi] = max (pos (3 : 4));
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
184 if (ai < bi)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
185 curv = [curv2, curv2 .* a ./ b];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
186 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
187 curv = [curv2 .* a ./ b, curv2];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
188 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
189 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
190 curv = curv2;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
191 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
192
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
193 if (all (curv) < 0.01)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
194 ## Special case : no curvature
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
195 x = [pos(1), pos(1) + pos(3), pos(1) + pos(3), pos(1), pos(1)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
196 y = [pos(2), pos(2), pos(2) + pos(4), pos(2) + pos(4), pos(2)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
197 else
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
198 p = pi / 2 * [0 : 15] / 15;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
199 c = curv .* pos(3 : 4) / 2;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
200 cx = c(1) * sin (p) - c(1);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
201 cy = c(2) * cos (p) - c(2);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
202 x = [pos(1) - fliplr(cx), pos(1) + pos(3) + cx, ...
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
203 pos(1) + pos(3) + fliplr(cx), pos(1) - cx, pos(1)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
204 y = [pos(2) - fliplr(cy), pos(2) - cy, pos(2) + pos(4) + fliplr(cy), ...
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
205 pos(2) + pos(4) + cy, pos(2) + c(2)];
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
206 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
207
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
208 set (kids, "xdata", x, "ydata", y);
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
209 unwind_protect_cleanup
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
210 recursion = false;
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
211 end_unwind_protect
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
212 endif
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
213 endfunction
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
214
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
215 function update_props (h, d)
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
216 kids = get (h, "children");
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
217 set (kids, "edgecolor", get (h, "edgecolor"),
17126
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
218 "linewidth", get (h, "linewidth"),
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
219 "linestyle", get (h, "linestyle"),
26589abbc78d Don't pass axis handle unnecessarily from high level to low level plot functions.
Rik <rik@octave.org>
parents: 17122
diff changeset
220 "facecolor", get (h, "facecolor"));
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
221 endfunction
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
222
12698
fb93b94dfc82 Add rectangle to new functions list in NEWS.
Rik <octave@nomad.inbox5.com>
parents: 12697
diff changeset
223
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
224 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
225 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
226 %! axis equal;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
227 %! rectangle ('Position', [0.05, 0.05, 0.9, 0.9], 'Curvature', [0.5, 0.5]);
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17126
diff changeset
228 %! title ('rectangle() with corners curved');
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
229
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
230 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
231 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
232 %! axis equal;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
233 %! rectangle ('Position', [0.05, 0.05, 0.9, 0.4], 'Curvature', 1.0);
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17126
diff changeset
234 %! title ('rectangle() with sides as complete arcs');
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
235
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
236 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
237 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
238 %! axis equal;
14245
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
239 %! h = rectangle ('Position', [0.05, 0.05, 0.9, 0.4], 'Curvature', 1.0);
4506eade9f04 Use Matlab coding conventions for demos in plot/ directory.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
240 %! set (h, 'FaceColor', [0, 1, 0]);
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17126
diff changeset
241 %! title ('rectangle() with FaceColor = green');
12697
ee4775d04d7f Add the rectangle function
David Bateman <dbateman@free.fr>
parents:
diff changeset
242