octave_packages/geometry-1.5.0/geom2d/circleAsPolygon.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2005-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} = } circleAsPolygon (@var{circle}, @var{N})
  36 %% Convert a circle into a series of points
  37 %%
  38 %%   P = circleAsPolygon(CIRCLE, N);
  39 %%   convert circle given as [x0 y0 r], where x0 and y0 are coordinate of
  40 %%   center, and r is the radius, into an array of  [(N+1)x2] double,
  41 %%   containing x and y values of points.
  42 %%   The polygon is closed
  43 %%
  44 %%   P = circleAsPolygon(CIRCLE);
  45 %%   uses a default value of N=64 points
  46 %%
  47 %%   Example
  48 %%   circle = circleAsPolygon([10 0 5], 16);
  49 %%   figure;
  50 %%   drawPolygon(circle);
  51 %%
  52 %%   @seealso{circles2d, polygons2d, createCircle}
  53 %% @end deftypefn
  54
  55 function varargout = circleAsPolygon(circle, varargin)
  56   % determines number of points
  57   N = 64;
  58   if ~isempty(varargin)
  59       N = varargin{1};
  60   end
  61
  62   % create circle
  63   t = linspace(0, 2*pi, N+1)';
  64   x = circle(1) + circle(3)*cos(t);
  65   y = circle(2) + circle(3)*sin(t);
  66
  67   if nargout==1
  68       varargout{1}=[x y];
  69   elseif nargout==2
  70       varargout{1}=x;
  71       varargout{2}=y;
  72   end
  73
  74 endfunction