Wipe

Paket	spark.effects
Klasse	public class Wipe
Vererbung	Wipe AnimateTransitionShader Animate Effect EventDispatcher Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Der Wipe-Effekt verwendet Pixel Bender, was für AIR-Mobilanwendungen nicht unterstützt wird.

Der Wipe-Effekt führt einen Bitmap-Übergangseffekt aus, indem ein richtungsbestimmtes Wischen zwischen der ersten und zweiten Bitmap erfolgt. Dieser Wischvorgang legt die zweite Bitmap im Verlauf der Animation in der Richtung frei, die durch die direction-Eigenschaft angegeben ist.

Ein vom Effekt geladenes Pixel-Shader-Programm führt den zugrunde liegenden Bitmap-Effekt aus. Wenn Sie ein anderes Wipe-Verhalten verwenden möchten, können Sie ein benutzerdefiniertes Pixel-Shader-Programm angeben. Das Pixel-Shader-Programm muss die für die shaderByteCode-Eigenschaft der AnimateTransitionShader-Klasse angegebenen Beschränkungen einhalten und drei zusätzliche Parameter bereitstellen. Folgende Zusatzparameter werden vom Wipe-Shader benötigt:

Ein ganzzahliger direction-Parameter, dessen Wert dasselbe bedeutet wie die verwandte String-Eigenschaft der Wipe-Klasse.
Zwei Fließkomma-Parameter: imageWidth und imageHeight.

Alle diese Parameter werden vom Shader-Programm eingestellt, wenn mit dem Abspielen des Effekts begonnen wird. Deshalb müssen diese Parameter vorhanden sein und eine entsprechend Aktion ausführen, damit der Effekt korrekt funktioniert.

MXML-Syntax expanded

MXML-Syntax ausblenden

The <s:Wipe> tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

  <s:Wipe
    Properties
    id="ID"
    direction="right"
  />

Standard-MXML-EigenschaftmotionPaths

Beispiele anzeigen

Verwandte API-Elemente

spark.effects.WipeDirection
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		bitmapFrom : BitmapData Die Bitmap-Daten, die den Startstatus dieses Effekts darstellen.	AnimateTransitionShader
		bitmapTo : BitmapData Die Bitmap-Daten, die den Endstatus dieses Effekts darstellen.	AnimateTransitionShader
		className : String [schreibgeschützt] Name der Effektklasse wie „Fade“.	Effect
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		customFilter : mx.effects:EffectTargetFilter Gibt ein benutzerdefiniertes Filterobjekt des Typs EffectTargetFilter an, das zur Ermittlung der Ziele dient, bei denen der Effekt wiedergegeben wird.	Effect
		direction : String = "right" Die Richtung, in die das Wischen während der Animation erfolgt: WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP oder WipeDirection.DOWN.	Wipe
		disableLayout : Boolean Wenn der Wert „true“ ist, wird durch den Effekt das Layout auf den übergeordneten Containern der Ziele deaktiviert, indem die autoLayout-Eigenschaft der Container auf „false“ gesetzt wird, und alle Layoutbeschränkungen auf Zielobjekten werden deaktivert.	Animate
		duration : Number Dauer des Effekts in Millisekunden.	Effect
		easer : IEaser Das Beschleunigungsverhalten für diesen Effekt.	Animate
		effectTargetHost : mx.effects:IEffectTargetHost Eine Eigenschaft, die Ihnen den Zugriff auf listenbasierte Zielsteuerelemente eines Dateneffekts ermöglicht.	Effect
		filter : String Gibt einen Algorithmus zum Filtern der Ziele für einen Effekt an.	Effect
		hideFocusRing : Boolean Bestimmt, ob der Effekt den Fokusring beim Start ausblenden soll.	Effect
		instanceClass : Class Ein Objekt der type-Klasse, das die Effektinstanzklasse für diese Effektklasse angibt.	Effect
		interpolator : IInterpolator Der Interpolator, der von diesem Effekt verwendet wird, um Werte zwischen den Anfangs- und Endwerten einer Eigenschaft zu berechnen.	Animate
		isPlaying : Boolean [schreibgeschützt] Ein Flag für den Schreibschutz, das auf „true“ gesetzt ist, wenn Instanzen des Effekts aktuell wiedergegeben werden, und andernfalls auf „false“.	Effect
		motionPaths : Vector.<MotionPath> Ein Vektor von MotionPath-Objekten, die alle den Namen einer zu animierenden Eigenschaft und die während der Animation von der Eigenschaft verwendeten Werte enthalten.	Animate
		perElementOffset : Number Zusätzliche Verzögerung (in Millisekunden) für Effektziele nach dem ersten Ziel des Effekts.	Effect
		playheadTime : Number Aktuelle Zeitposition des Effekts.	Effect
		relevantProperties : Array Ein Array von Eigenschaftsnamen zur Verwendung beim Filtern.	Effect
		relevantStyles : Array Ein Array von Stilnamen zur Verwendung beim Filtern.	Effect
		repeatBehavior : String Das Verhalten eines sich wiederholenden Effekts, also eines Effekts mit repeatCount gleich 0 oder > 1.	Animate
		repeatCount : int = 1 Ein Wert, der angibt, wie oft der Effekt wiederholt werden soll.	Effect
		repeatDelay : int = 0 Wartezeit in Millisekunden vor der Wiederholung des Effekts.	Effect
		shaderByteCode : Object Der Bytecode für das Pixel-Shader-Programm, der vom Effekt für die Animation zwischen den beiden Bitmaps verwendet wird.	AnimateTransitionShader
		shaderProperties : Object Eine Matrix von Parametername/Wert-Paaren, die vor der Wiedergabe an das Pixel-Shader-Programm übergeben werden.	AnimateTransitionShader
		startDelay : int = 0 Wartezeit in Millisekunden vor dem Starten des Effekts.	Effect
		target : Object Das Objekt, auf das dieser Effekt angewendet wird.	Effect
		targets : Array Ein Array von Objekten, die als Ziele des Effekts verwendet werden können.	Effect
		triggerEvent : Event Der EffectManager übergibt diesem Effekt das Ereignisobjekt, wenn ein Effekt ausgelöst wird, oder null, wenn der Effekt nicht vom EffectManager wiedergegeben wird.	Effect

Geschützte Eigenschaften

Vererbte geschützte Eigenschaften ausblenden

Vererbte geschützte Eigenschaften anzeigen

	Eigenschaft		Definiert von
		applyTransitionEndProperties : Boolean Dieses Flag steuert, ob der Effekt, wenn er in einem Übergang ausgeführt wird, automatisch die Eigenschaftswerte des Endstatus anwendet, statt die durch den Effekt eingestellten Werte beizubehalten.	Effect
		endValuesCaptured : Boolean = false Wenn dieses Flag auf „true“ gesetzt ist, wurden die Werte eines Effekts bereits bestimmt. Bei „false“ werden die Werte beim Ausführen des Effekts aus den aktuellen Eigenschaften der Effektziele übernommen.	Effect

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		Wipe(target:Object = null) Konstruktor.	Wipe
		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
		captureEndValues():void Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts und speichert sie als Endwerte.	Effect
		captureMoreStartValues(targets:Array):void Erfasst die aktuellen Werte der relevanten Eigenschaften eines zusätzlichen Zielsatzes. Flex verwendet diese Funktion, wenn ein Datenänderungseffekt ausgeführt wird.	Effect
		captureStartValues():void Erfasst die aktuellen Werte der relevanten Eigenschaften der Ziele des Effekts.	Effect
		createInstance(target:Object = null):IEffectInstance Erstellt eine einzelne Effektinstanz und initialisiert sie.	Effect
		createInstances(targets:Array = null):Array Verwendet ein Array von Zielobjekten und ruft die createInstance()-Methode auf jedem Ziel auf.	Effect
		deleteInstance(instance:IEffectInstance):void Entfernt Ereignis-Listener von einer Instanz und entfernt sie aus der Liste der Instanzen.	Effect
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		end(effectInstance:IEffectInstance = null):void Unterbricht einen aktuell wiedergegebenen Effekt und springt sofort zum Ende des Effekts.	Effect
		getAffectedProperties():Array Gibt ein Array von Strings zurück, wobei jeder String dem Namen einer Eigenschaft entspricht, die von diesem Effekt geändert wird.	Effect
		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
		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 Hält den Effekt an, bis die resume()-Methode aufgerufen wird.	Effect
		play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Startet die Wiedergabe des Effekts.	Effect
		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 Setzt den Effekt fort, nachdem er durch Aufrufen der pause()-Methode vorübergehend unterbrochen wurde.	Effect
		reverse():void Gibt den aktuell wiedergegebenen Effekt rückwärts wieder und beginnt dabei an der aktuellen Position des Effekts.	Effect
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		stop():void Hält den Effekt an und behält den aktuellen Status der Effektziele bei.	Effect
		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

Vererbte geschützte Methoden ausblenden

Vererbte geschützte Methoden anzeigen

	Methode		Definiert von
		applyValueToTarget(target:Object, property:String, value:*, props:Object):void Wird intern von der Effektinfrastruktur verwendet.	Effect
		effectEndHandler(event:EffectEvent):void Wird aufgerufen, wenn die Wiedergabe einer Effektinstanz abgeschlossen ist.	Effect
		effectStartHandler(event:EffectEvent):void Diese Methode wird aufgerufen, wenn die Wiedergabe der Effektinstanz beginnt.	Effect
		effectStopHandler(event:EffectEvent):void Wird aufgerufen, wenn eine Effektinstanz durch einen Aufruf der stop()-Methode angehalten wurde.	Effect
		filterInstance(propChanges:Array, target:Object):Boolean Bestimmt die Logik zum Filtern einer Effektinstanz.	Effect
		getValueFromTarget(target:Object, property:String):* Wird von der captureStartValues()-Methode aufgerufen, um den Wert einer Eigenschaft des Ziels abzurufen.	Effect
		initInstance(instance:IEffectInstance):void Kopiert Eigenschaften des Effekts in die Effektinstanz.	Effect

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Ü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
effectEnd	Wird ausgelöst, wenn die Wiedergabe einer der Effektinstanzen beendet wurde, da die Instanz das Ende erreicht hatte oder da der Effekt durch den Aufruf der end()-Methode unterbrochen wurde.	Effect
effectRepeat	Wird ausgelöst, wenn der Effekt eine neue Wiederholung beginnt, und zwar für jeden Effekt, der mehr als einmal wiederholt wird.	Animate
effectStart	Wird ausgelöst, wenn die Wiedergabe eines Effekts gestartet wird.	Effect
effectStop	Wird ausgelöst, wenn der Effekt angehalten wurde. Dies geschieht nur, wenn der Effekt durch Aufrufen der stop()-Methode unterbrochen wird.	Effect
effectUpdate	Wird jedes Mal ausgelöst, wenn der Effekt das Ziel aktualisiert.	Animate

Eigenschaftendetails

direction

Eigenschaft

public var direction:String = "right"

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Die Richtung, in die das Wischen während der Animation erfolgt: WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP oder WipeDirection.DOWN.

Der Standardwert ist WipeDirection.RIGHT.

Verwandte API-Elemente

WipeDirection.RIGHT
WipeDirection.UP
WipeDirection.LEFT
WipeDirection.DOWN

Konstruktordetails

()

Konstruktor

public function Wipe(target:Object = null)

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 4

Laufzeitversionen:

Flash Player 10, AIR 1.5

Konstruktor.

Parameter

target:Object (default = null) — Das Objekt, das mit diesem Effekt animiert wird.

Beispiele Verwendung dieses Beispiels

WipeExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<s:Application
    xmlns:fx="http://ns.adobe.com/mxml/2009"
    xmlns:mx="library://ns.adobe.com/flex/mx"
    xmlns:s="library://ns.adobe.com/flex/spark">

    <s:states>
        <s:State name="default"/>
        <s:State name="flipped"/>
    </s:states>

    <s:transitions>
        <s:Transition id="t1">
            <s:Wipe id="wipe"
                direction="right"
                target="{holder}"
                duration="1000" />
        </s:Transition>
    </s:transitions>

    <s:Panel title="Wipe Example"
        width="75%" height="75%">

        <s:HGroup width="100%" height="100%" left="5" top="5"
            horizontalCenter="0" verticalCenter="0">
            <s:Group id="holder">
                <s:BitmapImage
                    source="@Embed('assets/back2.png')"
                    visible="true" visible.flipped="false"/>
                <s:BitmapImage
                    source="@Embed('assets/c2.png')"
                    visible="false" visible.flipped="true"/>
            </s:Group>

            <!-- Directions -->
            <s:VGroup id="detailsBox"
                width="50%"
                left="0">
                <s:Label
                    width="99%"
                    color="blue"
                    text="Wipe wipes from bitmapFrom to the bitmapTo image in the given direction. Click the 'Wipe Right' button to see the effect."/>
            </s:VGroup>
        </s:HGroup>

        <s:Rect left="0" right="0" bottom="0" height="30">
            <s:fill>
                <s:LinearGradient rotation="90">
                    <s:GradientEntry color="0xE2E2E2" />
                    <s:GradientEntry color="0xD9D9D9" />
                </s:LinearGradient>
            </s:fill>
        </s:Rect>
        <s:Button
            left="5" bottom="5"
            label="Wipe Right"
            click="currentState = (currentState == 'flipped') ? 'default' : 'flipped';"/>
    </s:Panel>

</s:Application>

Rechtliche Hinweise | Onlinedatenschutzerklärung

Wipe - AS3 Flex

Klassen x

direction

Wipe