MaskEffectInstance

Paket	mx.effects.effectClasses
Klasse	public class MaskEffectInstance
Vererbung	MaskEffectInstance EffectInstance EventDispatcher Object
Unterklassen	IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die MaskEffectInstance-Klasse ist eine abstrakte Basisklasse, welche die Instanzklasse für die MaskEffect-Klasse implementiert.

Jede Effektklasse, die eine Unterklasse der TweenEffect-Klasse ist, unterstützt folgende Ereignisse:

tweenEnd: Wird ausgelöst, wenn der Tweeneffekt endet.
tweenUpdate: Wird jedes Mal ausgelöst, wenn eine TweenEffect-Klasse einen neuen Wert berechnet.

Das Ereignisobjekt, das für diese Ereignisse an den Ereignis-Listener übergeben wird, hat den Typ TweenEvent. Die TweenEvent-Klasse definiert die value-Eigenschaft, die den durch den Effekt berechneten Tween-Wert enthält. Für den Maskierungseffekt enthält die TweenEvent.value-Eigenschaft ein Array mit vier Elementen, wobei Folgendes gilt:

value[0]:Number Der Wert der x-Eigenschaft des Ziels.
value[1]:Number Der Wert der y-Eigenschaft des Ziels.
value[2]:Number Der Wert der scaleX-Eigenschaft des Ziels.
value[3]:Number Der Wert der scaleY-Eigenschaft des Ziels.

Verwandte API-Elemente

mx.effects.MaskEffect
mx.events.TweenEvent

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		className : String [schreibgeschützt] Name der Effektklasse wie „FadeInstance“.	EffectInstance
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		createMaskFunction : Function Funktion, die aufgerufen wird, wenn der Effekt die Maske erstellt.	MaskEffectInstance
		duration : Number Die Dauer des Effekts in Millisekunden.	EffectInstance
		effect : IEffect Das IEffect-Objekt, das dieses IEffectInstance-Objekt erstellt hat.	EffectInstance
		effectTargetHost : mx.effects:IEffectTargetHost Eine Eigenschaft, die Ihnen den Zugriff auf listenbasierte Zielsteuerelemente eines Dateneffekts ermöglicht.	EffectInstance
		hideFocusRing : Boolean Bestimmt, ob der Effekt den Fokusring beim Start ausblenden soll.	EffectInstance
		moveEasingFunction : Function Beschleunigungsfunktion zum Verschieben der Maske.	MaskEffectInstance
		playheadTime : Number Aktuelle Zeitposition des Effekts.	EffectInstance
		propertyChanges : PropertyChanges Gibt das PropertyChanges-Objekt an, das die Anfangs- und Endwerte für den Satz Eigenschaften enthält, die für die Ziele des Effekts relevant sind.	EffectInstance
		repeatCount : int Ein Wert, der angibt, wie oft der Effekt wiederholt werden soll.	EffectInstance
		repeatDelay : int Wartezeit in Millisekunden vor der Wiederholung des Effekts.	EffectInstance
		scaleEasingFunction : Function Beschleunigungsfunktion zum Skalieren der Maske.	MaskEffectInstance
		scaleXFrom : Number scaleX der Maske am Anfang.	MaskEffectInstance
		scaleXTo : Number scaleX der Maske am Ende.	MaskEffectInstance
		scaleYFrom : Number scaleY der Maske am Anfang.	MaskEffectInstance
		scaleYTo : Number scaleY der Maske am Ende.	MaskEffectInstance
		showTarget : Boolean Gibt an, dass die Zielkomponente sichtbar („false“) oder unsichtbar („true“) wird.	MaskEffectInstance
		startDelay : int Wartezeit in Millisekunden vor dem Starten des Effekts.	EffectInstance
		suspendBackgroundProcessing : Boolean Bei „true“ erfolgt keine Hintergrundverarbeitung, während der Effekt wiedergegeben wird.	EffectInstance
		target : Object Das UIComponent-Objekt, auf das dieser Effekt angewendet wird.	EffectInstance
		targetArea : Rectangle Der Bereich, in dem die Maske auf das Ziel angewendet wird.	MaskEffectInstance
		triggerEvent : Event Das Ereignis, falls zutreffend, das die Wiedergabe dieses Effekts ausgelöst hat.	EffectInstance
		xFrom : Number Die x-Koordinate der Maskenposition am Anfang.	MaskEffectInstance
		xTo : Number Die x-Koordinate der Zielposition der Maske.	MaskEffectInstance
		yFrom : Number Die y-Koordinate der Maskenposition am Anfang.	MaskEffectInstance
		yTo : Number Die y-Koordinate der Zielposition der Maske.	MaskEffectInstance

Geschützte Eigenschaften

Vererbte geschützte Eigenschaften ausblenden

Vererbte geschützte Eigenschaften anzeigen

	Eigenschaft		Definiert von
		effectMask : Shape Enthält die Effektmaske, d. h. entweder die durch die defaultCreateMask()-Methode erstellte Standardmaske oder die durch die Funktion an die createMaskFunction-Eigenschaft übergebene Maske.	MaskEffectInstance
		playCount : int = 0 Gibt an, wie oft die Instanz wiedergegeben wurde.	EffectInstance
		targetVisualBounds : Rectangle Die tatsächliche Größe des Effektziels einschließlich der Schlagschatten.	MaskEffectInstance

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		MaskEffectInstance(target:Object) Konstruktor.	MaskEffectInstance
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	EventDispatcher
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		end():void Unterbricht eine aktuell wiedergegebene Effektinstanz und springt sofort zum Ende des Effekts.	EffectInstance
		finishEffect():void Wird von der end()-Methode am Ende der Wiedergabe des Effekts aufgerufen.	EffectInstance
		finishRepeat():void Wird nach jeder Iteration eines wiederholten Effekts aufgerufen.	EffectInstance
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		initEffect(event:Event):void Sie wird aufgerufen, wenn der Effekt durch den EffectManager ausgelöst wurde.	EffectInstance
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		pause():void [override] Hält den Effekt an, bis die resume()-Methode aufgerufen wird.	MaskEffectInstance
		play():void Gibt die Effektinstanz auf dem Ziel wieder.	EffectInstance
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		resume():void [override] Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde.	MaskEffectInstance
		reverse():void [override] Gibt den Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts.	MaskEffectInstance
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		startEffect():void Gibt die Effektinstanz nach dem startDelay-Zeitraum auf dem Ziel wieder.	EffectInstance
		stop():void Hält den Effekt an und behält den aktuellen Status des Ziels bei.	EffectInstance
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	EventDispatcher

Geschützte Methoden

	Methode		Definiert von
		defaultCreateMask(targ:Object, bounds:Rectangle):Shape Erstellt die Standardmaske für den Effekt.	MaskEffectInstance
		initMaskEffect():void Initialisiert die move- und scale-Eigenschaften des Effekts.	MaskEffectInstance
		onMoveTweenEnd(value:Object):void Rückrufmethode, die aufgerufen wird, wenn die x- und die y-Position der Maske durch den Effekt ein letztes Mal aktualisiert werden sollen.	MaskEffectInstance
		onMoveTweenUpdate(value:Object):void Rückrufmethode, die aufgerufen wird, wenn die x- und die y-Position der Maske durch den Effekt aktualisiert werden sollen.	MaskEffectInstance
		onScaleTweenEnd(value:Object):void Rückrufmethode, die aufgerufen wird, wenn die scaleX- und die scaleY-Eigenschaften der Maske durch den Effekt ein letztes Mal aktualisiert werden sollen.	MaskEffectInstance
		onScaleTweenUpdate(value:Object):void Rückrufmethode, die aufgerufen wird, wenn die scaleX- und die scaleY-Eigenschaft der Maske durch den Effekt aktualisiert werden sollen.	MaskEffectInstance

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Ereignis		Übersicht	Definiert von
		activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
		deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher

Eigenschaftendetails

createMaskFunction

Eigenschaft

createMaskFunction:Function

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Funktion, die aufgerufen wird, wenn der Effekt die Maske erstellt. Der Standardwert ist eine Funktion, die ein Rechteck mit der gleichen Größe wie das Ziel zurückgibt.

Sie können diese Eigenschaft verwenden, um eine eigene Rückruffunktion zum Zeichnen der Maske festzulegen. Die Funktion muss folgende Signatur haben:

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

Sie setzen diese Eigenschaft auf den Namen der Funktion, wie im folgenden Beispiel für den WipeLeft-Effekt gezeigt:

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

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

effectMask

Eigenschaft

protected var effectMask:Shape

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Enthält die Effektmaske, d. h. entweder die durch die defaultCreateMask()-Methode erstellte Standardmaske oder die durch die Funktion an die createMaskFunction-Eigenschaft übergebene Maske.

moveEasingFunction

Eigenschaft

public var moveEasingFunction:Function

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Beschleunigungsfunktion zum Verschieben der Maske.

scaleEasingFunction

Eigenschaft

public var scaleEasingFunction:Function

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Beschleunigungsfunktion zum Skalieren der Maske.

scaleXFrom

Eigenschaft

public var scaleXFrom:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

scaleX der Maske am Anfang.

scaleXTo

Eigenschaft

public var scaleXTo:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

scaleX der Maske am Ende.

scaleYFrom

Eigenschaft

public var scaleYFrom:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

scaleY der Maske am Anfang.

scaleYTo

Eigenschaft

public var scaleYTo:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

scaleY der Maske am Ende.

showTarget

Eigenschaft

showTarget:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt an, dass die Zielkomponente sichtbar (false) oder unsichtbar (true) wird.

Der Standardwert ist true.

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

targetArea

Eigenschaft

public var targetArea:Rectangle

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Bereich, in dem die Maske auf das Ziel angewendet wird. Die Abmessungen sind von Ziel abhängig. Standardmäßig füllt der Bereich das ganze Ziel aus und wird folgendermaßen erstellt: new Rectangle(0, 0, target.width, target.height);

targetVisualBounds

Eigenschaft

protected var targetVisualBounds:Rectangle

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die tatsächliche Größe des Effektziels einschließlich der Schlagschatten. Flex berechnet den Wert dieser Eigenschaft. Sie müssen sie nicht einstellen.

xFrom

Eigenschaft

public var xFrom:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die x-Koordinate der Maskenposition am Anfang.

xTo

Eigenschaft

public var xTo:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die x-Koordinate der Zielposition der Maske.

yFrom

Eigenschaft

public var yFrom:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die y-Koordinate der Maskenposition am Anfang.

yTo

Eigenschaft

public var yTo:Number

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die y-Koordinate der Zielposition der Maske.

Konstruktordetails

()

Konstruktor

public function MaskEffectInstance(target:Object)

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Konstruktor.

Parameter

target:Object — Das Objekt, das mit diesem Effekt animiert wird.

Methodendetails

defaultCreateMask

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Erstellt die Standardmaske für den Effekt.

Parameter

	`targ:Object` — Das Effektziel.

	`bounds:Rectangle` — Die tatsächlichen visuellen Grenzen des Ziels einschließlich der Schlagschatten.

Rückgabewerte

()

Methode

override public function pause():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Hält den Effekt an, bis die resume()-Methode aufgerufen wird.

resume

()

Methode

override public function resume():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde.

reverse

()

Methode

override public function reverse():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt den Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts.

Rechtliche Hinweise | Onlinedatenschutzerklärung

MaskEffectInstance - AS3 Flex

Klassen x

createMaskFunction

effectMask

moveEasingFunction

scaleEasingFunction

scaleXFrom

scaleXTo

scaleYFrom

scaleYTo

showTarget

targetArea

targetVisualBounds

xFrom

xTo

yFrom

yTo