FrameScrub Flash Extension

Nicolas says:

Seriously, why keep on using Flash 8? For the AS2? upgrade to F9 at the very least, it’s compatible with many more extensions since the migration to AS3.

themartist says:

Sorry, it does work on CS6… absolutely AWESOME addition to my workflow… wow!

David Hernston says:

This is a pretty cool tool. Very Maya. You may also be interested to see a tool I just put up on my blog, also for making it easier to set the “first frame”, but using a moderately complex system of keyboard shortcuts:

http://blog.pinkandaint.com/start-frame-madness/

David Hernston says:

Hmmm. In CS4 it works but the display doesn’t update until after I release the mouse button. That is, I can’t see what the art looks like until I stop scrubbing. Have you run into this problem? It makes the tool much less useful that I had initially hoped.

By the way, in my previous comment I didn’t state it very well. What I meant is that setting up the keyboard shortcuts is moderately complex, but once they’re in place it’s a super easy and intuitive system and it greatly speeds up the process of setting the start frame (though you probably intuited that if you read my blog post).

David Hernston says:

Yeah, I use Windows. Believe me, I know what you mean about display issues like this. In fact, I think I’ve run into this same one before, perhaps when I was trying to develop a stage rotation (like an animation disc) tool. I don’t remember if I ever solved it. Maybe I’ll take a look at your code and see if I can figure anything out to get it to display properly in Windows CS4.

David Hernston says:

Oops, sorry about the formatting. I’ll try that again:

/*
* @author Justin Putney
* @website http://ajarproductions.com
* @version 0.0.2
*
* Updated 6/5/2012 by David Hernston (http://www.pinkandaint.com) to fix a display bug in
* Flash CS4 for Windows

*/


var didDrag = false;
var startPt = new Object();
var theTool;
var dragInt = 6;
var anchorFrame;
var loopArr = ["loop", "play once", "single frame"];
var anchorLoop;
var FL_VERSION = getFlashAuthVersion();
var NEEDS_REFRESH = (FL_VERSION > 9);
var SPACEBAR = 32;

function configureTool() {
	theTool = fl.tools.activeTool;
	theTool.setToolName("FrameScub");
	theTool.setIcon("FrameScrub.png");
	theTool.setMenuString("FrameScrub Tool");
	theTool.setToolTip("FrameScrub Tool");
	//theTool.setOptionsFile( "FrameScrub.xml" );
	
	///////////////////////////////////////////
	// shape PI
	theTool.setPI( "movie" );
}


function notifySettingsChanged() {
	theTool = fl.tools.activeTool;
}


function setCursor() {
	fl.tools.setCursor( 1 );
}

function activate() {
	theTool = fl.tools.activeTool;
}

/*function keyDown() {
	var pressed = fl.tools.getKeyDown();
	if(!didDrag && pressed == SPACEBAR){
		fl.selectTool("hand");
	}
}

function keyUP() {
	fl.selectTool("FrameScub");
}*/

function deactivate() {
}

function mouseDown() {
	fl.tools.setCursor( 4 );
	// start drawing of object
	if(fl.tools.altIsDown) fl.drawingLayer.beginDraw(true);
	
	// set the flag if the cursor moves "enough"
	didDrag = false;
	anchorFrame = 0; //failsafe
	anchorLoop = 0;	//failsafe
	startPt = fl.tools.penDownLoc;
	var sel = fl.getDocumentDOM().selection;
	var tSel = sel[0];
	if (tSel == '[object SymbolInstance]') {
		if (tSel.symbolType == 'graphic') {
			anchorFrame = tSel.firstFrame;
			switch(tSel.loop){
				case loopArr[0]:
					anchorLoop = 0;
					break;
				case loopArr[1]:
					anchorLoop = 1;
					break;
				case loopArr[2]:
					anchorLoop = 2;
					break;
				default:
					anchorLoop = 0;
			}
		
		} else if (tSel.symbolType == 'movie clip'){
				var confirmed = confirm('The selected instance of ' + tSel.libraryItem.name  + ' is a movieclip. In order to use FrameScrub, the instance must be converted to a graphic. \r\rWould you like to convert it to a graphic?');
					if(confirmed){ 
						tSel.symbolType = 'graphic'; 
						//reset selected item
						//tSel = dom.selection[i];
					}
		}
	}

}


function transformPoint( pt ) {
	var mat = fl.getDocumentDOM().viewMatrix;
	var x = pt.x*mat.a + pt.y*mat.c + mat.tx;
	var y = pt.x*mat.b + pt.y*mat.d + mat.ty;
	pt.x = x;
	pt.y = y;
	return pt;
}

function mouseMove(mouseLoc) {
	// only calculate an object if user drags the mouse
	if (fl.tools.mouseIsDown) {
		fl.tools.setCursor( 4 );
		// check how much the mouse has moved since the pen went down
		var pt1 = startPt;
		var pt2 = mouseLoc;
		var dx = pt2.x - pt1.x;
		var adx = (dx > 0) ? dx : -dx;
		var dragAmt = dragInt;
		
		// constrain with the shift key
		if (fl.tools.shiftIsDown) {
			dragAmt = dragInt * .2;
		}
		
		if (adx > dragInt) {
			didDrag = true;
			if(fl.tools.altIsDown) {
				dragAmt = dragInt * 2;
				updateLoopSetting(Math.round(dx/dragAmt), mouseLoc);
				return; //exit before altering firstFrame
			}
			updateSelection(Math.round(dx/dragAmt));
		}
	}
}

function mouseUp() {
	// end the drawing
	fl.drawingLayer.endDraw();
	fl.drawingLayer.beginDraw();
	fl.drawingLayer.endDraw();

	if (!didDrag && fl.documents.length > 0) {
	var pt1 = transformPoint(startPt);
	fl.getDocumentDOM().mouseClick({x:pt1.x, y:pt1.y}, fl.tools.shiftIsDown, false);
	}
	fl.tools.setCursor( 1 );
	//refresh view
	if(NEEDS_REFRESH) {
		var dom = fl.getDocumentDOM();
		var sel = dom.selection;
		//drawing a selectionrect is one of the few things that works
		dom.selectNone();
		dom.setSelectionRect({left:0, top:0, right:1, bottom:1});
		dom.selection = sel;
	}
}


function mouseDoubleClick() { 
	var pt1 = startPt; //transformPoint(startPt);
	fl.getDocumentDOM().mouseDblClk({x:pt1.x, y:pt1.y}, fl.tools.altIsDown, fl.tools.shiftIsDown, false)
}

function updateLoopSetting(delta, mouseLoc) {
	var newLoop = anchorLoop + delta;
	if(newLoop > 2) newLoop = 2;
	if(newLoop < 0) newLoop = 0;
	var dom = fl.getDocumentDOM();
	var sel = dom.selection;
	var tSel = sel[0];
	//dom.selectNone();
	if (tSel == '[object SymbolInstance]' && tSel.symbolType == 'graphic') {
		var loopStr = loopArr[newLoop];
		tSel.loop = loopStr;
		fl.drawingLayer.beginFrame();
		var pt1 = mouseLoc;
		pt1.y += 20; //move down from cursor
		pt1.x -= 10;
		fl.drawingLayer.moveTo(pt1.x, pt1.y);
		if(loopStr === 'loop') {
			var pt2 = {y: pt1.y, x: pt1.x + 20};
			var pt3 = {y: pt2.y, x: pt2.x + 20};
			fl.drawingLayer.curveTo( pt1.x+10, pt1.y-10, pt2.x, pt2.y);
			fl.drawingLayer.curveTo( pt2.x+10, pt2.y-10, pt3.x, pt3.y);
			fl.drawingLayer.curveTo( pt3.x-10, pt3.y+10, pt2.x, pt2.y);
			fl.drawingLayer.curveTo( pt2.x-10, pt2.y+10, pt1.x, pt1.y);
		} else if(loopStr === 'play once'){
			var pt2 = {y: pt1.y, x: pt1.x + 30};
			var pt3 = {y: pt2.y-7, x: pt2.x-7};
			var pt4 = {y: pt2.y+7, x: pt3.x};
			var pt5 = {y: pt1.y - 15, x: pt2.x};
			var pt6 = {y: pt1.y + 15, x: pt2.x};
			fl.drawingLayer.lineTo(pt2.x, pt2.y);
			fl.drawingLayer.lineTo(pt3.x, pt3.y);
			fl.drawingLayer.moveTo(pt2.x, pt2.y);
			fl.drawingLayer.lineTo(pt4.x, pt4.y);
			fl.drawingLayer.moveTo(pt5.x, pt5.y);
			fl.drawingLayer.lineTo(pt6.x, pt6.y);
		
		} else if(loopStr === 'single frame'){
			var pt2 = {y: pt1.y, x: pt1.x + 10};
			var pt3 = {y: pt2.y+20, x: pt2.x};
			var pt4 = {y: pt3.y, x: pt1.x};
			fl.drawingLayer.lineTo(pt2.x, pt2.y);
			fl.drawingLayer.lineTo(pt3.x, pt3.y);
			fl.drawingLayer.lineTo(pt4.x, pt4.y);
			fl.drawingLayer.lineTo(pt1.x, pt1.y);
		}
		
		fl.drawingLayer.endFrame();
	}
	//dom.selection = sel;
	dom.livePreview = true;
}

function updateSelection(delta) 
{
	var dom = fl.getDocumentDOM();
	var sel = dom.selection;
	var len = sel.length;
	/*var i;
	for(i=0; i<len; i++){*/
	if(len == 1) {
		var tSel = sel[0];
		if(tSel == '[object SymbolInstance]'){
			if(tSel.symbolType == 'graphic') {
				var maxFrame = tSel.libraryItem.timeline.frameCount-1;
				if(anchorFrame == undefined) anchorFrame = tSel.firstFrame;
				var newFrame = anchorFrame + delta;
				if(newFrame  maxFrame) newFrame = maxFrame;
				tSel.firstFrame = newFrame;
				dom.livePreview = true;
				updateDisplay()
			} 
		}
	}
	
}

function updateDisplay()
{
	// Update the display
	// This is just a workaround for a display bug introduced in the 10.0.2 update
	// It's only needed for Flash CS4, perhaps only in Windows.
	var doc = fl.getDocumentDOM();
	var selection = doc.selection;
	doc.setSelectionRect({left:-2000, top:-2000, right:-1990, bottom:-1990});	
	doc.selection = selection;
}

function getFlashAuthVersion(){
	return parseInt(fl.version.split(' ').pop().split(',')[0]);
}

Zardo says:

Apologies, the issue was not with your extension. Feel free to delete my earlier post. And thanks a million for a very useful tool.

Wip says:

Amazing work! Thanks a lot for this.
I was looking to bind a keyboard shortcut to it. Not super necessary I know, but just wondering if it’s possible.

Wip says:

Hey Justin, Thanks for that. I should’ve formulated my question differently though 🙂
While customising shortcuts, I can normally find extensions in the lists (commands), but can’t find this one anywhere, not even in the tools dropdown. I’m probably blind, any chance you know where it is?