]> Creatis software - CreaPhase.git/blob - octave_packages/geometry-1.5.0/geom2d/drawRect.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / drawRect.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{r} = } drawRect (@var{x}, @var{y}, @var{w}, @var{h})
36 %% @deftypefnx {Function File} {@var{r} = } drawRect (@var{x}, @var{y}, @var{w}, @var{h}, @var{theta})
37 %% @deftypefnx {Function File} {@var{r} = } drawRect (@var{coord})
38 %% Draw rectangle on the current axis.
39 %%   
40 %%   r = DRAWRECT(x, y, w, h) draw rectangle with width W and height H, at
41 %%   position (X, Y).
42 %%   the four corners of rectangle are then :
43 %%   (X, Y), (X+W, Y), (X, Y+H), (X+W, Y+H).
44 %%
45 %%   r = DRAWRECT(x, y, w, h, theta) also specifies orientation for
46 %%   rectangle. Theta is given in degrees.
47 %%
48 %%   r = DRAWRECT(coord) is the same as DRAWRECT(X,Y,W,H), but all
49 %%   parameters are packed into one array, whose dimensions is 4*1 or 5*1.
50 %%
51 %%
52 %%   @seealso{drawBox, drawOrientedBox}
53 %% @end deftypefn
54
55 function varargout = drawRect(varargin)
56
57   % default values
58   theta = 0;
59
60   % get entered values
61   if length(varargin) > 3
62       x = varargin{1};
63       y = varargin{2};
64       w = varargin{3};
65       h = varargin{4};
66       if length(varargin)> 4 
67           theta = varargin{5} * pi / 180;
68       end
69       
70   else
71       coord = varargin{1};
72       x = coord(1);
73       y = coord(2);
74       w = coord(3);
75       h = coord(4);
76       if length(coord) > 4
77           theta = coord(5) * pi / 180;
78       end
79   end
80
81   r = zeros(size(x));
82   for i = 1:length(x)
83       tx = zeros(5, 1);
84       ty = zeros(5, 1);
85       tx(1) = x(i);
86       ty(1) = y(i);
87       tx(2) = x(i) + w(i) * cos(theta(i));
88       ty(2) = y(i) + w(i) * sin(theta(i));
89       tx(3) = x(i) + w(i) * cos(theta(i)) - h(i) * sin(theta(i));
90       ty(3) = y(i) + w(i) * sin(theta(i)) + h(i) * cos(theta(i));
91       tx(4) = x(i) - h(i) * sin(theta(i));
92       ty(4) = y(i) + h(i) * cos(theta(i));
93       tx(5) = x(i);
94       ty(5) = y(i);
95
96       r(i) = line(tx, ty);
97   end
98
99   if nargout > 0
100       varargout{1} = r;
101   end
102
103 endfunction
104