Mercurial > hg > octave-lyh
annotate scripts/plot/surfl.m @ 17289:bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Macro handles options ("on") or properties ("position") more elegantly
than @code{"text"}.
* doc/interpreter/macros.texi: Add new @qcode macro.
* doc/interpreter/tips.txi: Add documentation about @qcode macro.
* doc/interpreter/basics.txi, doc/interpreter/container.txi,
doc/interpreter/emacs.txi, doc/interpreter/errors.txi,
doc/interpreter/eval.txi, doc/interpreter/expr.txi,
doc/interpreter/external.txi, doc/interpreter/func.txi,
doc/interpreter/grammar.txi, doc/interpreter/image.txi,
doc/interpreter/install.txi, doc/interpreter/interp.txi,
doc/interpreter/io.txi, doc/interpreter/matrix.txi,
doc/interpreter/numbers.txi, doc/interpreter/oop.txi,
doc/interpreter/package.txi, doc/interpreter/plot.txi,
doc/interpreter/quad.txi, doc/interpreter/sparse.txi,
doc/interpreter/strings.txi, doc/interpreter/system.txi,
doc/interpreter/vectorize.txi, libinterp/corefcn/balance.cc,
libinterp/corefcn/bitfcns.cc, libinterp/corefcn/cellfun.cc,
libinterp/corefcn/conv2.cc, libinterp/corefcn/data.cc,
libinterp/corefcn/debug.cc, libinterp/corefcn/defaults.cc,
libinterp/corefcn/dirfns.cc, libinterp/corefcn/dlmread.cc,
libinterp/corefcn/error.cc, libinterp/corefcn/file-io.cc,
libinterp/corefcn/find.cc, libinterp/corefcn/gammainc.cc,
libinterp/corefcn/graphics.cc, libinterp/corefcn/help.cc,
libinterp/corefcn/hex2num.cc, libinterp/corefcn/input.cc,
libinterp/corefcn/load-path.cc, libinterp/corefcn/load-save.cc,
libinterp/corefcn/ls-oct-ascii.cc, libinterp/corefcn/lu.cc,
libinterp/corefcn/luinc.cc, libinterp/corefcn/matrix_type.cc,
libinterp/corefcn/oct-hist.cc, libinterp/corefcn/pager.cc,
libinterp/corefcn/pr-output.cc, libinterp/corefcn/pt-jit.cc,
libinterp/corefcn/qz.cc, libinterp/corefcn/rand.cc,
libinterp/corefcn/regexp.cc, libinterp/corefcn/schur.cc,
libinterp/corefcn/sighandlers.cc, libinterp/corefcn/sparse.cc,
libinterp/corefcn/spparms.cc, libinterp/corefcn/str2double.cc,
libinterp/corefcn/svd.cc, libinterp/corefcn/symtab.cc,
libinterp/corefcn/syscalls.cc, libinterp/corefcn/toplev.cc,
libinterp/corefcn/tril.cc, libinterp/corefcn/typecast.cc,
libinterp/corefcn/utils.cc, libinterp/corefcn/variables.cc,
libinterp/dldfcn/__init_fltk__.cc, libinterp/dldfcn/chol.cc,
libinterp/dldfcn/colamd.cc, libinterp/dldfcn/fftw.cc, libinterp/dldfcn/qr.cc,
libinterp/dldfcn/symbfact.cc, libinterp/octave-value/ov-base.cc,
libinterp/octave-value/ov-fcn-handle.cc,
libinterp/octave-value/ov-fcn-inline.cc, libinterp/octave-value/ov-java.cc,
libinterp/octave-value/ov-range.cc, libinterp/octave-value/ov-struct.cc,
libinterp/octave-value/ov-usr-fcn.cc, libinterp/parse-tree/oct-parse.in.yy,
libinterp/parse-tree/pt-binop.cc, libinterp/parse-tree/pt-eval.cc,
libinterp/parse-tree/pt-mat.cc, scripts/@ftp/ftp.m,
scripts/deprecated/java_convert_matrix.m, scripts/deprecated/java_debug.m,
scripts/deprecated/java_unsigned_conversion.m, scripts/deprecated/shell_cmd.m,
scripts/general/dblquad.m, scripts/general/display.m,
scripts/general/genvarname.m, scripts/general/idivide.m,
scripts/general/interp1.m, scripts/general/interp2.m,
scripts/general/interp3.m, scripts/general/interpn.m, scripts/general/isa.m,
scripts/general/profexplore.m, scripts/general/profile.m,
scripts/general/quadgk.m, scripts/general/randi.m, scripts/general/structfun.m,
scripts/general/subsindex.m, scripts/general/triplequad.m,
scripts/geometry/griddata.m, scripts/geometry/griddata3.m,
scripts/geometry/griddatan.m, scripts/geometry/voronoi.m, scripts/help/help.m,
scripts/help/lookfor.m, scripts/image/cmpermute.m, scripts/image/colormap.m,
scripts/image/image.m, scripts/image/imagesc.m, scripts/image/imfinfo.m,
scripts/image/imformats.m, scripts/image/imread.m, scripts/image/imshow.m,
scripts/image/imwrite.m, scripts/image/ind2gray.m, scripts/image/lines.m,
scripts/image/rgb2ind.m, scripts/image/spinmap.m, scripts/io/dlmwrite.m,
scripts/io/strread.m, scripts/io/textread.m, scripts/io/textscan.m,
scripts/java/javaclasspath.m, scripts/java/usejava.m,
scripts/miscellaneous/bzip2.m, scripts/miscellaneous/computer.m,
scripts/miscellaneous/copyfile.m, scripts/miscellaneous/debug.m,
scripts/miscellaneous/dos.m, scripts/miscellaneous/edit.m,
scripts/miscellaneous/gzip.m, scripts/miscellaneous/license.m,
scripts/miscellaneous/mkoctfile.m, scripts/miscellaneous/movefile.m,
scripts/miscellaneous/parseparams.m, scripts/miscellaneous/unix.m,
scripts/optimization/fminbnd.m, scripts/optimization/fminsearch.m,
scripts/optimization/fminunc.m, scripts/optimization/fsolve.m,
scripts/optimization/fzero.m, scripts/optimization/glpk.m,
scripts/optimization/lsqnonneg.m, scripts/optimization/optimset.m,
scripts/optimization/pqpnonneg.m, scripts/pkg/pkg.m, scripts/plot/allchild.m,
scripts/plot/ancestor.m, scripts/plot/area.m, scripts/plot/axis.m,
scripts/plot/bar.m, scripts/plot/barh.m, scripts/plot/box.m,
scripts/plot/caxis.m, scripts/plot/cla.m, scripts/plot/clabel.m,
scripts/plot/clf.m, scripts/plot/close.m, scripts/plot/colorbar.m,
scripts/plot/daspect.m, scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m,
scripts/plot/ezsurf.m, scripts/plot/ezsurfc.m, scripts/plot/findall.m,
scripts/plot/findobj.m, scripts/plot/gcbo.m, scripts/plot/gcf.m,
scripts/plot/gco.m, scripts/plot/grid.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hidden.m, scripts/plot/hold.m,
scripts/plot/isonormals.m, scripts/plot/isosurface.m, scripts/plot/legend.m,
scripts/plot/mesh.m, scripts/plot/meshc.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pbaspect.m, scripts/plot/pcolor.m,
scripts/plot/plot.m, scripts/plot/print.m,
scripts/plot/private/__add_default_menu__.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/refreshdata.m, scripts/plot/saveas.m,
scripts/plot/scatter.m, scripts/plot/scatter3.m, scripts/plot/shading.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surfc.m, scripts/plot/surfl.m,
scripts/plot/tetramesh.m, scripts/plot/uigetfile.m, scripts/plot/uimenu.m,
scripts/plot/uiputfile.m, scripts/plot/waterfall.m, scripts/plot/whitebg.m,
scripts/plot/xlim.m, scripts/plot/ylim.m, scripts/plot/zlim.m,
scripts/polynomial/conv.m, scripts/polynomial/polyout.m,
scripts/polynomial/splinefit.m, scripts/set/ismember.m, scripts/set/powerset.m,
scripts/set/setdiff.m, scripts/set/union.m, scripts/set/unique.m,
scripts/signal/detrend.m, scripts/signal/filter2.m, scripts/signal/freqz.m,
scripts/signal/periodogram.m, scripts/signal/spectral_adf.m,
scripts/signal/spectral_xdf.m, scripts/sparse/eigs.m, scripts/sparse/svds.m,
scripts/specfun/legendre.m, scripts/special-matrix/gallery.m,
scripts/statistics/base/mean.m, scripts/statistics/base/moment.m,
scripts/statistics/tests/cor_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test.m,
scripts/statistics/tests/kolmogorov_smirnov_test_2.m,
scripts/statistics/tests/kruskal_wallis_test.m,
scripts/statistics/tests/prop_test_2.m, scripts/statistics/tests/sign_test.m,
scripts/statistics/tests/t_test.m, scripts/statistics/tests/t_test_2.m,
scripts/statistics/tests/t_test_regression.m,
scripts/statistics/tests/u_test.m, scripts/statistics/tests/var_test.m,
scripts/statistics/tests/welch_test.m,
scripts/statistics/tests/wilcoxon_test.m, scripts/statistics/tests/z_test.m,
scripts/statistics/tests/z_test_2.m, scripts/strings/base2dec.m,
scripts/strings/index.m, scripts/strings/isstrprop.m,
scripts/strings/mat2str.m, scripts/strings/regexptranslate.m,
scripts/strings/rindex.m, scripts/strings/str2num.m, scripts/strings/strcat.m,
scripts/strings/strjust.m, scripts/strings/strmatch.m,
scripts/strings/validatestring.m, scripts/testfun/demo.m,
scripts/testfun/example.m, scripts/testfun/test.m, scripts/time/addtodate.m,
scripts/time/asctime.m, scripts/time/datestr.m, scripts/time/datetick.m,
scripts/time/weekday.m, scripts/ui/errordlg.m, scripts/ui/helpdlg.m,
scripts/ui/inputdlg.m, scripts/ui/listdlg.m, scripts/ui/msgbox.m,
scripts/ui/questdlg.m, scripts/ui/warndlg.m: Use new @qcode macro.
author | Rik <rik@octave.org> |
---|---|
date | Mon, 19 Aug 2013 20:46:38 -0700 |
parents | 87ba70043bfc |
children | 68bcac3c043a |
rev | line source |
---|---|
14138
72c96de7a403
maint: update copyright notices for 2012
John W. Eaton <jwe@octave.org>
parents:
14092
diff
changeset
|
1 ## Copyright (C) 2009-2012 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 -*- |
10793
be55736a0783
Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents:
10549
diff
changeset
|
20 ## @deftypefn {Function File} {} surfl (@var{x}, @var{y}, @var{z}) |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
21 ## @deftypefnx {Function File} {} surfl (@var{z}) |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
22 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}) |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
23 ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}, @var{P}) |
11563
3c6e8aaa9555
Grammarcheck m-files before 3.4 release.
Rik <octave@nomad.inbox5.com>
parents:
11523
diff
changeset
|
24 ## @deftypefnx {Function File} {} surfl (@dots{}, "light") |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
25 ## @deftypefnx {Function File} {} surfl (@var{hax}, @dots{}) |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
26 ## @deftypefnx {Function File} {@var{h} =} surfl (@dots{}) |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
27 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
28 ## 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
|
29 ## |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
30 ## 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
|
31 ## 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
|
32 ## 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
|
33 ## 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
|
34 ## given, then it is plotted over the meshgrid |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
35 ## @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
|
36 ## Thus, columns of @var{z} correspond to different @var{x} values and rows |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
37 ## 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
|
38 ## |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
39 ## The default lighting mode @qcode{"cdata"}, changes the cdata property of the |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
40 ## surface object to give the impression of a lighted surface. |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
41 ## @strong{Warning:} The alternative mode @qcode{"light"} mode which creates a light |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
42 ## object to illuminate the surface is not implemented (yet). |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
43 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
44 ## The light source location can be specified using @var{L}. It can be given |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
45 ## 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
|
46 ## 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
|
47 ## counterclockwise to the current view. |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
48 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
49 ## 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
|
50 ## 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
|
51 ## @var{p} = [0.55 0.6 0.4 10]. |
14248 | 52 ## |
11595
5ec6aa05638d
Prevent doubled quotes around @table items in Info.
Rik <octave@nomad.inbox5.com>
parents:
11587
diff
changeset
|
53 ## @table @asis |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
54 ## @item @qcode{"AM"} strength of ambient light |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
55 ## |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
56 ## @item @qcode{"D"} strength of diffuse reflection |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
57 ## |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
58 ## @item @qcode{"SP"} strength of specular reflection |
10821
693e22af08ae
Grammarcheck documentation of m-files
Rik <octave@nomad.inbox5.com>
parents:
10793
diff
changeset
|
59 ## |
17289
bc924baa2c4e
doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents:
17219
diff
changeset
|
60 ## @item @qcode{"EXP"} specular exponent |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
61 ## @end table |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
62 ## |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
63 ## 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
|
64 ## 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
|
65 ## |
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
66 ## 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
|
67 ## surface object. |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
68 ## |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
69 ## Example: |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
70 ## |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
71 ## @example |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
72 ## @group |
14327
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
73 ## colormap (bone (64)); |
4d917a6a858b
doc: Use Octave coding conventions in @example blocks of docstrings.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
74 ## surfl (peaks); |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
75 ## shading interp; |
9051
1bf0ce0930be
Grammar check TexInfo in all .m files
Rik <rdrider0-list@yahoo.com>
parents:
9040
diff
changeset
|
76 ## @end group |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
77 ## @end example |
17126
eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Rik <rik@octave.org>
parents:
17052
diff
changeset
|
78 ## @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
|
79 ## @end deftypefn |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
80 |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
81 ## 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
|
82 |
17131 | 83 function h = surfl (varargin) |
84 | |
85 [hax, varargin, nargin] = __plt_get_axis_arg__ ("surfl", varargin{:}); | |
86 | |
87 if (nargin == 0) | |
88 print_usage (); | |
89 endif | |
90 | |
91 ## Check for lighting type. | |
92 use_cdata = true; | |
93 if (ischar (varargin{end})) | |
94 switch (tolower (varargin{end})) | |
95 case "light" | |
96 warning ("light method not supported (yet), using cdata method instead"); | |
97 ## This can be implemented when light objects are supported. | |
98 use_cdata = false; | |
99 case "cdata" | |
100 use_cdata = true; | |
101 otherwise | |
102 error ("surfl: unknown lighting method"); | |
103 endswitch | |
104 varargin(end) = []; | |
105 endif | |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
106 |
17131 | 107 ## Check for reflection properties argument. |
108 ## | |
109 ## r = [ambient light strength, | |
110 ## diffuse reflection strength, | |
111 ## specular reflection strength, | |
112 ## specular shine] | |
113 if (isnumeric (varargin{end}) && length (varargin{end}) == 4) | |
114 r = varargin{end}; | |
115 varargin(end) = []; | |
116 else | |
117 ## Default values. | |
118 r = [0.55, 0.6, 0.4, 10]; | |
119 endif | |
120 | |
121 ## Check for light vector (lv) argument. | |
122 have_lv = false; | |
123 if (isnumeric (varargin{end})) | |
124 len = numel (varargin{end}); | |
125 lastarg = varargin{end}; | |
126 if (len == 3) | |
127 lv = lastarg; | |
128 varargin(end) = []; | |
129 have_lv = true; | |
130 elseif (len == 2) | |
131 [lv(1), lv(2), lv(3)] = sph2cart ((lastarg(1) - 90) * pi/180, | |
132 lastarg(2) * pi/180, | |
133 1.0); | |
134 varargin(end) = []; | |
135 have_lv = true; | |
136 endif | |
137 endif | |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
138 |
17219
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
139 oldfig = []; |
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
140 if (isempty (hax)) |
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
141 oldfig = get (0, "currentfigure"); |
87ba70043bfc
Don't use ifelse in plot fcns to avoid unnecessary fcn evaluations.
Rik <rik@octave.org>
parents:
17198
diff
changeset
|
142 endif |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
143 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
|
144 hax = newplot (hax); |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
145 |
17131 | 146 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
|
147 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
|
148 set (hax, "view", [-37.5, 30], |
17131 | 149 "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
|
150 endif |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
151 |
8460
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
152 ## Get view vector (vv). |
17131 | 153 [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
|
154 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
|
155 |
17131 | 156 if (! have_lv) |
8460
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
157 ## Calculate light vector (lv) from view vector. |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
158 Phi = 45.0 / 180.0 * pi; |
8460
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
159 R = [cos(Phi), -sin(Phi), 0; |
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
160 sin(Phi), cos(Phi), 0; |
17131 | 161 0, 0, 1]; |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
162 lv = (R * vv.').'; |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
163 endif |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
164 |
14225
f0d903879eaa
Replace unnecessary strcmpi calls with strcmp.
Rik <octave@nomad.inbox5.com>
parents:
14223
diff
changeset
|
165 vn = get (htmp, "vertexnormals"); |
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
|
166 dar = get (hax, "plotboxaspectratio"); |
8460
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
167 vn(:,:,1) *= dar(1); |
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
168 vn(:,:,2) *= dar(2); |
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
169 vn(:,:,3) *= dar(3); |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
170 |
8460
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
171 ## Normalize vn. |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
172 vn = 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
|
173 [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
|
174 |
8460
e4c9ecb64411
diffuse.m, specular.m, surfl.m: style fixes
John W. Eaton <jwe@octave.org>
parents:
8450
diff
changeset
|
175 ## Ambient, diffuse, and specular term. |
17131 | 176 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
|
177 + 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
|
178 + r(3) * specular (vn(:,:,1), vn(:,:,2), vn(:,:,3), lv, vv, r(4))); |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
179 |
14225
f0d903879eaa
Replace unnecessary strcmpi calls with strcmp.
Rik <octave@nomad.inbox5.com>
parents:
14223
diff
changeset
|
180 set (htmp, "cdata", cdata ./ sum (r(1:3))); |
11587
c792872f8942
all script files: untabify and strip trailing whitespace
John W. Eaton <jwe@octave.org>
parents:
11563
diff
changeset
|
181 |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
182 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
|
183 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
|
184 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
|
185 endif |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
186 end_unwind_protect |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
187 |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
188 if (nargout > 0) |
17131 | 189 h = htmp; |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
190 endif |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
191 |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
192 endfunction |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
193 |
14223
ba7a26030214
Use Octave spacing convention in %!test blocks of surface plot functions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
194 |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
195 %!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
|
196 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14225
diff
changeset
|
197 %! [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
|
198 %! 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
|
199 %! surfl (X,Y,Z); |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
200 %! shading interp; |
17198
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17131
diff
changeset
|
201 %! title ('surfl() with defaults'); |
8450
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
202 |
6c4e2fc14beb
Add new 3D plotting function surfl. Add light functions diffuse and specular
Kai Habel
parents:
diff
changeset
|
203 %!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
|
204 %! clf; |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14225
diff
changeset
|
205 %! [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
|
206 %! colormap (copper (64)); |
11949c9795a0
Revamp %!demos in m-files to use Octave coding conventions on spacing, etc.
Rik <octave@nomad.inbox5.com>
parents:
14225
diff
changeset
|
207 %! [az, el] = view (); |
14223
ba7a26030214
Use Octave spacing convention in %!test blocks of surface plot functions.
Rik <octave@nomad.inbox5.com>
parents:
14138
diff
changeset
|
208 %! surfl (X,Y,Z, [az+225,el], [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
|
209 %! shading interp; |
17198
df4c4b7708a4
Add titles and clean-up plotting %!demos.
Rik <rik@octave.org>
parents:
17131
diff
changeset
|
210 %! 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
|
211 |