Mercurial > octave
view scripts/plot/appearance/camroll.m @ 30875:5d3faba0342e
doc: Ensure documentation lists output argument when it exists for all m-files.
For new users of Octave it is best to show explicit calling forms
in the documentation and to show a return argument when it exists.
* bp-table.cc, shift.m, accumarray.m, accumdim.m, bincoeff.m, bitcmp.m,
bitget.m, bitset.m, blkdiag.m, celldisp.m, cplxpair.m, dblquad.m, flip.m,
fliplr.m, flipud.m, idivide.m, int2str.m, interpft.m, logspace.m, num2str.m,
polyarea.m, postpad.m, prepad.m, randi.m, repmat.m, rng.m, rot90.m, rotdim.m,
structfun.m, triplequad.m, uibuttongroup.m, uicontrol.m, uipanel.m,
uipushtool.m, uitoggletool.m, uitoolbar.m, waitforbuttonpress.m, help.m,
__additional_help_message__.m, hsv.m, im2double.m, im2frame.m, javachk.m,
usejava.m, argnames.m, char.m, formula.m, inline.m, __vectorize__.m, findstr.m,
flipdim.m, strmatch.m, vectorize.m, commutation_matrix.m, cond.m, cross.m,
duplication_matrix.m, expm.m, orth.m, rank.m, rref.m, trace.m, vech.m, cast.m,
compare_versions.m, delete.m, dir.m, fileattrib.m, grabcode.m, gunzip.m,
inputname.m, license.m, list_primes.m, ls.m, mexext.m, movefile.m,
namelengthmax.m, nargoutchk.m, nthargout.m, substruct.m, swapbytes.m, ver.m,
verLessThan.m, what.m, fminunc.m, fsolve.m, fzero.m, optimget.m, __fdjac__.m,
matlabroot.m, savepath.m, campos.m, camroll.m, camtarget.m, camup.m, camva.m,
camzoom.m, clabel.m, diffuse.m, legend.m, orient.m, rticks.m, specular.m,
thetaticks.m, xlim.m, xtickangle.m, xticklabels.m, xticks.m, ylim.m,
ytickangle.m, yticklabels.m, yticks.m, zlim.m, ztickangle.m, zticklabels.m,
zticks.m, ellipsoid.m, isocolors.m, isonormals.m, stairs.m, surfnorm.m,
__actual_axis_position__.m, __pltopt__.m, close.m, graphics_toolkit.m, pan.m,
print.m, printd.m, __ghostscript__.m, __gnuplot_print__.m, __opengl_print__.m,
rotate3d.m, subplot.m, zoom.m, compan.m, conv.m, poly.m, polyaffine.m,
polyder.m, polyint.m, polyout.m, polyreduce.m, polyvalm.m, roots.m, prefdir.m,
prefsfile.m, profexplore.m, profexport.m, profshow.m, powerset.m, unique.m,
arch_rnd.m, arma_rnd.m, autoreg_matrix.m, bartlett.m, blackman.m, detrend.m,
durbinlevinson.m, fftconv.m, fftfilt.m, fftshift.m, fractdiff.m, hamming.m,
hanning.m, hurst.m, ifftshift.m, rectangle_lw.m, rectangle_sw.m, triangle_lw.m,
sinc.m, sinetone.m, sinewave.m, spectral_adf.m, spectral_xdf.m, spencer.m,
ilu.m, __sprand__.m, sprand.m, sprandn.m, sprandsym.m, treelayout.m, beta.m,
betainc.m, betaincinv.m, betaln.m, cosint.m, expint.m, factorial.m, gammainc.m,
gammaincinv.m, lcm.m, nthroot.m, perms.m, reallog.m, realpow.m, realsqrt.m,
sinint.m, hadamard.m, hankel.m, hilb.m, invhilb.m, magic.m, pascal.m, rosser.m,
toeplitz.m, vander.m, wilkinson.m, center.m, corr.m, cov.m, discrete_cdf.m,
discrete_inv.m, discrete_pdf.m, discrete_rnd.m, empirical_cdf.m,
empirical_inv.m, empirical_pdf.m, empirical_rnd.m, kendall.m, kurtosis.m,
mad.m, mean.m, meansq.m, median.m, mode.m, moment.m, range.m, ranks.m,
run_count.m, skewness.m, spearman.m, statistics.m, std.m, base2dec.m,
bin2dec.m, blanks.m, cstrcat.m, deblank.m, dec2base.m, dec2bin.m, dec2hex.m,
hex2dec.m, index.m, regexptranslate.m, rindex.m, strcat.m, strjust.m,
strtrim.m, strtrunc.m, substr.m, untabify.m, __have_feature__.m,
__prog_output_assert__.m, __run_test_suite__.m, example.m, fail.m, asctime.m,
calendar.m, ctime.m, date.m, etime.m:
Add return arguments to @deftypefn macros where they were missing. Rename
variables in functions (particularly generic "retval") to match documentation.
Rename some return variables for (hopefully) better clarity (e.g., 'ax' to 'hax'
to indicate it is a graphics handle to an axes object).
author | Rik <rik@octave.org> |
---|---|
date | Wed, 30 Mar 2022 20:40:27 -0700 |
parents | 796f54d4ddbf |
children | 597f3ee61a48 |
line wrap: on
line source
######################################################################## ## ## Copyright (C) 2016-2022 The Octave Project Developers ## ## See the file COPYRIGHT.md in the top-level directory of this ## distribution or <https://octave.org/copyright/>. ## ## 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 ## <https://www.gnu.org/licenses/>. ## ######################################################################## ## -*- texinfo -*- ## @deftypefn {} {} camroll (@var{theta}) ## @deftypefnx {} {} camroll (@var{hax}, @var{theta}) ## Roll the camera. ## ## Roll the camera clockwise by @var{theta} degrees. ## For example, the following command will roll the camera by ## 30 degrees clockwise (to the right); this will cause the scene ## to appear to roll by 30 degrees to the left: ## ## @example ## @group ## @c doctest: +SKIP ## peaks () ## camroll (30) ## @end group ## @end example ## ## Roll the camera back: ## ## @example ## @group ## @c doctest: +SKIP ## camroll (-30) ## @end group ## @end example ## ## The following command restores the default camera roll: ## ## @example ## @group ## @c doctest: +SKIP ## camup ("auto") ## @end group ## @end example ## ## By default, these commands affect the current axis; alternatively, an axis ## can be specified by the optional argument @var{hax}. ## ## @seealso{camzoom, camorbit, camlookat, camup} ## @end deftypefn function camroll (varargin) [hax, varargin, nargin] = __plt_get_axis_arg__ ("camroll", varargin{:}); if (nargin != 1) print_usage (); endif a = varargin{1}; if (! (isnumeric (a) && isscalar (a) )) print_usage (); endif if (isempty (hax)) hax = gca (); else hax = hax(1); endif dar = get (hax, "dataaspectratio"); view_ax = (camtarget (hax) - campos (hax)) ./ dar; view_ax /= norm (view_ax); ## orthogonalize the camup vector up = camup (hax) ./ dar; up = up - view_ax * dot (up, view_ax); up /= norm (up); ## rotate the modified camup vector around the view axis up = num2cell (up); [up{:}] = __rotate_around_axis__ (up{:}, a, view_ax, [0 0 0]); up = [up{:}] .* dar; camup (hax, up / norm (up)) endfunction %!demo %! clf; %! peaks (); %! camroll (30); %! title ("camroll() demo #1"); %!test %! hf = figure ("visible", "off"); %! unwind_protect %! sphere (10); %! campos ([10 0 0]); %! camroll (30); %! p = camup (); %! assert (p, [0 1/2 sqrt(3)/2], eps); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## test rolling, then rolling back %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hax = axes ("parent", hf); %! peaks (); %! p = camup (hax); %! assert (p, [0 0 1], eps); %! camroll (hax, 30); %! p = camup (hax); %! ## from Matlab R2017b %! q = [0.33969638129660373 0.02014238382998192 0.94031944194919104]; %! assert (p, q, 10*eps); %! camroll (hax, -30); %! ## Note: It does not go back to [0 0 1]: instead orthog to camera view: %! p = camup (hax); %! ## The "cameraupvector" is now perpendicular to the viewing vector %! dar = get (hax, "dataaspectratio"); %! ## FIXME: looser tolerance needed on i386 for assert below %! assert (dot (p./dar, (camtarget (hax) - campos (hax))./dar), 0, 32*eps); %! ## from Matlab R2017b %! q = [0.14033891839365262 0.18289323924769943 0.97306477226420207]; %! assert (p, q, 10*eps); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## test hax input by creating another axis %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hax1 = subplot (1, 2, 1); %! sphere (hax1); %! hax2 = subplot (1, 2, 2); %! sphere (hax2); %! camroll (hax1, 30); %! x = camup (hax1); %! y = camup (hax2); %! ## from Matlab R2016a %! assert (x, [0.66027810132845211 0.03915135893036471 0.75000000000000022], %! -1e-5); %! assert (y, [0 0 1]); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect ## Test input validation %!error <Invalid call> camroll (1, 2, 3) %!error <Invalid call> camroll ("mod") %!error <Invalid call> camroll (1, [1 2])