octave_packages/geometry-1.5.0/geom2d/drawBox.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2003-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} =} drawBox (@var{box})
  36 %% @deftypefnx {Function File} {@var{h} =} drawBox (@var{box}, @var{param}, @var{value}, ...)
  37 %% Draw a box defined by coordinate extents
  38 %%
  39 %% Draws a box defined by its extent: @var{box} = [@var{xmin} @var{xmax}
  40 %% @var{ymin} @var{ymax}]. Addtional
  41 %% arguments are passed to function @code{plot}. If requested, it returns the
  42 %% handle to the graphics object created.
  43 %%
  44 %% @seealso{drawOrientedBox, drawRect, plot}
  45 %% @end deftypefn
  46
  47 function varargout = drawBox(box, varargin)
  48
  49   % default values
  50   xmin = box(:,1);
  51   xmax = box(:,2);
  52   ymin = box(:,3);
  53   ymax = box(:,4);
  54
  55   nBoxes = size(box, 1);
  56   r = zeros(nBoxes, 1);
  57
  58   % iterate on boxes
  59   for i = 1:nBoxes
  60       % exract min and max values
  61       tx(1) = xmin(i);
  62       ty(1) = ymin(i);
  63       tx(2) = xmax(i);
  64       ty(2) = ymin(i);
  65       tx(3) = xmax(i);
  66       ty(3) = ymax(i);
  67       tx(4) = xmin(i);
  68       ty(4) = ymax(i);
  69       tx(5) = xmin(i);
  70       ty(5) = ymin(i);
  71
  72       % display polygon
  73       r(i) = plot(tx, ty, varargin{:});
  74   end
  75
  76   % format output
  77   if nargout > 0
  78       varargout = {r};
  79   end
  80
  81 endfunction