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>
5 %% All rights reserved.
6 %% (simplified BSD License)
8 %% Redistribution and use in source and binary forms, with or without
9 %% modification, are permitted provided that the following conditions are met:
11 %% 1. Redistributions of source code must retain the above copyright notice, this
12 %% list of conditions and the following disclaimer.
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.
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.
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.
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.
40 %% A Ray is represented in a parametric form: [x0 y0 dx dy].
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}.
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
55 %% ray = createRay(origin, theta);
60 %% @seealso{rays2d, createLine, points2d}
63 function ray = createRay(varargin)
65 if length(varargin)==2
69 % second input is the ray angle
70 ray = [p0 cos(arg) sin(arg)];
72 % second input is another point
76 elseif length(varargin)==3
80 ray = [x y cos(theta) sin(theta)];
83 error("Wrong number of arguments in 'createRay'. ");
91 %! ray = createRay(p1, p2);
93 %!assert (p1, ray(1,1:2), 1e-6);
94 %!assert (p2-p1, ray(1,3:4), 1e-6);
99 %! ray = createRay(p1, p2);
101 %!assert (2, size(ray, 1));
102 %!assert (p1, ray(:,1:2), 1e-6);
103 %!assert (p2-p1, ray(:,3:4), 1e-6);