newline.m

Univ. of Calgary CREWS的免费地震研究软件

function newline(action,arg2,arg3)

% newline(action,transfer)
% 
% NEWLINE is a general tool for creating new lines with the mouse in the current
% figure. Capabilities include: 
%		1) drawing in a line with simple mouse clicks
%		2) duplicating an existing line
%		3) breaking an existing line into two independent segments
%		4) deleting an entire line with a single mouse click
%
% NEWLINE dose not include the ability to modify the created lines in any way. For
% this purpose use the EDITLINES facility.
%
% This is not usually called directly but rather initiated through NEWLINEINIT
%
% mouse action definitions:
% 
% button 1 click ... draw in a line. The first click defines the line and subsequent
%		clicks append new points to the previous ones.
% button 2 click ... delete an entire line
% button 3 click ... duplicate an existing line
%
% NEWLINE is intended to be incorporated within larger tools with specific 
% tasks. Someone using it it that context need read no further.
% For further information type: help newlineinit
%  
% by G.F. Margrave December 1993
%
% NOTE: It is illegal for you to use this software for a purpose other
% than non-profit education or research UNLESS you are employed by a CREWES
% Project sponsor. By using this software, you are agreeing to the terms
% detailed in this software's Matlab source file.
 
% BEGIN TERMS OF USE LICENSE
%
% This SOFTWARE is maintained by the CREWES Project at the Department
% of Geology and Geophysics of the University of Calgary, Calgary,
% Alberta, Canada.  The copyright and ownership is jointly held by 
% its author (identified above) and the CREWES Project.  The CREWES 
% project may be contacted via email at:  [e-mail]
% 
% The term 'SOFTWARE' refers to the Matlab source code, translations to
% any other computer language, or object code
%
% Terms of use of this SOFTWARE
%
% 1) Use of this SOFTWARE by any for-profit commercial organization is
%    expressly forbidden unless said organization is a CREWES Project
%    Sponsor.
%
% 2) A CREWES Project sponsor may use this SOFTWARE under the terms of the 
%    CREWES Project Sponsorship agreement.
%
% 3) A student or employee of a non-profit educational institution may 
%    use this SOFTWARE subject to the following terms and conditions:
%    - this SOFTWARE is for teaching or research purposes only.
%    - this SOFTWARE may be distributed to other students or researchers 
%      provided that these license terms are included.
%    - reselling the SOFTWARE, or including it or any portion of it, in any
%      software that will be resold is expressly forbidden.
%    - transfering the SOFTWARE in any form to a commercial firm or any 
%      other for-profit organization is expressly forbidden.
%
% END TERMS OF USE LICENSE

% mouse button assignments
% button1 up ... a point is added to the end of the current line
%	causes initiation of drawing mode
% button2 up ... if not in drawing mode, then the line clicked is deleted
%	if in drawing mode, then the current line is completed as a polygon
% button3 up ... if not in drawing mode, then the line clicked is duplicated
%	if in drawing mode, the the current line is finished
%
% The program 'terminates' everytime one of the following actions occurs:
%	1) Button 3 is clicked while in draw mode. Then the current line is finished and its 
%	handle returned
%	2) Button 3 is clicked while not in draw mode. Then the handle of the newly duplicated
%	line is returned
%	3) Button 2 is clicked while not in draw mode. Then the negative of the handle of the
%	deleted line is returned
% At termination, the handle of the new line and its x and y coordinates are stored in
% the current axes userdata. Running newlinefini is the easiset way to retrieve this
%

if( strcmp(action,'init') )

	if(nargin==1)
		transfer=[];
	else
		transfer=arg2;
	end

	set(gca,'userdata',[]);
	% make an invisible storage bucket 
	hstore=uicontrol('style','text','visible','off','string','yrag_new',...
		'userdata',[]);
	hstore=uicontrol('style','text','visible','off','string','yrag_trans',...
		'userdata',transfer);
	% set the windowbuttondownfcn
	set(gcf,'windowbuttondownfcn','newline(''buttondown'')');
	set(gcf,'windowbuttonupfcn','');
	set(gcf,'windowbuttonmotionfcn','');

	return;
end

if(strcmp(action,'fini') )
	% clean up graphics if needed
	% Get the storage buckets
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				if( strcmp(get(h(k),'string'),'yrag_trans') )
					htrans=h(k);
					found=found+1;
				end
				
				if( found== 2)
					break;
				end
			end
		end
	end

	returnstuff=get(hstor,'userdata');
	set(gca,'userdata',returnstuff);
	%
	% the userdata of hstor is
	% [key hline x(1:npts) y(1:npts)]
	%

	% set the windowbuttondownfcn
	set(gcf,'windowbuttondownfcn','');
	set(gcf,'windowbuttonupfcn','');
	
	% transfer control if requested
	transfer=get(htrans,'userdata');
	if(~isempty(transfer))
		eval(transfer);
	end

	% make sure cursor is an arrow
	set(gcf,'pointer','arrow');

end

if( strcmp(action,'buttondown') )
	% Get the storage bucket
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				if( found== 1)
					break;
				end
			end
		end
	end

	% if there is information in the userdata of hstor, then we have a
	% line currently active

	lineinfo=get(hstor,'userdata');

	new=0;

	if(isempty(lineinfo))
		new=1;
	end

	% determine which button was pressed
	button=1;
	flag=get(gcf,'selectiontype');

	if(strcmp(flag,'extend') )
		button=2;
	elseif(strcmp(flag,'alt'))
		button=3;
	end

	% assign the windowbuttonupfcn

	if(new&button==2)
		set(gcf,'windowbuttonupfcn','newline(''kill'')');
	elseif(~new&button==2)
		set(gcf,'windowbuttonupfcn','newline(''poly'')');
	elseif(new&button==3)
		set(gcf,'windowbuttonupfcn','newline(''duplicate'')');
	elseif(~new&button==3)
		set(gcf,'windowbuttonupfcn','newline(''fini'')');
	else
		set(gcf,'windowbuttonupfcn','newline(''draw'')');
	end

	return

end

% line drawing section
if(strcmp(action,'draw'))

	set(gcf,'windowbuttonupfcn','');
	
	% Get the storage buckets
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				
				if( found== 1)
					break;
				end
			end
		end
	end

	%get the current points
	lineinfo=get(hstor,'userdata');

	% get the current point
	pt=get(gca,'currentpoint');
	xpt=pt(1,1);
	ypt=pt(1,2);

	%determine whether to extend and existing line or start a new one
	if(isempty(lineinfo))
		hline=line(xpt,ypt,'color',[.5 .5 .5],'erasemode','xor');
		
		% set the lineinfo in userdata
		set(hstor,'userdata',[1 hline xpt ypt]);

	else
		% save the undo information
		set(gca,'userdata',lineinfo);

		xy=lineinfo(3:length(lineinfo));
		x=xy(1:length(xy)/2);
		y=xy(1+length(xy)/2:length(xy));

		x=[x xpt];
		y=[y ypt];

		set(lineinfo(2),'xdata',x,'ydata',y);

		set(hstor,'userdata',[lineinfo(1:2) x y]);
	end
	
	return;

end

% terminate as a polygon
if(strcmp(action,'poly'))

	set(gcf,'windowbuttonupfcn','');
	
	% Get the storage buckets
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				
				if( found== 1)
					break;
				end
			end
		end
	end

	%get the current points
	lineinfo=get(hstor,'userdata');


	xy=lineinfo(3:length(lineinfo));
	x=xy(1:length(xy)/2);
	y=xy(1+length(xy)/2:length(xy));

	x=[x x(1)];
	y=[y y(1)];

	set(lineinfo(2),'xdata',x,'ydata',y);

	set(hstor,'userdata',[lineinfo(1:2) x y]);

	newline('fini');

	return;

end



if(strcmp(action,'undo') )
% Get the storage buckets
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				
				if( found== 1)
					break;
				end
			end
		end
	end
	
	if(isempty(hstor))
		if( nargin==3 )
			transfer=arg3;
		else
			transfer=[];
		end
		newline('init',transfer);
		h=get(gcf,'children');
		found=0;
		for k=1:length(h)
			if( strcmp(get(h(k),'type'),'uicontrol') )
				if( strcmp(get(h(k),'style'),'text') )
					if( strcmp(get(h(k),'string'),'yrag_new') )
						hstor=h(k);
						found=found+1;
					end
				
					if( found== 1)
						break;
					end
				end
			end
		end
	end
	
	if( nargin< 2 )
		% get the undo information
		undostuff=get(gca,'userdata');
	else
		undostuff = arg2;
	end
	
	if(isempty(undostuff))
		return;
	end
	
	% see if we have color information. This means we are restoring a line that
	% was deleted
	ind=find(isnan(undostuff));
	if(length(ind)>0)
		colorinfo=undostuff(ind(1)+1:length(undostuff));
		kolor=colorinfo(1:3);
		ls=colorinfo(4:5);
		if(isnan(ls(2))) ls=ls(1); end
		ls=setstr(ls);
		lw=colorinfo(6);
		em=setstr(colorinfo(7:length(colorinfo)));
		undostuff=undostuff(1:ind(1)-1);
	end
	
	key=undostuff(1);
	hline=undostuff(2);
	n=(length(undostuff)-2)/2;
	x=undostuff(3:n+2);
	y=undostuff(n+3:2*n+2);
	
	if( key == 4)
		hline=line(x,y,'color',kolor,'linestyle',ls,'linewidth',lw,'erasemode',em);
		set(hstor,'userdata',[3 hline x y]);
	elseif(key==1)
		set(hline,'xdata',x,'ydata',y);
		set(hstor,'userdata',[1 hline x y]);
	end
	
	
	
	% if we are restoring a deleted line, then we must terminate the newline
	% mode so that the line handle is returned
	if(length(colorinfo)>0)
		newline('fini');
	end

	return;
end

% line duplication
if(strcmp(action,'duplicate') )

	set(gcf,'windowbuttonupfcn','');
	
	% Get the storage buckets
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				
				if( found== 1)
					break;
				end
			end
		end
	end

% determine if the user clicked on a line

	hline=get(gcf,'currentobject');

	flag=get(hline,'type');

	if(~strcmp(flag,'line'))
		return;
	end

	x=get(hline,'xdata');
	y=get(hline,'ydata');

	ylim=get(gca,'ylim');
	yshift=abs(ylim(1)-ylim(2))*.05;

	y=y+yshift;

	hline=line(x,y,'color',[.5 .5 .5],'erasemode','xor');

	set(hstor,'userdata',[2 hline x y]);

	set(gca,'userdata',[]);% undo for duplicate is just delete

	newline('fini');

return;

end

% kill an entire line
if(strcmp(action,'kill'))
	

	set(gcf,'windowbuttonupfcn','');
	
	% Get the storage buckets
	h=get(gcf,'children');
	found=0;
	for k=1:length(h)
		if( strcmp(get(h(k),'type'),'uicontrol') )
			if( strcmp(get(h(k),'style'),'text') )
				if( strcmp(get(h(k),'string'),'yrag_new') )
					hstor=h(k);
					found=found+1;
				end
				
				if( found== 1)
					break;
				end
			end
		end
	end
	
% determine if the user clicked on a line

	hline=get(gcf,'currentobject');

	flag=get(hline,'type');

	if(~strcmp(flag,'line'))
		return;
	end

	x=get(hline,'xdata');
	y=get(hline,'ydata');

	% get the lines color, style, etc
	
	kolor=get(hline,'color');
	ls=abs(get(hline,'linestyle'));
	if(length(ls)==1) ls=[ls nan]; end
	lw=get(hline,'linewidth');
	em=get(hline,'erasemode');

	% set the undo information
	undostuff=[4 hline x y NaN kolor abs(ls) lw abs(em)];
	set(gca,'userdata',undostuff);

	% delete the line

	delete(hline);

	% set the information in hstor

	set(hstor,'userdata',undostuff);

	% newlinefini

	newline('fini');

	return;

end