Packageru.antkarlov.anthill
Classpublic class AntCamera
InheritanceAntCamera Inheritance AntBasic Inheritance Object

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

Реализует рендеринг всех визуальных сущностей.

Чтобы реализовать перемещение камеры (скролл уровней), используйте атрибут scroll для перемещения камеры в игровом мире.



Public Properties
 PropertyDefined By
 Inheritedactive : Boolean
Определяет активность объекта.
AntBasic
 Inheritedalive : Boolean
Определяет "живой" объект или нет.
AntBasic
 InheritedallowDebugDraw : Boolean
Определяет следует ли для объекта выполнять отладочную отрисовку.
AntBasic
  backgroundColor : uint
Цвет заливки.
AntCamera
  bounds : AntRect
Прямоугольник задающий границы для перемещения камеры.
AntCamera
  buffer : BitmapData
Основной буфер камеры куда производится отрисовка всех визуальных объектов.
AntCamera
 Inheritedcameras : Array
Указатель на массив камер AntG.cameras.
AntBasic
 Inheritedexists : Boolean
Определеяет существование объекта.
AntBasic
  fillBackground : Boolean
Флаг определяющий следует ли выполнять заливку цветом в буфер камеры перед рендером объектов.
AntCamera
  _flashSprite : Sprite
AntCamera
  followStyle : uint
Стиль слежения за объектом.
AntCamera
  height : int
Размер окна камеры по высоте.
AntCamera
  _isMasked : Boolean
AntCamera
  leadingFactor : Number
Фактор опережения камеры при движении за целью.
AntCamera
  _maskOffset : AntPoint
AntCamera
 InheritedNUM_OF_ACTIVE : int = 0
[static] Используется для автоматического подсчета активных объектов.
AntBasic
 InheritedNUM_OF_VISIBLE : int = 0
[static] Используется для автоматического подсчета видимых объектов.
AntBasic
 InheritedNUM_ON_SCREEN : int = 0
[static] Используется для автоматического подсчета количества объектов видимых камерами.
AntBasic
  positionPropertyX : String
Свойство цели для преследования которое используется для определения его позиции по X.
AntCamera
  positionPropertyY : String
Свойство цели для преследования которое используется для определения его позиции по Y.
AntCamera
  roundPosition : Boolean
Определяет следует ли при преследовании цели округлять координаты камеры.
AntCamera
  screenCenter : AntPoint
Центр экрана.
AntCamera
  screenSprite : Sprite
[read-only] Возвращает указатель на Sprite камеры.
AntCamera
  scroll : AntPoint
Содержит смещение камеры относительно игрового мира.
AntCamera
  smoothFactor : Number
Фактор отставания камеры при движении за целью.
AntCamera
  smoothing : Boolean
Определяет сглаживание для буфера камеры.
AntCamera
 Inheritedtag : int
Любое пользовательское значение которое может идентифицировать объект.
AntBasic
  target : AntEntity
Цель которую приследует камера.
AntCamera
 InheriteduserData : Object
Указатель на любые пользовательские данные.
AntBasic
 Inheritedvisible : Boolean
Определяет видимость объекта.
AntBasic
  width : int
Размер окна камеры по ширине.
AntCamera
  x : Number
Положение камеры на экране Flash окна по X.
AntCamera
  y : Number
Положение камеры на экране Flash окна по Y.
AntCamera
  zoom : Number
Определяет уровень приближения камеры.
AntCamera
  zoomStyle : String
Определяет тип приближения камеры.
AntCamera
Protected Properties
 PropertyDefined By
  _flashBitmap : Bitmap
Битмап для вывода буффера камеры на экран стандартными средствами Flash.
AntCamera
  _flashRect : Rectangle
Помшник для заливки буфера камеры цветом.
AntCamera
  _isShake : Boolean
AntCamera
  _newPos : AntPoint
Помошник для рассчета новой позиции камеры.
AntCamera
  _shakePos : AntPoint
AntCamera
  _shaker : Vector.<AntPoint>
AntCamera
  _shakerDelay : Number
AntCamera
  _shakerIndex : int
AntCamera
  _zoom : Number
Фактор увеличения изображения.
AntCamera
Public Methods
 MethodDefined By
  
AntCamera(aX:Number, aY:Number, aWidth:int, aHeight:int, aZoom:Number = 1)
AntCamera
  
Определяет начало отрисовки сущности использующей маску.
AntCamera
 Inherited
debugDraw(aCamera:AntCamera):void
Отладочная отрисовка.
AntBasic
  
destroy():void
[override] Уничтожает экземпляр камеры и осовобождает память.
AntCamera
 Inherited
draw(aCamera:AntCamera):void
Вызывается каждый кадр после вызова метода postUpdate() для отрисовки объекта.
AntBasic
  
endDrawMask(aMask:AntMask):void
Определяет окончание отрисовки сущности использующей маску.
AntCamera
  
focusOn(aX:Number, aY:Number):void
Моментальное перемещение камеры к указанным координатам.
AntCamera
  
focusOnPoint(aPoint:AntPoint):void
Моментальное перемещение камеры к указанной точке.
AntCamera
  
follow(aTarget:AntEntity, aStyle:uint):void
Устанавливает цель за которой будет выполнятся слежение.
AntCamera
 Inherited
kill():void
Вызывается когда объект необходимо временно "убить" и освободить для повторного использования.
AntBasic
 Inherited
postUpdate():void
Вызывается каждый кадр сразу после вызова метода update();
AntBasic
 Inherited
preUpdate():void
Вызывается каждый кадр перед вызовом метода update().
AntBasic
 Inherited
revive():void
Воскрешает объект после "убийства" для повторного использования.
AntBasic
  
setBounds(aLowerX:int, aLowerY:int, aUpperX:int, aUpperY:int):void
Устанавливает ограничение для перемещения камеры.
AntCamera
  
update():void
[override] Обработка действий камеры.
AntCamera
Protected Methods
 MethodDefined By
  
limitByX(aValue:Number):Number
Ограничивает значение по горизонтали согласно заданным границам.
AntCamera
  
limitByY(aValue:Number):Number
Ограничивает значение по вертикали согласно заданным границам.
AntCamera
Public Constants
 ConstantDefined By
  STYLE_FREELY : uint = 0
[static] Стиль слежения камеры: свободный стиль, по X и Y.
AntCamera
  STYLE_HORIZONTAL : uint = 1
[static] Стиль слежения камеры: горизонтальный, только по X.
AntCamera
  STYLE_VERTICAL : uint = 2
[static] Стиль слежения камеры: вертикальный, только по Y.
AntCamera
  ZOOM_STYLE_CENTER : String = styleCenter
[static]
AntCamera
Property Detail
_flashBitmapproperty
protected var _flashBitmap:Bitmap

Битмап для вывода буффера камеры на экран стандартными средствами Flash.

_flashRectproperty 
protected var _flashRect:Rectangle

Помшник для заливки буфера камеры цветом.

_flashSpriteproperty 
public var _flashSprite:Sprite

_isMaskedproperty 
public var _isMasked:Boolean

_isShakeproperty 
protected var _isShake:Boolean

_maskOffsetproperty 
public var _maskOffset:AntPoint

_newPosproperty 
protected var _newPos:AntPoint

Помошник для рассчета новой позиции камеры.

_shakePosproperty 
protected var _shakePos:AntPoint

_shakerproperty 
protected var _shaker:Vector.<AntPoint>

_shakerDelayproperty 
protected var _shakerDelay:Number

_shakerIndexproperty 
protected var _shakerIndex:int

_zoomproperty 
protected var _zoom:Number

Фактор увеличения изображения.

The default value is 1.

backgroundColorproperty 
public var backgroundColor:uint

Цвет заливки.

The default value is 0xFF000000.

boundsproperty 
public var bounds:AntRect

Прямоугольник задающий границы для перемещения камеры.

The default value is null.

bufferproperty 
public var buffer:BitmapData

Основной буфер камеры куда производится отрисовка всех визуальных объектов.

fillBackgroundproperty 
public var fillBackground:Boolean

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

The default value is false.

followStyleproperty 
public var followStyle:uint

Стиль слежения за объектом.

The default value is STYLE_FREELY.

heightproperty 
public var height:int

Размер окна камеры по высоте.

leadingFactorproperty 
public var leadingFactor:Number

Фактор опережения камеры при движении за целью.

The default value is 8.

positionPropertyXproperty 
public var positionPropertyX:String

Свойство цели для преследования которое используется для определения его позиции по X.

The default value is "globalX".

positionPropertyYproperty 
public var positionPropertyY:String

Свойство цели для преследования которое используется для определения его позиции по Y.

The default value is "globalY".

roundPositionproperty 
public var roundPosition:Boolean

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

The default value is false.

screenCenterproperty 
public var screenCenter:AntPoint

Центр экрана.

screenSpriteproperty 
screenSprite:Sprite  [read-only]

Возвращает указатель на Sprite камеры.


Implementation
    public function get screenSprite():Sprite
scrollproperty 
public var scroll:AntPoint

Содержит смещение камеры относительно игрового мира. Чтобы прокручивать игровые миры, достаточно менять значения scroll.x и scroll.y.

The default value is (0,0).

smoothFactorproperty 
public var smoothFactor:Number

Фактор отставания камеры при движении за целью.

The default value is 0.25.

smoothingproperty 
smoothing:Boolean

Определяет сглаживание для буфера камеры.

The default value is false.


Implementation
    public function get smoothing():Boolean
    public function set smoothing(value:Boolean):void
targetproperty 
public var target:AntEntity

Цель которую приследует камера.

The default value is null.

widthproperty 
public var width:int

Размер окна камеры по ширине.

xproperty 
public var x:Number

Положение камеры на экране Flash окна по X.

yproperty 
public var y:Number

Положение камеры на экране Flash окна по Y.

zoomproperty 
zoom:Number

Определяет уровень приближения камеры.

The default value is 1.


Implementation
    public function get zoom():Number
    public function set zoom(value:Number):void
zoomStyleproperty 
zoomStyle:String

Определяет тип приближения камеры.

The default value is ZOOM_STYLE_DEFAULT.


Implementation
    public function get zoomStyle():String
    public function set zoomStyle(value:String):void
Constructor Detail
AntCamera()Constructor
public function AntCamera(aX:Number, aY:Number, aWidth:int, aHeight:int, aZoom:Number = 1)

Parameters
aX:Number
 
aY:Number
 
aWidth:int
 
aHeight:int
 
aZoom:Number (default = 1)
Method Detail
beginDrawMask()method
public function beginDrawMask(aMask:AntMask):void

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

Parameters

aMask:AntMask — Указатель на маску которая будет временно применена к камере.

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

Уничтожает экземпляр камеры и осовобождает память.

endDrawMask()method 
public function endDrawMask(aMask:AntMask):void

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

Parameters

aMask:AntMask — Указатель на маску которая ранее была применена к камере.

focusOn()method 
public function focusOn(aX:Number, aY:Number):void

Моментальное перемещение камеры к указанным координатам.

Parameters

aX:Number — Новая позиция камеры по горизонтали.
 
aY:Number — Новая позиция камеры по вертикали.

focusOnPoint()method 
public function focusOnPoint(aPoint:AntPoint):void

Моментальное перемещение камеры к указанной точке.

Parameters

aPoint:AntPoint — Точка к которой будет перемещена камера.

follow()method 
public function follow(aTarget:AntEntity, aStyle:uint):void

Устанавливает цель за которой будет выполнятся слежение.

Parameters

aTarget:AntEntity — Цель за которой будет выполнятся слежение.
 
aStyle:uint (default = NaN) — Стиль слежения.

limitByX()method 
protected function limitByX(aValue:Number):Number

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

Parameters

aValue:Number — Новая позиция по горизонтали.

Returns
Number — Если новая позиция вышла за пределы границы, то вернет крайнюю доступную позицию.
limitByY()method 
protected function limitByY(aValue:Number):Number

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

Parameters

aValue:Number — Новая позиция по вертикали.

Returns
Number — Если новая позиция вышла за пределы границы, то вернет крайнюю доступную позицию.
setBounds()method 
public function setBounds(aLowerX:int, aLowerY:int, aUpperX:int, aUpperY:int):void

Устанавливает ограничение для перемещения камеры.

Parameters

aLowerX:int — Минимально допустимая позиция камеры по X (обычно это 0).
 
aLowerY:int — Минимально допустимая позиция камеры по Y (обычно это 0).
 
aUpperX:int — Максимально допустимая позиция камеры по X (обычно это ширина уровня).
 
aUpperY:int — Максимально допустимая позиция камеры по Y (обычно это высота уровня).

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

Обработка действий камеры.

Constant Detail
STYLE_FREELYConstant
public static const STYLE_FREELY:uint = 0

Стиль слежения камеры: свободный стиль, по X и Y.

STYLE_HORIZONTALConstant 
public static const STYLE_HORIZONTAL:uint = 1

Стиль слежения камеры: горизонтальный, только по X.

STYLE_VERTICALConstant 
public static const STYLE_VERTICAL:uint = 2

Стиль слежения камеры: вертикальный, только по Y.

ZOOM_STYLE_CENTERConstant 
public static const ZOOM_STYLE_CENTER:String = styleCenter