octave_packages/geometry-1.5.0/geom2d/isPointOnRay.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2007-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{b} = } isPointOnRay (@var{point}, @var{ray})
  36 %% @deftypefnx {Function File} {@var{b} = } isPointOnRay (@var{point}, @var{ray}, @var{tol})
  37 %% Test if a point belongs to a ray
  38 %%
  39 %%  @var{b} = isPointOnRay(@var{point}, @var{ray});
  40 %%  Returns @code{true} if point @var{point} belongs to the ray @var{ray}.
  41 %%  @var{point} is given by [x y] and RAY by [x0 y0 dx dy]. @var{tol} gives the
  42 %%  tolerance for the calculations.
  43 %%
  44 %%  @seealso{rays2d, points2d, isPointOnLine}
  45 %% @end deftypefn
  46
  47 function b = isPointOnRay(point, ray, varargin)
  48
  49   % extract computation tolerance
  50   tol = 1e-14;
  51   if ~isempty(varargin)
  52       tol = varargin{1};
  53   end
  54
  55   % number of rays and points
  56   Nr = size(ray, 1);
  57   Np = size(point, 1);
  58
  59   % if several rays or several points, adapt sizes of arrays
  60   x0 = repmat(ray(:,1)', Np, 1);
  61   y0 = repmat(ray(:,2)', Np, 1);
  62   dx = repmat(ray(:,3)', Np, 1);
  63   dy = repmat(ray(:,4)', Np, 1);
  64   xp = repmat(point(:,1), 1, Nr);
  65   yp = repmat(point(:,2), 1, Nr);
  66
  67   % test if points belongs to the supporting line
  68   b1 = abs ( (xp-x0).*dy - (yp-y0).*dx ) ./ hypot(dx, dy) < tol;
  69
  70   % check if points lie the good direction on the rays
  71   ind     = abs (dx) > abs (dy);
  72   t       = zeros (size (b1));
  73   t(ind)  = (xp(ind)-x0(ind))./dx(ind);
  74   t(~ind) = (yp(~ind)-y0(~ind))./dy(~ind);
  75
  76   % combine the two tests
  77   b = b1 & (t >= 0);
  78
  79 endfunction
  80
  81 %!shared ray
  82 %! p1 = [10 20];
  83 %! p2 = [80 20];
  84 %! ray = createRay (p1, p2);
  85
  86 %!assert (isPointOnRay([10 20], ray));
  87 %!assert (isPointOnRay([80 20], ray));
  88 %!assert (isPointOnRay([50 20], ray));
  89 %!assert (isPointOnRay([50 20+1e-3], ray,1e-2));
  90 %!assert ( !isPointOnRay([50 20+1e-3], ray,1e-4));
  91 %!assert ( !isPointOnRay([9.99 20], ray));
  92 %!assert ( !isPointOnRay([80 20.01], ray));
  93 %!assert ( !isPointOnRay([50 21], ray));
  94 %!assert ( !isPointOnRay([79 19], ray));