Packagecom.catalystapps.gaf.data
Classpublic class GAFBundle
InheritanceGAFBundle Inheritance Object

GAFBundle is utility class that used to save all converted GAFTimelines from bundle in one place with easy access after conversion complete



Public Properties
 PropertyDefined By
  name : String
The name of the bundle.
GAFBundle
  timelines : Vector.<GAFTimeline>
Deprecated Since 5.0: Please Use com.catalystapps.gaf.data.GAFBundle.getGAFTimeline()
[read-only] Returns all GAFTimeline's from bundle as Vector
GAFBundle
Public Methods
 MethodDefined By
  
dispose():void
Disposes all assets in bundle
GAFBundle
  
getCustomRegion(swfName:String, linkage:String, scale:Number, csf:Number):IGAFTexture
Returns IGAFTexture (custom image) from bundle by swfName and linkage.
GAFBundle
  
getGAFTimeline(swfName:String, linkage:String = rootTimeline):GAFTimeline
Returns GAFTimeline from bundle by swfName and linkage.
GAFBundle
  
Deprecated Since 5.0: Please Use com.catalystapps.gaf.data.GAFBundle.getGAFTimeline()
Returns GAFTimeline from bundle by timelineID
GAFBundle
  
Deprecated Since 5.0: Please Use com.catalystapps.gaf.data.GAFBundle.getGAFTimeline()
Returns GAFTimeline from bundle by linkage
GAFBundle
Property Detail
nameproperty
name:String

The name of the bundle. Used in GAFTimelinesManager to identify specific bundle. Should be specified by user using corresponding setter or by passing the name as second parameter in GAFTimelinesManager.addGAFBundle(). The name can be auto-setted by ZipToGAFAssetConverter in two cases: 1) If ZipToGAFAssetConverter.id is not empty ZipToGAFAssetConverter sets the bundle name equal to it's id; 2) If ZipToGAFAssetConverter.id is empty, but gaf package (zip or folder) contain only one gaf config file, ZipToGAFAssetConverter sets the bundle name equal to the name of the gaf config file.


Implementation
    public function get name():String
    public function set name(value:String):void
timelinesproperty 
timelines:Vector.<GAFTimeline>  [read-only]
Deprecated Since 5.0: Please Use com.catalystapps.gaf.data.GAFBundle.getGAFTimeline()

Returns all GAFTimeline's from bundle as Vector


Implementation
    public function get timelines():Vector.<GAFTimeline>
Method Detail
dispose()method
public function dispose():void

Disposes all assets in bundle

getCustomRegion()method 
public function getCustomRegion(swfName:String, linkage:String, scale:Number, csf:Number):IGAFTexture

Returns IGAFTexture (custom image) from bundle by swfName and linkage. Then it can be used to replace animation parts or create new animation parts.

Parameters

swfName:String — is the name of SWF file where original Bitmap/Sprite was located (or the name of the gaf config file where it is located)
 
linkage:String — is the linkage name of the Bitmap/Sprite
 
scale:Number (default = NaN) — Texture atlas Scale that will be used for IGAFTexture creation. Possible values are values from converted animation config.
 
csf:Number (default = NaN) — Texture atlas content scale factor (CSF) that will be used for IGAFTexture creation. Possible values are values from converted animation config.

Returns
IGAFTextureIGAFTexture (custom image) from bundle.

See also

getGAFTimeline()method 
public function getGAFTimeline(swfName:String, linkage:String = rootTimeline):GAFTimeline

Returns GAFTimeline from bundle by swfName and linkage.

Parameters

swfName:String — is the name of SWF file where original timeline was located (or the name of the gaf config file where it is located).
 
linkage:String (default = rootTimeline) — is the linkage name of the timeline. If you need to get the Main Timeline from SWF use the "rootTimeline" linkage name.

Returns
GAFTimelineGAFTimeline from bundle
getGAFTimelineByID()method 
public function getGAFTimelineByID(swfName:String):GAFTimeline
Deprecated Since 5.0: Please Use com.catalystapps.gaf.data.GAFBundle.getGAFTimeline()

Returns GAFTimeline from bundle by timelineID

Parameters

swfName:String — is the name of swf file, used to create gaf file

Returns
GAFTimelineGAFTimeline on the stage of swf file
getGAFTimelineByLinkage()method 
public function getGAFTimelineByLinkage(linkage:String):GAFTimeline
Deprecated Since 5.0: Please Use com.catalystapps.gaf.data.GAFBundle.getGAFTimeline()

Returns GAFTimeline from bundle by linkage

Parameters

linkage:String — linkage in a fla file library

Returns
GAFTimelineGAFTimeline from bundle