DropShadow Documentation

Author: Alex Uhlmann
Last Modified: 09/28/05 09:59:19

Summary

DropShadow class:

DropShadow Properties:

DropShadow Methods:

DropShadow class

version: Documentation not provided.

description:

Animates the DropShadowFilter of a movieclip or a number of movieclips.

Example 1: (Example .swf) apply a filter animation with default values.

			import flash.filters.DropShadowFilter;
			
			var filterEnd:DropShadowFilter = new DropShadowFilter();
			new DropShadow(mc,filterEnd).animate(0,100);
			

Example 2: (Example .swf) do the same, just the other way around

			import flash.filters.DropShadowFilter;
			
			var filterEnd:DropShadowFilter = new DropShadowFilter();
			new DropShadow(mc,filterEnd).animate(100,0);
			

Example 3: (Example .swf) As with other IAnimatable classes you can set specific start and end values. To do the same as in example 2 you can apply a default filter instance as start value and a "null" value as end value. null defines a filter instance that won't be visible.

			import flash.filters.DropShadowFilter;
			
			var filterStart:DropShadowFilter = new DropShadowFilter();
			var myDropShadow:DropShadow = new DropShadow(mc,[filterStart,null]);
			myDropShadow.animationStyle(1000,Linear.easeNone);
			myDropShadow.animate(0,100);
			

Example 4: (Example .swf) Instances of the flash.filters classes are stacked to the filters Array of the movieclip you use. AnimationPackage offers you control if you want to animate existing filters, if you want to create a new filter, or replace an existing filter. By default, and in the examples above, we've always added a new filter instance to our movieclip mc. If you want to animate an existing filter you have to specify the index of the element in the movieclip's filters Array you want to manipulate. This example applies two different filters to the filters Array of movieclip mc and then animates element 1, which is the DropShadowFilter. You would replace the GlowFilter at index 0 and add new filter with specifying either no filterIndex as in the examples above or an index higher than 1.

			import flash.filters.GlowFilter;
			import flash.filters.DropShadowFilter;
			
			var glowFilter:GlowFilter = new GlowFilter();
			mc.filters = [glowFilter];
			var dropShadowFilter:DropShadowFilter = new DropShadowFilter();
			mc.filters = [glowFilter,dropShadowFilter];
			
			var newDropShadowFilter:DropShadowFilter = new DropShadowFilter();
			newDropShadowFilter.distance = 60;
			var myDropShadowIn:DropShadow = new DropShadow(mc,1,newDropShadowFilter);
			myDropShadowIn.animationStyle(1000,Circ.easeInOut);
			myDropShadowIn.addEventListener("onEnd",this);
			myDropShadowIn.animate(0,100);
			

Example 5: (Example .swf) Filter classes can have properties that don't animate. You can set those properties either as start value to the flash.filters instance or to AnimationPackage's filter class itself as done in this example. When the animation is invoked the property will be applied. In the following we apply the knockout property directly to the DropShadow instance. Only distance, blurX and blurY will animate.

			import flash.filters.DropShadowFilter;
			
			var filterEnd:DropShadowFilter = new DropShadowFilter();
			filterEnd.distance = 8;
			filterEnd.blurX = 15;
			filterEnd.blurY = 15;
			var myDropShadow:DropShadow = new DropShadow(mc,filterEnd);
			myDropShadow.knockout = true;
			myDropShadow.animationStyle(3000,Sine.easeInOut);
			myDropShadow.animate(0,100);
			

Example 6: (Example .swf) To animate many movieclips the same way, this class also accepts an Array of movieclips instead of one movieclip. This way yields to a better performance than creating a new class instance for each movieclip you want to animate. Different start values of your movieclip properties are considered when animating multiple movieclips within one animation instance. Here, we animate a drop shadow in and out.

			import flash.filters.DropShadowFilter;
			
			var mcs:Array = new Array(mc1, mc2, mc3);
			
			var dropShadowFilter:DropShadowFilter = new DropShadowFilter();
			var myDropShadowIn:DropShadow = new DropShadow(mcs,dropShadowFilter);
			myDropShadowIn.setOptimizationMode(true);
			myDropShadowIn.animationStyle(1000,Circ.easeOut);
			myDropShadowIn.addEventListener("onEnd",this);
			myDropShadowIn.animate(0,100);
			function onEnd(e:Object) {
				var myDropShadowOut:DropShadow = new DropShadow(mcs,0,null);
				myDropShadowOut.animationStyle(1000,Circ.easeIn);
				myDropShadowOut.animate(0,100);
			}

			

Example 7: (Example .swf) Showcase some of the DropShadow features in a Sequence.

				import flash.filters.DropShadowFilter;
				
				var filter1:DropShadowFilter = new DropShadowFilter();
				var myDropShadow1:DropShadow = new DropShadow(mc,filter1);
				
				var filter2:DropShadowFilter = new DropShadowFilter();
				filter2.distance = 50;
				var myDropShadow2:DropShadow = new DropShadow(mc,filter2);
				myDropShadow2.setStartValues([dropShadowFilter1]);

				var filter3:DropShadowFilter = new DropShadowFilter();
				filter3.distance = 4;
				var myDropShadow3:DropShadow = new DropShadow(mc,filter3);
				myDropShadow3.setStartValues([dropShadowFilter2]);

				var filter4:DropShadowFilter = new DropShadowFilter();
				filter4.angle = 180;
				var myDropShadow4:DropShadow = new DropShadow(mc,filter4);
				myDropShadow4.setStartValues([dropShadowFilter3]);

				var filter5:DropShadowFilter = new DropShadowFilter();
				filter5.angle = 45;
				filter5.blurX = 20;
				filter5.blurY = 20;
				var myDropShadow5:DropShadow = new DropShadow(mc,filter5);
				myDropShadow5.setStartValues([dropShadowFilter4]);

				var filter6:DropShadowFilter = new DropShadowFilter();
				filter6.strength = 4;
				filter6.alpha = 50;
				var myDropShadow6:DropShadow = new DropShadow(mc,filter6);
				myDropShadow6.setStartValues([dropShadowFilter5]);

				var mySequence:Sequence = new Sequence();
				mySequence.addChild(myDropShadow1);
				mySequence.addChild(myDropShadow2);
				mySequence.addChild(myDropShadow3);
				mySequence.addChild(myDropShadow4);
				mySequence.addChild(myDropShadow5);
				mySequence.addChild(myDropShadow6);
				
				mySequence.addEventListener("onEnd",this,"knockout");
				mySequence.animationStyle(3000,Circ.easeInOut);
				mySequence.animate(0,100);
				
				var innerStatus:Text = new Text();
				innerStatus.setText("inner "+false,0,0);
				var knockoutStatus:Text = new Text();
				knockoutStatus.setText("knockout "+false,0,15);
				var hideObjectStatus:Text = new Text();
				hideObjectStatus.setText("hideObject "+false,0,30);
				
				function knockout(e:Object) {	
					innerStatus.updateText("inner "+false);
					knockoutStatus.updateText("knockout "+true);
					hideObjectStatus.updateText("hideObject "+false);
				
					var children:Array = mySequence.getChildren();
					for(var i:Number=0; i < children.length; i++) {
						children[i].inner = false;
						children[i].knockout = true;
						children[i].hideObject = false;
					}
					mySequence.removeEventListener("onEnd",this,"knockout");
					mySequence.addEventListener("onEnd",this,"inner");
					mySequence.animate(0,100);
				}
				
				function inner(e:Object) {
					innerStatus.updateText("inner "+true);
					knockoutStatus.updateText("knockout "+false);
					hideObjectStatus.updateText("hideObject "+false);
					
					var children:Array = mySequence.getChildren();
					for(var i:Number=0; i < children.length; i++) {
						children[i].knockout = false;
						children[i].inner = true;
						children[i].hideObject = false;
					}
					mySequence.removeEventListener("onEnd",this,"inner");
					mySequence.addEventListener("onEnd",this,"innerAndKnockout");
					mySequence.animate(0,100);
				}
				function innerAndKnockout(e:Object) {
					innerStatus.updateText("inner "+true);
					knockoutStatus.updateText("knockout "+true);
					hideObjectStatus.updateText("hideObject "+false);
					
					var children:Array = mySequence.getChildren();
					for(var i:Number=0; i < children.length; i++) {
						children[i].inner = true;
						children[i].knockout = true;
						children[i].hideObject = false;
					}
					mySequence.removeEventListener("onEnd",this,"innerAndKnockout");
					mySequence.addEventListener("onEnd",this,"hideObject");
					mySequence.animate(0,100);
				}
				
				function hideObject(e:Object) {
					innerStatus.updateText("inner "+false);
					knockoutStatus.updateText("knockout "+false);
					hideObjectStatus.updateText("hideObject "+true);	
					
					var children:Array = mySequence.getChildren();
					for(var i:Number=0; i < children.length; i++) {
						children[i].inner = false;
						children[i].knockout = false;		
						children[i].hideObject = true;
					}
					mySequence.removeEventListener("onEnd",this,"hideObject");
					mySequence.addEventListener("onEnd",this,"original");
					mySequence.animate(0,100);
				}
				
				function original(e:Object) {
					innerStatus.updateText("inner "+false);
					knockoutStatus.updateText("knockout "+false);
					hideObjectStatus.updateText("hideObject "+false);		
					
					var children:Array = mySequence.getChildren();
					for(var i:Number=0; i < children.length; i++) {
						children[i].inner = false;
						children[i].knockout = false;		
						children[i].hideObject = false;
					}
					mySequence.removeEventListener("onEnd",this,"original");
					mySequence.addEventListener("onEnd",this,"knockout");
					mySequence.animate(0,100);
				}
			

usage:

var myInstance:DropShadow = new DropShadow(mc);

var myInstance:DropShadow = new DropShadow(mc, filter, duration, callback);

var myInstance:DropShadow = new DropShadow(mc, filter, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mc, filterIndex, filter, duration, callback);

var myInstance:DropShadow = new DropShadow(mc, filterIndex, filter, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mc, values);

var myInstance:DropShadow = new DropShadow(mc, values, duration, callback);

var myInstance:DropShadow = new DropShadow(mc, values, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mc, filterIndex, values);

var myInstance:DropShadow = new DropShadow(mc, filterIndex, values, duration, callback);

var myInstance:DropShadow = new DropShadow(mc, filterIndex, values, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mcs);

var myInstance:DropShadow = new DropShadow(mcs, filter, duration, callback);

var myInstance:DropShadow = new DropShadow(mcs, filter, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mcs, filterIndex, filter, duration, callback);

var myInstance:DropShadow = new DropShadow(mcs, filterIndex, filter, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mcs, values);

var myInstance:DropShadow = new DropShadow(mcs, values, duration, callback);

var myInstance:DropShadow = new DropShadow(mcs, values, duration, easing, callback);

var myInstance:DropShadow = new DropShadow(mcs, filterIndex, values);

var myInstance:DropShadow = new DropShadow(mcs, filterIndex, values, duration, callback);

var myInstance:DropShadow = new DropShadow(mcs, filterIndex, values, duration, easing, callback);

parameters:

• mc (MovieClip) Movieclip to animate.
• mcs (Array) array of movieclips to animate.
• filterIndex (Number) position of the element in the Movieclip's filter property that shall be manipulated.
• filter (DropShadowFilter) Targeted DropShadowFilter object to animate to.
• values (Array) optional start and end values.
• duration (Number) Duration of animation in milliseconds or frames. Default is milliseconds.
• easing (Object) Easing equation in Robert Penner style. Default equation is Linear.easeNone. www.robertpenner.com/easing/
• callback (String) Function to invoke after animation. See AnimationCore class.

DropShadow Properties:

DropShadow Methods:

myInstance.animate(start, end);

myInstance.goto(percentage);

myInstance.animationStyle(duration);

myInstance.animationStyle(duration, callback);

myInstance.animationStyle(duration, easing, callback);

myInstance.roundResult(rounded);

myInstance.forceEnd(forceEndVal);

myInstance.setOptimizationMode(optimize);

myInstance.addEventListener(event, listener);

myInstance.addEventListener(event, listener, handler);

myInstance.removeEventListener(event, listener);

myInstance.removeEventListener(event, listener, handler);

myInstance.removeAllEventListeners();

myInstance.removeAllEventListeners(event);

myInstance.eventListenerExists(event, listener);

myInstance.eventListenerExists(event, listener, handler);