License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / graphics / macros / edit_curv.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) 1993 - INRIA - Serge Steer
3 // Copyright (C) 1993 - INRIA - Habib Jreij
4 // Copyright (C) 2012 - 2016 - Scilab Enterprises
5 //
6 // This file is hereby licensed under the terms of the GNU GPL v2.0,
7 // pursuant to article 5.3.4 of the CeCILL v.2.1.
8 // This file was originally licensed under the terms of the CeCILL v2.1,
9 // and continues to be available under such terms.
10 // For more information, see the COPYING file which you should have received
11 // along with this program.
12
13 function [x,y,ok,gc]=edit_curv(x,y,job,tit,gc)
14     //   mod_curv  - Edition  de courbe interactive
15     //%Syntaxe
16     //  [x,y,ok]=mod_curv(xd,yd,job,tit)
17     //%Parametres
18     //  xd    :  vecteur des abscisses donnees (eventuellement [])
19     //  yd    :  vecteur des ordonnees donnees (eventuellement [])
20     //  job   :  chaine de 3 caracteres  specifiant les operations
21     //           permises:
22     //            - Si la chaine contient le caractere 'a', il est
23     //              possible d'ajouter des points aux donnees, sinon
24     //              il est seulement possible de les deplacer
25     //            - Si la chaine contient le caractere 'x', il est
26     //              possible de deplacer les points horizontalement
27     //            - Si la chaine contient le caractere 'y', il est
28     //              possible de deplacer les points verticalement
29     //  tit   : liste de trois chaines de caracteres
30     //          tit(1) : titre de la courbe (peut etre un vecteur colonne)
31     //          tit(2) : label de l'axe des abscisses
32     //          tit(3) : label de l'axe des ordonnees
33     //  x     : vecteur des abscisses resultat
34     //  y     : vecteur des ordonnees resultat
35     //  ok    : vaut %t si la sortie as ete demandee par le menu Ok
36     //           et  %f si la sortie as ete demandee par le menu Abort
37     //%menus
38     //  Ok    : sortie de l'editeur et retour de la courbe editee
39     //  Abort : sortie de l'editeur et retour au donnes initiales
40     //  Undo  : annulation de la derniere modification
41     //  Size  : changement des bornes du graphique
42     //  Grids : changement des graduations du graphique
43     //  Clear : effacement de la courbe (x=[] et y=[]) (sans quitter l'editeur)
44     //  Read  : lecture de la courbe a partir d'un fichier d'extension .xy
45     //  Save  : sauvegarde binaire (sur un fichier d'extension .xy) de
46     //          la courbe
47     //!
48     [lhs,rhs]=argn(0)
49
50     ok = %t;
51     if rhs==0 then x=[]; y=[],end;
52     if rhs==1 then y=x;x=(1:size(y,"*"))',end
53     if rhs<3  then job="axy",end
54     if rhs<4 then tit=[" "," "," "],end
55     if size(tit,"*")<3 then tit(3)=" ",end
56     //
57
58     [mx,nx] = size(x); x=x(:)
59     [my,ny] = size(y); y=y(:)
60     n = min(mx*nx,my*ny)
61     x= x(1:n);y=y(1:n);
62     xsav=x; ysav=y; xs=x; ys=y;
63     //
64     lj = length(job)
65     add=0;modx=0;mody=0
66     for k=1:lj
67         jk = part(job,k)
68         select jk
69         case "a" then add = 1,
70         case "x" then modx= 1
71         case "y" then mody= 1
72         else error(msprintf(gettext("%s: Wrong value for input argument #%d: Must be in the set {%s}.\n"), "edit_curv", 3, "a, x, y"));
73         end
74     end
75     eps = 0.03
76     symbsiz = 0.2
77     // bornes initiales du graphique
78     if rhs<5 then
79         if mx<>0 then
80             xmx = max(x); xmn = min(x)
81             ymx = max(y); ymn = min(y)
82             dx = xmx-xmn;  dy = ymx-ymn
83             if dx==0 then dx=max(xmx/2,1),end
84             xmn=xmn-dx/10;xmx=xmx+dx/10
85             if dy==0 then dy=max(ymx/2,1),end;
86             ymn=ymn-dy/10;ymx=ymx+dy/10;
87         else
88             xmn=0;ymn=0;xmx=1;ymx=1;dx=1;dy=1
89         end
90         rect=[xmn,ymn,xmx,ymx];
91         axisdata=[2 10 2 10];
92         gc = list(rect,axisdata);
93     else //** rhs=5 as in Scicos ;)
94         [rect,axisdata] = gc(1:2)
95         xmn = rect(1);
96         ymn = rect(2);
97         xmx = rect(3);
98         ymx = rect(4);
99         dx  = xmx-xmn;
100         dy  = ymx-ymn;
101     end
102
103     // Set menus and callbacks
104     menu_d = ["Read","Save","Clear"]
105     menu_e = ["Undo","Size","Replot","Ok","Abort"]
106     menus  = list(["Edit","Data"],menu_e,menu_d)
107     w="menus(2)(";rpar=")"
108     Edit=w(ones(menu_e))+string(1:size(menu_e,"*"))+rpar(ones(menu_e))
109     w="menus(3)(";rpar=")"
110     Data=w(ones(menu_d))+string(1:size(menu_d,"*"))+rpar(ones(menu_d))
111
112     curwin = max(winsid())+1;
113     scf(curwin) ;
114
115     // Disable the menus and toolbars
116     toolbar(curwin,"off");
117     delmenu(curwin,gettext("File"));
118     delmenu(curwin,gettext("Tools"));
119     delmenu(curwin,gettext("Edit"));;
120     delmenu(curwin,"?");
121
122     execstr("Edit_"+string(curwin)+"=Edit");
123     execstr("Data_"+string(curwin)+"=Data");
124     menubar(curwin,menus)
125     //
126     edit_curv_figure = gcf();
127     edit_curv_figure.figure_name = "edit_curv";
128
129     edit_curv_axes = gca();
130     edit_curv_axes.data_bounds = [rect(1),rect(2);rect(3),rect(4)]
131     edit_curv_axes.axes_visible="on";
132     edit_curv_axes.grid=[4 4];
133     if x<>[] then
134         xpolys(x*[1 1],y*[1 1],[1,-1])
135         hdl=edit_curv_axes.children.children
136     else
137         hdl=[]
138     end
139
140     xtitle(tit(1),tit(2),tit(3));
141
142
143     // -- boucle principale
144     while %t then
145         [n1,n2] = size(x);
146         npt = n1*n2 ;
147
148         [btn,xc,yc,win,Cmenu] = get_click();
149
150         //** disp([btn,xc,yc,win]); //** DEBUG only
151
152         c1 = [xc,yc];
153
154         if Cmenu=="Quit" then Cmenu="Abort",end
155         if Cmenu==[]     then Cmenu="edit",end
156         if Cmenu=="Exit" then Cmenu="Ok",end
157
158         select Cmenu
159         case [] then
160             // ce n est pas un menu
161             break
162
163         case "Ok" then    //    -- ok menu
164             rect = matrix(edit_curv_axes.data_bounds',1,4);
165             gc   = list(rect,axisdata);
166             delete(edit_curv_figure)
167             return;
168
169         case "Abort" then //    -- abort menu
170             x = xsav
171             y = ysav
172             delete(edit_curv_figure)
173             ok = %f;
174             return
175
176         case "XClose" then //** the user manually close the win
177             x = xsav
178             y = ysav
179             ok = %f;
180             return
181
182         case "Undo" then
183             x=xs;y=ys
184             if x<>[] then hdl.data=[x y]; end
185
186         case "Size" then
187             while %t
188                 [ok,xmn,xmx,ymn,ymx]=getvalue("Please input new limits",..
189                 ["xmin";"xmax";"ymin";"ymax"],..
190                 list("vec",1,"vec",1,"vec",1,"vec",1),..
191                 string([xmn;xmx;ymn;ymx]))
192                 if ~ok then break,end
193                 if xmn>xmx|ymn>ymx then
194                     messagebox("Limits are not accettable","modal");
195                 else
196                     break
197                 end
198             end
199             if ok then
200                 dx=xmx-xmn;dy=ymx-ymn
201                 if dx==0 then dx=max(xmx/2,1),xmn=xmn-dx/10;xmx=xmx+dx/10;end
202                 if dy==0 then dy=max(ymx/2,1),ymn=ymn-dy/5;ymx=ymx+dy/10;end
203                 rect=[xmn,ymn,xmx,ymx];
204                 edit_curv_axes.data_bounds=[rect(1),rect(2);rect(3),rect(4)]
205             end
206
207         case "Clear" then
208             if hdl<>[] then delete(hdl),hdl=[];end
209             x=[];y=[];
210
211         case "Read" then
212             [x,y]=readxy()
213             mx=min(prod(size(x)),prod(size(y)))
214             if mx<>0 then
215                 xmx=max(x);xmn=min(x)
216                 ymx=max(y);ymn=min(y)
217                 dx=xmx-xmn;dy=ymx-ymn
218                 if dx==0 then dx=max(xmx/2,1),xmn=xmn-dx/10;xmx=xmx+dx/10;end
219                 if dy==0 then dy=max(ymx/2,1),ymn=ymn-dy/5;ymx=ymx+dy/10;end
220             else
221                 xmn=0;ymn=0;xmx=1;ymx=1;dx=1;dy=1
222             end
223             rect=[xmn,ymn,xmx,ymx];
224             edit_curv_axes.data_bounds=[rect(1),rect(2);rect(3),rect(4)]
225             if x<>[]&y<>[] then
226                 if hdl==[] then
227                     xpolys(x(1)*[1 1],y(1)*[1 1],[1,-1])
228                     hdl=gce();hdl=hdl.children
229                 end
230                 hdl.data=[x y];
231             else
232                 if hdl<>[] then delete(hdl),end
233                 x=[];y=[];
234             end
235
236         case "Save" then
237             savexy(x,y)
238
239         case "Replot" then
240             // for compatibility only, perform nothing on purpose
241
242         case "edit" then
243             npt=prod(size(x))
244             if npt<>0 then
245                 dist=((x-ones(npt,1)*c1(1))/dx).^2+((y-ones(npt,1)*c1(2))/dy).^2
246                 [m,k]=min(dist);m=sqrt(m)
247             else
248                 m=3*eps
249             end
250             if m<eps then                 //on deplace le point
251                 xs=x;ys=y
252                 [x,y]=movept(x,y)
253             else
254                 if add==1 then
255                     xs=x;ys=y                  //on rajoute un point de cassure
256                     [x,y]=addpt(c1,x,y)
257                 end
258             end
259         end
260     end
261 endfunction
262
263
264 function [btn,xc,yc,win,Cmenu] = get_click(flag)
265     //** 05/01/09 : update for Scilab 5.1: (close code is now -1000)
266
267     if ~or(winsid()==curwin) then
268         Cmenu = "Quit";
269         return        ;
270     end
271
272     if argn(2) == 1 then
273         [btn, xc, yc, win, str] = xclick(flag);
274     else
275         [btn, xc, yc, win, str] = xclick();
276     end
277
278     if btn == -1000 then //** user close the window [X]
279         if win == curwin then
280             Cmenu = "XClose";
281         else
282             Cmenu = "Open/Set";
283         end
284         return ;
285     end
286
287     if btn == -2 then //** user select a dynamic menu
288         xc = 0; yc = 0;
289         execstr("Cmenu=" + part(str, 9:length(str) - 1) );
290         execstr("Cmenu=" + Cmenu);
291         return;
292     end
293
294     Cmenu = [];
295
296 endfunction
297
298
299 function [x,y] = addpt(c1,x,y)
300     // permet de rajouter un point de cassure
301     npt = prod(size(x))
302     c1 = c1'
303     if hdl==[] then
304         x = c1(1);
305         y = c1(2);
306         xpolys(x*[1 1],y*[1 1],[1,-1]);
307         hdl = resume(edit_curv_axes.children(1).children)
308     end
309     //recherche des intervalles en x contenant l'abscisse designee
310     kk=[]
311     if npt>1 then
312         kk=find((x(1:npt-1)-c1(1)*ones(x(1:npt-1)))..
313         .*(x(2:npt)-c1(1)*ones(x(2:npt)))<=0)
314     end
315     if  kk<>[] then
316         //    recherche du segment sur le quel on a designe un point
317         pp=[];d=[];i=0
318         for k=kk
319             i=i+1
320             pr=projaff(x(k:k+1),y(k:k+1),c1)
321             if (x(k)-pr(1))*(x(k+1)-pr(1))<=0 then
322                 pp=[pp pr]
323                 d1=rect(3)-rect(1)
324                 d2=rect(4)-rect(2)
325                 d=[d norm([d1;d2].\(pr-c1))]
326             end
327         end
328         if d<>[] then
329             [m,i]=min(d)
330             if m<eps
331                 k=kk(i)
332                 pp=pp(:,i)
333                 x=x([1:k k:npt]);x(k+1)=pp(1);
334                 y=y([1:k k:npt]);y(k+1)=pp(2);
335                 hdl.data=[x y];
336                 return
337             end
338         end
339     end
340     d1=rect(3)-rect(1)
341     d2=rect(4)-rect(2)
342     if norm([d1;d2].\([x(1);y(1)]-c1))<norm([d1;d2].\([x(npt);y(npt)]-c1)) then
343         //  -- mise a jour de x et y
344         x(2:npt+1)=x;x(1)=c1(1)
345         y(2:npt+1)=y;y(1)=c1(2)
346     else
347         //  -- mise a jour de x et y
348         x(npt+1)=c1(1)
349         y(npt+1)=c1(2)
350     end
351     hdl.data=[x y];
352 endfunction
353
354 function [x,y]=movept(x,y)
355     //on bouge un point existant
356     hdl;
357     rep(3)=-1
358     while rep(3)==-1 do
359         rep = xgetmouse();
360         xc=rep(1);yc=rep(2);c2=[xc;yc]
361         if modx==0 then c2(1)=x(k);end
362         if mody==0 then c2(2)=y(k);end
363         x(k)=c2(1);y(k)=c2(2)
364         hdl.data=[x,y];
365     end
366 endfunction
367
368
369 function [x,y] = readxy()
370
371     function xy = findPolyline(children)
372         xy = [];
373         for i = 1:length(children)
374             select children(i).type,
375             case "Polyline" then
376                 xy = children(i).data;
377                 return
378             case "Axes" then
379                 xy = findPolyline(children(i).children);
380                 return
381             case "Compound" then
382                 xy = findPolyline(children(i).children);
383                 return
384             end
385         end
386     endfunction
387
388     fn=uigetfile(["*.scg";"*.sod";"*.xy"], "", _("Select a file to load"));
389     if fn <> "" then
390         [pth, fnm, ext] = fileparts(fn);
391         flname = fnm + ext;
392
393         select ext
394         case ".scg" then
395             loaded_figure=figure("visible", "off");
396             if execstr("xload(fn, loaded_figure.figure_id)","errcatch") == 0 then
397                 loaded_figure.visible = "off";
398                 scf(edit_curv_figure);
399                 xy = findPolyline(loaded_figure.children);
400                 delete(loaded_figure);
401                 if xy <> [] then
402                     x=xy(:,1);y=xy(:,2);
403                 else
404                     messagebox(msprintf(_("%s: The file "'%s"' does not " +..
405                     "contains any "'Polyline"' graphic entity.\n"), "edit_curve", flname));
406                     return
407                 end
408             else
409                 messagebox(msprintf(_("%s: Cannot open file "'%s"' " +..
410                 "for reading.\n"), "edit_curv", flname), "modal");
411                 return
412             end
413         case ".xy" then
414             if execstr("xy = read(fn,-1,2)","errcatch") == 0 then
415                 x=xy(:,1);y=xy(:,2);
416             else
417                 messagebox(msprintf(_("%s: Cannot open file "'%s"' " +..
418                 "for reading.\n"), "edit_curv", flname), "modal");
419                 return
420             end
421         case ".sod" then
422             if execstr("load(fn)","errcatch") == 0 then
423                 x=xy(:,1);y=xy(:,2);
424             else
425                 messagebox(msprintf(_("%s: Cannot open file "'%s"' " +..
426                 "for reading.\n"), "edit_curv", flname), "modal");
427                 return
428             end
429         else
430             messagebox(_("Error in file format."), "modal");
431             return
432         end
433     else
434         x=x
435         y=y
436     end
437 endfunction
438
439
440 function savexy(x,y)
441     fn=uiputfile(["*.sod";"*.xy"], "", _("Select a file to write"));
442     if fn <> "" then
443         [pth, fnm, ext] = fileparts(fn);
444         flname = fnm + ext;
445         xy = [x y];
446         fil = fn;
447
448         select ext
449         case "" then
450             fil = fil + ".xy";
451             ext = ".xy";
452         case ".xy" then
453             // empty case fil = fn
454         case ".sod" then
455             // empty case fil = fn
456         else
457             fil = pth + fnm + ".xy";
458             ext = ".xy";
459         end
460
461         select ext
462         case ".sod" then
463             if execstr("save(fil,""xy"")","errcatch")<>0 then
464                 messagebox(msprintf(_("%s: The file "'%s"' " +..
465                 "cannot be written.\n"), "edit_curv", flname), "modal");
466                 return
467             end
468         case ".xy" then
469             isErr = execstr("write(fil,xy)","errcatch")
470             if isErr == 240 then
471                 mdelete(fil); // write cannot overwrite an existing file
472                 isErr = execstr("write(fil,xy)","errcatch");
473             end
474             if isErr <> 0 then
475                 messagebox(msprintf(_("%s: The file "'%s"' " +..
476                 "cannot be written.\n"), "edit_curv", flname), "modal");
477                 return
478             end
479         end
480     end
481 endfunction