comparison scripts/plot/specular.m @ 10793:be55736a0783

Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents d1978e7364ad
children c776f063fefe
comparison
equal deleted inserted replaced
10792:91342260063e 10793:be55736a0783
15 ## You should have received a copy of the GNU General Public License 15 ## You should have received a copy of the GNU General Public License
16 ## along with Octave; see the file COPYING. If not, see 16 ## along with Octave; see the file COPYING. If not, see
17 ## <http://www.gnu.org/licenses/>. 17 ## <http://www.gnu.org/licenses/>.
18 18
19 ## -*- texinfo -*- 19 ## -*- texinfo -*-
20 ## @deftypefn {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v}) 20 ## @deftypefn {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v})
21 ## @deftypefnx {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v}, @var{se}) 21 ## @deftypefnx {Function File} {} specular (@var{sx}, @var{sy}, @var{sz}, @var{l}, @var{v}, @var{se})
22 ## Calculate specular reflection strength of a surface defined by the normal 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. 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{L} and @var{V} respectively. 24 ## The light and view vectors can be specified using parameter @var{L} and
25 ## Both can be given as 2-element vectors [azimuth, elevation] in degrees or as 3-element 25 ## @var{V} respectively.
26 ## vector [x, y, z]. An optional 6th argument describes the specular exponent (spread) @var{se}. 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}.
27 ## @seealso{surfl, diffuse} 30 ## @seealso{surfl, diffuse}
28 ## @end deftypefn 31 ## @end deftypefn
29 32
30 ## Author: Kai Habel <kai.habel@gmx.de> 33 ## Author: Kai Habel <kai.habel@gmx.de>
31 34