gugga.animations.MaskAnimation Class Reference

Inheritance diagram for gugga.animations.MaskAnimation:

[legend]Collaboration diagram for gugga.animations.MaskAnimation:

[legend]List of all members.

---

Detailed Description

Author:

Barni

Definition at line 21 of file MaskAnimation.as.

Public Member Functions
function get	Type ()
function set	Type (aValue:MaskAnimationTypes)
function get	Target ()
function set	Target (aValue:MovieClip)
function get	Time ()
function set	Time (aValue:Number)
function get	EasingType ()
function set	EasingType (aValue:Function)
function get	Direction ()
function set	Direction (aValue:MotionDirections)
function get	MotionType ()
function set	MotionType (aValue:MotionTypes)
function	addCuePoint (aPosition:Number, aEventName:String)
function	getCuePointEventNames ()
function	start ()
function	isRunning ()
function	isImmediatelyInterruptable ()
function	interrupt ()
function	dispose ()
Static Public Member Functions
static function	createWipeInAnimation (aDirection:MotionDirections, aTarget:MovieClip, aTime:Number, aEasingType:Function, aDelay:Number)
static function	createWipeOutAnimation (aDirection:MotionDirections, aTarget:MovieClip, aTime:Number, aEasingType:Function, aDelay:Number)
static function	createFlyInAnimation (aDirection:MotionDirections, aTarget:MovieClip, aTime:Number, aEasingType:Function, aDelay:Number)
static function	createFlyOutAnimation (aDirection:MotionDirections, aTarget:MovieClip, aTime:Number, aEasingType:Function, aDelay:Number)
Private Member Functions
function	MaskAnimation (aTarget:MovieClip, aType:MaskAnimationTypes, aDirection:MotionDirections, aMotionType:MotionTypes)
function	configureAnimation (aClip:MovieClip)
function	createMask ()
function	getFinalPosition (aClip:MovieClip)
function	getStartingPosition (aClip:MovieClip)
function	calculateDirectionBasedOffset (aClip:MovieClip, aDirection:MotionDirections)
function	onCompleted ()
Static Private Member Functions
static function	applyAdditionalProperties (aAnimation:MaskAnimation, aTime:Number, aEasingType:Function)
Private Attributes
var	mType: MaskAnimationTypes
var	mTarget: MovieClip
var	mTime: Number = 1
var	mEasingType: Function = PennerEasing.linear
var	mDirection: MotionDirections
var	mMotionType: MotionTypes
var	mAnimation: PropertiesTweenAnimation
var	mMask: MovieClip
Static Private Attributes
static var	MASK_BOUNDARIES_PATCH: Number = 5
static var	MASK_INCREMENT:Number = 0

---

Constructor & Destructor Documentation

function gugga.animations.MaskAnimation.MaskAnimation	(	aTarget:MovieClip	,
		aType:MaskAnimationTypes	,
		aDirection:MotionDirections	,
		aMotionType:MotionTypes
	)			[private]

Definition at line 54 of file MaskAnimation.as.

---

Member Function Documentation

function get gugga.animations.MaskAnimation.Type

(

)

Definition at line 28 of file MaskAnimation.as.

function set gugga.animations.MaskAnimation.Type

(

aValue:MaskAnimationTypes

)

Definition at line 29 of file MaskAnimation.as.

function get gugga.animations.MaskAnimation.Target

(

)

Definition at line 32 of file MaskAnimation.as.

function set gugga.animations.MaskAnimation.Target

(

aValue:MovieClip

)

Definition at line 33 of file MaskAnimation.as.

function get gugga.animations.MaskAnimation.Time

(

)

Definition at line 36 of file MaskAnimation.as.

function set gugga.animations.MaskAnimation.Time

(

aValue:Number

)

Definition at line 37 of file MaskAnimation.as.

function get gugga.animations.MaskAnimation.EasingType

(

)

Definition at line 40 of file MaskAnimation.as.

function set gugga.animations.MaskAnimation.EasingType

(

aValue:Function

)

Definition at line 41 of file MaskAnimation.as.

function get gugga.animations.MaskAnimation.Direction

(

)

Definition at line 44 of file MaskAnimation.as.

function set gugga.animations.MaskAnimation.Direction

(

aValue:MotionDirections

)

Definition at line 45 of file MaskAnimation.as.

function get gugga.animations.MaskAnimation.MotionType

(

)

Definition at line 48 of file MaskAnimation.as.

function set gugga.animations.MaskAnimation.MotionType

(

aValue:MotionTypes

)

Definition at line 49 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.addCuePoint	(	aPosition:Number	,
		aEventName:String
	)

Definition at line 71 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.getCuePointEventNames

(

)

Definition at line 77 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.start

(

)

Definition at line 82 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.isRunning

(

)

Definition at line 115 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.isImmediatelyInterruptable

(

)

Definition at line 120 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.interrupt

(

)

Definition at line 125 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.dispose

(

)

Definition at line 131 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.configureAnimation

(

aClip:MovieClip

)

[private]

Definition at line 137 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.createMask

(

)

[private]

Mask increment is added in order to assure with full confidence that the newly created mask instance name is unique.

The version without this Mask increment was causing bugs in cases of consequent playing of mask animations on a single movie clip.

The bug actually was caused by setting masks with the same instance name, no mather of whether this masks have already been disposed.

Definition at line 148 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.getFinalPosition

(

aClip:MovieClip

)

[private]

Definition at line 189 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.getStartingPosition

(

aClip:MovieClip

)

[private]

Definition at line 203 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.calculateDirectionBasedOffset	(	aClip:MovieClip	,
		aDirection:MotionDirections
	)			[private]

Definition at line 217 of file MaskAnimation.as.

function gugga.animations.MaskAnimation.onCompleted

(

)

[private]

Definition at line 264 of file MaskAnimation.as.

References gugga.events.EventDispatcher.dispatchEvent().

Here is the call graph for this function:

static function gugga.animations.MaskAnimation.createWipeInAnimation	(	aDirection:MotionDirections	,
		aTarget:MovieClip	,
		aTime:Number	,
		aEasingType:Function	,
		aDelay:Number
	)			[static]

Definition at line 270 of file MaskAnimation.as.

static function gugga.animations.MaskAnimation.createWipeOutAnimation	(	aDirection:MotionDirections	,
		aTarget:MovieClip	,
		aTime:Number	,
		aEasingType:Function	,
		aDelay:Number
	)			[static]

Definition at line 282 of file MaskAnimation.as.

static function gugga.animations.MaskAnimation.createFlyInAnimation	(	aDirection:MotionDirections	,
		aTarget:MovieClip	,
		aTime:Number	,
		aEasingType:Function	,
		aDelay:Number
	)			[static]

Definition at line 294 of file MaskAnimation.as.

static function gugga.animations.MaskAnimation.createFlyOutAnimation	(	aDirection:MotionDirections	,
		aTarget:MovieClip	,
		aTime:Number	,
		aEasingType:Function	,
		aDelay:Number
	)			[static]

Definition at line 306 of file MaskAnimation.as.

static function gugga.animations.MaskAnimation.applyAdditionalProperties	(	aAnimation:MaskAnimation	,
		aTime:Number	,
		aEasingType:Function
	)			[static, private]

Definition at line 318 of file MaskAnimation.as.

---

Member Data Documentation

var gugga.animations.MaskAnimation.MASK_BOUNDARIES_PATCH [static, private]

Definition at line 23 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.MASK_INCREMENT [static, private]

Definition at line 25 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mType [private]

Definition at line 27 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mTarget [private]

Definition at line 31 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mTime [private]

Definition at line 35 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mEasingType [private]

Definition at line 39 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mDirection [private]

Definition at line 43 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mMotionType [private]

Definition at line 47 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mAnimation [private]

Definition at line 51 of file MaskAnimation.as.

var gugga.animations.MaskAnimation.mMask [private]

Definition at line 52 of file MaskAnimation.as.

---