Mercurial > octave
view scripts/plot/surfl.m @ 17122:eaab03308c0b
doc: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
* doc/interpreter/plot.txi: Add @findex entries that were in xlim.m
* scripts/miscellaneous/getappdata.m scripts/miscellaneous/setappdata.m,
scripts/plot/allchild.m, scripts/plot/ancestor.m, scripts/plot/area.m,
scripts/plot/axes.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/closereq.m, scripts/plot/colorbar.m,
scripts/plot/comet.m, scripts/plot/comet3.m, scripts/plot/compass.m,
scripts/plot/contour.m, scripts/plot/contour3.m, scripts/plot/contourc.m,
scripts/plot/contourf.m, scripts/plot/copyobj.m, scripts/plot/cylinder.m,
scripts/plot/daspect.m, scripts/plot/diffuse.m, scripts/plot/ellipsoid.m,
scripts/plot/errorbar.m, scripts/plot/ezcontour.m, scripts/plot/ezcontourf.m,
scripts/plot/ezmesh.m, scripts/plot/ezmeshc.m, scripts/plot/ezplot.m,
scripts/plot/ezplot3.m, scripts/plot/ezpolar.m, scripts/plot/ezsurf.m,
scripts/plot/ezsurfc.m, scripts/plot/feather.m, scripts/plot/figure.m,
scripts/plot/fill.m, scripts/plot/findall.m, scripts/plot/findobj.m,
scripts/plot/fplot.m, scripts/plot/gca.m, scripts/plot/gcbf.m,
scripts/plot/gcbo.m, scripts/plot/gcf.m, scripts/plot/gco.m,
scripts/plot/ginput.m, scripts/plot/graphics_toolkit.m, scripts/plot/grid.m,
scripts/plot/gtext.m, scripts/plot/guidata.m, scripts/plot/guihandles.m,
scripts/plot/hdl2struct.m, scripts/plot/hggroup.m, scripts/plot/hidden.m,
scripts/plot/hist.m, scripts/plot/hold.m, scripts/plot/ishghandle.m,
scripts/plot/ishold.m, scripts/plot/isocolors.m, scripts/plot/isprop.m,
scripts/plot/legend.m, scripts/plot/line.m, scripts/plot/linkprop.m,
scripts/plot/loglog.m, scripts/plot/loglogerr.m, scripts/plot/mesh.m,
scripts/plot/meshc.m, scripts/plot/meshgrid.m, scripts/plot/meshz.m,
scripts/plot/newplot.m, scripts/plot/orient.m, scripts/plot/pareto.m,
scripts/plot/patch.m, scripts/plot/pcolor.m, scripts/plot/peaks.m,
scripts/plot/pie.m, scripts/plot/pie3.m, scripts/plot/plot.m,
scripts/plot/plot3.m, scripts/plot/plotmatrix.m, scripts/plot/plotyy.m,
scripts/plot/polar.m, scripts/plot/print.m, scripts/plot/quiver.m,
scripts/plot/quiver3.m, scripts/plot/rectangle.m, scripts/plot/refresh.m,
scripts/plot/refreshdata.m, scripts/plot/ribbon.m, scripts/plot/rose.m,
scripts/plot/saveas.m, scripts/plot/scatter.m, scripts/plot/scatter3.m,
scripts/plot/semilogx.m, scripts/plot/semilogxerr.m, scripts/plot/semilogy.m,
scripts/plot/semilogyerr.m, scripts/plot/shading.m, scripts/plot/shg.m,
scripts/plot/shrinkfaces.m, scripts/plot/slice.m, scripts/plot/specular.m,
scripts/plot/sphere.m, scripts/plot/stairs.m, scripts/plot/stem.m,
scripts/plot/stem3.m, scripts/plot/struct2hdl.m, scripts/plot/subplot.m,
scripts/plot/surf.m, scripts/plot/surface.m, scripts/plot/surfc.m,
scripts/plot/surfl.m, scripts/plot/tetramesh.m, scripts/plot/text.m,
scripts/plot/title.m, scripts/plot/trimesh.m, scripts/plot/triplot.m,
scripts/plot/trisurf.m, scripts/plot/view.m, scripts/plot/waitbar.m,
scripts/plot/waitforbuttonpress.m, scripts/plot/waterfall.m,
scripts/plot/whitebg.m, scripts/plot/xlabel.m, scripts/plot/xlim.m,
scripts/plot/ylabel.m, scripts/plot/ylim.m, scripts/plot/zlabel.m,
scripts/plot/zlim.m: Rewrite docstrings for most plot functions.
Emphasize clarity, use common "voice", and increase density of seealso links.
author | Rik <rik@octave.org> |
---|---|
date | Wed, 31 Jul 2013 13:53:30 -0700 |
parents | 1118d566bcd4 |
children | fd9a8b1a8768 |
line wrap: on
line source
## 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{x}, @var{y}, @var{z}) ## @deftypefnx {Function File} {} surfl (@var{z}) ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}) ## @deftypefnx {Function File} {} surfl (@var{x}, @var{y}, @var{z}, @var{L}, @var{P}) ## @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 "cdata", changes the cdata property of the ## surface object to give the impression of a lighted surface. ## @strong{Warning:} The alternative mode "light" mode which creates a light ## object to illuminate the surface is not implemented (yet). ## ## The light source location can be specified using @var{L}. 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 "AM" strength of ambient light ## ## @item "D" strength of diffuse reflection ## ## @item "SP" strength of specular reflection ## ## @item "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 retval = surfl (varargin) [hax, varargin] = __plt_get_axis_arg__ ("surfl", varargin{:}); oldfig = ifelse (isempty (hax), [], get (0, "currentfigure")); unwind_protect hax = newplot (hax); ## Check for lighting type. use_cdata = true; if (ischar (varargin{end})) lstr = tolower (varargin{end}); if (strncmp (lstr, "light", 5)) warning ("light method not supported (yet), using cdata method instead"); ## This can be implemented when light objects are supported. use_cdata = false; elseif (strncmp (lstr, "cdata", 5)) use_cdata = true; else error ("surfl: unknown lighting method"); endif varargin(end) = []; endif ## Check for reflection properties argument. ## ## r = [ambient light strength, ## diffuse reflection strength, ## specular reflection strength, ## specular shine] if (length (varargin{end}) == 4 && isnumeric (varargin{end})) 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 htmp = surface ([varargin, "parent", hax]{:}); if (! ishold (hax)) set (hax, "view", [-37.5, 30], "xgrid", "on", "ygrid", "on", "zgrid", "on", "clim", [0 1]); endif ## Get view vector (vv). a = axis; [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 = 45.0 / 180.0 * pi; 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 = 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))); set (htmp, "cdata", cdata ./ sum (r(1:3))); unwind_protect_cleanup if (! isempty (oldfig)) set (0, "currentfigure", oldfig); endif end_unwind_protect if (nargout > 0) retval = htmp; endif endfunction %!demo %! clf; %! [X,Y,Z] = sombrero (); %! colormap (copper (64)); %! surfl (X,Y,Z); %! shading interp; %!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;