octave_packages/geometry-1.5.0/geom2d/polarPoint.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{point} = } polarPoint (@var{rho}, @var{theta})
  36 %% @deftypefnx {Function File} {@var{point} = } polarPoint (@var{theta})
  37 %% @deftypefnx {Function File} {@var{point} = } polarPoint (@var{point}, @var{rho}, @var{theta})
  38 %% @deftypefnx {Function File} {@var{point} = } polarPoint (@var{x0}, @var{y0}, @var{rho}, @var{theta})
  39 %%Create a point from polar coordinates (rho + theta)
  40 %%
  41 %%   Creates a point using polar coordinate. @var{theta} is angle with horizontal
  42 %%   (counted counter-clockwise, and in radians), and @var{rho} is the distance to
  43 %%   origin. If only angle is given radius @var{rho} is assumed to be 1.
  44 %%
  45 %%   If a point is given, adds the coordinate of the point to the coordinate of the specified
  46 %%   point. For example, creating a point with :
  47 %%     P = polarPoint([10 20], 30, pi/2);
  48 %%   will give a result of [40 20].
  49 %%
  50 %%   @seealso{points2d}
  51 %% @end deftypefn
  52
  53 function point = polarPoint(varargin)
  54
  55   % default values
  56   x0 = 0; y0=0;
  57   rho = 1;
  58   theta =0;
  59
  60   % process input parameters
  61   if length(varargin)==1
  62       theta = varargin{1};
  63   elseif length(varargin)==2
  64       rho = varargin{1};
  65       theta = varargin{2};
  66   elseif length(varargin)==3
  67       var = varargin{1};
  68       x0 = var(:,1);
  69       y0 = var(:,2);
  70       rho = varargin{2};
  71       theta = varargin{3};
  72   elseif length(varargin)==4
  73       x0 = varargin{1};
  74       y0 = varargin{2};
  75       rho = varargin{3};
  76       theta = varargin{4};
  77   end
  78
  79   point = [x0 + rho.*cos(theta) , y0+rho.*sin(theta)];
  80
  81 endfunction
  82
  83