Packageru.antkarlov.anthill
Classpublic class AntMask
InheritanceAntMask Inheritance AntBasic Inheritance Object

Language Version : ActionScript 3
Since : 26.02.2013
Runtime Versions : AIR 1.0, Flash Player 9.0.0

Анимированная маска которая может быть применена к любой сущности.

Работа с маской очень похожа на работу с актером. Для маски подходят точно такие же анимации как и для актеров. При использовании анимации прозрачные области кадров считаются как не прозрачные, а непрозрачные области являются своеобразным окном в которое можно видеть что находится под маской.



Public Properties
 PropertyDefined By
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
  animationSpeed : Number
Скорость воспроизведения анимации.
AntMask
  backgroundColor : uint
Цвет которым будет заливаться буфер маски.
AntMask
  buffer : BitmapData
AntMask
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
  currentAnimation : String
[read-only] Возвращает имя текущей анимации.
AntMask
  currentFrame : Number
Номер текущего кадра с учетом скорости анимации.
AntMask
  eventComplete : AntSignal
Событие срабатывающее по окончанию проигрывания анимации.
AntMask
 Inheritedexists : Boolean
Определеяет существование объекта.
AntBasic
  fillBackground : Boolean
Флаг определяющий следует ли выполнять заливку буфера маски.
AntMask
  globalX : Number
Глобальная позиция маски по X в игровом мире с учетом положения сущности к которой применена маска.
AntMask
  globalY : Number
Глобальная позиция маски по Y в игровом мире с учетом положения сущности к которой применена маска.
AntMask
  height : int
Размер маски по высоте, зависит от размера текущего кадра анимации.
AntMask
  isPlaying : Boolean
[read-only] Определяет проигрывается ли анимация.
AntMask
 InheritedNUM_OF_ACTIVE : int = 0
[static] Используется для автоматического подсчета активных объектов.
AntBasic
 InheritedNUM_OF_VISIBLE : int = 0
[static] Используется для автоматического подсчета видимых объектов.
AntBasic
 InheritedNUM_ON_SCREEN : int = 0
[static] Используется для автоматического подсчета количества объектов видимых камерами.
AntBasic
  origin : AntPoint
Осевая точка маски.
AntMask
  repeat : Boolean
Зациклинность воспроизведения анимации.
AntMask
  reverse : Boolean
Проигрывание анимации в обратном порядке.
AntMask
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
  totalFrames : int
Общее количество кадров для текущей анимации.
AntMask
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
 Inheritedvisible : Boolean
Определяет видимость объекта.
AntBasic
  width : int
Размер маски по ширине, зависит от размера текущего кадра анимации.
AntMask
  x : Number
Положение маски по X относительно сущности к которой она применена.
AntMask
  y : Number
Положение маски по Y относительно сущности к которой она применена.
AntMask
Protected Properties
 PropertyDefined By
  _animations : AntStorage
AntMask
  _backendBuffer : BitmapData
AntMask
  _curAnim : AntAnimation
AntMask
  _curAnimName : String
AntMask
  _flashPointTarget : Point
AntMask
  _flashPointZero : Point
AntMask
  _flashRect : Rectangle
AntMask
  _pixels : BitmapData
AntMask
  _playing : Boolean
AntMask
  _prevFrame : int
AntMask
Public Methods
 MethodDefined By
  
AntMask
  
addAnimation(aAnim:AntAnimation, aName:String = null, aSwitch:Boolean = true):void
Добавляет новую анимацию.
AntMask
  
addAnimationFromCache(aKey:String, aName:String = null, aSwitch:Boolean = true):void
Добавляет новую анимацию из кэша анимаций.
AntMask
  
Удаляет все анимации из актера.
AntMask
 Inherited
debugDraw(aCamera:AntCamera):void
Отладочная отрисовка.
AntBasic
  
destroy():void
[override] Используется для уничтожения объекта и освобождения занимаемых им ресурсов.
AntMask
 Inherited
draw(aCamera:AntCamera):void
Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntBasic
  
drawTo(aTarget:BitmapData):void
Применяет альфа канал к буферу маски и выполняет отрисовку содержимого буфера в указанный битмап.
AntMask
  
gotoAndPlay(aFrame:Number):void
Переводит текущую анимацию актера на указанный кадр и запускает воспроизведение.
AntMask
  
gotoAndStop(aFrame:Number):void
Переводит текущую анимацию на указанный кадр и останавливает воспроизведение.
AntMask
 Inherited
kill():void
Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntBasic
  
nextFrame(aUseSpeed:Boolean = false):void
Выполняет переход к следущему кадру текущей анимации.
AntMask
  
play():void
Запускает воспроизведение текущией анимации.
AntMask
  
Запускает воспроизведение текущей анимации со случайного кадра.
AntMask
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
 Inherited
preUpdate():void
Вызывается каждый кадр перед вызовом метода update().
AntBasic
  
prevFrame(aUseSpeed:Boolean = false):void
Выполняет переход к предыдущему кадру текущей анимации.
AntMask
  
removeAnimation(aName:String):void
Удаляет анимацию с указанным именем.
AntMask
 Inherited
revive():void
Воскрешает объект после "убийства" для повторного использования.
AntBasic
  
stop():void
Останавливает воспроизведение текущей анимации.
AntMask
  
switchAnimation(aName:String):void
Переключение анимации.
AntMask
  
update():void
[override] Вызывается каждый кадр.
AntMask
  
updatePosition(aParent:AntEntity, aCamera:AntCamera):void
Обновляет позицию маски с учетом родительской сущности и текущей камеры.
AntMask
Protected Methods
 MethodDefined By
  
Выполняется когда цикл проигрывания текущей анимации завершен.
AntMask
  
calcFrame(aFrame:int = 0):void
Перерасчет текущего кадра.
AntMask
  
goto(aFrame:Number):void
Переводит текущую анимацию на указанный кадр.
AntMask
  
Сброс внутренних помошников.
AntMask
  
Обновление текущей анимации.
AntMask
Property Detail
_animationsproperty
protected var _animations:AntStorage

_backendBufferproperty 
protected var _backendBuffer:BitmapData

_curAnimproperty 
protected var _curAnim:AntAnimation

_curAnimNameproperty 
protected var _curAnimName:String

_flashPointTargetproperty 
protected var _flashPointTarget:Point

_flashPointZeroproperty 
protected var _flashPointZero:Point

_flashRectproperty 
protected var _flashRect:Rectangle

_pixelsproperty 
protected var _pixels:BitmapData

_playingproperty 
protected var _playing:Boolean

_prevFrameproperty 
protected var _prevFrame:int

animationSpeedproperty 
public var animationSpeed:Number

Скорость воспроизведения анимации.

The default value is 1.

backgroundColorproperty 
public var backgroundColor:uint

Цвет которым будет заливаться буфер маски.

The default value is 0xFF000000.

bufferproperty 
public var buffer:BitmapData

currentAnimationproperty 
currentAnimation:String  [read-only]

Возвращает имя текущей анимации.


Implementation
    public function get currentAnimation():String
currentFrameproperty 
public var currentFrame:Number

Номер текущего кадра с учетом скорости анимации. Значение может быть дробным.

The default value is 1.

eventCompleteproperty 
public var eventComplete:AntSignal

Событие срабатывающее по окончанию проигрывания анимации. Добавляемый метод должен иметь аргумент типа function onComplete(actor:AntActor):void {}

fillBackgroundproperty 
public var fillBackground:Boolean

Флаг определяющий следует ли выполнять заливку буфера маски.

The default value is false.

globalXproperty 
public var globalX:Number

Глобальная позиция маски по X в игровом мире с учетом положения сущности к которой применена маска.

The default value is 0.

globalYproperty 
public var globalY:Number

Глобальная позиция маски по Y в игровом мире с учетом положения сущности к которой применена маска.

The default value is 0.

heightproperty 
public var height:int

Размер маски по высоте, зависит от размера текущего кадра анимации.

The default value is 0.

isPlayingproperty 
isPlaying:Boolean  [read-only]

Определяет проигрывается ли анимация.


Implementation
    public function get isPlaying():Boolean
originproperty 
public var origin:AntPoint

Осевая точка маски.

The default value is (0,0).

repeatproperty 
public var repeat:Boolean

Зациклинность воспроизведения анимации.

The default value is true.

reverseproperty 
public var reverse:Boolean

Проигрывание анимации в обратном порядке.

The default value is false.

totalFramesproperty 
public var totalFrames:int

Общее количество кадров для текущей анимации.

The default value is 1.

widthproperty 
public var width:int

Размер маски по ширине, зависит от размера текущего кадра анимации.

The default value is 0.

xproperty 
public var x:Number

Положение маски по X относительно сущности к которой она применена.

The default value is 0.

yproperty 
public var y:Number

Положение маски по Y относительно сущности к которой она применена.

The default value is 0.

Constructor Detail
AntMask()Constructor
public function AntMask()

Method Detail
addAnimation()method
public function addAnimation(aAnim:AntAnimation, aName:String = null, aSwitch:Boolean = true):void

Добавляет новую анимацию. Если локальное имя анимации не указано, то добавленная анимация будет доступна по глобальному имени.

Parameters

aAnim:AntAnimation — Анимация которую необходимо добавить.
 
aName:String (default = null) — Локальное имя анимации по которому можно будет произвести переключение на эту анимацию.
 
aSwitch:Boolean (default = true) — Переключение на добавленную анимацию.

addAnimationFromCache()method 
public function addAnimationFromCache(aKey:String, aName:String = null, aSwitch:Boolean = true):void

Добавляет новую анимацию из кэша анимаций. Если локальное имя анимации не указано, то добавленная анимация будет доступна по глобальному имени.

Parameters

aKey:String — Имя анимации в кэше которую необходимо добавить.
 
aName:String (default = null) — Локальное имя анимации по которому можно будет произвести переключение на эту анимацию.
 
aSwitch:Boolean (default = true) — Переключение на добавленную анимацию.

animComplete()method 
protected function animComplete():void

Выполняется когда цикл проигрывания текущей анимации завершен.

calcFrame()method 
protected function calcFrame(aFrame:int = 0):void

Перерасчет текущего кадра.

Parameters

aFrame:int (default = 0)

clearAnimations()method 
public function clearAnimations():void

Удаляет все анимации из актера.

destroy()method 
override public function destroy():void

Используется для уничтожения объекта и освобождения занимаемых им ресурсов. Перекройте этот метод чтобы корректно освобождать используемые ресурсы при уничтожении объекта.

drawTo()method 
public function drawTo(aTarget:BitmapData):void

Применяет альфа канал к буферу маски и выполняет отрисовку содержимого буфера в указанный битмап.

Parameters

aTarget:BitmapData — Битмап в который будет отрисовано содержимое буфера маски.

goto()method 
protected function goto(aFrame:Number):void

Переводит текущую анимацию на указанный кадр.

Parameters

aFrame:Number — Кадр на который необходимо перевести текущую анимацию.

gotoAndPlay()method 
public function gotoAndPlay(aFrame:Number):void

Переводит текущую анимацию актера на указанный кадр и запускает воспроизведение.

Parameters

aFrame:Number — Номер кадра на который необходимо перевести текущую анимацию.

gotoAndStop()method 
public function gotoAndStop(aFrame:Number):void

Переводит текущую анимацию на указанный кадр и останавливает воспроизведение.

Parameters

aFrame:Number — Номер кадра на который необходимо перевести текущую анимацию.

nextFrame()method 
public function nextFrame(aUseSpeed:Boolean = false):void

Выполняет переход к следущему кадру текущей анимации.

Parameters

aUseSpeed:Boolean (default = false) — Флаг определяющий следует ли при переходе к следущему кадру использовать скорость анимации.

play()method 
public function play():void

Запускает воспроизведение текущией анимации.

playRandomFrame()method 
public function playRandomFrame():void

Запускает воспроизведение текущей анимации со случайного кадра.

prevFrame()method 
public function prevFrame(aUseSpeed:Boolean = false):void

Выполняет переход к предыдущему кадру текущей анимации.

Parameters

aUseSpeed:Boolean (default = false) — Флаг определяющий следует ли при переходе к предыдущему кадру использовать скорость анимации.

removeAnimation()method 
public function removeAnimation(aName:String):void

Удаляет анимацию с указанным именем.

Parameters

aName:String — Локальное имя анимации которую необходимо удалить.

resetHelpers()method 
protected function resetHelpers():void

Сброс внутренних помошников.

stop()method 
public function stop():void

Останавливает воспроизведение текущей анимации.

switchAnimation()method 
public function switchAnimation(aName:String):void

Переключение анимации.

Parameters

aName:String — Локальное имя анимации на которую следует переключится.

update()method 
override public function update():void

Вызывается каждый кадр.

updateAnimation()method 
protected function updateAnimation():void

Обновление текущей анимации.

updatePosition()method 
public function updatePosition(aParent:AntEntity, aCamera:AntCamera):void

Обновляет позицию маски с учетом родительской сущности и текущей камеры.

Parameters

aParent:AntEntity — Указатель на сущность для которой применена маска.
 
aCamera:AntCamera — Текущая камера.