Mercurial > octave-nkf
view scripts/plot/util/findobj.m @ 17572:7bb76a22cde1
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/findobj.m@0ad2f93fd83c |
children | d63878346099 |
line wrap: on
line source
## Copyright (C) 2007-2012 Ben Abbott ## ## 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} {@var{h} =} findobj () ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} findobj (@var{prop_name}, @var{prop_value}, "-@var{logical_op}", @var{prop_name}, @var{prop_value}) ## @deftypefnx {Function File} {@var{h} =} findobj ("-property", @var{prop_name}) ## @deftypefnx {Function File} {@var{h} =} findobj ("-regexp", @var{prop_name}, @var{pattern}) ## @deftypefnx {Function File} {@var{h} =} findobj (@var{hlist}, @dots{}) ## @deftypefnx {Function File} {@var{h} =} findobj (@var{hlist}, "flat", @dots{}) ## @deftypefnx {Function File} {@var{h} =} findobj (@var{hlist}, "-depth", @var{d}, @dots{}) ## Find graphics object with specified property values. ## ## The simplest form is ## ## @example ## findobj (@var{prop_name}, @var{prop_value}) ## @end example ## ## @noindent ## which returns the handles of all objects which have a property named ## @var{prop_name} that has the value @var{prop_value}. If multiple ## property/value pairs are specified then only objects meeting all of the ## conditions are returned. ## ## The search can be limited to a particular set of objects and their ## descendants, by passing a handle or set of handles @var{hlist} as the first ## argument. ## ## The depth of the object hierarchy to search can be limited with the ## @qcode{"-depth"} argument. An example of searching only three generations ## of children is: ## ## @example ## findobj (@var{hlist}, "-depth", 3, @var{prop_name}, @var{prop_value}) ## @end example ## ## Specifying a depth @var{d} of 0, limits the search to the set of objects ## passed in @var{hlist}. A depth @var{d} of 0 is equivalent to the ## @qcode{"flat"} argument. ## ## A specified logical operator may be applied to the pairs of @var{prop_name} ## and @var{prop_value}. The supported logical operators are: ## @qcode{"-and"}, @qcode{"-or"}, ## @qcode{"-xor"}, @qcode{"-not"}. ## ## Objects may also be matched by comparing a regular expression to the ## property values, where property values that match ## @code{regexp (@var{prop_value}, @var{pattern})} are returned. ## ## Finally, objects may be matched by property name only by using the ## @qcode{"-property"} option. ## ## Implementation Note: The search only includes objects with visible ## handles (HandleVisibility = @qcode{"on"}). @xref{XREFfindall,,findall}, to ## search for all objects including hidden ones. ## @seealso{findall, allchild, get, set} ## @end deftypefn ## Author: Ben Abbott <bpabbott@mac.com> function h = findobj (varargin) depth = NaN; if (nargin == 0) handles = 0; n1 = 0; else if (! isempty (varargin{1})) if (ishandle (varargin{1}(1))) handles = varargin{1}; n1 = 2; else handles = 0; n1 = 1; endif else ## Return [](0x1) for compatibility. h = zeros (0, 1); return; endif if (n1 <= nargin) if (ischar (varargin{n1})) if (strcmpi (varargin{n1}, "flat")) depth = 0; n1 = n1 + 1; elseif (strcmpi (varargin{n1}, "-depth")) depth = varargin{n1+1}; n1 = n1 + 2; endif else error ("findobj: properties and options must be strings"); endif endif endif if (n1 <= nargin && nargin > 0) args = varargin(n1 : nargin); else args = {}; endif regularexpression = []; property = []; logicaloperator = {}; pname = {}; pvalue = {}; np = 1; na = 1; operatorprecedence = {"-not", "-and", "-or", "-xor"}; while (na <= numel (args)) regularexpression(np) = 0; property(np) = 0; logicaloperator{np} = "and"; if (ischar (args{na})) if (strcmpi (args{na}, "-regexp")) if (na + 2 <= numel (args)) regularexpression(np) = 1; na = na + 1; pname{np} = args{na}; na = na + 1; pvalue{np} = args{na}; na = na + 1; np = np + 1; else error ("findobj: inconsistent number of arguments"); endif elseif (strcmpi (args{na}, "-property")) if (na + 1 <= numel (args)) na = na + 1; property(np) = 1; pname{np} = args{na}; na = na + 1; pvalue{np} = []; np = np + 1; else error ("findobj: inconsistent number of arguments"); endif elseif (! strcmp (args{na}(1), "-")) ## Parameter/value pairs. if (na + 1 <= numel (args)) pname{np} = args{na}; na = na + 1; pvalue{np} = args{na}; na = na + 1; if (na <= numel (args)) if (ischar (args{na})) if (any (strcmpi (args{na}, operatorprecedence))) logicaloperator{np} = args{na}(2:end); na = na+1; endif else error ("findobj: properties and options must be strings"); endif else logicaloperator{np} = "and"; endif np = np + 1; else error ("findobj: inconsistent number of arguments"); endif else ## This is sloppy ... but works like Matlab. if (strcmpi (args{na}, "-not")) h = []; return; endif na = na + 1; endif else error ("findobj: properties and options must be strings"); endif endwhile numpairs = np - 1; if (! isempty (logicaloperator)) logicaloperator = shift (logicaloperator, 1); endif ## Load all objects which qualify for being searched. idepth = 0; h = handles; while (numel (handles) && ! (idepth >= depth)) children = []; for n = 1 : numel (handles) children = [children; get(handles(n), "children")]; endfor handles = children; h = [h; children]; idepth = idepth + 1; endwhile if (numpairs > 0) match = true (numel (h), numpairs); for nh = 1 : numel (h) p = get (h(nh)); for np = 1 : numpairs fields = fieldnames (p); fieldindex = find (strcmpi (fields, pname{np}), 1); if (numel (fieldindex)) pname{np} = fields{fieldindex}; if (property(np)) match(nh,np) = true; else if (regularexpression(np)) foo = regexp (p.(pname{np}), pvalue{np}, "once"); if (isempty (foo)) match(nh,np) = false; else match(nh,np) = foo; endif elseif (numel (p.(pname{np})) == numel (pvalue{np})) if (ischar (pvalue{np}) && ischar (p.(pname{np}))) match(nh,np) = strcmpi (pvalue{np}, p.(pname{np})); elseif (isnumeric (pvalue{np} && isnumeric (p.(pname{np})))) match(nh,np) = (pvalue{np} == p.(pname{np})); else match(nh,np) = isequal (pvalue{np}, p.(pname{np})); endif else match(nh,np) = false; endif endif else match(nh,np) = false; endif endfor endfor if (numpairs > 1) for no = 1 : numel (operatorprecedence) pairs = find (strcmp (logicaloperator(2:end), ... operatorprecedence{no}(2:end))); for np = sort (pairs, "descend") if (no == 1) match(:,np+1) = ! match(:,np+1); logicaloperator(np+1) = {"and"}; else match(:,np) = feval (logicaloperator{np+1}, match(:,np), ... match(:,np+1)); logicaloperator(np+1) = []; match(:,np+1) = []; numpairs = numpairs - 1; endif if (numpairs < 2) break; endif endfor if (numpairs < 2) break; endif endfor endif else match = true (numel (h), 1); endif h = h(match); h = h(:); endfunction %!test %! hf = figure ("visible", "off"); %! unwind_protect %! h = findobj (gca (), "-property", "foo"); %! assert (isempty (h)); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! h = plot (1:10); %! set (h, "tag", "foobar"); %! g = findobj (gcf (), "tag", "foobar", "type", "line", "color", [0 0 1]); %! assert (g, h); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! l = line; %! obj = findobj (hf, "type", "line"); %! assert (l, obj); %! assert (gca, findobj (hf, "type", "axes")); %! assert (hf, findobj (hf, "type", "figure")); %! assert (isempty (findobj (hf, "type", "xyzxyz"))); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! subplot (2,2,1); %! imagesc (rand (10)); %! subplot (2,2,2); %! surf (peaks); %! subplot (2,2,3); %! contour (peaks); %! subplot (2,2,4); %! plot (peaks); %! h1 = findobj (gcf (), "-regexp", "Type", "image|surface|hggroup"); %! h2 = findobj (gcf (), "Type", "image", %! "-or", "Type", "surface", %! "-or", "Type", "hggroup"); %! assert (h2, h1); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! toolkit = graphics_toolkit ("gnuplot"); %! hf = figure ("visible", "off"); %! unwind_protect %! h1 = subplot (2,2,1); %! h2 = subplot (2,2,2); %! h3 = subplot (2,2,3, "userdata", struct ("foo", "bar")); %! h4 = subplot (2,2,4); %! h = findobj (hf, "userdata", struct ("foo", "bar")); %! assert (h, h3); %! unwind_protect_cleanup %! close (hf); %! graphics_toolkit (toolkit); %! end_unwind_protect %!test %! toolkit = graphics_toolkit ("gnuplot"); %! hf = figure ("visible", "off"); %! unwind_protect %! h1 = subplot (2,2,1, "tag", "1"); %! h2 = subplot (2,2,2, "tag", "2"); %! h3 = subplot (2,2,3, "tag", "3"); %! h4 = subplot (2,2,4, "tag", "4"); %! h = findobj (hf, "type", "axes", "-not", "tag", "1"); %! assert (h, [h4; h3; h2]) %! unwind_protect_cleanup %! close (hf); %! graphics_toolkit (toolkit); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! h1 = subplot (2, 2, 1); %! set (h1, "userdata", struct ("column", 1, "row", 1)); %! h2 = subplot (2, 2, 2); %! set (h2, "userdata", struct ("column", 2, "row", 1)); %! h3 = subplot (2, 2, 3); %! set (h3, "userdata", struct ("column", 1, "row", 2)); %! h4 = subplot (2, 2, 4); %! set (h4, "userdata", struct ("column", 2, "row", 2)); %! h = findobj (hf, "type", "axes", %! "-not", "userdata", struct ("column", 1, "row", 1)); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %! assert (h, [h4; h3; h2]) %!test %! hf = figure ("visible", "off"); %! unwind_protect %! ha = axes (); %! plot (1:10); %! h = findobj (hf, "type", "figure", %! "-or", "parent", hf, %! "-and", "type", "axes"); %! unwind_protect_cleanup %! close (hf) %! end_unwind_protect %! assert (h, [hf; ha]) %!test %! hf = figure ("visible", "off"); %! unwind_protect %! set (hf, "tag", "foo"); %! h1 = subplot (2,2,1, "tag", "foo"); %! h2 = subplot (2,2,2, "tag", "bar"); %! h3 = subplot (2,2,3, "tag", "foo"); %! h4 = subplot (2,2,4, "tag", "bar"); %! h = findobj (hf, "type", "axes", "-xor", "tag", "foo"); %! assert (h, [hf; h4; h2]); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect %!test %! hf = figure ("visible", "off"); %! unwind_protect %! hax1 = subplot (2,1,1); %! hl1 = plot (rand (10,1)); %! hax2 = subplot (2,1,2); %! hl2 = plot (rand (10,1)); %! hobj = findobj (hf); %! assert (hobj, [hf; hax2; hax1; hl2; hl1]); %! unwind_protect_cleanup %! close (hf); %! end_unwind_protect