octave_packages/geometry-1.5.0/geom2d/projPointOnLine.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{point} = } projPointOnLine (@var{pt1}, @var{line})
  36 %%  Project of a point orthogonally onto a line
  37 %%
  38 %%   Computes the (orthogonal) projection of point @var{pt1} onto the line @var{line}.
  39 %%
  40 %%   Function works also for multiple points and lines. In this case, it
  41 %%   returns multiple points.
  42 %%   Point @var{pt1} is a [N*2] array, and @var{line} is a [N*4] array (see createLine
  43 %%   for details). Result @var{point} is a [N*2] array, containing coordinates of
  44 %%   orthogonal projections of @var{pt1} onto lines @var{line}.
  45 %%
  46 %%   @seealso{lines2d, points2d, isPointOnLine, linePosition}
  47 %% @end deftypefn
  48
  49 function point = projPointOnLine(point, line)
  50
  51   % ensure input arguments have same size
  52   if size(line, 1)==1 && size(point, 1)>1
  53       line = repmat(line, [size(point, 1) 1]);
  54   end
  55   if size(point, 1)==1 && size(line, 1)>1
  56       point = repmat(point, [size(line, 1) 1]);
  57   end
  58
  59   % slope of line
  60   dx = line(:, 3);
  61   dy = line(:, 4);
  62
  63   % first find relative position of projection on the line,
  64   tp = ((point(:, 2) - line(:, 2)).*dy + (point(:, 1) - line(:, 1)).*dx) ./ (dx.*dx+dy.*dy);
  65
  66   % convert position on line to cartesian coordinate
  67   point = line(:,1:2) + [tp tp].*[dx dy];
  68
  69 endfunction