1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
|
########################################################################
##
## Copyright (C) 2007-2024 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 {} {} scatter3 (@var{x}, @var{y}, @var{z})
## @deftypefnx {} {} scatter3 (@var{x}, @var{y}, @var{z}, @var{s})
## @deftypefnx {} {} scatter3 (@var{x}, @var{y}, @var{z}, @var{s}, @var{c})
## @deftypefnx {} {} scatter3 (@dots{}, @var{style})
## @deftypefnx {} {} scatter3 (@dots{}, "filled")
## @deftypefnx {} {} scatter3 (@dots{}, @var{prop}, @var{val})
## @deftypefnx {} {} scatter3 (@var{hax}, @dots{})
## @deftypefnx {} {@var{h} =} scatter3 (@dots{})
## Draw a 3-D scatter plot.
##
## A marker is plotted at each point defined by the coordinates in the vectors
## @var{x}, @var{y}, and @var{z}.
##
## The size of the markers is determined by @var{s}, which can be a scalar
## or a vector of the same length as @var{x}, @var{y}, and @var{z}. If @var{s}
## is not given, or is an empty matrix, then a default value of 8 points is
## used.
##
## The color of the markers is determined by @var{c}, which can be a string
## defining a fixed color; a 3-element vector giving the red, green, and blue
## components of the color; a vector of the same length as @var{x} that gives
## a scaled index into the current colormap; or an @nospell{Nx3} matrix
## defining the RGB color of each marker individually.
##
## The marker to use can be changed with the @var{style} argument, that is a
## string defining a marker in the same manner as the @code{plot} command.
## If no marker is specified it defaults to @qcode{"o"} or circles.
## If the argument @qcode{"filled"} is given then the markers are filled.
##
## If the first argument @var{hax} is an axes handle, then plot into this axes,
## rather than the current axes returned by @code{gca}.
##
## The optional return value @var{h} is a graphics handle to the scatter
## object representing the points.
##
## @example
## @group
## [x, y, z] = peaks (20);
## scatter3 (x(:), y(:), z(:), [], z(:));
## @end group
## @end example
##
## Programming Note: The full list of properties is documented at
## @ref{Scatter Properties}.
## @seealso{scatter, patch, plot}
## @end deftypefn
function h = scatter3 (varargin)
[hax, varargin, nargin] = __plt_get_axis_arg__ ("scatter3", varargin{:});
if (nargin < 2)
print_usage ();
endif
oldfig = [];
if (! isempty (hax))
oldfig = get (0, "currentfigure");
endif
unwind_protect
hax = newplot (hax);
htmp = __scatter__ (hax, 3, "scatter3", varargin{:});
if (! ishold ())
set (hax, "view", [-37.5, 30],
"xgrid", "on", "ygrid", "on", "zgrid", "on");
endif
unwind_protect_cleanup
if (! isempty (oldfig))
set (0, "currentfigure", oldfig);
endif
end_unwind_protect
if (nargout > 0)
h = htmp;
endif
endfunction
%!demo
%! clf;
%! [x, y, z] = peaks (20);
%! scatter3 (x(:), y(:), z(:), [], z(:));
%! title ({"Default scatter3() plot", ...
%! "constant size bubbles and color determined by Z"});
%!demo
%! clf;
%! x = rand (20,1); y = rand (20,1); z = rand (20,1);
%! scatter3 (x(:), y(:), z(:), 10, z(:), "s");
%! title ({"scatter3() plot", ...
%! "marker is square, size is 10, color determined by Z"});
%!demo
%! clf;
%! x = rand (20,1); y = rand (20,1); z = rand (20,1);
%! scatter3 (x(:), y(:), z(:), 20*z(:), [], "s");
%! title ({"scatter3() plot", ...
%! "marker is square, size is determined by Z"});
%!demo
%! clf;
%! x = rand (20,1); y = rand (20,1); z = rand (20,1);
%! scatter3 (x(:), y(:), z(:), 20*z(:), z(:), "s");
%! title ({"scatter3() plot", ...
%! "marker is square, size and color determined by Z"});
|