Packagecom.catalystapps.gaf.core
Classpublic class GAFTimelinesManager
InheritanceGAFTimelinesManager Inheritance Object

Utility class that allows easily manage all GAFTimeline's



Public Methods
 MethodDefined By
  
addGAFBundle(bundle:GAFBundle, bundleName:String = null):void
[static] Add all GAFTimeline's from bundle into timelines collection
GAFTimelinesManager
  
getCustomRegion(swfName:String, linkage:String, scale:Number, csf:Number):IGAFTexture
Returns IGAFTexture (custom image) from bundle by swfName and linkage.
GAFTimelinesManager
  
getGAFMovieClip(swfName:String, linkage:String = rootTimeline):GAFMovieClip
[static] Returns instance of GAFMovieClip.
GAFTimelinesManager
  
getGAFTimeline(swfName:String, linkage:String = rootTimeline):GAFTimeline
[static] Returns GAFTimeline from timelines collection by swfName and linkage.
GAFTimelinesManager
  
[static] Removes all GAFBundle objects from the GAFTimelinesManager and dispose them.
GAFTimelinesManager
  
removeAndDisposeBundle(bundleName:String):void
[static] Removes specified GAFBundle object from the GAFTimelinesManager and dispose it.
GAFTimelinesManager
Method Detail
addGAFBundle()method
public static function addGAFBundle(bundle:GAFBundle, bundleName:String = null):void

Add all GAFTimeline's from bundle into timelines collection

Parameters

bundle:GAFBundle
 
bundleName:String (default = null) — The name of the bundle. Used in GAFTimelinesManager to identify specific 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
IGAFTexture — IGAFTexture (custom image) from bundle.

See also

com.catalystapps.gaf.data.GAFBundle.getCustomRegion();
getGAFMovieClip()method 
public static function getGAFMovieClip(swfName:String, linkage:String = rootTimeline):GAFMovieClip

Returns instance of GAFMovieClip. In case when GAFTimeline with specified swfName and linkage is absent - returns null

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
GAFMovieClip — new instance of GAFMovieClip
getGAFTimeline()method 
public static function getGAFTimeline(swfName:String, linkage:String = rootTimeline):GAFTimeline

Returns GAFTimeline from timelines collection 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
GAFTimeline — GAFTimeline from timelines collection
removeAndDisposeAll()method 
public static function removeAndDisposeAll():void

Removes all GAFBundle objects from the GAFTimelinesManager and dispose them. Use this method to free memory when all bundles don't need anymore.

removeAndDisposeBundle()method 
public static function removeAndDisposeBundle(bundleName:String):void

Removes specified GAFBundle object from the GAFTimelinesManager and dispose it. Use this method to free memory when all content of the specified bundle doesn't need anymore.

Parameters

bundleName:String — the name of the bundle that was given to it when bundle was added to the GAFTimelinesManager.