AL_AddInBetween.js

/******************************** A D D   I N B E T W E E N  ***************************/
/*

	Author : Alexandre Cormier 
	Compatible : ToonBoom 20 
	version : 1.2
	Creation Date : 14_11_2020
	Licence : Mozilla Public License Version 2.0


	Adds a key between two keyframes with  interpolation factor. 


*/


function AL_AddInBetween(){

	//MessageLog.trace(arguments.callee.name)

	scene.beginUndoRedoAccum("AL_PurgePalettesFiles");
	
	InputDialog();
	
	scene.endUndoRedoAccum();
	
	function InputDialog (){
		
		//MessageLog.trace(arguments.callee.name)
	    var d = new Dialog
	    d.title = "AL_AddInBetween";
	    d.width = 100;

		var OrderInput = new ComboBox();
		 OrderInput.label = "Pourcentage  : ";
		 OrderInput.editable = true;
		 OrderInput.itemList = [5,10,20,30,40,50,60,70,80,90,95];
		d.add( OrderInput );


		if ( d.exec() ){	
		
			var pourcentage = OrderInput.currentItem
	
			AddInBetween_process(pourcentage)

		}
		
	}
	
	
}	



/* FOR SEPARATED BUTTONS : */

function tween_10(){
	AddInBetween_process(10);
}



function tween_20(){
	AddInBetween_process(20);
}


function tween_30(){
	AddInBetween_process(30);
}

function tween_50(){
	AddInBetween_process(50);
}

function tween_70(){
	AddInBetween_process(70);
}

function tween_80(){
	AddInBetween_process(80);
}

function tween_90(){
	AddInBetween_process(90);
}


function tween_120(){
	AddInBetween_process(120);
}


function tween_minus30(){
	AddInBetween_process(-30);
}




function AddInBetween_process(POURCENTAGE){
	
	//MessageLog.trace(arguments.callee.name)
	
	var selected_nodes = selection.selectedNodes(0);
	var CURRENT_FRAME = frame.current();
	var numSelLayers = Timeline.numLayerSel;
	
	
	var nodes_to_treat = Array();
	var columns_to_treat = Array();
	
	var float_factor = 100/parseFloat(POURCENTAGE)

	
	nodes_to_treat = selected_layers_to_nodes();
	nodes_to_treat = filter_nodes_by_type(nodes_to_treat,["PEG","CurveModule","OffsetModule","BendyBoneModule","FreeFormDeformation"])
	columns_to_treat = fetch_colummns(nodes_to_treat)
	columns_to_treat = filter_columns_by_type(columns_to_treat,["3DPATH","BEZIER","EASE","QUATERNIONPATH"]) // not supported : "QUATERNIONPATH"

	scene.beginUndoRedoAccum("AL_PurgePalettesFiles");

	treat_columns(frame.current(),columns_to_treat,float_factor);
	
	scene.endUndoRedoAccum();	
	

	// ************** FONCTIONS 
	

	// filters functions
	
	function selected_layers_to_nodes(){
		
		//MessageLog.trace(arguments.callee.name)
		
		node_list = Array();
		
		var numSelLayers = Timeline.numLayerSel;
		
		for ( var i = 0; i < numSelLayers; i++ )
		{
			if ( Timeline.selIsNode( i ) ){
				node_list.push(Timeline.selToNode(i));
			}
		}

		return unique_array(node_list);
		
	}

	function filter_nodes_by_type(nodes_list,relevant_types){
		
		//MessageLog.trace(arguments.callee.name)
		
		//MessageLog.trace(nodes_list);
		//MessageLog.trace(relevant_types);
		var relevant_nodes = Array();

		for(var n = 0 ; n < nodes_list.length; n++){ 

			var currentNode = nodes_list[n];
			
			//dynamic array search : add sub nodes to the loop 
			if(node.type(currentNode)=="GROUP"){
				
				var currentGroup = currentNode
				var subNodesInGroup= node.numberOfSubNodes(currentGroup);
						
				for (var sn = 0; sn<subNodesInGroup;sn++){

					var sub_node= node.subNode(currentGroup,sn);
					nodes_list.push(sub_node);

				} 

			} 
			
			if(relevant_types.indexOf(node.type(currentNode))!=-1){
				relevant_nodes.push(currentNode);
			}

		} 	
		return relevant_nodes; 
	}
	
	
	function filter_columns_by_type (column_list,relevant_types){
		
		//MessageLog.trace(arguments.callee.name)
		
		var filtered_list = Array();
		
		for(var i = 0 ; i<column_list.length;i++){
			
				if(relevant_types.indexOf(column.type(column_list[i]))!=-1){
					
					filtered_list.push(column_list[i])
					
					//MessageLog.trace(column.type(column_list[i]));
					
				}
		}
		
		return filtered_list;
	}
	

	function fetch_colummns(nodes_list){
		
		//MessageLog.trace(arguments.callee.name)
		
		var columns_list = Array();
		
		
		
		for(var n = 0 ; n < nodes_list.length; n++){ 
		
		
			var currentNode = nodes_list[n];
			
			var linked_columns = get_linked_columns(currentNode);
			
			if(linked_columns.length >0){
				columns_list = columns_list.concat(linked_columns);
			}
		}
		
		
		return unique_array(columns_list); 
		
	}
	
	
	
	
	function treat_columns(_frame,column_list,factor){
		
		//MessageLog.trace(arguments.callee.name)
		//MessageLog.trace(column_list)
		
		for(var c = 0 ;c < column_list.length; c++){ 
			
			var current_column = column_list[c]
			add_inBetween_key(_frame,column_list[c],factor);
			
		}
		
		return true
		
	}

	
	function get_next_bezierkey(_column,_frame){
		
		//MessageLog.trace(arguments.callee.name)

		var key = false;
		var s = 0;
		
		for (var f = _frame ; f<=frame.numberOf();f++){
				if(column.isKeyFrame(_column,s,f)){
					
					//MessageLog.trace(f);
					key = column.getEntry(_column,s,f)
					return key;
					
				}
			
					
		}
		
		return key;
		
		

	}
	
	function get_previous_bezierkey(_column,_frame){
		
		//MessageLog.trace(arguments.callee.name)

		var key = false;
		var s = 0;
		
		for (var f = _frame ; f>=0;f--){
			
				if(column.isKeyFrame(_column,s,f)){
					
					//MessageLog.trace(f);
					key = column.getEntry(_column,s,f)
					return key;
					
				}
			
	
		}
		
		return key;
		
		

	}
	
	
	function get_next_3Dkey(_column,_frame){
		
		//MessageLog.trace(arguments.callee.name)

		sub_column = 4;
		key = Array();
		s = 1;
		
		for (var f = _frame ; f<=frame.numberOf();f++){
				

				 if(column.isKeyFrame(_column,s,f)){
		
					for (s = s ; s<sub_column;s++){

						key.push(column.getEntry(_column,s,f))

					}
					
					return key;
	
				}
					
		}
		
		return false;
		
		

	}
	
	function get_previous_3Dkey(_column,_frame){
		
		//MessageLog.trace(arguments.callee.name)

		sub_column = 4;
		key = Array();
		s = 1;
		
		for (var f = _frame ; f>=0;f--){
				
				if(column.isKeyFrame(_column,s,f)){
		
					for (s = s ; s<sub_column;s++){

						key.push(column.getEntry(_column,s,f))

					}
					
					return key;
	
				}
					
		}
		
		return false;
		

	}
	
	

	
	function float_to_tb_coords(tbv){
		
		var result = 0
		
		reslut = tbv.split(" ")[0];
		var letter = tbv.split(" ")[1];
		
		if(letter == "W" || "B" || "S"){
			
			result = "-"+result;
		}
		
		//MessageLog.trace(" from "+tbv+"  to   "+result)
		
		return parseFloat(result)
		
	}
		
	function add_inBetween_key(_frame,_column,_ratio){

			var CURRENT_FRAME = _frame;
			var new_key = null;
			var column_type = ""
			var next_key = ""
			var previous_key = ""
			
			if(column.type(_column) =="3DPATH"){
				
				//MessageLog.trace("3DPATH")
				
				next_key = get_next_3Dkey(_column,CURRENT_FRAME)
				previous_key = get_previous_3Dkey(_column,CURRENT_FRAME)
				
				if(next_key !== false && previous_key !==false){
					
					new_key = interpolate_3d(previous_key,next_key,_ratio);
				
					column.setEntry(_column,1,CURRENT_FRAME,new_key[0]);
					column.setEntry(_column,2,CURRENT_FRAME,new_key[1]);
					column.setEntry(_column,3,CURRENT_FRAME,new_key[2]);				
					
				}
				

				
			}else{
				
				//MessageLog.trace("BEZIER")
				
				next_key = get_next_bezierkey(_column,CURRENT_FRAME)
				previous_key = get_previous_bezierkey(_column,CURRENT_FRAME)
				
				if(next_key !== false && previous_key !==false){
				
					//MessageLog.trace("ENTRY")
					new_key = interpolate_bezier(previous_key,next_key,_ratio)
					column.setEntry(_column,0,CURRENT_FRAME,new_key);
					//column.setEntry(_column,1,CURRENT_FRAME,new_key);
					
				}
				
				
				
			}
			
			column.setKeyFrame(_column,CURRENT_FRAME);
			
			//MessageLog.trace(column.getDisplayName(_column))
			//MessageLog.trace("previous "+previous_key)
			//MessageLog.trace("next "+next_key)
			//MessageLog.trace("interpo "+new_key)
			
			return new_key;
			
	}
	
	 
	function interpolate_bezier (_valueA,_valueB,_ratio){
		
			var  A = parseFloat(_valueA);
			var  B = parseFloat(_valueB);
			var result = A + ((B-A)/_ratio);
			
			return result;
		
	}
	
	function interpolate_3d (array1,array2,_ratio){
		
		var factor = 1/_ratio;
		
		var p1x = toonboom_coords_to_float(array1[0])
		var p1y = toonboom_coords_to_float(array1[1])
		var p1z = toonboom_coords_to_float(array1[2])
		
		var p2x = toonboom_coords_to_float(array2[0])
		var p2y = toonboom_coords_to_float(array2[1])
		var p2z = toonboom_coords_to_float(array2[2])
	
		var result = Array();
		
		var p1 = new Point3d(p1x,p1y,p1z)
		var p2 = new Point3d(p2x,p2y,p2z)
		var p3 = new Point3d()
		p3.interpolate(factor,p1,p2)
		
		result.push(p3.x);
		result.push(p3.y);
		result.push(p3.z);
			
		//MessageLog.trace("new 3dpoint  "+result);
			
		return result;
		
	}

	function toonboom_coords_to_float(tbv){
		
		var result = 0
		
		result= tbv.split(" ")[0];
		var letter = tbv.split(" ")[1];
		
		
		
		if(letter == "W" || letter =="B" || letter =="S"){
			
			result = "-"+result;
		}
		
		
		result = parseFloat(result)
		
		//MessageLog.trace(" from "+tbv+"  to   "+result)

		return result
		
	}	
	
	function get_linked_columns(_node){
		
		var node_columns = Array();
	
		var attrList = getAttributesNameList (_node);
		
		for (var i=0; i<attrList.length; i++){
			
			var attribute_name = attrList[i]
			
			//MessageLog.trace("*****"+attribute_name);
			

			
			var linked_column = node.linkedColumn(_node,attribute_name)
			
			if( linked_column !=""){
				
				//MessageLog.trace(attribute_name);

				node_columns.push(linked_column);
			}
			
		}
		
		return node_columns;
		
		
	}
	

	function getAttributesNameList (snode){
		
		//MessageLog.trace(arguments.callee.name)
		
		var attrList = node.getAttrList(snode, frame.current(),"");
		var name_list= Array();
		
		for (var i=0; i<attrList.length; i++){	

			var attr = attrList[i];
			var a_name = attr.keyword();
			var sub_attr = attr.getSubAttributes()
			name_list.push(a_name);

			if(sub_attr.length > 0){
				for (var j=0; j<sub_attr.length; j++){	
					attrList.push(sub_attr[j]);
					var sub_attr_name = sub_attr[j].fullKeyword()
					name_list.push(sub_attr_name);
				}
			}
			
		}
		
		//MessageLog.trace(name_list)
		
		return name_list;
		
	}
	
	
	
	
	function unique_array(arr){
		
		var unique_array = Array();
		for(var i = 0 ; i<arr.length;i++){
			if(unique_array.indexOf(arr[i])==-1){
				unique_array.push(arr[i]);
			}
		}
		return unique_array;
		
	}
		
	
}