File: view.m

package info (click to toggle)
octave 10.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 660; xml: 192
file content (219 lines) | stat: -rw-r--r-- 6,047 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
########################################################################
##
## Copyright (C) 2007-2025 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  {} {} view (@var{azimuth}, @var{elevation})
## @deftypefnx {} {} view ([@var{azimuth} @var{elevation}])
## @deftypefnx {} {} view ([@var{x} @var{y} @var{z}])
## @deftypefnx {} {} view (2)
## @deftypefnx {} {} view (3)
## @deftypefnx {} {} view (@var{hax}, @dots{})
## @deftypefnx {} {[@var{azimuth}, @var{elevation}] =} view ()
## Query or set the viewpoint for the current axes.
##
## The parameters @var{azimuth} and @var{elevation} can be given as two
## arguments or as 2-element vector.  The viewpoint can also be specified with
## Cartesian coordinates @var{x}, @var{y}, and @var{z}.
##
## The call @code{view (2)} sets the viewpoint to
## @w{@var{azimuth} = 0}@ and @w{@var{elevation} = 90}, which is the default
## for 2-D graphs.
##
## The call @code{view (3)} sets the viewpoint to
## @w{@var{azimuth} = -37.5}@ and @w{@var{elevation} = 30}, which is the
## default for 3-D graphs.
##
## If the first argument @var{hax} is an axes handle, then operate on
## this axes rather than the current axes returned by @code{gca}.
##
## If no inputs are given, return the current @var{azimuth} and
## @var{elevation}.
## @end deftypefn

function [azimuth, elevation] = view (varargin)

  [hax, varargin, nargin] = __plt_get_axis_arg__ ("view", varargin{:});

  if (nargin > 2)
    print_usage ();
  endif

  if (nargout > 0 && nargin > 0)
    error ("view: cannot simultaneously get and set viewpoint");
  endif

  if (isempty (hax))
    hax = gca ();
  endif

  if (nargin == 0)
    vw = get (hax, "view");
    az = vw(1);
    el = vw(2);
  elseif (numel (varargin) == 1)
    x = varargin{1};
    if (numel (x) == 2)
      az = x(1);
      el = x(2);
    elseif (numel (x) == 3)
      if (x(2) == 0)
        ## special case for negative 0
        [az, el] = cart2sph (x(2), x(1), x(3));

        if (x(1) == 0)
          ## Matlab Compatibility: Force +0 azimuth instead of +/-0 or
          ## +/-180deg azimuth for z-aligned vector.
          az = 0;
        endif

      else
        [az, el] = cart2sph (-x(2), x(1), x(3));
      endif
      az *= 180/pi;
      el *= 180/pi;
    elseif (x == 2)
      az = 0;
      el = 90;
    elseif (x == 3)
      az = -37.5;
      el = 30;
    else
      print_usage ();
    endif
  elseif (numel (varargin) == 2)
    az = varargin{1};
    el = varargin{2};
  endif

  if (nargin > 0)
    set (hax, "view", [az, el]);
  else
    if (nargout == 1)
      azimuth = [az, el];
    elseif (nargout == 2)
      azimuth = az;
      elevation = el;
    endif
  endif

endfunction


%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   plot3 ([0,1], [0,1], [0,1]);
%!   [az, el] = view ();
%!   assert ([az, el], [-37.5, 30], eps);
%!   view (2);
%!   [az, el] = view ();
%!   assert ([az, el], [0, 90], eps);
%!   view ([1 1 0]);
%!   [az, el] = view ();
%!   assert ([az, el], [135, 0], eps);
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!test
%! hf = figure ("visible", "off");
%! unwind_protect
%!   line ();
%!   [az, el] = view ();
%!   assert ([az, el], [0, 90], eps);
%!   view (3);
%!   [az, el] = view ();
%!   assert ([az, el], [-37.5, 30], eps);
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!test <*57800>
%! hf = figure ("visible", "off");
%! unwind_protect
%!   plot3 ([0,1], [0,1], [0,1]);
%!   view ([0, 0, 1]);
%!   [az, el] = view ();
%!   assert ([az, el], [0, 90], eps);
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!test <*65641>
%! hf = figure ("visible", "off");
%! unwind_protect
%!   plot3 ([0,1], [0,1], [0,1]);
%!   view ([1, 0, 0]);
%!   [az, el] = view ();
%!   assert ([az, el], [90, 0], eps);
%!   view ([-1, 0, 0]);
%!   [az, el] = view ();
%!   assert ([az, el], [-90, 0], eps);
%!   view ([0, 1, 0]);
%!   [az, el] = view ();
%!   assert ([az, el], [180, 0], eps);
%!   view ([0, -1, 0]);
%!   [az, el] = view ();
%!   assert ([az, el], [0, 0], eps);
%!   view ([0, 0, 1]);
%!   [az, el] = view ();
%!   assert ([az, el], [0, 90], eps);
%!   view ([0, 0, -1]);
%!   [az, el] = view ();
%!   assert ([az, el], [0, -90], eps);
%!   view ([1, 0.001, 0]);
%!   [az, el] = view ();
%!   assert ([az, el], [90 + 0.001*180/pi, 0], eps ("single"));
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect

%!test <*65641> # Verify compatible z-vector viewpoint.
%! hf = figure ("visible", "off");
%! unwind_protect
%!   ml_out = [0, 90, Inf] .* ones (8, 1);
%!   ml_out(1:2:end-1, 2) = -90;
%!   output = NaN (8, 3);
%!   plot3 ([0,1], [0,1], [0,1]);
%!   idx = 1;
%!   for x1 = [-0, 0]
%!     for x2 = [-0, 0]
%!       for x3 = [-1, 1]
%!         view ([x1, x2, x3]);
%!         [az, el] = view ();
%!         output(idx, :) = [az, el, 1/az];
%!         idx++;
%!       endfor
%!     endfor
%!   endfor
%!   assert (isequaln (output, ml_out));
%! unwind_protect_cleanup
%!   close (hf);
%! end_unwind_protect


## Test input validation
%!error <Invalid call> view (0, 0, 1)
%!error <cannot simultaneously get and set> [a, b] = view ([1, 1, 1])