octave_packages/m/plot/specular.m

   1 ## Copyright (C) 2009-2012 Kai Habel
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn  {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{lv}, @var{vv})
  21 ## @deftypefnx {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{lv}, @var{vv}, @var{se})
  22 ## Calculate specular reflection strength of a surface defined by the normal
  23 ## vector elements @var{sx}, @var{sy}, @var{sz} using Phong's approximation.
  24 ## The light and view vectors can be specified using parameter @var{lv} and
  25 ## @var{vv} respectively.
  26 ## Both can be given as 2-element vectors [azimuth, elevation] in degrees or as
  27 ## 3-element
  28 ## vector [x, y, z].  An optional 6th argument describes the specular exponent
  29 ## (spread) @var{se}.
  30 ## @seealso{surfl, diffuse}
  31 ## @end deftypefn
  32
  33 ## Author: Kai Habel <kai.habel@gmx.de>
  34
  35 function retval = specular (sx, sy, sz, lv, vv, se)
  36
  37   if (nargin < 5 || nargin > 6)
  38     print_usage ();
  39   endif
  40
  41   ## Checks for specular exponent (se).
  42   if (nargin < 6)
  43     se = 10;
  44   else
  45     if (!isnumeric (se) || numel (se) != 1 || se <= 0)
  46       error ("specular: exponent must be positive scalar");
  47     endif
  48   endif
  49
  50   ## Checks for normal vector.
  51   if (!size_equal (sx, sy, sz))
  52     error ("specular: SX, SY, and SZ must have same size");
  53   endif
  54
  55   ## Check for light vector (lv) argument.
  56   if (length (lv) < 2 || length (lv) > 3)
  57     error ("specular: light vector LV must be a 2- or 3-element vector");
  58   elseif (length (lv) == 2)
  59     [lv(1), lv(2), lv(3)] = sph2cart (lv(1) * pi/180, lv(2) * pi/180, 1.0);
  60   endif
  61
  62   ## Check for view vector (vv) argument.
  63   if (length (vv) < 2 || length (lv) > 3)
  64     error ("specular: view vector VV must be a 2- or 3-element vector");
  65   elseif (length (vv) == 2)
  66     [vv(1), vv(2), vv(3)] = sph2cart (vv(1) * pi / 180, vv(2) * pi / 180, 1.0);
  67   endif
  68
  69   ## Normalize view and light vector.
  70   if (sum (abs (lv)) > 0)
  71     lv  /= norm (lv);
  72   endif
  73   if (sum (abs (vv)) > 0)
  74     vv  /= norm (vv);
  75   endif
  76
  77   ## Calculate normal vector lengths and dot-products.
  78   ns = sqrt (sx.^2 + sy.^2 + sz.^2);
  79   l_dot_n = (sx * lv(1) + sy * lv(2) + sz * lv(3)) ./ ns;
  80   v_dot_n = (sx * vv(1) + sy * vv(2) + sz * vv(3)) ./ ns;
  81
  82   ## Calculate specular reflection using Phong's approximation.
  83   retval = 2 * l_dot_n .* v_dot_n - dot (lv, vv);
  84
  85   ## Set zero if light is on the other side.
  86   retval(l_dot_n < 0) = 0;
  87
  88   ## Allow postive values only.
  89   retval(retval < 0) = 0;
  90   retval = retval .^ se;
  91
  92 endfunction