octave_packages/geometry-1.5.0/geom2d/createRay.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{ray} = } createRay (@var{point}, @var{angle})
  36 %% @deftypefnx {Function File} { @var{ray} = } createRay (@var{x0},@var{y0}, @var{angle})
  37 %% @deftypefnx {Function File} { @var{ray} = } createRay (@var{p1}, @var{p2})
  38 %%  Create a ray (half-line), from various inputs.
  39 %%
  40 %%  A Ray is represented in a parametric form: [x0 y0 dx dy].
  41 %%   x = x0 + t*dx
  42 %%   y = y0 + t*dy;
  43 %%   for all t>0.
  44 %%
  45 %%   @var{point} is a Nx2 array giving the starting point of the ray, and @var{angle} is the
  46 %%   orientation of the ray respect to the positive x-axis. The ray origin can be specified with 2 input arguments @var{x0},@var{y0}.
  47 %%
  48 %%   If two points @var{p1}, @var{p2} are given, creates a ray starting from point @var{p1} and going in the direction of point
  49 %%   @var{p2}.
  50 %%
  51 %%   Example
  52 %% @example
  53 %%   origin  = [3 4];
  54 %%   theta   = pi/6;
  55 %%   ray = createRay(origin, theta);
  56 %%   axis([0 10 0 10]);
  57 %%   drawRay(ray);
  58 %% @end example
  59 %%
  60 %% @seealso{rays2d, createLine, points2d}
  61 %% @end deftypefn
  62
  63 function ray = createRay(varargin)
  64
  65   if length(varargin)==2
  66       p0 = varargin{1};
  67       arg = varargin{2};
  68       if size(arg, 2)==1
  69           % second input is the ray angle
  70           ray = [p0 cos(arg) sin(arg)];
  71       else
  72           % second input is another point
  73           ray = [p0 arg-p0];
  74       end
  75
  76   elseif length(varargin)==3
  77       x = varargin{1};
  78       y = varargin{2};
  79       theta = varargin{3};
  80       ray = [x y cos(theta) sin(theta)];
  81
  82   else
  83       error("Wrong number of arguments in 'createRay'. ");
  84   end
  85
  86 endfunction
  87
  88 %!shared p1,p2,ray
  89 %!  p1 = [1 1];
  90 %!  p2 = [2 3];
  91 %!  ray = createRay(p1, p2);
  92
  93 %!assert (p1, ray(1,1:2), 1e-6);
  94 %!assert (p2-p1, ray(1,3:4), 1e-6);
  95
  96 %!shared p1,p2,ray
  97 %!  p1 = [1 1;1 1];
  98 %!  p2 = [2 3;2 4];
  99 %!  ray = createRay(p1, p2);
 100
 101 %!assert (2, size(ray, 1));
 102 %!assert (p1, ray(:,1:2), 1e-6);
 103 %!assert (p2-p1, ray(:,3:4), 1e-6);
 104