/src/com/greensock/plugins/BlurFilterPlugin.as
ActionScript | 62 lines | 19 code | 4 blank | 39 comment | 1 complexity | 4ec4842693698d3a556985ddbb1f50e9 MD5 | raw file
- /**
- * VERSION: 2.0
- * DATE: 8/18/2009
- * ACTIONSCRIPT VERSION: 3.0
- * UPDATES AND DOCUMENTATION AT: http://www.TweenMax.com
- **/
- package com.greensock.plugins {
- import com.greensock.*;
-
- import flash.filters.BlurFilter;
- /**
- * Tweens a BlurFilter. The following properties are available (you only need to define the ones you want to tween):
- * <code>
- * <ul>
- * <li> blurX : Number [0]</li>
- * <li> blurY : Number [0]</li>
- * <li> quality : uint [2]</li>
- * <li> index : uint</li>
- * <li> addFilter : Boolean [false]</li>
- * <li> remove : Boolean [false]</li>
- * </ul>
- * </code>
- *
- * Set <code>remove</code> to true if you want the filter to be removed when the tween completes. <br /><br />
- *
- * <b>USAGE:</b><br /><br />
- * <code>
- * import com.greensock.TweenLite; <br />
- * import com.greensock.plugins.TweenPlugin; <br />
- * import com.greensock.plugins.BlurFilterPlugin; <br />
- * TweenPlugin.activate([BlurFilterPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
- *
- * TweenLite.to(mc, 1, {blurFilter:{blurX:10, blurY:10}}); <br /><br />
- * </code>
- *
- * <b>Copyright 2011, GreenSock. All rights reserved.</b> This work is subject to the terms in <a href="http://www.greensock.com/terms_of_use.html">http://www.greensock.com/terms_of_use.html</a> or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.
- *
- * @author Jack Doyle, jack@greensock.com
- */
- public class BlurFilterPlugin extends FilterPlugin {
- /** @private **/
- public static const API:Number = 1.0; //If the API/Framework for plugins changes in the future, this number helps determine compatibility
- /** @private **/
- private static var _propNames:Array = ["blurX","blurY","quality"];
-
- /** @private **/
- public function BlurFilterPlugin() {
- super();
- this.propName = "blurFilter";
- this.overwriteProps = ["blurFilter"];
- }
-
- /** @private **/
- override public function onInitTween(target:Object, value:*, tween:TweenLite):Boolean {
- _target = target;
- _type = BlurFilter;
- initFilter(value, new BlurFilter(0, 0, value.quality || 2), _propNames);
- return true;
- }
-
- }
- }