Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / drawRay.m

diff --git a/octave_packages/geometry-1.5.0/geom2d/drawRay.m b/octave_packages/geometry-1.5.0/geom2d/drawRay.m
new file mode 100644 (file)
index 0000000..a6c4cd9
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/drawRay.m
@@ -0,0 +1,66 @@
+%% Copyright (c) 2011, INRA
+%% 2003-2011, David Legland <david.legland@grignon.inra.fr>
+%% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
+%%
+%% All rights reserved.
+%% (simplified BSD License)
+%%
+%% Redistribution and use in source and binary forms, with or without
+%% modification, are permitted provided that the following conditions are met:
+%%
+%% 1. Redistributions of source code must retain the above copyright notice, this
+%%    list of conditions and the following disclaimer.
+%%     
+%% 2. Redistributions in binary form must reproduce the above copyright notice, 
+%%    this list of conditions and the following disclaimer in the documentation
+%%    and/or other materials provided with the distribution.
+%%
+%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+%% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+%% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+%% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+%% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
+%% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+%% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
+%% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+%% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+%% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+%% POSSIBILITY OF SUCH DAMAGE.
+%%
+%% The views and conclusions contained in the software and documentation are
+%% those of the authors and should not be interpreted as representing official
+%% policies, either expressed or implied, of copyright holder.
+
+%% -*- texinfo -*-
+%% @deftypefn {Function File} {@var{h} = } drawRay (@var{ray})
+%% @deftypefnx {Function File} {@var{h} = } drawRay (@var{ray}, @var{param}, @var{value})
+%% Draw a ray on the current axis.
+%%
+%% With @var{ray} having the syntax: [x0 y0 dx dy], draws the ray starting from
+%%  point (x0 y0) and going to direction (dx dy), clipped with the current
+%%  window axis. @var{param}, @var{value} pairs are passed to function @code{line}.
+%%
+%%   @seealso{rays2d, drawLine, line}
+%% @end deftypefn
+
+function varargout = drawRay(ray, varargin)
+
+  % get bounding box limits
+  bb = axis(gca);
+
+  % compute clipped shapes
+  [clipped isInside] = clipRay(ray, bb);
+
+  % allocate memory for handle
+  h = -ones(size(ray, 1), 1);
+
+  % draw visible rays
+  h(isInside) = drawEdge(clipped(isInside, :), varargin{:});
+
+  % process output
+  if nargout>0
+      varargout = {h};
+  end
+
+endfunction
+