Mercurial > octave-nkf
diff scripts/plot/draw/surfl.m @ 17572:7bb76a22cde1
maint: Split scripts/plot directory into 4 pieces.
scripts/gui : user-interface functions
scripts/plot/appearance : functions controlling plot appearance
scripts/plot/draw : plotting functions which produce graphs
scripts/plot/util : low-level plotting functions and utilities.
* scripts/gui/guidata.m, scripts/gui/guihandles.m, scripts/gui/module.mk,
scripts/gui/private/__file_filter__.m,
scripts/gui/private/__fltk_file_filter__.m,
scripts/gui/private/__is_function__.m, scripts/gui/private/__uigetdir_fltk__.m,
scripts/gui/private/__uigetfile_fltk__.m,
scripts/gui/private/__uiobject_split_args__.m,
scripts/gui/private/__uiputfile_fltk__.m, scripts/gui/uicontextmenu.m,
scripts/gui/uicontrol.m, scripts/gui/uigetdir.m, scripts/gui/uigetfile.m,
scripts/gui/uimenu.m, scripts/gui/uipanel.m, scripts/gui/uipushtool.m,
scripts/gui/uiputfile.m, scripts/gui/uiresume.m, scripts/gui/uitoggletool.m,
scripts/gui/uitoolbar.m, scripts/gui/uiwait.m, scripts/gui/waitbar.m,
scripts/gui/waitforbuttonpress.m: Moved from scripts/plot to scripts/gui
* scripts/plot/appearance/__clabel__.m,
scripts/plot/appearance/__getlegenddata__.m, scripts/plot/appearance/axis.m,
scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m,
scripts/plot/appearance/clabel.m, scripts/plot/appearance/daspect.m,
scripts/plot/appearance/diffuse.m, scripts/plot/appearance/grid.m,
scripts/plot/appearance/gtext.m, scripts/plot/appearance/hidden.m,
scripts/plot/appearance/legend.m,
scripts/plot/appearance/orient.m, scripts/plot/appearance/pbaspect.m,
scripts/plot/appearance/private/__axis_label__.m,
scripts/plot/appearance/private/__axis_limits__.m,
scripts/plot/appearance/shading.m, scripts/plot/appearance/specular.m,
scripts/plot/appearance/text.m, scripts/plot/appearance/title.m,
scripts/plot/appearance/view.m, scripts/plot/appearance/whitebg.m,
scripts/plot/appearance/xlabel.m, scripts/plot/appearance/xlim.m,
scripts/plot/appearance/ylabel.m, scripts/plot/appearance/ylim.m,
scripts/plot/appearance/zlabel.m, scripts/plot/appearance/zlim.m:
Moved from scripts/plot to subdir appearance.
* scripts/plot/draw/area.m, scripts/plot/draw/bar.m, scripts/plot/draw/barh.m,
scripts/plot/draw/colorbar.m, scripts/plot/draw/comet.m,
scripts/plot/draw/comet3.m, scripts/plot/draw/compass.m,
scripts/plot/draw/contour.m, scripts/plot/draw/contour3.m,
scripts/plot/draw/contourc.m, scripts/plot/draw/contourf.m,
scripts/plot/draw/cylinder.m, scripts/plot/draw/ellipsoid.m,
scripts/plot/draw/errorbar.m, scripts/plot/draw/ezcontour.m,
scripts/plot/draw/ezcontourf.m, scripts/plot/draw/ezmesh.m,
scripts/plot/draw/ezmeshc.m, scripts/plot/draw/ezplot.m,
scripts/plot/draw/ezplot3.m, scripts/plot/draw/ezpolar.m,
scripts/plot/draw/ezsurf.m, scripts/plot/draw/ezsurfc.m,
scripts/plot/draw/feather.m, scripts/plot/draw/fill.m,
scripts/plot/draw/fplot.m, scripts/plot/draw/hist.m,
scripts/plot/draw/isocolors.m, scripts/plot/draw/isonormals.m,
scripts/plot/draw/isosurface.m, scripts/plot/draw/line.m,
scripts/plot/draw/loglog.m, scripts/plot/draw/loglogerr.m,
scripts/plot/draw/mesh.m, scripts/plot/draw/meshc.m, scripts/plot/draw/meshz.m,
scripts/plot/draw/pareto.m,
scripts/plot/draw/patch.m, scripts/plot/draw/pcolor.m,
scripts/plot/draw/peaks.m, scripts/plot/draw/pie.m, scripts/plot/draw/pie3.m,
scripts/plot/draw/plot.m, scripts/plot/draw/plot3.m,
scripts/plot/draw/plotmatrix.m, scripts/plot/draw/plotyy.m,
scripts/plot/draw/polar.m, scripts/plot/draw/private/__add_datasource__.m,
scripts/plot/draw/private/__bar__.m, scripts/plot/draw/private/__contour__.m,
scripts/plot/draw/private/__errcomm__.m,
scripts/plot/draw/private/__errplot__.m,
scripts/plot/draw/private/__ezplot__.m,
scripts/plot/draw/private/__interp_cube__.m,
scripts/plot/draw/private/__line__.m,
scripts/plot/draw/private/__marching_cube__.m,
scripts/plot/draw/private/__patch__.m, scripts/plot/draw/private/__pie__.m,
scripts/plot/draw/private/__plt__.m, scripts/plot/draw/private/__quiver__.m,
scripts/plot/draw/private/__scatter__.m, scripts/plot/draw/private/__stem__.m,
scripts/plot/draw/quiver.m, scripts/plot/draw/quiver3.m,
scripts/plot/draw/rectangle.m, scripts/plot/draw/ribbon.m,
scripts/plot/draw/rose.m, scripts/plot/draw/scatter.m,
scripts/plot/draw/scatter3.m, scripts/plot/draw/semilogx.m,
scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogy.m,
scripts/plot/draw/semilogyerr.m, scripts/plot/draw/shrinkfaces.m,
scripts/plot/draw/slice.m, scripts/plot/draw/sombrero.m,
scripts/plot/draw/sphere.m, scripts/plot/draw/stairs.m,
scripts/plot/draw/stem.m, scripts/plot/draw/stem3.m,
scripts/plot/draw/stemleaf.m, scripts/plot/draw/surf.m,
scripts/plot/draw/surface.m, scripts/plot/draw/surfc.m,
scripts/plot/draw/surfl.m, scripts/plot/draw/surfnorm.m,
scripts/plot/draw/tetramesh.m, scripts/plot/draw/trimesh.m,
scripts/plot/draw/triplot.m, scripts/plot/draw/trisurf.m,
scripts/plot/draw/waterfall.m: Moved from plot/ to subdir draw.
* scripts/plot/util/__actual_axis_position__.m,
scripts/plot/util/__default_plot_options__.m,
scripts/plot/util/__gnuplot_drawnow__.m,
scripts/plot/util/__next_line_color__.m,
scripts/plot/util/__next_line_style__.m,
scripts/plot/util/__plt_get_axis_arg__.m, scripts/plot/util/__pltopt__.m,
scripts/plot/util/allchild.m, scripts/plot/util/ancestor.m,
scripts/plot/util/axes.m, scripts/plot/util/cla.m, scripts/plot/util/clf.m,
scripts/plot/util/close.m, scripts/plot/util/closereq.m,
scripts/plot/util/colstyle.m, scripts/plot/util/copyobj.m,
scripts/plot/util/figure.m, scripts/plot/util/findall.m,
scripts/plot/util/findfigs.m, scripts/plot/util/findobj.m,
scripts/plot/util/gca.m, scripts/plot/util/gcbf.m, scripts/plot/util/gcbo.m,
scripts/plot/util/gcf.m, scripts/plot/util/gco.m, scripts/plot/util/ginput.m,
scripts/plot/util/gnuplot_binary.in, scripts/plot/util/graphics_toolkit.m,
scripts/plot/util/hdl2struct.m, scripts/plot/util/hggroup.m,
scripts/plot/util/hold.m, scripts/plot/util/isaxes.m,
scripts/plot/util/isfigure.m, scripts/plot/util/ishghandle.m,
scripts/plot/util/ishold.m, scripts/plot/util/isprop.m,
scripts/plot/util/linkprop.m, scripts/plot/util/meshgrid.m,
scripts/plot/util/ndgrid.m,
scripts/plot/util/newplot.m, scripts/plot/util/print.m,
scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/private/__fltk_ginput__.m,
scripts/plot/util/private/__fltk_print__.m,
scripts/plot/util/private/__ghostscript__.m,
scripts/plot/util/private/__gnuplot_get_var__.m,
scripts/plot/util/private/__gnuplot_ginput__.m,
scripts/plot/util/private/__gnuplot_has_feature__.m,
scripts/plot/util/private/__gnuplot_has_terminal__.m,
scripts/plot/util/private/__gnuplot_open_stream__.m,
scripts/plot/util/private/__gnuplot_print__.m,
scripts/plot/util/private/__gnuplot_version__.m,
scripts/plot/util/private/__go_draw_axes__.m,
scripts/plot/util/private/__go_draw_figure__.m,
scripts/plot/util/private/__print_parse_opts__.m,
scripts/plot/util/private/__tight_eps_bbox__.m, scripts/plot/util/refresh.m,
scripts/plot/util/refreshdata.m, scripts/plot/util/saveas.m,
scripts/plot/util/shg.m, scripts/plot/util/struct2hdl.m,
scripts/plot/util/subplot.m: Moved from plot to subdir util.
* etc/HACKING: Updated directory structure info.
* scripts/Makefile.am, scripts/plot/appearance/module.mk,
scripts/plot/draw/module.mk, scripts/plot/util/module.mk:
Added new directories to build system.
author | Rik <rik@octave.org> |
---|---|
date | Fri, 04 Oct 2013 17:09:08 -0700 |
parents | scripts/plot/surfl.m@326af26556ea |
children | d63878346099 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/scripts/plot/draw/surfl.m Fri Oct 04 17:09:08 2013 -0700 @@ -0,0 +1,213 @@ +## Copyright (C) 2009-2012 Kai Habel +## +## This file is part of Octave. +## +## Octave is free software; you can redistribute it and/or modify it +## under the terms of the GNU General Public License as published by +## the Free Software Foundation; either version 3 of the License, or (at +## your option) any later version. +## +## Octave is distributed in the hope that it will be useful, but +## WITHOUT ANY WARRANTY; without even the implied warranty of +## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +## General Public License for more details. +## +## You should have received a copy of the GNU General Public License +## along with Octave; see the file COPYING. If not, see +## <http://www.gnu.org/licenses/>. + +## -*- texinfo -*- +## @deftypefn {Function File} {} surfl (@var{z}) +## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}) +## @deftypefnx {Function File} {} surfl (@dots{}, @var{lsrc}) +## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{lsrc}, @var{P}) +## @deftypefnx {Function File} {} surfl (@dots{}, "cdata") +## @deftypefnx {Function File} {} surfl (@dots{}, "light") +## @deftypefnx {Function File} {} surfl (@var{hax}, @dots{}) +## @deftypefnx {Function File} {@var{h} =} surfl (@dots{}) +## +## Plot a 3-D surface using shading based on various lighting models. +## +## The surface mesh is plotted using shaded rectangles. The vertices of the +## rectangles [@var{x}, @var{y}] are typically the output of @code{meshgrid}. +## over a 2-D rectangular region in the x-y plane. @var{z} determines the +## height above the plane of each vertex. If only a single @var{z} matrix is +## given, then it is plotted over the meshgrid +## @code{@var{x} = 1:columns (@var{z}), @var{y} = 1:rows (@var{z})}. +## Thus, columns of @var{z} correspond to different @var{x} values and rows +## of @var{z} correspond to different @var{y} values. +## +## The default lighting mode @qcode{"cdata"}, changes the cdata property of the +## surface object to give the impression of a lighted surface. +## @strong{Warning:} The alternative mode @qcode{"light"} mode which creates a +## light object to illuminate the surface is not implemented (yet). +## +## The light source location can be specified using @var{lsrc}. It can be given +## as a 2-element vector [azimuth, elevation] in degrees, or as a 3-element +## vector [lx, ly, lz]. The default value is rotated 45 degrees +## counterclockwise to the current view. +## +## The material properties of the surface can specified using a 4-element +## vector @var{P} = [@var{AM} @var{D} @var{SP} @var{exp}] which defaults to +## @var{p} = [0.55 0.6 0.4 10]. +## +## @table @asis +## @item @qcode{"AM"} strength of ambient light +## +## @item @qcode{"D"} strength of diffuse reflection +## +## @item @qcode{"SP"} strength of specular reflection +## +## @item @qcode{"EXP"} specular exponent +## @end table +## +## If the first argument @var{hax} is an axes handle, then plot into this axis, +## rather than the current axes returned by @code{gca}. +## +## The optional return value @var{h} is a graphics handle to the created +## surface object. +## +## Example: +## +## @example +## @group +## colormap (bone (64)); +## surfl (peaks); +## shading interp; +## @end group +## @end example +## @seealso{diffuse, specular, surf, shading, colormap, caxis} +## @end deftypefn + +## Author: Kai Habel <kai.habel@gmx.de> + +function h = surfl (varargin) + + [hax, varargin, nargin] = __plt_get_axis_arg__ ("surfl", varargin{:}); + + if (nargin == 0) + print_usage (); + endif + + ## Check for lighting type. + use_cdata = true; + if (ischar (varargin{end})) + switch (tolower (varargin{end})) + case "light" + warning ("surfl: light method not supported (yet), using cdata method instead"); + ## This can be implemented when light objects are supported. + use_cdata = false; + case "cdata" + use_cdata = true; + otherwise + error ("surfl: unknown lighting method"); + endswitch + varargin(end) = []; + endif + + ## Check for reflection properties argument. + ## + ## r = [ambient light strength, + ## diffuse reflection strength, + ## specular reflection strength, + ## specular shine] + if (isnumeric (varargin{end}) && length (varargin{end}) == 4) + r = varargin{end}; + varargin(end) = []; + else + ## Default values. + r = [0.55, 0.6, 0.4, 10]; + endif + + ## Check for light vector (lv) argument. + have_lv = false; + if (isnumeric (varargin{end})) + len = numel (varargin{end}); + lastarg = varargin{end}; + if (len == 3) + lv = lastarg; + varargin(end) = []; + have_lv = true; + elseif (len == 2) + [lv(1), lv(2), lv(3)] = sph2cart ((lastarg(1) - 90) * pi/180, + lastarg(2) * pi/180, + 1.0); + varargin(end) = []; + have_lv = true; + endif + endif + + oldfig = []; + if (! isempty (hax)) + oldfig = get (0, "currentfigure"); + endif + unwind_protect + hax = newplot (hax); + + htmp = surface (varargin{:}); + if (! ishold (hax)) + set (hax, "view", [-37.5, 30], + "xgrid", "on", "ygrid", "on", "zgrid", "on", "clim", [0 1]); + endif + + ## Get view vector (vv). + [az, el] = view (); + vv = sph2cart ((az - 90) * pi/180.0, el * pi/180.0, 1.0); + + if (! have_lv) + ## Calculate light vector (lv) from view vector. + phi = pi / 4; # 45 degrees + R = [cos(phi), -sin(phi), 0; + sin(phi), cos(phi), 0; + 0, 0, 1]; + lv = (R * vv.').'; + endif + + vn = get (htmp, "vertexnormals"); + dar = get (hax, "plotboxaspectratio"); + vn(:,:,1) *= dar(1); + vn(:,:,2) *= dar(2); + vn(:,:,3) *= dar(3); + + ## Normalize vn. + vn ./= repmat (sqrt (sumsq (vn, 3)), [1, 1, 3]); + [nr, nc] = size (get (htmp, "zdata")); + + ## Ambient, diffuse, and specular term. + cdata = ( r(1) * ones (nr, nc) + + r(2) * diffuse (vn(:,:,1), vn(:,:,2), vn(:,:,3), lv) + + r(3) * specular (vn(:,:,1), vn(:,:,2), vn(:,:,3), lv, vv, r(4))); + cdata ./= sum (r(1:3)); + + set (htmp, "cdata", cdata); + + unwind_protect_cleanup + if (! isempty (oldfig)) + set (0, "currentfigure", oldfig); + endif + end_unwind_protect + + if (nargout > 0) + h = htmp; + endif + +endfunction + + +%!demo +%! clf; +%! [X,Y,Z] = sombrero (); +%! colormap (copper (64)); +%! surfl (X,Y,Z); +%! shading interp; +%! title ('surfl() with defaults'); + +%!demo +%! clf; +%! [X,Y,Z] = sombrero (); +%! colormap (copper (64)); +%! [az, el] = view (); +%! surfl (X,Y,Z, [az+225,el], [0.2 0.6 0.4 25]); +%! shading interp; +%! title ('surfl() with lighting vector and material properties'); +