Mercurial > octave-nkf
comparison scripts/plot/draw/tetramesh.m @ 20208:777f26aa8e3e stable
doc: Update more docstrings to have one sentence summary as first line.
Reviewed plot/ and gui/ in scripts directory.
* scripts/gui/errordlg.m, scripts/gui/helpdlg.m, scripts/gui/inputdlg.m,
scripts/gui/listdlg.m, scripts/gui/msgbox.m,
scripts/gui/private/__get_funcname__.m,
scripts/gui/private/__uiobject_split_args__.m, scripts/gui/questdlg.m,
scripts/gui/uigetdir.m, scripts/gui/uigetfile.m, scripts/gui/uiwait.m,
scripts/gui/waitbar.m, scripts/gui/warndlg.m,
scripts/plot/appearance/annotation.m, scripts/plot/appearance/axis.m,
scripts/plot/appearance/box.m, scripts/plot/appearance/caxis.m,
scripts/plot/appearance/datetick.m, scripts/plot/appearance/hidden.m,
scripts/plot/appearance/legend.m, scripts/plot/appearance/xlim.m,
scripts/plot/appearance/ylim.m, scripts/plot/appearance/zlim.m,
scripts/plot/draw/area.m, scripts/plot/draw/comet.m,
scripts/plot/draw/comet3.m, scripts/plot/draw/contour.m,
scripts/plot/draw/contourf.m, scripts/plot/draw/isocolors.m,
scripts/plot/draw/isonormals.m, scripts/plot/draw/isosurface.m,
scripts/plot/draw/plotmatrix.m, scripts/plot/draw/quiver.m,
scripts/plot/draw/quiver3.m, scripts/plot/draw/ribbon.m,
scripts/plot/draw/semilogxerr.m, scripts/plot/draw/semilogyerr.m,
scripts/plot/draw/sphere.m, scripts/plot/draw/surfl.m,
scripts/plot/draw/tetramesh.m, scripts/plot/util/allchild.m,
scripts/plot/util/ancestor.m, scripts/plot/util/axes.m,
scripts/plot/util/colstyle.m, scripts/plot/util/frame2im.m,
scripts/plot/util/gnuplot_binary.in, scripts/plot/util/hgsave.m,
scripts/plot/util/im2frame.m, scripts/plot/util/isaxes.m,
scripts/plot/util/isfigure.m, scripts/plot/util/linkaxes.m,
scripts/plot/util/ndgrid.m, scripts/plot/util/pan.m, scripts/plot/util/print.m,
scripts/plot/util/printd.m, scripts/plot/util/private/__add_default_menu__.m,
scripts/plot/util/rotate.m, scripts/plot/util/rotate3d.m,
scripts/plot/util/saveas.m, scripts/plot/util/struct2hdl.m,
scripts/plot/util/subplot.m, scripts/plot/util/zoom.m:
Update more docstrings to have one sentence summary as first line.
author | Rik <rik@octave.org> |
---|---|
date | Sat, 09 May 2015 22:50:09 -0700 |
parents | 4197fc428c7d |
children |
comparison
equal
deleted
inserted
replaced
20207:4f45eaf83908 | 20208:777f26aa8e3e |
---|---|
21 ## @deftypefnx {Function File} {} tetramesh (@var{T}, @var{X}, @var{C}) | 21 ## @deftypefnx {Function File} {} tetramesh (@var{T}, @var{X}, @var{C}) |
22 ## @deftypefnx {Function File} {} tetramesh (@dots{}, @var{property}, @var{val}, @dots{}) | 22 ## @deftypefnx {Function File} {} tetramesh (@dots{}, @var{property}, @var{val}, @dots{}) |
23 ## @deftypefnx {Function File} {@var{h} =} tetramesh (@dots{}) | 23 ## @deftypefnx {Function File} {@var{h} =} tetramesh (@dots{}) |
24 ## Display the tetrahedrons defined in the m-by-4 matrix @var{T} as 3-D patches. | 24 ## Display the tetrahedrons defined in the m-by-4 matrix @var{T} as 3-D patches. |
25 ## | 25 ## |
26 ## @var{T} is typically the output of a Delaunay triangulation | 26 ## @var{T} is typically the output of a Delaunay triangulation of a 3-D set |
27 ## of a 3-D set of points. Every row of @var{T} contains four indices into | 27 ## of points. Every row of @var{T} contains four indices into the n-by-3 |
28 ## the n-by-3 matrix @var{X} of the vertices of a tetrahedron. Every row in | 28 ## matrix @var{X} of the vertices of a tetrahedron. Every row in @var{X} |
29 ## @var{X} represents one point in 3-D space. | 29 ## represents one point in 3-D space. |
30 ## | 30 ## |
31 ## The vector @var{C} specifies the color of each tetrahedron as an index | 31 ## The vector @var{C} specifies the color of each tetrahedron as an index |
32 ## into the current colormap. The default value is 1:m where m is the number | 32 ## into the current colormap. The default value is 1:m where m is the number |
33 ## of tetrahedrons; the indices are scaled to map to the full range of the | 33 ## of tetrahedrons; the indices are scaled to map to the full range of the |
34 ## colormap. If there are more tetrahedrons than colors in the colormap then | 34 ## colormap. If there are more tetrahedrons than colors in the colormap then |