| Пакет | spark.effects |
| Класс | public class Wipe |
| Наследование | Wipe  AnimateTransitionShader Animate Effect EventDispatcher Object |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
 | Эффект Wipe использует Pixel Bender, который не поддерживается в мобильных приложениях AIR. |
Эффект Wipe выполняет растровый переход, посредством выполнения направленного стирания между первым и вторым растровыми изображениями. Процесс стирания делает видимым второе по ходу анимации растровое изображение в направлении, обозначенном свойством
direction.
Программа пиксельного затенения, загруженная эффектом, выполняет основной растровый эффект. Если требуется использовать другой вариант поведения Wipe, то можно указать пользовательскую программу пиксельного затенения. Программа пиксельного затенения должна соответствовать ограничениям, указанным для свойства shaderByteCode класса AnimateTransitionShader, и предоставлять три дополнительных параметра. Дополнительные параметры, необходимые для затенения Wipe:
- Целочисленный параметр
directionсо значением, аналогичным связанному свойству строки в классе Wipe. - Два параметра плавающей запятой:
imageWidthиimageHeight.
Все эти параметры установлены для шейдера при запуске воспроизведения эффекта, таким образом, данные параметры должны существовать и выполнять определенные действия для правильного функционирования эффекта.
Синтаксис MXML
Показать синтаксис MXML
Скрыть синтаксис MXMLThe <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"
/>
Свойство MXML по умолчаниюmotionPaths
Связанные элементы API
spark.effects.WipeDirection
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode
spark.effects.AnimateTransitionShader
spark.effects.AnimateTransitionShader.shaderByteCode
Общедоступные свойства
| Свойство | Определено | ||
|---|---|---|---|
 | bitmapFrom : BitmapData
Данные растрового изображения, представляющие начальное состояние эффекта. | AnimateTransitionShader | |
| bitmapTo : BitmapData
Растровые данные, представляющие конечное состояние эффекта. | AnimateTransitionShader | |
| className : String [только для чтения]
Имя класса эффекта, например Fade. | Effect | |
| constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| customFilter : mx.effects:EffectTargetFilter
Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект. | Effect | |
| direction : String = "right"
Направление, в котором движется стирание в процессе анимации, может принимать следующие значения: WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP или WipeDirection.DOWN. | Wipe | ||
| disableLayout : Boolean
Если значение равно true, эффект отключает макет на вышестоящих контейнерах его целевых объектов, устанавливая для свойства autoLayout контейнеров значение false, а также отключает любые ограничения макета на целевые объекты. | Animate | |
| duration : Number
Продолжительность эффекта в миллисекундах. | Effect | |
| easer : IEaser
Реакция замедления для этого эффекта. | Animate | |
| effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. | Effect | |
| filter : String
Указывает алгоритм фильтрации целевых объектов для эффекта. | Effect | |
| hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. | Effect | |
| instanceClass : Class
Объект типа Class, указывающий класс класса экземпляра эффекта для данного класса эффекта. | Effect | |
| interpolator : IInterpolator
Для вычисления значений между начальными и конечными значениями свойства данным эффектом используется интерполятор. | Animate | |
| isPlaying : Boolean [только для чтения]
Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае. | Effect | |
| motionPaths : Vector.<MotionPath>
Вектор объектов MotionPath, каждый из которых содержит имя подлежащего анимации свойства и значения, которые данное свойство принимает в процессе анимации. | Animate | |
| perElementOffset : Number
Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта. | Effect | |
| playheadTime : Number
Текущая позиция эффекта. | Effect | |
| relevantProperties : Array
Массив имен свойств, используемых при выполнении фильтрации. | Effect | |
| relevantStyles : Array
Массив имен стилей, используемых при выполнении фильтрации. | Effect | |
| repeatBehavior : String
Поведение повторяющегося эффекта, то есть эффекта со значением repeatCount, равным 0 или > 1. | Animate | |
| repeatCount : int = 1
Число повторов эффекта. | Effect | |
| repeatDelay : int = 0
Время ожидания (в миллисекундах) перед повторением эффекта. | Effect | |
| shaderByteCode : Object
Байт-код для программы затенения пикселей, которую эффект использует для анимации между двумя данными растровыми изображениями. | AnimateTransitionShader | |
| shaderProperties : Object
Схема пары «имя/значение» параметра передается в программу затенения пикселей до воспроизведения. | AnimateTransitionShader | |
| startDelay : int = 0
Время ожидания (в миллисекундах) перед запуском эффекта. | Effect | |
| target : Object
Объект, к которому применяется данный эффект. | Effect | |
| targets : Array
Массив объектов, являющихся целевыми объектами эффекта. | Effect | |
| triggerEvent : Event
Объект Event, переданный в Effect с помощью EffectManager при запуске эффекта, или null, если эффект воспроизводится без EffectManager. | Effect | |
Защищенные свойства
Общедоступные методы
| Метод | Определено | ||
|---|---|---|---|
Конструктор. | Wipe | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
|
Обеспечивает сбор текущих значений соответствующих свойств целевых объектов эффекта и сохраняет их как конечные значения. | Effect | |
|
Обеспечивает сбор текущих значений соответствующих свойств дополнительного набора целевых объектов. Flex использует эту функцию при воспроизведении эффекта изменения данных.
| Effect | |
|
Обеспечивает сбор текущих значений соответствующих свойств для целевых объектов эффекта. | Effect | |
|
Создает отдельный экземпляр эффекта и инициализирует его. | Effect | |
|
Принимает массив целевых объектов и вызывает метод createInstance() для каждой цели. | Effect | |
|
Удаляет прослушиватели событий из экземпляра и удаляет экземпляр из списка экземпляров. | Effect | |
|
Посылает событие в поток событий. | EventDispatcher | |
|
Прерывает эффект, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. | Effect | |
|
Возвращает массив строк, где каждая строка представляет собой имя свойства, которое было изменено данным эффектом. | Effect | |
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
|
Приостанавливает эффект до вызова метода resume(). | Effect | |
|
Начинает воспроизведение эффекта | Effect | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
|
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause(). | Effect | |
|
Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта. | Effect | |
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии. | Effect | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
События
Сведения о свойстве
direction | свойство |
public var direction:String = "right"| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 4 |
| Версии среды выполнения: | Flash Player 10, AIR 1.5 |
Направление, в котором движется стирание в процессе анимации, может принимать следующие значения: WipeDirection.RIGHT, WipeDirection.LEFT, WipeDirection.UP или WipeDirection.DOWN.
Значением по умолчанию является WipeDirection.RIGHT.
Связанные элементы API
Сведения о конструкторе
Wipe | () | Конструктор |
Примеры Использование этого примера
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>
Tue Jun 12 2018, 11:34 AM Z