octave_packages/geometry-1.5.0/geom2d/parallelLine.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{res} = } parallelLine (@var{line}, @var{point})
  36 %% @deftypefnx {Function File} {@var{res} = } parallelLine (@var{line}, @var{dist})
  37 %% Create a line parallel to another one.
  38 %%
  39 %%   Returns the line with same direction vector than @var{line} and going through
  40 %%   the point given by @var{point}.
  41 %%   @var{line} is given as [x0 y0 dx dy] and @var{point} is [xp yp].
  42 %%
  43 %%   Uses relative distance to specify position. The new line will be
  44 %%   located at distance @var{dist}, counted positive in the right side of @var{line}
  45 %%   and negative in the left side.
  46 %%
  47 %%   @seealso{lines2d, orthogonalLine, distancePointLine}
  48 %% @end deftypefn
  49
  50 function res = parallelLine(line, point)
  51
  52   if size(point, 1)==1
  53       % use a distance. Compute position of point located at distance DIST on
  54       % the line orthogonal to the first one.
  55       point = pointOnLine([line(:,1) line(:,2) line(:,4) -line(:,3)], point);
  56   end
  57
  58   % normal case: compute line through a point with given direction
  59   res = zeros(1, 4);
  60   res(1:2) = point;
  61   res(3:4) = line(3:4);
  62
  63 endfunction