Packagecom.catalystapps.gaf.data
Classpublic class GAFTimeline
InheritanceGAFTimeline Inheritance Object

GAFTimeline represents converted GAF file. It is like a library symbol in Flash IDE that contains all information about GAF animation. It is used to create GAFMovieClip that is ready animation object to be used in starling display list


Public Properties
 PropertyDefined By
  contentScaleFactor : Number
Texture atlas content scale factor (csf) that will be used for GAFMovieClip creation.
GAFTimeline
  gafgfxData : GAFGFXData
Graphical data storage that used by GAFTimeline.
GAFTimeline
  id : String
[read-only] Timeline identifier (name given at animation's upload or assigned by developer)
GAFTimeline
  linkage : String
[read-only] Timeline linkage in a fla file library
GAFTimeline
  scale : Number
Texture atlas scale that will be used for GAFMovieClip creation.
GAFTimeline
Public Methods
 MethodDefined By
  
GAFTimeline(timelineConfig:GAFTimelineConfig)
Creates an GAFTimeline object
GAFTimeline
  
dispose():void
Disposes the underlying GAF timeline config
GAFTimeline
  
getTextureByName(animationObjectName:String):IGAFTexture
Returns GAF Texture by name of an instance inside a timeline.
GAFTimeline
  
loadInVideoMemory(content:String = contentDefault, scale:Number, csf:Number):void
Load all graphical data connected with this asset in device GPU memory.
GAFTimeline
  
unloadFromVideoMemory(content:String = contentDefault, scale:Number, csf:Number):void
Unload all all graphical data connected with this asset from device GPU memory.
GAFTimeline
Public Constants
 ConstantDefined By
  CONTENT_ALL : String = contentAll
[static]
GAFTimeline
  CONTENT_DEFAULT : String = contentDefault
[static]
GAFTimeline
  CONTENT_SPECIFY : String = contentSpecify
[static]
GAFTimeline
Property Detail
contentScaleFactorproperty
contentScaleFactor:Number

Texture atlas content scale factor (csf) that will be used for GAFMovieClip creation. To create GAFMovieClip's with different csf assign appropriate csf to GAFTimeline and only after that instantiate GAFMovieClip. Possible values are values from converted animation config. They are depends from project settings on site converter


Implementation
    public function get contentScaleFactor():Number
    public function set contentScaleFactor(value:Number):void
gafgfxDataproperty 
gafgfxData:GAFGFXData

Graphical data storage that used by GAFTimeline.


Implementation
    public function get gafgfxData():GAFGFXData
    public function set gafgfxData(value:GAFGFXData):void
idproperty 
id:String  [read-only]

Timeline identifier (name given at animation's upload or assigned by developer)


Implementation
    public function get id():String
linkageproperty 
linkage:String  [read-only]

Timeline linkage in a fla file library


Implementation
    public function get linkage():String
scaleproperty 
scale:Number

Texture atlas scale that will be used for GAFMovieClip creation. To create GAFMovieClip's with different scale assign appropriate scale to GAFTimeline and only after that instantiate GAFMovieClip. Possible values are values from converted animation config. They are depends from project settings on site converter


Implementation
    public function get scale():Number
    public function set scale(value:Number):void
Constructor Detail
GAFTimeline()Constructor
public function GAFTimeline(timelineConfig:GAFTimelineConfig)

Creates an GAFTimeline object

Parameters
timelineConfig:GAFTimelineConfig — GAF timeline config
Method Detail
dispose()method
public function dispose():void

Disposes the underlying GAF timeline config

getTextureByName()method 
public function getTextureByName(animationObjectName:String):IGAFTexture

Returns GAF Texture by name of an instance inside a timeline.

Parameters

animationObjectName:String — name of an instance inside a timeline

Returns
IGAFTexture — GAF Texture
loadInVideoMemory()method 
public function loadInVideoMemory(content:String = contentDefault, scale:Number, csf:Number):void

Load all graphical data connected with this asset in device GPU memory. Used in case of manual control of GPU memory usage. Works only in case when all graphical data stored in RAM (Starling.handleLostContext should be set to true before asset conversion)

Parameters

content:String (default = contentDefault) — content type that should be loaded. Available types: CONTENT_ALL, CONTENT_DEFAULT, CONTENT_SPECIFY
 
scale:Number (default = NaN) — in case when specified content is CONTENT_SPECIFY scale and csf should be set in required values
 
csf:Number (default = NaN) — in case when specified content is CONTENT_SPECIFY scale and csf should be set in required values

unloadFromVideoMemory()method 
public function unloadFromVideoMemory(content:String = contentDefault, scale:Number, csf:Number):void

Unload all all graphical data connected with this asset from device GPU memory. Used in case of manual control of video memory usage

Parameters

content:String (default = contentDefault) — content type that should be loaded (CONTENT_ALL, CONTENT_DEFAULT, CONTENT_SPECIFY)
 
scale:Number (default = NaN) — in case when specified content is CONTENT_SPECIFY scale and csf should be set in required values
 
csf:Number (default = NaN) — in case when specified content is CONTENT_SPECIFY scale and csf should be set in required values

Constant Detail
CONTENT_ALLConstant
public static const CONTENT_ALL:String = contentAll

CONTENT_DEFAULTConstant 
public static const CONTENT_DEFAULT:String = contentDefault

CONTENT_SPECIFYConstant 
public static const CONTENT_SPECIFY:String = contentSpecify





Mon Jan 25 2016, 01:16 PM +02:00