| Пакет | mx.effects.effectClasses |
| Класс | public class MaskEffectInstance |
| Наследование | MaskEffectInstance  EffectInstance EventDispatcher Object |
| Подклассы | IrisInstance, WipeDownInstance, WipeLeftInstance, WipeRightInstance, WipeUpInstance |
| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Каждый класс эффекта, являющийся подклассом класса TweenEffect, поддерживает следующие события:
-
tweenEnd: передается по завершении эффекта Tween. -
tweenUpdate: передается при каждом вычислении классом TweenEffect нового значения.
Объект события, передаваемый в средство прослушивания этих событий, имеет тип TweenEvent. Класс TweenEvent определяет свойство value, которое содержит значение Tween, вычисленное эффектом. Для эффекта Mask свойство TweenEvent.value содержит массив из 4 элементов, где:
- value[0]:Number является значением свойства
xцелевого объекта; - value[1]:Number является значением свойства
yцелевого объекта; - value[2]:Number является значением свойства
scaleXцелевого объекта; - value[3]:Number является значением свойства
scaleYцелевого объекта.
Связанные элементы API
Скрыть унаследованные общедоступные свойства
Показать унаследованные общедоступные свойства| Свойство | Определено | ||
|---|---|---|---|
 | className : String [только для чтения]
Имя класса эффекта, например FadeInstance. | EffectInstance | |
| constructor : Object
Ссылка на объект класса или функцию конструктора для данного экземпляра объекта. | Object | |
| createMaskFunction : Function
Функция, вызываемая при создании маски путем реализации эффекта. | MaskEffectInstance | ||
| duration : Number
Продолжительность эффекта, в миллисекундах. | EffectInstance | |
| effect : IEffect
Объект IEffect, создавший данный объект IEffectInstance. | EffectInstance | |
| effectTargetHost : mx.effects:IEffectTargetHost
Свойства, позволяющие получить доступ к целевому элементу управления на основе списка для эффекта данных. | EffectInstance | |
| hideFocusRing : Boolean
Определяет, должен ли эффект скрыть кольцо фокуса при запуске. | EffectInstance | |
| moveEasingFunction : Function
Функция замедления, используемая для перемещения маски. | MaskEffectInstance | ||
| playheadTime : Number
Текущая позиция эффекта. | EffectInstance | |
| propertyChanges : PropertyChanges
Указывает объект PropertyChanges, содержащий начальные и конечные значения для набора свойств, относящихся к целевым объектам эффекта. | EffectInstance | |
| repeatCount : int
Число повторов эффекта. | EffectInstance | |
| repeatDelay : int
Время ожидания (в миллисекундах) перед повторением эффекта. | EffectInstance | |
| scaleEasingFunction : Function
Функция замедления, используемая для масштабирования маски. | MaskEffectInstance | ||
| scaleXFrom : Number
Начальное значение scaleX для маски. | MaskEffectInstance | ||
| scaleXTo : Number
Конечное значение scaleX для маски. | MaskEffectInstance | ||
| scaleYFrom : Number
Начальное значение scaleY для маски. | MaskEffectInstance | ||
| scaleYTo : Number
Конечное значение scaleY для маски. | MaskEffectInstance | ||
| showTarget : Boolean
Указывает, что целевой компонент становится видимым (false) или невидимым (true). | MaskEffectInstance | ||
| startDelay : int
Время ожидания (в миллисекундах) перед запуском эффекта. | EffectInstance | |
| suspendBackgroundProcessing : Boolean
Если значение равно true, блокирует всю фоновую обработку во время воспроизведения эффекта. | EffectInstance | |
| target : Object
Объект UIComponent, к которому применяется данный эффект. | EffectInstance | |
| targetArea : Rectangle
Область применения маски для целевого объекта. | MaskEffectInstance | ||
| triggerEvent : Event
Событие (при наличии), запускающее воспроизведение эффекта. | EffectInstance | |
| xFrom : Number
Координата х начальной позиции для маски. | MaskEffectInstance | ||
| xTo : Number
Координата х целевой позиции для маски. | MaskEffectInstance | ||
| yFrom : Number
Координата у начальной позиции для маски. | MaskEffectInstance | ||
| yTo : Number
Координата у целевой позиции для маски. | MaskEffectInstance | ||
| Свойство | Определено | ||
|---|---|---|---|
| effectMask : Shape
Содержит маску эффекта: либо маску по умолчанию, создаваемую методом defaultCreateMask(), либо маску, определяемую функцией, переданной в свойство createMaskFunction. | MaskEffectInstance | ||
| playCount : int = 0
Число воспроизведений экземпляра. | EffectInstance | |
| targetVisualBounds : Rectangle
Фактический размер целевого объекта эффекта, включая тени. | MaskEffectInstance | ||
| Метод | Определено | ||
|---|---|---|---|
MaskEffectInstance(target:Object)
Конструктор. | MaskEffectInstance | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Регистрирует объект прослушивателя события на объекте EventDispatcher для получения прослушивателем уведомления о событии. | EventDispatcher | |
|
Посылает событие в поток событий. | EventDispatcher | |
|
Прерывает экземпляр эффекта, воспроизводящийся в настоящее время, и осуществляет немедленный переход в конец эффекта. | EffectInstance | |
|
Вызывается методом end() по завершении воспроизведения эффекта. | EffectInstance | |
|
Вызывается после завершения воспроизведения повторяющегося эффекта при каждой итерации. | EffectInstance | |
|
Проверяет, имеет ли объект EventDispatcher прослушиватели, зарегистрированные для определенного типа события. | EventDispatcher | |
|
Показывает, определено ли заданное свойство для объекта. | Object | |
|
Этот метод вызывается в случае запуска эффекта посредством EffectManager. | EffectInstance | |
|
Показывает, есть ли экземпляр класса Object в цепи прототипов объекта, заданного в качестве параметра. | Object | |
[переопределить]
Приостанавливает эффект до вызова метода resume(). | MaskEffectInstance | ||
|
Воспроизводит экземпляр эффекта для целевого объекта. | EffectInstance | |
|
Показывает наличие заданного свойства и его перечисляемость. | Object | |
|
Удаляет прослушиватель из объекта EventDispatcher. | EventDispatcher | |
[переопределить]
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause(). | MaskEffectInstance | ||
[переопределить]
Воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта. | MaskEffectInstance | ||
|
Задает доступность динамического свойства для операций цикла. | Object | |
|
Воспроизводит экземпляр эффекта для целевого объекта после истечения периода startDelay. | EffectInstance | |
|
Останавливает эффект, оставляя целевой объект в текущем состоянии. | EffectInstance | |
|
Возвращает строковое представление этого объекта, отформатированного в соответствии со стандартами, принятыми для данной локали. | Object | |
|
Возвращает строковое представление заданного объекта. | Object | |
|
Возвращает элементарное значение заданного объекта. | Object | |
|
Проверяет, зарегистрирован ли прослушиватель события для указанного типа события с данным объектом EventDispatcher или любым его предшественником. | EventDispatcher | |
| Метод | Определено | ||
|---|---|---|---|
Создает маску по умолчанию для данного эффекта. | MaskEffectInstance | ||
Инициализирует свойства move и scale данного эффекта. | MaskEffectInstance | ||
Метод обратного вызова, который вызывается при последнем обновлении позиций x и y маски в рамках реализации эффекта. | MaskEffectInstance | ||
Метод обратного вызова, который вызывается при обновлении позиций x и y маски в рамках реализации эффекта. | MaskEffectInstance | ||
Метод обратного вызова, который вызывается при последнем обновлении свойств scaleX и scaleY маски в рамках реализации эффекта. | MaskEffectInstance | ||
Метод обратного вызова, который вызывается при обновлении свойств scaleX и scaleY маски в рамках реализации эффекта. | MaskEffectInstance | ||
createMaskFunction | свойство |
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 Shape();
// Create mask.
return myMask;
}
Следует установить это свойство для имени функции, как показано в примере для эффекта WipeLeft:
<mx:WipeLeft id="showWL" createMaskFunction="createLargeMask" showTarget="false"/>
Реализация
public function get createMaskFunction():Function public function set createMaskFunction(value:Function):voideffectMask | свойство |
protected var effectMask:Shape| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Содержит маску эффекта: либо маску по умолчанию, создаваемую методом defaultCreateMask(), либо маску, определяемую функцией, переданной в свойство createMaskFunction.
moveEasingFunction | свойство |
public var moveEasingFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция замедления, используемая для перемещения маски.
scaleEasingFunction | свойство |
public var scaleEasingFunction:Function| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Функция замедления, используемая для масштабирования маски.
scaleXFrom | свойство |
public var scaleXFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начальное значение scaleX для маски.
scaleXTo | свойство |
public var scaleXTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конечное значение scaleX для маски.
scaleYFrom | свойство |
public var scaleYFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Начальное значение scaleY для маски.
scaleYTo | свойство |
public var scaleYTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Конечное значение scaleY для маски.
showTarget | свойство |
showTarget:Boolean| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Указывает, что целевой компонент становится видимым (false) или невидимым (true).
Значением по умолчанию является true.
Реализация
public function get showTarget():Boolean public function set showTarget(value:Boolean):voidtargetArea | свойство |
public var targetArea:Rectangle| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Область применения маски для целевого объекта. Размеры указываются относительно самого целевого объекта. По умолчанию область, которая совпадает с целевым объектом, создается следующим образом: new Rectangle(0, 0, target.width, target.height);
targetVisualBounds | свойство |
protected var targetVisualBounds:Rectangle| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Фактический размер целевого объекта эффекта, включая тени. Значение этого свойства вычисляется в приложении Flex; устанавливать его самостоятельно не требуется.
xFrom | свойство |
public var xFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата х начальной позиции для маски.
xTo | свойство |
public var xTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата х целевой позиции для маски.
yFrom | свойство |
public var yFrom:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата у начальной позиции для маски.
yTo | свойство |
public var yTo:Number| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Координата у целевой позиции для маски.
MaskEffectInstance | () | Конструктор |
defaultCreateMask | () | метод |
protected function defaultCreateMask(targ:Object, bounds:Rectangle):Shape| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Создает маску по умолчанию для данного эффекта.
Параметры
targ:Object — Целевой объект эффекта.
| |
bounds:Rectangle — Фактические визуальные пределы целевого объекта, включая тени.
|
Shape — Объект Shape, определяющий маску.
|
initMaskEffect | () | метод |
protected function initMaskEffect():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Инициализирует свойства move и scale данного эффекта. Все подклассы должны отменять эту функцию. Flex вызывает ее после создания эффекта маски, но перед созданием эффекта анимации.
onMoveTweenEnd | () | метод |
protected function onMoveTweenEnd(value:Object):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Метод обратного вызова, который вызывается при последнем обновлении позиций x и y маски в рамках реализации эффекта. Этот метод не вызывается напрямую. Этот метод реализует метод суперкласса.
Параметры
value:Object — Содержит последние значения x и y для позиции маски, где value[0] содержит позицию x маски, и value[1] содержит позицию y.
|
onMoveTweenUpdate | () | метод |
protected function onMoveTweenUpdate(value:Object):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Метод обратного вызова, который вызывается при обновлении позиций x и y маски в рамках реализации эффекта. Этот метод не вызывается напрямую. Этот метод реализует метод суперкласса.
Параметры
value:Object — Содержит интерполированные значения x и y для позиции маски, где value[0] содержит новую позицию x маски, и value[1] содержит новую позицию y.
|
onScaleTweenEnd | () | метод |
protected function onScaleTweenEnd(value:Object):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Метод обратного вызова, который вызывается при последнем обновлении свойств scaleX и scaleY маски в рамках реализации эффекта. Этот метод не вызывается напрямую. Этот метод реализует метод суперкласса.
Параметры
value:Object — Содержит последние значения scaleX и scaleY для маски, где value[0] содержит значение scaleX маски, и value[1] содержит значение scaleY.
|
onScaleTweenUpdate | () | метод |
protected function onScaleTweenUpdate(value:Object):void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Метод обратного вызова, который вызывается при обновлении свойств scaleX и scaleY маски в рамках реализации эффекта. Этот метод не вызывается напрямую. Этот метод реализует метод суперкласса.
Параметры
value:Object — Содержит интерполированные значения scaleX и scaleY для маски, где value[0] содержит новое значение scaleX маски, и value[1] содержит новое значение scaleY.
|
pause | () | метод |
override public function pause():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Приостанавливает эффект до вызова метода resume().
resume | () | метод |
override public function resume():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Продолжает воспроизведение эффекта после установки паузы путем вызова метода pause().
reverse | () | метод |
override public function reverse():void| Язык версии: | ActionScript 3.0 |
| Версия продукта: | Flex 3 |
| Версии среды выполнения: | Flash Player 9, AIR 1.1 |
Воспроизводит эффект в обратном порядке, начиная с текущей позиции эффекта.
Tue Jun 12 2018, 11:34 AM Z