AQBlink
| Kind of class: | public class |
|---|---|
| Package: | |
| Inherits from: | |
| Classpath: | org.asaplibrary.util.actionqueue.AQBlink |
| File last modified: | Wednesday, 11 May 2011, 18:51:56 |
Action method to control the timed blinking (making more or less visible) of a DisplayObject.
Options are:
- Blinking an individual object by periodically setting its alpha values; this makes it possible to let a DisplayObject blink while be visible at the same time
- Showing and hiding a group of objects by moving their mask clip (this sets the visibility; no alpha values)
Summary
Class properties
- MASK_OFFSCREEN_X : Number
Instance methods
-
blink
(inDO:DisplayObject, inCount:int, inFrequency:Number, inMaxAlpha:Number, inMinAlpha:Number, inStartAlpha:Number = Number.NaN, inDuration:Number = Number.NaN, inEffect:Function = null) : Function
- Lets a DisplayObject blink (toggle between 2 alpha values).
-
maskBlink
(inDO:DisplayObject, inCount:int, inFrequency:Number, inHideAtStart:Boolean = true, inDuration:Number = Number.NaN, inEffect:Function = null) : Function
- When you have multiple objects that should simply be hidden while blinking, a simple solution is to use a mask and put all objects under the mask.
Class properties
MASK_OFFSCREEN_X
static MASK_OFFSCREEN_X:Number = -9999(read,write)
Instance methods
blink
function blink(inDO:DisplayObject,
inCount:int,
inFrequency:Number,
inMaxAlpha:Number,
inMinAlpha:Number,
inStartAlpha:Number = Number.NaN,
inDuration:Number = Number.NaN,
inEffect:Function = null) : Function
Lets a DisplayObject blink (toggle between 2 alpha values).
Parameters
inDO :DisplayObject to blink
inCount :the number of times the object should blink (the number of cycles, where each cycle is a full sine curve)
inFrequency :number of blinks per second
inMaxAlpha :the highest alpha when blinking; when no value is passed the current inDO's current alpha is used
inMinAlpha :the lowest alpha when blinking; when no value is passed the current inDO's current alpha is used
inStartAlpha:(optional) the starting alpha; if not given, a calculated middle value is used. The resulting starting alpha depends on the position of that value on a sine curve.
inDuration :(optional: pass either inDuration or inCount - if inDuration is given, inCount will be ignored) length of blinking in seconds; when 0, blinking is infinite, otherwise the movement will be stopped as soon as the duration has passed; in seconds
inEffect :(optional) an effect function, for instance one of the fl.transitions.easing methods
Example
-
This code will let a shape blink 4 times with a frequency of 2 blinks per second, with a max alpha of 1 and a min alpha of 0.1, starting out with min alpha:
var queue:ActionQueue = new ActionQueue(); queue.addAction(new AQBlink().blink(shape, 4, 2, 1, .1, .1)); queue.run();
This code will do the same, but for a duration of 2 seconds:var queue:ActionQueue = new ActionQueue(); queue.addAction(new AQBlink().blink(shape, 4, 2, 1, .1, .1, 2)); queue.run();
Returns
- A reference to initDoBlink that in turn returns the performing blink TimedAction.
maskBlink
function maskBlink(inDO:DisplayObject,
inCount:int,
inFrequency:Number,
inHideAtStart:Boolean = true,
inDuration:Number = Number.NaN,
inEffect:Function = null) : Function
When you have multiple objects that should simply be hidden while blinking, a simple solution is to use a mask and put all objects under the mask. Then you only have to control the mask to set the visibility of its contents. But masks cannot be given an alpha value, so you cannot use blink. maskBlink moves the mask off screen (x position to MASK_OFFSCREEN_X).
Parameters
inDO :the mask to move back and forth with a blinking frequency
inCount :the number of times the object should blink (the number of cycles, where each cycle is a full sine curve)
inFrequency :number of blinks per second
inHideAtStart:(optional) if true the blinking starts with the object set to invisible; if false it starts with the object set to visible; default is true (visible)
inDuration :(optional: pass either inDuration or inCount - if inDuration is given, inCount will be ignored) length of blinking in seconds; when 0, blinking is infinite, otherwise the movement will be stopped as soon as the duration has passed; in seconds
inEffect :(optional) an effect function, for instance one of the fl.motion.easing methods
Example
-
This code shows and hides a mask object for 2 seconds (count of 4 will be ignored) with frequency of 4 per second, starting out visible:
var queue:ActionQueue = new ActionQueue(); queue.addAction( new AQBlink().maskBlink(shape, 4, 1, true, 2 )); queue.run();
Returns
- A reference to initDoMaskBlink that in turn returns the performing mask blink TimedAction.