summaryrefslogtreecommitdiff
path: root/inst/geom2d/drawBox.m
blob: b3bd6f8114723dfc3c1d0e26c039d7cc69003222 (plain)
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
%% Copyright (c) 2011, INRA
%% 2003-2011, David Legland <david.legland@grignon.inra.fr>
%% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
%%
%% All rights reserved.
%% (simplified BSD License)
%%
%% Redistribution and use in source and binary forms, with or without
%% modification, are permitted provided that the following conditions are met:
%%
%% 1. Redistributions of source code must retain the above copyright notice, this
%%    list of conditions and the following disclaimer.
%%     
%% 2. Redistributions in binary form must reproduce the above copyright notice, 
%%    this list of conditions and the following disclaimer in the documentation
%%    and/or other materials provided with the distribution.
%%
%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
%% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
%% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
%% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
%% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
%% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
%% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
%% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
%% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
%% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
%% POSSIBILITY OF SUCH DAMAGE.
%%
%% The views and conclusions contained in the software and documentation are
%% those of the authors and should not be interpreted as representing official
%% policies, either expressed or implied, of copyright holder.

%% -*- texinfo -*-
%% @deftypefn {Function File} {@var{h} =} drawBox (@var{box})
%% @deftypefnx {Function File} {@var{h} =} drawBox (@var{box}, @var{param}, @var{value}, ...)
%% Draw a box defined by coordinate extents
%% 
%% Draws a box defined by its extent: @var{box} = [@var{xmin} @var{xmax}
%% @var{ymin} @var{ymax}]. Addtional
%% arguments are passed to function @code{plot}. If requested, it returns the
%% handle to the graphics object created.
%%
%% @seealso{drawOrientedBox, drawRect, plot}
%% @end deftypefn

function varargout = drawBox(box, varargin)

  % default values
  xmin = box(:,1);
  xmax = box(:,2);
  ymin = box(:,3);
  ymax = box(:,4);

  nBoxes = size(box, 1);
  r = zeros(nBoxes, 1);

  % iterate on boxes
  for i = 1:nBoxes
      % exract min and max values
      tx(1) = xmin(i);
      ty(1) = ymin(i);
      tx(2) = xmax(i);
      ty(2) = ymin(i);
      tx(3) = xmax(i);
      ty(3) = ymax(i);
      tx(4) = xmin(i);
      ty(4) = ymax(i);
      tx(5) = xmin(i);
      ty(5) = ymin(i);

      % display polygon
      r(i) = plot(tx, ty, varargin{:});
  end

  % format output
  if nargout > 0
      varargout = {r};
  end
  
endfunction