Mercurial > octave-nkf

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Grammarcheck the documentation from m-files.
author Rik <octave@nomad.inbox5.com>
date Sun, 18 Jul 2010 20:35:16 -0700
parents 95c3e38098bf
children 693e22af08ae
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} {} surfl (@var{x}, @var{y}, @var{z}) 20 ## @deftypefn {Function File} {} surfl (@var{x}, @var{y}, @var{z})
21 ## @deftypefnx {Function File} {} surfl (@var{z}) 21 ## @deftypefnx {Function File} {} surfl (@var{z})
22 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}) 22 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L})
23 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}, @var{P}) 23 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}, @var{P})
24 ## @deftypefnx {Function File} {} surfl (@dots{},"light") 24 ## @deftypefnx {Function File} {} surfl (@dots{},"light")
25 ## Plot a lighted surface given matrices @var{x}, and @var{y} from @code{meshgrid} and 25 ## Plot a lighted surface given matrices @var{x}, and @var{y} from
26 ## @code{meshgrid} and
26 ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of 27 ## a matrix @var{z} corresponding to the @var{x} and @var{y} coordinates of
27 ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex 28 ## the mesh. If @var{x} and @var{y} are vectors, then a typical vertex
28 ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z} 29 ## is (@var{x}(j), @var{y}(i), @var{z}(i,j)). Thus, columns of @var{z}
29 ## correspond to different @var{x} values and rows of @var{z} correspond 30 ## correspond to different @var{x} values and rows of @var{z} correspond
30 ## to different @var{y} values. 31 ## to different @var{y} values.
31 ## 32 ##
32 ## The light direction can be specified using @var{L}. It can be 33 ## The light direction can be specified using @var{L}. It can be
33 ## given as 2-element vector [azimuth, elevation] in degrees or as 3-element vector [lx, ly, lz]. 34 ## given as 2-element vector [azimuth, elevation] in degrees or as 3-element
35 ## vector [lx, ly, lz].
34 ## The default value is rotated 45° counter-clockwise from the current view. 36 ## The default value is rotated 45° counter-clockwise from the current view.
35 ## 37 ##
36 ## The material properties of the surface can specified using a 4-element vector 38 ## The material properties of the surface can specified using a 4-element vector
37 ## @var{P} = [@var{AM} @var{D} @var{SP} @var{exp}] which defaults to 39 ## @var{P} = [@var{AM} @var{D} @var{SP} @var{exp}] which defaults to
38 ## @var{p} = [0.55 0.6 0.4 10]. 40 ## @var{p} = [0.55 0.6 0.4 10].
41 ## @item "D" strength of diffuse reflection 43 ## @item "D" strength of diffuse reflection
42 ## @item "SP" strength of specular reflection 44 ## @item "SP" strength of specular reflection
43 ## @item "EXP" specular exponent 45 ## @item "EXP" specular exponent
44 ## @end table 46 ## @end table
45 ## 47 ##
46 ## The default lighting mode "cdata", changes the cdata property to give the impression 48 ## The default lighting mode "cdata", changes the cdata property to give the
47 ## of a lighted surface. Please note: the alternative "light" mode, which creates a light 49 ## impression
50 ## of a lighted surface. Please note: the alternative "light" mode, which
51 ## creates a light
48 ## object to illuminate the surface is not implemented (yet). 52 ## object to illuminate the surface is not implemented (yet).
49 ## 53 ##
50 ## Example: 54 ## Example:
51 ## 55 ##
52 ## @example 56 ## @example