octave_packages/geometry-1.5.0/geom2d/drawOrientedBox.m

   1 %% Copyright (c) 2011, INRA
   2 %% 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{hb} = } drawOrientedBox (@var{box})
  36 %% @deftypefnx {Function File} {@var{hb} = } drawOrientedBox (@dots{}, @var{param}, @var{value})
  37 %% Draw centered oriented rectangle.
  38 %%
  39 %%   Syntax
  40 %%   drawOrientedBox(BOX)
  41 %%   drawOrientedBox(BOX, 'PropertyName', propertyvalue, ...)
  42 %%
  43 %%   Description
  44 %%   drawOrientedBox(OBOX)
  45 %%   Draws an oriented rectangle (or bounding box) on the current axis.
  46 %%   OBOX is a 1-by-5 row vector containing box center, dimension (length
  47 %%   and width) and orientation (in degrees):
  48 %%   OBOX = [CX CY LENGTH WIDTH THETA].
  49 %%
  50 %%   When OBOX is a N-by-5 array, the N boxes are drawn.
  51 %%
  52 %%   HB = drawOrientedBox(...)
  53 %%   Returns a handle to the created graphic object(s). Object style can be
  54 %%   modified using syntaw like:
  55 %%   set(HB, 'color', 'g', 'linewidth', 2);
  56 %%
  57 %%   @seealso{drawPolygon, drawRect, drawBox}
  58 %% @end deftypefn
  59
  60 function varargout = drawOrientedBox(box, varargin)
  61
  62   %% Parses input arguments
  63
  64   if nargin > 4 && sum(cellfun(@isnumeric, varargin(1:4))) == 4
  65       cx  = box;
  66       cy  = varargin{1};
  67       hl   = varargin{2} / 2;
  68       hw   = varargin{3} / 2;
  69       theta   = varargin{4};
  70       varargin = varargin(5:end);
  71   else
  72       cx  = box(:,1);
  73       cy  = box(:,2);
  74       hl   = box(:,3) / 2;
  75       hw   = box(:,4) / 2;
  76       theta = box(:,5);
  77   end
  78
  79
  80   %% Draw each box
  81
  82   % allocate memory for graphical handle
  83   hr = zeros(length(cx), 1);
  84
  85   % iterate on oriented boxes
  86   for i = 1:length(cx)
  87       % pre-compute angle data
  88       cot = cosd(theta(i));
  89       sit = sind(theta(i));
  90
  91       % x and y shifts
  92       lc = hl(i) * cot;
  93       ls = hl(i) * sit;
  94       wc = hw(i) * cot;
  95       ws = hw(i) * sit;
  96
  97       % coordinates of box vertices
  98       vx = cx(i) + [-lc + ws; lc + ws ; lc - ws ; -lc - ws ; -lc + ws];
  99       vy = cy(i) + [-ls - wc; ls - wc ; ls + wc ; -ls + wc ; -ls - wc];
 100
 101       % draw polygons
 102       hr(i) = line(vx, vy, varargin{:});
 103   end
 104
 105
 106   %% Format output
 107
 108   if nargout > 0
 109       varargout = {hr};
 110   end
 111
 112 endfunction
 113