octave_packages/geometry-1.5.0/geom2d/rays2d.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2008-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} rays2d ()
  36 %% Description of functions operating on planar rays
  37 %%
  38 %%   A ray is defined by a point (its origin), and a vector (its
  39 %%   direction). The different parameters are bundled into a row vector:
  40 %%   @code{RAY = [x0 y0 dx dy];}
  41 %%
  42 %%   The ray contains all the points (x,y) such that:
  43 %%   x = x0 + t*dx
  44 %%   y = y0 + t*dy;
  45 %%   for all t>0
  46 %%
  47 %%   Contrary to a (straight) line, the points located before the origin do
  48 %%   not belong to the ray.
  49 %%   However, as rays and lines have the same representation, some functions
  50 %%   working on lines are also working on rays (like @code{transformLine}).
  51 %%
  52 %%   @seealso{points2d, vectors2d, lines2d, createRay, bisector, isPointOnRay,
  53 %%   clipRay, drawRay}
  54 %% @end deftypefn
  55
  56 function rays2d(varargin)
  57
  58   help('rays2d');
  59
  60 endfunction