octave_packages/geometry-1.5.0/geom2d/drawParabola.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2006-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} = } drawParabola (@var{parabola})
  36 %% @deftypefnx {Function File} {@var{h} = } drawParabola (@var{parabola}, @var{t})
  37 %% @deftypefnx {Function File} {@var{h} = } drawParabola (@dots{}, @var{param}, @var{value})
  38 %% Draw a parabola on the current axis.
  39 %%
  40 %%   drawParabola(PARABOLA);
  41 %%   Draws a vertical parabola, defined by its vertex and its parameter.
  42 %%   Such a parabola admits a vertical axis of symetry.
  43 %%
  44 %%   The algebraic equation of parabola is given by:
  45 %%      (Y - YV) = A * (X - VX)^2
  46 %%   Where XV and YV are vertex coordinates and A is parabola parameter.
  47 %%
  48 %%   A parametric equation of parabola is given by:
  49 %%      x(t) = t + VX;
  50 %%      y(t) = A * t^2 + VY;
  51 %%
  52 %%   PARABOLA can also be defined by [XV YV A THETA], with theta being the
  53 %%   angle of rotation of the parabola (in degrees and Counter-Clockwise).
  54 %%
  55 %%   drawParabola(PARABOLA, T);
  56 %%   Specifies which range of 't' are used for drawing parabola. If T is an
  57 %%   array with only two values, the first and the last values are used as
  58 %%   interval bounds, and several values are distributed within this
  59 %%   interval.
  60 %%
  61 %%   drawParabola(..., NAME, VALUE);
  62 %%   Can specify one or several graphical options using parameter name-value
  63 %%   pairs.
  64 %%
  65 %%   H = drawParabola(...);
  66 %%   Returns an handle to the created graphical object.
  67 %%
  68 %%
  69 %%   Example:
  70 %%   @example
  71 %%   figure(1); clf; hold on;
  72 %%   drawParabola([50 50 .2 30]);
  73 %%   drawParabola([50 50 .2 30], [-1 1], 'color', 'r', 'linewidth', 2);
  74 %%   axis equal;
  75 %% @end example
  76 %%
  77 %%   @seealso{drawCircle, drawEllipse}
  78 %% @end deftypefn
  79
  80 function varargout = drawParabola(varargin)
  81
  82   % Extract parabola
  83   if nargin<1
  84       error('geom2d:IllegalArgument', ...
  85           'Please specify parabola representation');
  86   end
  87
  88   % input parabola is given as a packed array
  89   parabola = varargin{1};
  90   varargin(1) = [];
  91   x0 = parabola(:,1);
  92   y0 = parabola(:,2);
  93   a  = parabola(:,3);
  94
  95   if size(parabola, 2)>3
  96       theta = parabola(:, 4);
  97   else
  98       theta = zeros(length(a), 1);
  99   end
 100
 101   % extract parametrisation bounds
 102   bounds = [-100 100];
 103   if ~isempty(varargin)
 104       var = varargin{1};
 105       if isnumeric(var)
 106           bounds = var;
 107           varargin(1) = [];
 108       end
 109   end
 110
 111   % create parametrisation
 112   if length(bounds)>2
 113       t = bounds;
 114   else
 115       t = linspace(bounds(1), bounds(end), 100);
 116   end
 117
 118   % create handle array (in the case of several parabola)
 119   h = zeros(size(x0));
 120
 121   % draw each parabola
 122   for i=1:length(x0)
 123       % compute transformation
 124       trans = ...
 125           createTranslation(x0(i), y0(i)) * ...
 126           createRotation(deg2rad(theta(i))) * ...
 127           createScaling(1, a);
 128
 129           % compute points on the parabola
 130       [xt yt] = transformPoint(t(:), t(:).^2, trans);
 131
 132       % draw it
 133       h(i) = plot(xt, yt, varargin{:});
 134   end
 135
 136   % process output arguments
 137   if nargout>0
 138       varargout{1}=h;
 139   end
 140
 141 endfunction
 142