Mercurial > hg > octave-nkf

comparison scripts/plot/util/hdl2struct.m @ 17572:7bb76a22cde1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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/hdl2struct.m@1c89599167a6
children d63878346099
comparison
equal deleted inserted replaced
17571:6e4ea5c8a4bb 17572:7bb76a22cde1
1 ## Copyright (C) 2012 pdiribarne
2 ##
3 ## This program is free software; you can redistribute it and/or modify
4 ## it under the terms of the GNU General Public License as published by
5 ## the Free Software Foundation; either version 3 of the License, or
6 ## (at your option) any later version.
7 ##
8 ## This program is distributed in the hope that it will be useful,
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 ## GNU General Public License for more details.
12 ##
13 ## You should have received a copy of the GNU General Public License
14 ## along with Octave; see the file COPYING. If not, see
15 ## <http://www.gnu.org/licenses/>.
16
17 ## -*- texinfo -*-
18 ## @deftypefn {Function File} {@var{s} =} hdl2struct (@var{h})
19 ## Return a structure, @var{s}, whose fields describe the properties
20 ## of the object, and its children, associated with the handle, @var{h}.
21 ##
22 ## The fields of the structure @var{s} are @qcode{"type"}, @qcode{"handle"},
23 ## @qcode{"properties"}, @qcode{"children"}, and @qcode{"special"}.
24 ## @seealso{struct2hdl, findobj}
25 ## @end deftypefn
26
27 ## Author: pdiribarne <pdiribarne@new-host.home>
28 ## Created: 2012-03-04
29
30 function s = hdl2struct (h)
31
32 if (nargin != 1 || !ishandle (h))
33 print_usage ();
34 endif
35
36 hiddenh = get (0, "showhiddenhandles");
37 if (strcmp (hiddenh, "on"))
38 set (0, "showhiddenhandles", "off");
39 endif
40
41 ## main object
42 main = get (h);
43 s.handle = h;
44 s.type = main.type;
45 s.properties = getprops (h);
46 s.children = [];
47 s.special = [];
48
49 ## sweep all children but legends, colorbars, uimenu and hggroup children
50 ## in reverse order
51 kids = main.children;
52 lg = findobj (h, "-depth", 1, "tag", "legend");
53 cb = findobj (h, "-depth", 1, "tag", "colorbar");
54 ui = findobj (h, "-depth", 1, "type", "uimenu");
55 nkids = length (kids);
56 ii = 0;
57 while (nkids)
58 if (! any (kids (nkids) == lg) && ! any (kids (nkids) == cb)
59 && ! any (kids (nkids) == ui) && ! strcmp (main.type, "hggroup"))
60 ii++;
61 s.children(ii) = hdl2struct (kids(nkids));
62 endif
63 nkids--;
64 endwhile
65
66 ## add non "children" children objects (title, xlabel, ...) and
67 ## hggroup children and tag theim in "special"
68 special = [];
69 if (strcmp (main.type, "hggroup"))
70 special = main.children;
71 endif
72 special = [special getspecial(h)];
73 nsp = length (special);
74 while (nsp)
75 ii++;
76 s.children(ii) = hdl2struct (special(nsp));
77 s.special(nsp) = ii;
78 nsp--;
79 endwhile
80
81 ## look for legends and colorbars among "main"'s brothers and add them
82 ## to the children list
83 if (strcmp (main.type, "axes"))
84 par = main.parent;
85 lg = findobj (par, "-depth", 1, "tag", "legend");
86 if (! isempty (lg))
87 idx = arrayfun (@(x) get(x).userdata.handle(end) == h, lg);
88 lg = lg(find (idx));
89 endif
90 nlg = length (lg);
91 if (nlg == 1)
92 ii++;
93 s.children(ii) = hdl2struct (lg);
94 elseif (nlg > 1)
95 error ("hdl2struct: more than one legend found");
96 endif
97
98 cb = findobj (par, "-depth", 1, "tag", "colorbar");
99 if (! isempty (cb))
100 idx = arrayfun (@(x) get(x).axes == h, cb);
101 cb = cb(find (idx));
102 endif
103
104 ncb = length (cb);
105 if (ncb == 1)
106 ii++;
107 s.children(ii) = hdl2struct (cb);
108 elseif (nlg > 1)
109 error ("hdl2struct: more than one colorbar found");
110 endif
111 endif
112
113 set (0, "showhiddenhandles", hiddenh);
114
115 endfunction
116
117 function hdlist = getspecial (h)
118 obj = get (h);
119 ## return handles to special children
120 fields = fieldnames (obj);
121 hdlist = [];
122
123 regkids = get ( h, "children");
124 set (0, "showhiddenhandles", "on");
125 allkids = get ( h, "children");
126 set (0, "showhiddenhandles", "off");
127 speckids = arrayfun (@(x) ! any (x == regkids), allkids);
128 hdlist = allkids (find (speckids));
129 hdlist = reshape (hdlist, 1, numel (hdlist));
130
131 endfunction
132
133 function prpstr = getprops (h)
134 obj = get (h);
135 ## get usefull properties rejecting readonly, children, handles ...
136 fields = fieldnames (obj);
137 hdlist = [];
138
139 forbid = {"beingdeleted", "busyaction", "buttondownfcn", ...
140 "children", "clipping", "createfcn", ...
141 "deletefcn", "handlevisibility", "hittest", ...
142 "interruptible", "parent", "selected" ,...
143 "selectionhighlight", "type", "__modified__", ...
144 "uicontextmenu", "__graphics_toolkit__", "currentaxes", ...
145 "currentcharacter", "currentobject","tightinset", ...
146 "currentpoint", "extent"};
147
148 nflds = length (fields);
149 ii = 0;
150 while (nflds)
151 prop = fields{nflds};
152 val = obj.(fields{nflds});
153 ii++;
154 if (! any (strcmp (prop, forbid)))
155 prpstr.(prop) = val;
156 endif
157 nflds--;
158 endwhile
159
160 ## hidden properties
161 hidden = {"autopos_tag", "looseinset"};
162 for ii = 1:numel (hidden)
163 if (isprop (h, hidden{ii}))
164 prpstr.(hidden{ii}) = get (h, hidden{ii});
165 endif
166 endfor
167
168 endfunction
169
170
171 ## FIXME: need validation tests
172