octave_packages/geometry-1.5.0/geom2d/drawPoint.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2004-2011, David Legland <david.legland@grignon.inra.fr>
   3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
   4 %%
   5 %% All rights reserved.
   6 %% (simplified BSD License)
   7 %%
   8 %% Redistribution and use in source and binary forms, with or without
   9 %% modification, are permitted provided that the following conditions are met:
  10 %%
  11 %% 1. Redistributions of source code must retain the above copyright notice, this
  12 %%    list of conditions and the following disclaimer.
  13 %%
  14 %% 2. Redistributions in binary form must reproduce the above copyright notice,
  15 %%    this list of conditions and the following disclaimer in the documentation
  16 %%    and/or other materials provided with the distribution.
  17 %%
  18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 %% POSSIBILITY OF SUCH DAMAGE.
  29 %%
  30 %% The views and conclusions contained in the software and documentation are
  31 %% those of the authors and should not be interpreted as representing official
  32 %% policies, either expressed or implied, of copyright holder.
  33
  34 %% -*- texinfo -*-
  35 %% @deftypefn {Function File} {@var{h} = } drawPoint (@var{x}, @var{y})
  36 %% @deftypefnx {Function File} {@var{h} = } drawPoint (@var{coord})
  37 %% @deftypefnx {Function File} {@var{h} = } drawPoint (@dots{}, @var{opt})
  38 %% Draw the point on the axis.
  39 %
  40 %   Draws points defined by coordinates @var{x} and @var{y}Y.
  41 %   @var{x} and @var{y} should be array the same size. Coordinates can be
  42 %   packed coordinates in a single [N*2] array @var{coord}. Options @var{opt}
  43 %   are passed to the @code{plot} function.
  44 %
  45 %   @seealso{points2d, clipPoints}
  46 %
  47 %% @end deftypefn
  48
  49 function varargout = drawPoint(varargin)
  50
  51   % process input arguments
  52   var = varargin{1};
  53   if size(var, 2)==1
  54       % points stored in separate arrays
  55       px = varargin{1};
  56       py = varargin{2};
  57       varargin(1:2) = [];
  58   else
  59       % points packed in one array
  60       px = var(:, 1);
  61       py = var(:, 2);
  62       varargin(1) = [];
  63   end
  64
  65   % ensure we have column vectors
  66   px = px(:);
  67   py = py(:);
  68
  69   % default drawing options, but keep specified options if it has the form of
  70   % a bundled string
  71   if length(varargin)~=1
  72       varargin = [{'linestyle', 'none', 'marker', 'o', 'color', 'b'}, varargin];
  73   end
  74
  75   % plot the points, using specified drawing options
  76   h = plot(px(:), py(:), varargin{:});
  77
  78   % process output arguments
  79   if nargout>0
  80       varargout{1}=h;
  81   end
  82
  83 endfunction
  84
  85 %!demo
  86 %!   drawPoint(10, 10);
  87
  88 %!demo
  89 %!   t = linspace(0, 2*pi, 20)';
  90 %!   drawPoint([5*cos(t)+10 3*sin(t)+10], 'r+');
  91