annotate scripts/plot/draw/surfl.m @ 19630:0e1f5a750d00

maint: Periodic merge of gui-release to default.
author John W. Eaton <jwe@octave.org>
date Tue, 20 Jan 2015 10:24:46 -0500
parents 92ec75319e73 446c46af4b42
children 4197fc428c7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17572
diff changeset
1 ## Copyright (C) 2009-2013 Kai Habel
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
2 ##
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
3 ## This file is part of Octave.
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
4 ##
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
8 ## your option) any later version.
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
9 ##
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
13 ## General Public License for more details.
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
14 ##
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
15 ## You should have received a copy of the GNU General Public License
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
17 ## <http://www.gnu.org/licenses/>.
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
18
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
19 ## -*- texinfo -*-
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
20 ## @deftypefn {Function File} {} surfl (@var{z})
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
21 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z})
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
22 ## @deftypefnx {Function File} {} surfl (@dots{}, @var{lsrc})
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
23 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{lsrc}, @var{P})
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
24 ## @deftypefnx {Function File} {} surfl (@dots{}, "cdata")
11563
3c6e8aaa9555 Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents: 11523
diff changeset
25 ## @deftypefnx {Function File} {} surfl (@dots{}, "light")
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
26 ## @deftypefnx {Function File} {} surfl (@var{hax}, @dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
27 ## @deftypefnx {Function File} {@var{h} =} surfl (@dots{})
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
28 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
29 ## Plot a 3-D surface using shading based on various lighting models.
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
30 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
31 ## The surface mesh is plotted using shaded rectangles. The vertices of the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
32 ## rectangles [@var{x}, @var{y}] are typically the output of @code{meshgrid}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
33 ## over a 2-D rectangular region in the x-y plane. @var{z} determines the
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
34 ## height above the plane of each vertex. If only a single @var{z} matrix is
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
35 ## given, then it is plotted over the meshgrid
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
36 ## @code{@var{x} = 1:columns (@var{z}), @var{y} = 1:rows (@var{z})}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
37 ## Thus, columns of @var{z} correspond to different @var{x} values and rows
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
38 ## of @var{z} correspond to different @var{y} values.
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
39 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
40 ## The default lighting mode @qcode{"cdata"}, changes the cdata property of the
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
41 ## surface object to give the impression of a lighted surface.
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
42 ## @strong{Warning:} The alternative mode @qcode{"light"} mode which creates a
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
43 ## light object to illuminate the surface is not implemented (yet).
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
44 ##
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
45 ## The light source location can be specified using @var{lsrc}. It can be given
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
46 ## as a 2-element vector [azimuth, elevation] in degrees, or as a 3-element
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
47 ## vector [lx, ly, lz]. The default value is rotated 45 degrees
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
48 ## counterclockwise to the current view.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
49 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
50 ## The material properties of the surface can specified using a 4-element
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
51 ## vector @var{P} = [@var{AM} @var{D} @var{SP} @var{exp}] which defaults to
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
52 ## @var{p} = [0.55 0.6 0.4 10].
14248
48cb466f1418 surfl.m: Update docstring.
Rik <octave@nomad.inbox5.com>
parents: 14237
diff changeset
53 ##
11595
5ec6aa05638d Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
54 ## @table @asis
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
55 ## @item @qcode{"AM"} strength of ambient light
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
56 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
57 ## @item @qcode{"D"} strength of diffuse reflection
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
58 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
59 ## @item @qcode{"SP"} strength of specular reflection
10821
693e22af08ae Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents: 10793
diff changeset
60 ##
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17211
diff changeset
61 ## @item @qcode{"EXP"} specular exponent
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
62 ## @end table
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
63 ##
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
64 ## If the first argument @var{hax} is an axes handle, then plot into this axis,
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
65 ## rather than the current axes returned by @code{gca}.
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
66 ##
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
67 ## The optional return value @var{h} is a graphics handle to the created
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
68 ## surface object.
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
69 ##
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
70 ## Example:
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
71 ##
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
72 ## @example
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
73 ## @group
14327
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
74 ## colormap (bone (64));
4d917a6a858b doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
75 ## surfl (peaks);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
76 ## shading interp;
9051
1bf0ce0930be Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents: 9040
diff changeset
77 ## @end group
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
78 ## @end example
17122
eaab03308c0b doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents: 17052
diff changeset
79 ## @seealso{diffuse, specular, surf, shading, colormap, caxis}
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
80 ## @end deftypefn
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
81
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
82 ## Author: Kai Habel <kai.habel@gmx.de>
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
83
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
84 function h = surfl (varargin)
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
85
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
86 [hax, varargin, nargin] = __plt_get_axis_arg__ ("surfl", varargin{:});
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
87
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
88 if (nargin == 0)
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
89 print_usage ();
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
90 endif
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
91
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
92 ## Check for lighting type.
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
93 use_cdata = true;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
94 if (ischar (varargin{end}))
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
95 switch (tolower (varargin{end}))
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
96 case "light"
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
97 warning ("surfl: light method not supported (yet), using cdata method instead");
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
98 ## This can be implemented when light objects are supported.
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
99 use_cdata = false;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
100 case "cdata"
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
101 use_cdata = true;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
102 otherwise
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
103 error ("surfl: unknown lighting method");
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
104 endswitch
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
105 varargin(end) = [];
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
106 endif
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
107
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
108 ## Check for reflection properties argument.
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
109 ##
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
110 ## r = [ambient light strength,
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
111 ## diffuse reflection strength,
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
112 ## specular reflection strength,
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
113 ## specular shine]
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
114 if (isnumeric (varargin{end}) && length (varargin{end}) == 4)
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
115 r = varargin{end};
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
116 varargin(end) = [];
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
117 else
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
118 ## Default values.
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
119 r = [0.55, 0.6, 0.4, 10];
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
120 endif
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
121
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
122 ## Check for light vector (lv) argument.
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
123 have_lv = false;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
124 if (isnumeric (varargin{end}))
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
125 len = numel (varargin{end});
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
126 lastarg = varargin{end};
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
127 if (len == 3)
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
128 lv = lastarg;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
129 varargin(end) = [];
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
130 have_lv = true;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
131 elseif (len == 2)
19627
446c46af4b42 strip trailing whitespace from most source files
John W. Eaton <jwe@octave.org>
parents: 17744
diff changeset
132 [lv(1), lv(2), lv(3)] = sph2cart ((lastarg(1) - 90) * pi/180,
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
133 lastarg(2) * pi/180,
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
134 1.0);
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
135 varargin(end) = [];
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
136 have_lv = true;
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
137 endif
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
138 endif
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
139
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
140 oldfig = [];
17301
68bcac3c043a Correct inversion accidentally introduced in cset 87ba70043bfc.
Rik <rik@octave.org>
parents: 17281
diff changeset
141 if (! isempty (hax))
17211
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
142 oldfig = get (0, "currentfigure");
87ba70043bfc Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents: 17190
diff changeset
143 endif
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
144 unwind_protect
17052
1118d566bcd4 surf.m, surfc.m, surfl.m, surfnorm.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16754
diff changeset
145 hax = newplot (hax);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
146
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
147 htmp = surface (varargin{:});
17052
1118d566bcd4 surf.m, surfc.m, surfl.m, surfnorm.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16754
diff changeset
148 if (! ishold (hax))
1118d566bcd4 surf.m, surfc.m, surfl.m, surfnorm.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16754
diff changeset
149 set (hax, "view", [-37.5, 30],
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
150 "xgrid", "on", "ygrid", "on", "zgrid", "on", "clim", [0 1]);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
151 endif
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
152
8460
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
153 ## Get view vector (vv).
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
154 [az, el] = view ();
16754
022dba56de1e eliminate unnecessary normalisation of view vector in surfl (bug #39241)
Andreas Weber <andy.weber.aw@googlemail.com>
parents: 14868
diff changeset
155 vv = sph2cart ((az - 90) * pi/180.0, el * pi/180.0, 1.0);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
156
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
157 if (! have_lv)
8460
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
158 ## Calculate light vector (lv) from view vector.
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
159 phi = pi / 4; # 45 degrees
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
160 R = [cos(phi), -sin(phi), 0;
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
161 sin(phi), cos(phi), 0;
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
162 0, 0, 1];
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
163 lv = (R * vv.').';
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
164 endif
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
165
14225
f0d903879eaa Replace unnecessary strcmpi calls with strcmp.
Rik <octave@nomad.inbox5.com>
parents: 14223
diff changeset
166 vn = get (htmp, "vertexnormals");
18434
92ec75319e73 surfl.m: normalize using dataaspectratio, not plotboxaspectratio.
Rik <rik@octave.org>
parents: 17744
diff changeset
167 dar = get (hax, "dataaspectratio");
8460
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
168 vn(:,:,1) *= dar(1);
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
169 vn(:,:,2) *= dar(2);
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
170 vn(:,:,3) *= dar(3);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
171
8460
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
172 ## Normalize vn.
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
173 vn ./= repmat (sqrt (sumsq (vn, 3)), [1, 1, 3]);
14868
5d3a684236b0 maint: Use Octave coding conventions for cuddling parentheses in scripts directory
Rik <octave@nomad.inbox5.com>
parents: 14335
diff changeset
174 [nr, nc] = size (get (htmp, "zdata"));
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
175
8460
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
176 ## Ambient, diffuse, and specular term.
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
177 cdata = ( r(1) * ones (nr, nc)
8460
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
178 + r(2) * diffuse (vn(:,:,1), vn(:,:,2), vn(:,:,3), lv)
e4c9ecb64411 diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents: 8450
diff changeset
179 + r(3) * specular (vn(:,:,1), vn(:,:,2), vn(:,:,3), lv, vv, r(4)));
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
180 cdata ./= sum (r(1:3));
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
181
17491
326af26556ea surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17301
diff changeset
182 set (htmp, "cdata", cdata);
11587
c792872f8942 all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents: 11563
diff changeset
183
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
184 unwind_protect_cleanup
17052
1118d566bcd4 surf.m, surfc.m, surfl.m, surfnorm.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16754
diff changeset
185 if (! isempty (oldfig))
1118d566bcd4 surf.m, surfc.m, surfl.m, surfnorm.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16754
diff changeset
186 set (0, "currentfigure", oldfig);
1118d566bcd4 surf.m, surfc.m, surfl.m, surfnorm.m: Update to use new __plt_get_axis_arg__.
Pantxo Diribarne <pantxo.diribarne@gmail.com>
parents: 16754
diff changeset
187 endif
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
188 end_unwind_protect
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
189
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
190 if (nargout > 0)
17127
fd9a8b1a8768 surfl.m: Overhaul function.
Rik <rik@octave.org>
parents: 17122
diff changeset
191 h = htmp;
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
192 endif
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
193
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
194 endfunction
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
195
14223
ba7a26030214 Use Octave spacing convention in %!test blocks of surface plot functions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
196
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
197 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14225
diff changeset
198 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14225
diff changeset
199 %! [X,Y,Z] = sombrero ();
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14225
diff changeset
200 %! colormap (copper (64));
14223
ba7a26030214 Use Octave spacing convention in %!test blocks of surface plot functions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
201 %! surfl (X,Y,Z);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
202 %! shading interp;
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17127
diff changeset
203 %! title ('surfl() with defaults');
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
204
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
205 %!demo
14237
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14225
diff changeset
206 %! clf;
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14225
diff changeset
207 %! [X,Y,Z] = sombrero ();
11949c9795a0 Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents: 14225
diff changeset
208 %! colormap (copper (64));
18434
92ec75319e73 surfl.m: normalize using dataaspectratio, not plotboxaspectratio.
Rik <rik@octave.org>
parents: 17744
diff changeset
209 %! surfl (X,Y,Z, [62.50,30], [0.2 0.6 0.4 25]);
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
210 %! shading interp;
17190
df4c4b7708a4 Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents: 17127
diff changeset
211 %! title ('surfl() with lighting vector and material properties');
8450
6c4e2fc14beb Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff changeset
212