]> Creatis software - CreaPhase.git/blob - octave_packages/geometry-1.5.0/geom2d/drawLabels.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / drawLabels.m
1 %% Copyright (c) 2011, INRA
2 %% 2003-2011, David Legland <david.legland@grignon.inra.fr>
3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
4 %%
5 %% All rights reserved.
6 %% (simplified BSD License)
7 %%
8 %% Redistribution and use in source and binary forms, with or without
9 %% modification, are permitted provided that the following conditions are met:
10 %%
11 %% 1. Redistributions of source code must retain the above copyright notice, this
12 %%    list of conditions and the following disclaimer.
13 %%     
14 %% 2. Redistributions in binary form must reproduce the above copyright notice, 
15 %%    this list of conditions and the following disclaimer in the documentation
16 %%    and/or other materials provided with the distribution.
17 %%
18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 %% POSSIBILITY OF SUCH DAMAGE.
29 %%
30 %% The views and conclusions contained in the software and documentation are
31 %% those of the authors and should not be interpreted as representing official
32 %% policies, either expressed or implied, of copyright holder.
33
34 %% -*- texinfo -*-
35 %% @deftypefn {Function File} drawLabels (@var{x}, @var{y}, @var{lbl})
36 %% @deftypefnx {Function File} drawLabels (@var{pos}, @var{lbl})
37 %% @deftypefnx {Function File} drawLabels (@dots{}, @var{numbers}, @var{format})
38 %% Draw labels at specified positions.
39 %%   
40 %%   DRAWLABELS(X, Y, LBL) draw labels LBL at position X and Y.
41 %%   LBL can be either a string array, or a number array. In this case,
42 %%   string are created by using sprintf function, with '%.2f' mask.
43 %%
44 %%   DRAWLABELS(POS, LBL) draw labels LBL at position specified by POS,
45 %%   where POS is a N*2 int array.
46 %%
47 %%   DRAWLABELS(..., NUMBERS, FORMAT) create labels using sprintf function,
48 %%   with the mask given by FORMAT (e. g. '%03d' or '5.3f'), and the
49 %%   corresponding values.
50 %% @end deftypefn
51
52 function varargout = drawLabels(varargin)
53
54   % check if enough inputs are given
55   if isempty(varargin)
56       error('wrong number of arguments in drawLabels');
57   end
58
59   % process input parameters
60   var = varargin{1};
61   if size(var, 2)==1
62       if length(varargin)<3
63           error('wrong number of arguments in drawLabels');
64       end
65       px  = var;
66       py  = varargin{2};
67       lbl = varargin{3};
68       varargin(1:3) = [];
69   else
70       if length(varargin)<2
71           error('wrong number of arguments in drawLabels');
72       end
73       px  = var(:,1);
74       py  = var(:,2);
75       lbl = varargin{2};
76       varargin(1:2) = [];
77   end
78
79   format = '%.2f';
80   if ~isempty(varargin)
81       format = varargin{1};
82   end
83   if size(format, 1)==1 && size(px, 1)>1
84       format = repmat(format, size(px, 1), 1);
85   end
86
87   labels = cell(length(px), 1);
88   if isnumeric(lbl)
89       for i=1:length(px)
90           labels{i} = sprintf(format(i,:), lbl(i));
91       end
92   elseif ischar(lbl)
93       for i=1:length(px)
94           labels{i} = lbl(i,:);
95       end
96   elseif iscell(lbl)
97       labels = lbl;
98   end
99   labels = char(labels);
100
101   h = text(px, py, labels);
102
103   if nargout>0
104       varargout{1}=h;
105   end
106
107 endfunction
108