octave_packages/geometry-1.5.0/geom2d/ellipseAsPolygon.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2004-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{p} = } ellipseAsPolygon (@var{ell}, @var{n})
  36 %% Convert an ellipse into a series of points
  37 %%
  38 %%   P = ellipseAsPolygon(ELL, N);
  39 %%   converts ELL given as [x0 y0 a b] or [x0 y0 a b theta] into a polygon
  40 %%   with N edges. The result P is (N+1)-by-2 array containing coordinates
  41 %%   of the N+1 vertices of the polygon.
  42 %%   The resulting polygon is closed, i.e. the last point is the same as the
  43 %%   first one.
  44 %%
  45 %%   P = ellipseAsPolygon(ELL);
  46 %%   Use a default number of edges equal to 72. This result in one piont for
  47 %%   each 5 degrees.
  48 %%
  49 %%   [X Y] = ellipseAsPolygon(...);
  50 %%   Return the coordinates o fvertices in two separate arrays.
  51 %%
  52 %%   @seealso{ellipses2d, circleAsPolygon, rectAsPolygon, drawEllipse}
  53 %% @end deftypefn
  54
  55 function varargout = ellipseAsPolygon(ellipse, N)
  56
  57   % default value for N
  58   if nargin < 2
  59       N = 72;
  60   end
  61
  62   % angle of ellipse
  63   theta = 0;
  64   if size(ellipse, 2) > 4
  65       theta = ellipse(:,5);
  66   end
  67
  68   % get ellipse parameters
  69   xc = ellipse(:,1);
  70   yc = ellipse(:,2);
  71   a  = ellipse(:,3);
  72   b  = ellipse(:,4);
  73
  74   % create time basis
  75   t = linspace(0, 2*pi, N+1)';
  76
  77   % pre-compute trig functions (angles is in degrees)
  78   cot = cosd(theta);
  79   sit = sind(theta);
  80
  81   % position of points
  82   x = xc + a * cos(t) * cot - b * sin(t) * sit;
  83   y = yc + a * cos(t) * sit + b * sin(t) * cot;
  84
  85   % format output depending on number of a param.
  86   if nargout == 1
  87       varargout = {[x y]};
  88   elseif nargout == 2
  89       varargout = {x, y};
  90   end
  91
  92 endfunction
  93