CacheAsBitmapPlugin.as
3.35 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/**
* VERSION: 0.9
* DATE: 2010-06-29
* ACTIONSCRIPT VERSION: 3.0
* UPDATES AND DOCUMENTATION AT: http://www.TweenMax.com
**/
package com.greensock.plugins {
import com.greensock.*;
import flash.display.DisplayObject;
/**
* Forces the <code>cacheAsBitmap</code> property of a DisplayObject to be a certain value (<code>true</code> or <code>false</code>)
* during the tween and then sets it back to whatever it was before the tween was rendered for the first time. This <i>can</i> improve
* performance in certain situations, like when the DisplayObject <strong>NOT</strong> tweening its rotation, scaleX, scaleY, or similar
* things with its <code>transform.matrix</code>. See Adobe's docs for details about when it is appropriate to set <code>cacheAsBitmap</code>
* to <code>true</code>. Also beware that whenever a DisplayObject's <code>cacheAsBitmap</code> is <code>true</code>, it will ONLY be
* rendered on whole pixel values which can lead to animation that looks "choppy" at slow speeds.<br /><br />
*
* For example, if you want to set <code>cacheAsBitmap</code> to <code>true</code> while the tween is running, do:<br /><br /><code>
*
* TweenLite.to(mc, 1, {x:100, cacheAsBitmap:true});<br /><br /></code>
*
* <b>USAGE:</b><br /><br />
* <code>
* import com.greensock.TweenLite; <br />
* import com.greensock.plugins.TweenPlugin; <br />
* import com.greensock.plugins.CacheAsBitmapPlugin; <br />
* TweenPlugin.activate([CacheAsBitmapPlugin]); //activation is permanent in the SWF, so this line only needs to be run once.<br /><br />
*
* TweenLite.to(mc, 1, {x:100, cacheAsBitmap:true}); <br /><br />
* </code>
*
* <b>Copyright 2010, 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 CacheAsBitmapPlugin extends TweenPlugin {
/** @private **/
public static const API:Number = 1.0; //If the API/Framework for plugins changes in the future, this number helps determine compatibility
/** @private **/
protected var _target:DisplayObject;
/** @private **/
protected var _tween:TweenLite;
/** @private **/
protected var _cacheAsBitmap:Boolean;
/** @private **/
protected var _initVal:Boolean;
/** @private **/
public function CacheAsBitmapPlugin() {
super();
this.propName = "cacheAsBitmap";
this.overwriteProps = ["cacheAsBitmap"];
}
/** @private **/
override public function onInitTween(target:Object, value:*, tween:TweenLite):Boolean {
_target = target as DisplayObject;
_tween = tween;
_initVal = _target.cacheAsBitmap;
_cacheAsBitmap = Boolean(value);
return true;
}
/** @private **/
override public function set changeFactor(n:Number):void {
if (_tween.cachedDuration == _tween.cachedTime || _tween.cachedTime == 0) { //a changeFactor of 1 doesn't necessarily mean the tween is done - if the ease is Elastic.easeOut or Back.easeOut for example, they could hit 1 mid-tween.
_target.cacheAsBitmap = _initVal;
} else if (_target.cacheAsBitmap != _cacheAsBitmap) {
_target.cacheAsBitmap = _cacheAsBitmap;
}
}
}
}