| Пакет | mx.effects |
| Класс | public class MaskEffect |
| Наследование | MaskEffect  Effect EventDispatcher Object |
| Подклассы | Iris, WipeDown, WipeLeft, WipeRight, WipeUp |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Эффект маски для применения эффекта использует перекрытие, называемое маской. По умолчанию маска представляет собой прямоугольник того же размера, что и целевой компонент.
Начальное или конечное состояние целевого компонента эффекта маски должно быть невидимым. Это означает, что эффект маски всегда приводит к появлению на экране или исчезновению с экрана целевого компонента.
Свойства scaleXFrom, scaleYFrom, scaleXTo и scaleX используются для указания начального и конечного масштаба маски, где значение 1,0 обозначает масштабирование маски в соответствии с размером целевого компонента, 2,0 –масштабирование в соответствии с удвоенным размером компонента, 0,5 –масштабирование в соответствии с половинным размером и т. д. Для использования какого-либо из этих свойств необходимо указать все четыре свойства.
Свойства xFrom, yFrom, xTo и yTo используются для указания координат начального и конечного положения маски относительно целевого компонента, где (0, 0) соответствует верхнему левому углу целевого компонента. Для использования какого-либо из этих свойств необходимо указать все четыре свойства.
Координаты начального и конечного положения маски зависят от типа эффекта и значения свойства show (true или false). Например, для эффекта WipeLeft и свойства show со значением false координаты начального положения маски равны (0, 0), что соответствует верхнему левому углу целевого компонента, а координаты конечного положения соответствуют верхнему правому углу целевого компонента и равны (width, 0), где width – ширина целевого компонента.
Для свойства show со значением true при применении эффекта WipeLeft координаты начального положения маски равны (width, 0), а координаты конечного положения равны (0, 0).
Показать синтаксис MXML
Скрыть синтаксис MXMLThe MaskEffect class defines the following properties, which all of its subclasses inherit:
<mx:tagname
createMaskFunction=""
moveEasingFunction=""
scaleEasingFunction=""
scaleXFrom=""
scaleXTo=""
scaleYFrom=""
scaleYTo=""
show="true|false"
xFrom=""
xTo=""
yFrom=""
yTo=""
/>
Связанные элементы API
| Свойство | Определено | ||
|---|---|---|---|
 | className : String [только для чтения]
Имя класса эффекта, например Fade. | Effect | |
| constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| createMaskFunction : Function
Функция, вызываемая при создании маски путем реализации эффекта. | MaskEffect | ||
| customFilter : mx.effects:EffectTargetFilter
Указывает пользовательский объект фильтра типа EffectTargetFilter, используемый эффектом для определения целевых объектов, для которых должен воспроизводиться эффект. | Effect | |
| duration : Number
Продолжительность эффекта в миллисекундах. | Effect | |
| effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. | Effect | |
| filter : String
Указывает алгоритм фильтрации целевых объектов для эффекта. | Effect | |
| hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. | Effect | |
| instanceClass : Class
Объект типа Class, указывающий класс класса экземпляра эффекта для данного класса эффекта. | Effect | |
| isPlaying : Boolean [только для чтения]
Флаг только для чтения, принимающий значение true, если какой-либо экземпляр эффекта воспроизводится в настоящее время, и false в противном случае. | Effect | |
| moveEasingFunction : Function
Функция замедления, используемая для перемещения маски. | MaskEffect | ||
| perElementOffset : Number
Дополнительная задержка (в миллисекундах) для целевых объектов эффекта, обрабатываемых после первого целевого объекта эффекта. | Effect | |
| playheadTime : Number
Текущая позиция эффекта. | Effect | |
| relevantProperties : Array
Массив имен свойств, используемых при выполнении фильтрации. | Effect | |
| relevantStyles : Array
Массив имен стилей, используемых при выполнении фильтрации. | Effect | |
| repeatCount : int = 1
Число повторов эффекта. | Effect | |
| repeatDelay : int = 0
Время ожидания (в миллисекундах) перед повторением эффекта. | Effect | |
| scaleEasingFunction : Function
Функция замедления, используемая для масштабирования маски. | MaskEffect | ||
| scaleXFrom : Number
Начальное значение scaleX для маски. | MaskEffect | ||
| scaleXTo : Number
Конечное значение scaleX для маски. | MaskEffect | ||
| scaleYFrom : Number
Начальное значение scaleY для маски. | MaskEffect | ||
| scaleYTo : Number
Конечное значение scaleY для маски. | MaskEffect | ||
| showTarget : Boolean
Указывает, что целевой компонент становится видимым (true) или невидимым (false). | MaskEffect | ||
| startDelay : int = 0
Время ожидания (в миллисекундах) перед запуском эффекта. | Effect | |
| suspendBackgroundProcessing : Boolean = false
Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта. | Effect | |
| target : Object
Объект, к которому применяется данный эффект. | Effect | |
| targets : Array
Массив объектов, являющихся целевыми объектами эффекта. | Effect | |
| triggerEvent : Event
Объект Event, переданный в Effect с помощью EffectManager при запуске эффекта, или null, если эффект воспроизводится без EffectManager. | Effect | |
| xFrom : Number
Координата х начальной позиции для маски. | MaskEffect | ||
| xTo : Number
Координата х целевой позиции для маски. | MaskEffect | ||
| yFrom : Number
Координата у начальной позиции для маски. | MaskEffect | ||
| yTo : Number
Координата у целевой позиции для маски. | MaskEffect | ||
| Метод | Определено | ||
|---|---|---|---|
MaskEffect(target:Object = null)
Конструктор. | MaskEffect | ||
| 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 | |
[переопределить]
Возвращает свойства компонентов, измененные данным эффектом. | MaskEffect | ||
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
|
Приостанавливает эффект до вызова метода resume(). | Effect | |
|
Начинает воспроизведение эффекта | Effect | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
|
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause(). | Effect | |
|
Если эффект воспроизводится в настоящее время, воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта. | Effect | |
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Останавливает эффект, оставляя целевые объекты эффекта в текущем состоянии. | Effect | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
| Метод | Определено | ||
|---|---|---|---|
|
Используется внутренне инфраструктурой Effect. | Effect | |
|
Вызывается по завершении воспроизведения экземпляра эффекта. | Effect | |
|
Этот метод вызывается в момент начала воспроизведения эффекта. | Effect | |
|
Вызывается при остановке воспроизведения экземпляра эффекта посредством вызова метода stop(). | Effect | |
|
Определяет логику фильтрации экземпляра эффекта. | Effect | |
|
Вызывается методом captureStartValues() для получения значения свойства целевого объекта. | Effect | |
|
Свойства копий эффекта для экземпляра эффекта. | Effect | |
Вызывается, когда TweenEffect отправляет TweenEvent. | MaskEffect | ||
| Событие | Сводка | Определено | ||
|---|---|---|---|---|
| [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR перемещается в фокус операционной системы и становится активным. | EventDispatcher | ||
| [многоадресное событие] Отправляется, когда проигрыватель Flash Player или приложение AIR теряет фокус системы и становится неактивным. | EventDispatcher | ||
| Отправляется в момент завершения воспроизведения экземпляра эффекта, по завершении воспроизведения экземпляра или при прерывании воспроизведения эффекта посредством вызова метода end(). | Effect | ||
| Отправляется в момент начала воспроизведения эффекта. | Effect | ||
| Отправляется в момент прекращения воспроизведения эффекта, что происходит только в том случае, если воспроизведение эффекта было прервано посредством вызова метода stop(). | Effect | ||
| Отправляется по завершении эффекта. | MaskEffect | |||
| Отправляется при запуске эффекта, что соответствует первому вызову методов onMoveTweenUpdate() и onScaleTweenUpdate(). | MaskEffect | |||
| Передается при каждом обновлении целевого объекта эффектом. | MaskEffect | |||
createMaskFunction | свойство |
public var createMaskFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция, вызываемая при создании маски путем реализации эффекта. Значением по умолчанию является функция, возвращающая объект Rectangle с размерами, совпадающими с размерами целевого объекта.
Пользовательская функция маски имеет следующую подпись:
public function createLargeMask(targ:Object, bounds:Rectangle):Shape
{
var myMask:Shape = new FlexShape();
// Create mask.
return myMask;
}
Пользовательская функция маски принимает первый аргумент, соответствующий целевому компоненту эффекта, и второй аргумент, определяющий размеры цели, что позволяет правильно установить размеры маски. Этот аргумент используется для получения доступа к свойствам целевого компонента, таким как width и height, позволяющим создать маску с правильными размерами.
Функция возвращает отдельный объект Shape, определяющий маску.
moveEasingFunction | свойство |
public var moveEasingFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция замедления, используемая для перемещения маски.
Значением по умолчанию является null.
scaleEasingFunction | свойство |
public var scaleEasingFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция замедления, используемая для масштабирования маски.
Значением по умолчанию является null.
scaleXFrom | свойство |
public var scaleXFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начальное значение scaleX для маски.
Для определения данного свойства необходимо указать все четыре свойства: scaleXFrom, scaleYFrom, scaleXTo и scaleX.
scaleXTo | свойство |
public var scaleXTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конечное значение scaleX для маски.
Для определения данного свойства необходимо указать все четыре свойства: scaleXFrom, scaleYFrom, scaleXTo и scaleX.
scaleYFrom | свойство |
public var scaleYFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начальное значение scaleY для маски.
Для определения данного свойства необходимо указать все четыре свойства: scaleXFrom, scaleYFrom, scaleXTo и scaleX.
scaleYTo | свойство |
public var scaleYTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конечное значение scaleY для маски.
Для определения данного свойства необходимо указать все четыре свойства: scaleXFrom, scaleYFrom, scaleXTo и scaleX.
showTarget | свойство |
showTarget:Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает, что целевой компонент становится видимым (true) или невидимым (false). Если данный эффект указывается для триггера showEffect или hideEffect, Flex присваивает свойству showTarget или значение true, если компонент становится видимым, или значение false, если компонент становится невидимым. Если эффект используется с другими триггерами эффектов, его необходимо установить самостоятельно, как правило, в прослушивателе события startEffect.
Значением по умолчанию является true.
Реализация
public function get showTarget():Boolean public function set showTarget(value:Boolean):voidxFrom | свойство |
public var xFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата х начальной позиции для маски.
Для определения данного свойства необходимо указать все четыре свойства: xFrom, yFrom, xTo и yTo.
xTo | свойство |
public var xTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата х целевой позиции для маски.
Для определения данного свойства необходимо указать все четыре свойства: xFrom, yFrom, xTo и yTo.
yFrom | свойство |
public var yFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата у начальной позиции для маски.
Для определения данного свойства необходимо указать все четыре свойства: xFrom, yFrom, xTo и yTo.
yTo | свойство |
public var yTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата у целевой позиции для маски.
Для определения данного свойства необходимо указать все четыре свойства: xFrom, yFrom, xTo и yTo.
MaskEffect | () | Конструктор |
getAffectedProperties | () | метод |
override public function getAffectedProperties():Array| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Возвращает свойства компонентов, измененные данным эффектом. Этот метод возвращает массив, содержащий: [visible, width, height]. Так как все подклассы эффектов WipeDown, WipeLeft, WipeRight и WipeDown изменяют эти же самые свойства, в соответствующих классах данный метод не реализуются.
Если создается подкласс класса MaskEffect для воспроизведения пользовательского эффекта, и этот подкласс изменяет другой набор свойств целевого объекта, метод следует переопределить и возвратить массив, содержащий список свойств, изменяемых данным подклассом.
ВозвращаетArray — Массив строк, указывающий имена свойств, измененных данным эффектом.
|
Связанные элементы API
tweenEventHandler | () | метод |
protected function tweenEventHandler(event:mx.events:TweenEvent):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Вызывается, когда TweenEffect отправляет TweenEvent. В случае переопределения данного метода следует убедиться, что вызывается вышестоящий метод.
Параметры
event:mx.events:TweenEvent — Объект события типа TweenEvent.
|
tweenEnd | Событие |
mx.events.TweenEventсвойство TweenEvent.type =
mx.events.TweenEvent.TWEEN_END| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется по завершении эффекта.
После однократного воспроизведения эффекта данное событие происходит одновременно с событием effectEnd. Если эффект повторяющийся, оно происходит в конце каждого повторения эффекта, а событие endEffect происходит после последнего воспроизведения эффекта.
TweenEvent.TWEEN_END определяет значение свойства type объекта события tweenEnd.
Свойства объекта события имеют следующие значения:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
value | Значение, передаваемое в метод onTweenEnd(). |
tweenStart | Событие |
mx.events.TweenEventсвойство TweenEvent.type =
mx.events.TweenEvent.TWEEN_START| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Отправляется при запуске эффекта, что соответствует первому вызову методов onMoveTweenUpdate() и onScaleTweenUpdate(). Одновременно Flex также отправляет первое событие tweenUpdate для эффекта.
Событие Effect.effectStart отправляется перед событием tweenStart.
TweenEvent.TWEEN_START определяет значение свойства type объекта события tweenStart.
Свойства объекта события имеют следующие значения:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
value | Значение, передаваемое в метод onTweenUpdate(). |
tweenUpdate | Событие |
mx.events.TweenEventсвойство TweenEvent.type =
mx.events.TweenEvent.TWEEN_UPDATE| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Передается при каждом обновлении целевого объекта эффектом. Отправка данного события соответствует вызовам методов onMoveTweenUpdate() и onScaleTweenUpdate().
TweenEvent.TWEEN_UPDATE определяет значение свойства type объекта события tweenUpdate.
Свойства объекта события имеют следующие значения:
| Свойство | Значение |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | Объект, определяющий прослушиватель события, который выполняет обработку события. Например, если используется myButton.addEventListener() для регистрации прослушивателя события, значением currentTarget является myButton. |
target | Объект, отправивший событие. Это не всегда тот объект, который прослушивает событие. Свойство currentTarget всегда используется для получения доступа к объекту, прослушивающему событие. |
value | Значение, передаваемое в метод onTweenUpdate(). |
Tue Jun 12 2018, 11:34 AM Z