octave_packages/geometry-1.5.0/polygons2d/drawPolygon.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2005-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} = } drawPolygon (@var{coord})
  36 %% @deftypefnx {Function File} {@var{h} = } drawPolygon (@var{px}, @var{py})
  37 %% @deftypefnx {Function File} {@var{h} = } drawPolygon (@var{polys})
  38 %% Draw a polygon specified by a list of points.
  39 %%
  40 %%   drawPolygon(COORD);
  41 %%   Packs coordinates in a single [N*2] array.
  42 %%
  43 %%   drawPolygon(PX, PY);
  44 %%   Specifies coordinates in separate arrays.
  45 %%
  46 %%   drawPolygon(POLYS)
  47 %%   Packs coordinate of several polygons in a cell array. Each element of
  48 %%   the array is a Ni*2 double array.
  49 %%
  50 %%   H = drawPolygon(...);
  51 %%   Also return a handle to the list of line objects.
  52 %%
  53 %%
  54 %%   @seealso{polygons2d, drawCurve}
  55 %% @end deftypefn
  56
  57 function varargout = drawPolygon(varargin)
  58
  59   % check input
  60   if isempty(varargin)
  61       error('need to specify a polygon');
  62   end
  63
  64   var = varargin{1};
  65
  66   %% Manage cell arrays of polygons
  67
  68   % case of a set of polygons stored in a cell array
  69   if iscell(var)
  70       N = length(var);
  71       h = zeros(N, 1);
  72       for i = 1:N
  73           state = ishold(gca);
  74           hold on;
  75           % check for empty polygons
  76           if ~isempty(var{i})
  77               h(i) = drawPolygon(var{i}, varargin{2:end});
  78           end
  79           if ~state
  80               hold off
  81           end
  82       end
  83
  84       if nargout > 0
  85           varargout = {h};
  86       end
  87
  88       return;
  89   end
  90
  91
  92   %% Parse coordinates and options
  93
  94   % Extract coordinates of polygon vertices
  95   if size(var, 2) > 1
  96       % first argument is a polygon array
  97       px = var(:, 1);
  98       py = var(:, 2);
  99       varargin(1) = [];
 100   else
 101       % arguments 1 and 2 correspond to x and y coordinate respectively
 102       if length(varargin) < 2
 103           error('Should specify either a N-by-2 array, or 2 N-by-1 vectors');
 104       end
 105
 106       px = varargin{1};
 107       py = varargin{2};
 108       varargin(1:2) = [];
 109   end
 110
 111   % set default line format
 112   if isempty(varargin)
 113       varargin = {'b-'};
 114   end
 115
 116   % check case of polygons with holes
 117   if sum(isnan(px(:))) > 0
 118       polygons = splitPolygons([px py]);
 119       h = drawPolygon(polygons);
 120
 121       if nargout > 0
 122           varargout = {h};
 123       end
 124
 125       return;
 126   end
 127
 128
 129   %% Draw the polygon
 130
 131   % ensure last point is the same as the first one
 132   px(size(px, 1)+1, :) = px(1,:);
 133   py(size(py, 1)+1, :) = py(1,:);
 134
 135   % draw the polygon outline
 136   h = plot(px, py, varargin{:});
 137
 138   % format output arg
 139   if nargout > 0
 140       varargout = {h};
 141   end
 142
 143 endfunction
 144