MaskEffectInstance

Pakket	mx.effects.effectClasses
Klasse	public class MaskEffectInstance
Overerving	MaskEffectInstance EffectInstance EventDispatcher Object
Subklassen	IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

The MaskEffectInstance class is an abstract base class that implements the instance class for the MaskEffect class.

Every effect class that is a subclass of the TweenEffect class supports the following events:

tweenEnd: Dispatched when the tween effect ends.
tweenUpdate: Dispatched every time a TweenEffect class calculates a new value.

The event object passed to the event listener for these events is of type TweenEvent. The TweenEvent class defines the property value, which contains the tween value calculated by the effect. For the Mask effect, the TweenEvent.value property contains a 4-item Array, where:

value[0]:Number The value of the target's x property.
value[1]:Number The value of the target's y property.
value[2]:Number The value of the target's scaleX property.
value[3]:Number The value of the target's scaleY property.

Verwante API-elementen

mx.effects.MaskEffect
mx.events.TweenEvent

Openbare eigenschappen

Overerfde openbare eigenschappen verbergen

Overerfde openbare eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		className : String [alleen-lezen] The name of the effect class, such as "FadeInstance".	EffectInstance
		constructor : Object Verwijzing naar het klasseobject of de constructorfunctie van een bepaalde objectinstantie.	Object
		createMaskFunction : Function Function called when the effect creates the mask.	MaskEffectInstance
		duration : Number The duration of the effect, in milliseconds.	EffectInstance
		effect : IEffect The IEffect object that created this IEffectInstance object.	EffectInstance
		effectTargetHost : mx.effects:IEffectTargetHost A property that lets you access the target list-based control of a data effect.	EffectInstance
		hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect.	EffectInstance
		moveEasingFunction : Function Easing function to use for moving the mask.	MaskEffectInstance
		playheadTime : Number Current time position of the effect.	EffectInstance
		propertyChanges : PropertyChanges Specifies the PropertyChanges object containing the start and end values for the set of properties relevant to the effect's targets.	EffectInstance
		repeatCount : int Number of times to repeat the effect.	EffectInstance
		repeatDelay : int Amount of time, in milliseconds, to wait before repeating the effect.	EffectInstance
		scaleEasingFunction : Function Easing function to use for scaling the mask.	MaskEffectInstance
		scaleXFrom : Number Initial scaleX for mask.	MaskEffectInstance
		scaleXTo : Number Ending scaleX for mask.	MaskEffectInstance
		scaleYFrom : Number Initial scaleY for mask.	MaskEffectInstance
		scaleYTo : Number Ending scaleY for mask.	MaskEffectInstance
		showTarget : Boolean Specifies that the target component is becoming visible, false, or invisible, true.	MaskEffectInstance
		startDelay : int Amount of time, in milliseconds, to wait before starting the effect.	EffectInstance
		suspendBackgroundProcessing : Boolean If true, blocks all background processing while the effect is playing.	EffectInstance
		target : Object The UIComponent object to which this effect is applied.	EffectInstance
		targetArea : Rectangle The area where the mask is applied on the target.	MaskEffectInstance
		triggerEvent : Event The event, if any, which triggered the playing of the effect.	EffectInstance
		xFrom : Number Initial position's x coordinate for mask.	MaskEffectInstance
		xTo : Number Destination position's x coordinate for mask.	MaskEffectInstance
		yFrom : Number Initial position's y coordinate for mask.	MaskEffectInstance
		yTo : Number Destination position's y coordinate for mask.	MaskEffectInstance

Beschermde eigenschappen

Overerfde beschermde eigenschappen verbergen

Overerfde beschermde eigenschappen weergeven

	Eigenschap		Gedefinieerd door
		effectMask : Shape Contains the effect mask, either the default mask created by the defaultCreateMask() method, or the one specified by the function passed to the createMaskFunction property.	MaskEffectInstance
		playCount : int = 0 Number of times that the instance has been played.	EffectInstance
		targetVisualBounds : Rectangle The actual size of the effect target, including any drop shadows.	MaskEffectInstance

Openbare methoden

Overerfde openbare methoden verbergen

Overerfde openbare methoden weergeven

	Methode		Gedefinieerd door
		MaskEffectInstance(target:Object) Constructor.	MaskEffectInstance
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registreert een gebeurtenislistenerobject bij een object EventDispatcher, zodat de listener een melding van een gebeurtenis ontvangt.	EventDispatcher
		dispatchEvent(event:Event):Boolean Verzendt een gebeurtenis naar de gebeurtenisstroom.	EventDispatcher
		end():void Interrupts an effect instance that is currently playing, and jumps immediately to the end of the effect.	EffectInstance
		finishEffect():void Called by the end() method when the effect finishes playing.	EffectInstance
		finishRepeat():void Called after each iteration of a repeated effect finishes playing.	EffectInstance
		hasEventListener(type:String):Boolean Controleert of het object EventDispatcher listeners heeft geregistreerd voor een specifiek type gebeurtenis.	EventDispatcher
		hasOwnProperty(name:String):Boolean Geeft aan of voor een object een opgegeven eigenschap is gedefinieerd.	Object
		initEffect(event:Event):void This method is called if the effect was triggered by the EffectManager.	EffectInstance
		isPrototypeOf(theClass:Object):Boolean Geeft aan of een instantie van de klasse Object zich in de prototypeketen van het object bevindt dat als parameter is opgegeven.	Object
		pause():void [overschrijven] Pauses the effect until you call the resume() method.	MaskEffectInstance
		play():void Plays the effect instance on the target.	EffectInstance
		propertyIsEnumerable(name:String):Boolean Geeft aan of de opgegeven eigenschap bestaat en kan worden opgesomd.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Verwijdert een listener uit het object EventDispatcher.	EventDispatcher
		resume():void [overschrijven] Resumes the effect after it has been paused by a call to the pause() method.	MaskEffectInstance
		reverse():void [overschrijven] Plays the effect in reverse, starting from the current position of the effect.	MaskEffectInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Stelt de beschikbaarheid van een dynamische eigenschap voor lusbewerkingen in.	Object
		startEffect():void Plays the effect instance on the target after the startDelay period has elapsed.	EffectInstance
		stop():void Stops the effect, leaving the target in its current state.	EffectInstance
		toLocaleString():String Geeft de tekenreeksweergave van dit object weer, geformatteerd volgens de locatiespecifieke conventies.	Object
		toString():String Retourneert een tekenreeksrepresentatie van het opgegeven object.	Object
		valueOf():Object Retourneert de primitieve waarde van het opgegeven object.	Object
		willTrigger(type:String):Boolean Controleert of een gebeurtenislistener is geregistreerd bij dit object EventDispatcher of een van de voorouders voor het opgegeven type gebeurtenis.	EventDispatcher

Beschermde methoden

	Methode		Gedefinieerd door
		defaultCreateMask(targ:Object, bounds:Rectangle):Shape Creates the default mask for the effect.	MaskEffectInstance
		initMaskEffect():void Initializes the move and scale properties of the effect.	MaskEffectInstance
		onMoveTweenEnd(value:Object):void Callback method that is called when the x and y position of the mask should be updated by the effect for the last time.	MaskEffectInstance
		onMoveTweenUpdate(value:Object):void Callback method that is called when the x and y position of the mask should be updated by the effect.	MaskEffectInstance
		onScaleTweenEnd(value:Object):void Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect for the last time.	MaskEffectInstance
		onScaleTweenUpdate(value:Object):void Callback method that is called when the scaleX and scaleY properties of the mask should be updated by the effect.	MaskEffectInstance

Gebeurtenissen

Klik voor meer informatie over gebeurtenissen.

Overerfde gebeurtenissen verbergen

Overerfde gebeurtenissen weergeven

	Gebeurtenis		Overzicht	Gedefinieerd door
		activate	[uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de besturingssysteemfocus krijgt en actief wordt.	EventDispatcher
		deactivate	[uitgezonden gebeurtenis] Wordt verzonden wanneer Flash Player of de AIR-toepassing de systeemfocus verliest en inactief wordt.	EventDispatcher

Eigenschapdetails

createMaskFunction

eigenschap

createMaskFunction:Function

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Function called when the effect creates the mask. The default value is a function that returns a Rectangle with the same dimensions as the effect target.

You can use this property to specify your own callback function to draw the mask. The function must have the following signature:

	  public function createLargeMask(targ:Object, bounds:Rectangle):Shape {
	    var myMask:Shape = new Shape();
	    // Create mask.
	  
	    return myMask;
	  }

You set this property to the name of the function, as the following example shows for the WipeLeft effect:

	    <mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>

Implementatie
public function get createMaskFunction():Function
public function set createMaskFunction(value:Function):void

effectMask

eigenschap

protected var effectMask:Shape

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Contains the effect mask, either the default mask created by the defaultCreateMask() method, or the one specified by the function passed to the createMaskFunction property.

moveEasingFunction

eigenschap

public var moveEasingFunction:Function

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Easing function to use for moving the mask.

scaleEasingFunction

eigenschap

public var scaleEasingFunction:Function

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Easing function to use for scaling the mask.

scaleXFrom

eigenschap

public var scaleXFrom:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Initial scaleX for mask.

scaleXTo

eigenschap

public var scaleXTo:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Ending scaleX for mask.

scaleYFrom

eigenschap

public var scaleYFrom:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Initial scaleY for mask.

scaleYTo

eigenschap

public var scaleYTo:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Ending scaleY for mask.

showTarget

eigenschap

showTarget:Boolean

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Specifies that the target component is becoming visible, false, or invisible, true.

De standaardwaarde is true.

Implementatie
public function get showTarget():Boolean
public function set showTarget(value:Boolean):void

targetArea

eigenschap

public var targetArea:Rectangle

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

The area where the mask is applied on the target. The dimensions are relative to the target itself. By default, the area is the entire target and is created like this: new Rectangle(0, 0, target.width, target.height);

targetVisualBounds

eigenschap

protected var targetVisualBounds:Rectangle

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

The actual size of the effect target, including any drop shadows. Flex calculates the value of this property; you do not have to set it.

xFrom

eigenschap

public var xFrom:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Initial position's x coordinate for mask.

xTo

eigenschap

public var xTo:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Destination position's x coordinate for mask.

yFrom

eigenschap

public var yFrom:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Initial position's y coordinate for mask.

yTo

eigenschap

public var yTo:Number

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Destination position's y coordinate for mask.

Constructordetails

()

Constructor

public function MaskEffectInstance(target:Object)

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Constructor.

Parameters

target:Object — The Object to animate with this effect.

Methodedetails

defaultCreateMask

()

methode

protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Creates the default mask for the effect.

Parameters

	`targ:Object` — The effect target.

	`bounds:Rectangle` — The actual visual bounds of the target which includes drop shadows

Geretourneerde waarde

()

methode

override public function pause():void

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Pauses the effect until you call the resume() method.

resume

()

methode

override public function resume():void

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Resumes the effect after it has been paused by a call to the pause() method.

reverse

()

methode

override public function reverse():void

Taalversie:

ActionScript 3.0

Productversie:

Flex 3

Runtimeversies:

Flash Player 9, AIR 1.1

Plays the effect in reverse, starting from the current position of the effect.

Juridische kennisgeving | Online privacybeleid

MaskEffectInstance - AS3 Flex

Pakkettenx

Taalelementen

Bijlagen

Pakket mx.effects.effectClasses

createMaskFunction

effectMask

moveEasingFunction

scaleEasingFunction

scaleXFrom

scaleXTo

scaleYFrom

scaleYTo

showTarget

targetArea

targetVisualBounds

xFrom

xTo

yFrom

yTo