Mercurial > octave
view scripts/plot/draw/private/__quiver__.m @ 32084:7dcb6b4a4218
quiver: Marker & arrowhead name/value property style consistency (bug #64134)
* __quiver__.m: Add have_line_spec check after applying any name-value
properties to maintain arrowhead display status.
* __quiver__.m (update_plot): Add linewidth property to base marker object
set call.
* quiver.m: Add BIST to ensure marker properties are updated correctly.
Remove unnecessary strcmp from other BIST assert calls.
* etc/NEWS.9.md: Update description of changes to quiver note under General
Improvements.
author | Nicholas R. Jankowski <jankowski.nicholas@gmail.com> |
---|---|
date | Mon, 08 May 2023 11:49:41 -0400 |
parents | 03fe0b635d2e |
children | 2e484f9f1f18 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2007-2023 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {@var{hg} =} __quiver__ (@dots{}) ## Undocumented internal function. ## @end deftypefn function [hax, hg]= __quiver__ (varargin) hax = varargin{1}; is3d = varargin{2}; autoscale = 0.9; ## Matlab uses 0.2, but Octave's algorithm produces equivalent visual ## results if arrowsize=0.33. Since this is just a non-dimensional ## scaling factor we scale the arrowsize property value by 0.33/0.20 ## in order to get equivalent visual results while keeping equivalent ## property values. arrowsize = 0.20; lastnumeric = find (cellfun ("ischar", varargin(3:nargin)), 1) - 1; if (isempty (lastnumeric)) lastnumeric = nargin; ## Recast non-float inputs as doubles to avoid erroneous plots. varargin(3:end) = cellfun ('double', varargin(3:end), ... "UniformOutput", false); else lastnumeric += 2; ## Recast non-float inputs as doubles to avoid erroneous plots. varargin(3:lastnumeric) = cellfun ('double', varargin(3:lastnumeric), "UniformOutput", false); ## Check for scaling factor "off" and set it to 0. if ((nargin > lastnumeric) && strcmpi (varargin{lastnumeric+1}, "off")) varargin(++lastnumeric) = 0; endif endif if (is3d) ## quiver3 3D input validation. switch (lastnumeric) case {6,7} [z, u, v, w] = deal (varargin{3:6}); if (isvector (z) && ! isvector (u)) if (! size_equal (u, v, w)) error ("quiver3: U, V, and W must be the same size"); elseif (numel(z) != size (u, 3)) error (["quiver3: Z vector length must equal size of ", ... "U, V, and W in dim 3"]); endif [x, y, z] = meshgrid (1 : columns (u), 1 : rows (u), z); else if (! size_equal (z, u, v, w)) error ("quiver3: Z, U, V, and W must be the same size"); endif [x, y] = meshgrid (1 : columns (u), 1 : rows (u), 1:size (u, 3)); endif case {8,9} [x, y, z, u, v, w] = deal (varargin{3:8}); if (isvector (x) && isvector (y) && isvector (z) && ! isvector (u)) if (! size_equal (u, v, w)) error ("quiver3: U, V, and W must be the same size"); elseif (numel(x) != columns (u)) error (["quiver3: X vector length must equal number of ", ... "columns in U, V, and W"]); elseif (numel(y) != rows (u)) error (["quiver3: Y vector length must equal number of ", ... "rows in U, V, and W"]); elseif (numel(z) != size (u, 3)) error (["quiver3: Z vector length must equal size of ", ... "U, V, and W in dim 3"]); endif [x, y, z] = meshgrid (x, y, z); elseif (! size_equal (x, y, z, u, v, w)) error ("quiver3: X, Y, Z, U, V, and W must be the same size"); endif otherwise ## too few or too many numeric inputs before first style input print_usage ("quiver3"); endswitch else ## quiver 2D input validation. switch (lastnumeric) case {4,5} [u, v] = deal (varargin{3:4}); if (! size_equal (u, v)) error ("quiver: U and V must be the same size"); endif [x, y] = meshgrid (1:columns (u), 1:rows (u)); case {6,7} # [x, y, u, v] = deal (varargin{3:6}); if (isvector (x) && isvector (y) && ... (! isvector (u) || ! isvector (v) )) if (! size_equal (u, v)) error ("quiver: U and V must be the same size"); elseif (numel (x) != columns (u)) error (["quiver: X vector length must equal number of ", ... "columns in U and V"]); elseif (numel (y) != rows (u)) error (["quiver: Y vector length must equal number of ", ... "rows in U and V"]); endif [x, y] = meshgrid (x, y); elseif (! size_equal (x, y, u, v)) error ("quiver: X, Y, U, and V must be the same size"); endif otherwise ## too few or too many numeric inputs before first style input print_usage ("quiver"); endswitch endif if (rem (lastnumeric, 2)) autoscale = varargin{lastnumeric}; # Last odd input is scale factor. if (autoscale < 0 || ! isscalar (autoscale)) if (is3d) error (["quiver3: scaling factor must be a non-negative scalar ", ... "or 'off'"]); else error (["quiver: scaling factor must be a non-negative scalar ", ... "or 'off'"]); endif endif endif ioff = lastnumeric + 1; have_filled = false; have_line_spec = false; args = {}; while (ioff <= nargin) arg = varargin{ioff++}; if (ischar (arg) && strcmpi (arg, "filled")) have_filled = true; elseif ((ischar (arg) || iscellstr (arg)) && ! have_line_spec) [linespec, valid] = __pltopt__ ("quiver", arg, false); if (valid) have_line_spec = true; if (isempty (linespec.linestyle) || strcmp (linespec.linestyle, "none")) linespec.linestyle = "-"; endif else args{end+1} = arg; if (ioff <= nargin) args{end+1} = varargin{ioff++}; endif endif else args{end+1} = arg; if (ioff <= nargin) args{end+1} = varargin{ioff++}; endif endif endwhile ## Normalize 0.20 to 1/3 for plotting arrowsize /= 0.20 * 3; ## Scale the arrows to fit in the grid uu = u; vv = v; if (is3d) ww = w; len = max (sqrt (u(:).^2 + v(:).^2 + w(:).^2)); else len = max (sqrt (u(:).^2 + v(:).^2)); endif if (len > 0 && autoscale && numel (u) >= 1) if (isvector (x)) nx = ny = sqrt (length (x)); else [ny, nx] = size (x); # assume meshgrid fmt, x in columns, y in rows endif dx = (max (x(:)) - min (x(:))) / nx; dy = (max (y(:)) - min (y(:))) / ny; if (is3d) dz = (max (z(:)) - min (z(:))) / max (nx, ny); else dz = 0; endif sd = sqrt (dx.^2 + dy.^2 + dz.^2) / len; if (sd != 0) s = autoscale * sd; else # special case of identical points with multiple vectors s = autoscale; endif uu = s * u; vv = s * v; if (is3d) ww = s * w; endif endif hax = newplot (hax); hstate = get (hax, "nextplot"); unwind_protect if (have_line_spec) ls = linespec.linestyle; lc = linespec.color; if (isempty (lc)) lc = __next_line_color__ (); endif else ls = "-"; lc = __next_line_color__ (); endif ## Must occur after __next_line_color__ in order to work correctly. hg = hggroup ("__appdata__", struct ("__creator__", "__quiver__")); if (is3d) args = __add_datasource__ ("quiver3", hg, {"x", "y", "z", "u", "v", "w"}, args{:}); else args = __add_datasource__ ("quiver", hg, {"x", "y", "z", "u", "v", "w"}, args{:}); endif hold (hax, "on"); addproperty ("xdata", hg, "data", x); addproperty ("ydata", hg, "data", y); addproperty ("udata", hg, "data", u); addproperty ("vdata", hg, "data", v); if (is3d) addproperty ("zdata", hg, "data", z); addproperty ("wdata", hg, "data", w); else addproperty ("zdata", hg, "data", []); addproperty ("wdata", hg, "data", []); endif addlistener (hg, "xdata", @update_data); addlistener (hg, "ydata", @update_data); addlistener (hg, "zdata", @update_data); addlistener (hg, "udata", @update_data); addlistener (hg, "vdata", @update_data); addlistener (hg, "wdata", @update_data); x = x(:); y = y(:); xend = x + uu(:); yend = y + vv(:); if (is3d) z = z(:); zend = z + ww(:); endif ## Draw arrow shaft as one line object if (is3d) h1 = plot3 ([x.'; xend.'; NaN(1, length (x))](:), [y.'; yend.'; NaN(1, length (y))](:), [z.'; zend.'; NaN(1, length (z))](:), "linestyle", ls, "color", lc, "parent", hg); else h1 = plot ([x.'; xend.'; NaN(1, length (x))](:), [y.'; yend.'; NaN(1, length (y))](:), "linestyle", ls, "color", lc, "parent", hg); endif xtmp = x + uu(:) * (1 - arrowsize); ytmp = y + vv(:) * (1 - arrowsize); if (is3d) xydist = sqrt (uu(:).^2 + vv(:).^2 + ww(:).^2) ./ ... (sqrt (uu(:).^2 + vv(:).^2) + eps); xarrw1 = xtmp + vv(:) .* xydist * arrowsize / 4; xarrw2 = xtmp - vv(:) .* xydist * arrowsize / 4; yarrw1 = ytmp - uu(:) .* xydist * arrowsize / 4; yarrw2 = ytmp + uu(:) .* xydist * arrowsize / 4; zarrw1 = zarrw2 = zend - ww(:) * arrowsize; else xarrw1 = xtmp + vv(:) * arrowsize / 3; xarrw2 = xtmp - vv(:) * arrowsize / 3; yarrw1 = ytmp - uu(:) * arrowsize / 3; yarrw2 = ytmp + uu(:) * arrowsize / 3; endif ## Draw arrowhead as one line object ## Arrowhead is constructed, but NOT displayed, when marker is present. if (have_line_spec) if (! isempty (linespec.marker) && ! strcmp (linespec.marker, "none")) ls = "none"; endif endif if (is3d) h2 = plot3 ([xarrw1.'; xend.'; xarrw2.'; NaN(1, length (x))](:), [yarrw1.'; yend.'; yarrw2.'; NaN(1, length (y))](:), [zarrw1.'; zend.'; zarrw2.'; NaN(1, length (z))](:), "linestyle", ls, "color", lc, "parent", hg); else h2 = plot ([xarrw1.'; xend.'; xarrw2.'; NaN(1, length (x))](:), [yarrw1.'; yend.'; yarrw2.'; NaN(1, length (y))](:), "linestyle", ls, "color", lc, "parent", hg); endif ## Draw arrow base marker as a third line object if (! have_line_spec || isempty (linespec.marker)) mk = "none"; else mk = linespec.marker; endif if (is3d) h3 = plot3 (x, y, z, "linestyle", "none", "color", lc, "marker", mk, "parent", hg); else h3 = plot (x, y, "linestyle", "none", "color", lc, "marker", mk, "parent", hg); endif if (have_filled) set (h3, "markerfacecolor", lc); endif ## Set up the hggroup properties and listeners if (autoscale) addproperty ("autoscale", hg, "radio", "{on}|off", "on"); addproperty ("autoscalefactor", hg, "data", autoscale); else addproperty ("autoscale", hg, "radio", "{on}|off", "off"); addproperty ("autoscalefactor", hg, "data", 1.0); endif addlistener (hg, "autoscale", @update_data); addlistener (hg, "autoscalefactor", @update_data); addproperty ("maxheadsize", hg, "data", arrowsize * .20*3); addlistener (hg, "maxheadsize", @update_data); addproperty ("showarrowhead", hg, "radio", "{on}|off", "on"); addlistener (hg, "showarrowhead", @update_props); addproperty ("color", hg, "linecolor", get (h1, "color")); addproperty ("linestyle", hg, "linelinestyle", get (h1, "linestyle")); addproperty ("linewidth", hg, "linelinewidth", get (h1, "linewidth")); addproperty ("marker", hg, "linemarker", get (h3, "marker")); addproperty ("markerfacecolor", hg, "linemarkerfacecolor", get (h3, "markerfacecolor")); addproperty ("markersize", hg, "linemarkersize", get (h3, "markersize")); addlistener (hg, "color", @update_props); addlistener (hg, "linestyle", @update_props); addlistener (hg, "linewidth", @update_props); addlistener (hg, "marker", @update_props); addlistener (hg, "markerfacecolor", @update_props); addlistener (hg, "markersize", @update_props); ## Matlab property, although Octave does not implement it. addproperty ("hittestarea", hg, "radio", "on|{off}", "off"); if (! isempty (args)) set (hg, args{:}); if (have_line_spec && ! isempty (linespec.marker) && ... ! strcmp (linespec.marker, "none")) set (h2, "linestyle", "none"); endif endif unwind_protect_cleanup set (hax, "nextplot", hstate); end_unwind_protect endfunction function update_data (h, ~) x = get (h, "xdata"); y = get (h, "ydata"); z = get (h, "zdata"); u = get (h, "udata"); v = get (h, "vdata"); w = get (h, "wdata"); s = get (h, "autoscalefactor"); arrowsize = get (h, "maxheadsize"); arrowsize /= 0.20 * 3; kids = get (h, "children"); if (isempty (z) || isempty (w)) is3d = false; else is3d = true; endif if (strcmp (get (h, "autoscale"), "on") && s != 0) ## Scale the arrows to fit in the grid if (isvector (x)) nx = ny = sqrt (length (x)); else [ny, nx] = size (x); endif dx = (max (x(:)) - min (x(:))) / nx; dy = (max (y(:)) - min (y(:))) / ny; if (is3d) dz = (max (z(:)) - min (z(:))) / max (nx, ny); len = max (sqrt (u(:).^2 + v(:).^2 + w(:).^2)); else dz = 0; len = max (sqrt (u(:).^2 + v(:).^2)); endif if (len > 0) sd = sqrt (dx.^2 + dy.^2 + dz.^2) / len; if (sd != 0) s *= sd; endif u = s * u; v = s * v; if (is3d) w = s * w; endif endif endif x = x(:); y = y(:); xend = x + u(:); yend = y + v(:); if (is3d) z = z(:); zend = z + w(:); endif set (kids(3), "xdata", [x.'; xend.'; NaN(1, length (x))](:), "ydata", [y.'; yend.'; NaN(1, length (y))](:)); if (is3d) set (kids(3), "zdata", [z.'; zend.'; NaN(1, length (z))](:)); endif xtmp = x + u(:) * (1 - arrowsize); ytmp = y + v(:) * (1 - arrowsize); if (is3d) xydist = sqrt (u(:).^2 + v(:).^2 + w(:).^2) ./ ... (sqrt (u(:).^2 + v(:).^2) + eps); xarrw1 = xtmp + v(:) .* xydist * arrowsize / 4; xarrw2 = xtmp - v(:) .* xydist * arrowsize / 4; yarrw1 = ytmp - u(:) .* xydist * arrowsize / 4; yarrw2 = ytmp + u(:) .* xydist * arrowsize / 4; zarrw1 = zarrw2 = zend - w(:) * arrowsize; else xarrw1 = xtmp + v(:) * arrowsize / 3; xarrw2 = xtmp - v(:) * arrowsize / 3; yarrw1 = ytmp - u(:) * arrowsize / 3; yarrw2 = ytmp + u(:) * arrowsize / 3; endif set (kids(2), "xdata", [x.'; xend.'; NaN(1, length (x))](:), "ydata", [y.'; yend.'; NaN(1, length (y))](:)); if (is3d) set (kids(2), "zdata", [z.'; zend.'; NaN(1, length (z))](:)); endif set (kids(2), "xdata", [xarrw1.'; xend.'; xarrw2.'; NaN(1, length (x))](:), "ydata", [yarrw1.'; yend.'; yarrw2.'; NaN(1, length (y))](:)); if (is3d) set (kids(2), "zdata", [zarrw1.'; zend.'; zarrw2.'; NaN(1, length (z))](:)); endif set (kids(1), "xdata", x, "ydata", y); if (is3d) set (kids(1), "zdata", z); endif endfunction function update_props (h, ~) kids = get (h, "children"); set (kids([3 2]), {"color", "linestyle", "linewidth"}, get (h, {"color", "linestyle", "linewidth"})); set (kids(2), "visible", get (h, "showarrowhead")); set (kids(1), {"color", "marker", "markerfacecolor", "markersize", ... "linewidth"}, get (h, {"color", "marker", "markerfacecolor", ... "markersize", "linewidth"})); endfunction