octave_packages/geometry-1.5.0/geom2d/drawCircle.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{h} = } drawCircle (@var{x0}, @var{y0}, @var{r})
  36 %% @deftypefnx {Function File} {@var{h} = } drawCircle (@var{circle})
  37 %% @deftypefnx {Function File} {@var{h} = } drawCircle (@var{center}, @var{radius})
  38 %% @deftypefnx {Function File} {@var{h} = } drawCircle (@dots{}, @var{nstep})
  39 %% @deftypefnx {Function File} {@var{h} = } drawCircle (@dots{}, @var{name}, @var{value})
  40 %% Draw a circle on the current axis
  41 %%
  42 %%   drawCircle(X0, Y0, R);
  43 %%   Draw the circle with center (X0,Y0) and the radius R. If X0, Y0 and R
  44 %%   are column vectors of the same length, draw each circle successively.
  45 %%
  46 %%   drawCircle(CIRCLE);
  47 %%   Concatenate all parameters in a Nx3 array, where N is the number of
  48 %%   circles to draw.
  49 %%
  50 %%   drawCircle(CENTER, RADIUS);
  51 %%   Specify CENTER as Nx2 array, and radius as a Nx1 array.
  52 %%
  53 %%   drawCircle(..., NSTEP);
  54 %%   Specify the number of edges that will be used to draw the circle.
  55 %%   Default value is 72, creating an approximation of one point for each 5
  56 %%   degrees.
  57 %%
  58 %%   drawCircle(..., NAME, VALUE);
  59 %%   Specifies plotting options as pair of parameters name/value. See plot
  60 %%   documentation for details.
  61 %%
  62 %%
  63 %%   H = drawCircle(...);
  64 %%   return handles to each created curve.
  65 %%
  66 %%   @seealso{circles2d, drawCircleArc, drawEllipse}
  67 %% @end deftypefn
  68
  69 function varargout = drawCircle(varargin)
  70
  71   % process input parameters
  72   var = varargin{1};
  73   if size(var, 2) == 1
  74       x0 = varargin{1};
  75       y0 = varargin{2};
  76       r  = varargin{3};
  77       varargin(1:3) = [];
  78
  79   elseif size(var, 2) == 2
  80       x0 = var(:,1);
  81       y0 = var(:,2);
  82       r  = varargin{2};
  83       varargin(1:2) = [];
  84
  85   elseif size(var, 2) == 3
  86       x0 = var(:,1);
  87       y0 = var(:,2);
  88       r  = var(:,3);
  89       varargin(1) = [];
  90   else
  91       error('bad format for input in drawCircle');
  92   end
  93
  94   % ensure each parameter is column vector
  95   x0 = x0(:);
  96   y0 = y0(:);
  97   r = r(:);
  98
  99   % default number of discretization steps
 100   N = 72;
 101
 102   % check if discretization step is specified
 103   if ~isempty(varargin)
 104       var = varargin{1};
 105       if length(var)==1 && isnumeric(var)
 106           N = round(var);
 107           varargin(1) = [];
 108       end
 109   end
 110
 111   % parametrization variable for circle (use N+1 as first point counts twice)
 112   t = linspace(0, 2*pi, N+1);
 113   cot = cos(t);
 114   sit = sin(t);
 115
 116   % empty array for graphic handles
 117   h = zeros(size(x0));
 118
 119   % compute discretization of each circle
 120   for i = 1:length(x0)
 121       xt = x0(i) + r(i) * cot;
 122       yt = y0(i) + r(i) * sit;
 123
 124       h(i) = plot(xt, yt, varargin{:});
 125   end
 126
 127   if nargout > 0
 128       varargout = {h};
 129   end
 130
 131 endfunction
 132