| Previous | Next | Frames (Show Nav) | No Frames |
| Summary: Field | Property | Constructor | Method | Detail: Field | Property | Constructor | Method |
Object | +--com.mosesSupposes.fuse.FuseFMP
// 1. normal
FuseFMP.writeFilter(clip1, "DropShadow");
FuseFMP.setFilterProp(box, "DropShadow_color", 0x336699);
// 2. Shortcuts registered with ZigoEngine
// (or FuseFMP.simpleSetup called if using without ZigoEngine)
clip1.writeFilter("DropShadow");
clip1.DropShadow_color = "#336699"; // supports strings for color
clip1.DropShadow_blur = 10; // sets blurX & blurY at once
Field Summary | |
| public static | BLUR_ZERO: Boolean = true |
| When true, generated BlurFilters are set to 0 blurX & blurY until manually set. | |
| public static |
VERSION: String = FuseKitCommon.VERSION |
| Enables kit version to be retrieved at runtime or when reviewing a decompiled swf. | |
Method Summary | |
| public static | deinitialize ( ): Void |
| Removes shortcuts from specific targets, or from base prototypes if no targets are passed. | |
| public static | getAllShortcuts ( ): Array |
| Retrieves an array of supported property shortcut strings. Similar to traceAllFilters. | |
| public static | getFilter ( target: Object, filter: Object, createNew: Boolean ): BitmapFilter |
| Fast getter for a single filter with the option to generate a new filter if missing. | |
| public static | getFilterIndex ( target: Object, filter: Object ): Number |
| Gets current filter index. | |
| public static | getFilterName ( instance: BitmapFilter ): String |
| Generic method to get a string version of any filter instance's class name. | |
| public static | getFilterProp ( target: Object, propname: String, createNew: Boolean ): Object |
| Fast getter for a single filter property with option to generate a new filter if missing. | |
| public static | initialize ( target: Object ): Void |
| Adds shortcuts to all target objects passed. | |
| public static | removeFilter ( target: Object, filter: Object ): Boolean |
| Clears filter. | |
| public static | setFilterProp ( target: Object, propname: Object, value: Object ): Void |
| Fast setter for a specific filter property. Generates a new filter if needed. | |
| public static | setFilterProps ( target: Object, filterOrPropsObj: Object, propsObj: Object ): Void |
| Power method that handles multiple targets, props, and filters in one call. Generates new filters as needed. | |
| public static | simpleSetup ( ): Void |
| Extends MC, Button & TF prototypes with FuseFMP shortcuts. | |
| public static | traceAllFilters ( ): Void |
| Lists all filters and shortcut properties (Bevel_blurX, etc.) to the Output panel for reference. | |
| public static | writeFilter ( target: Object, filter: Object, propsObj: Object ): Number |
| Writes a new filter or overwrites an existing filter. | |
| public static var BLUR_ZERO: Boolean = true |
| When true, generated BlurFilters are set to 0 blurX & blurY until manually set. FuseFMP always creates new BitmapFilters with default properties, but BlurFilter has been found to be a special case in that the default blur of 4 frequently requires extra code to undo back to 0. For example: (Assuming no blur has been applied in advance) without BLUR_ZERO, the Fuse action {start_Blur_blurX:100} results in a Blur_blurY of 4 and a blurX tween from 100 to 4, leaving the target slightly fuzzy. With BLUR_ZERO turned on the same action would show only the blurX tween from 100 to 0 with the target ending up looking crisp. |
| public static var VERSION: String = FuseKitCommon.VERSION |
Enables kit version to be retrieved at runtime or when reviewing a decompiled swf.
|
|
| Removes shortcuts from specific targets, or from base prototypes if no targets are passed. |
|
|
| Retrieves an array of supported property shortcut strings. Similar to traceAllFilters. |
|
|
| Fast getter for a single filter with the option to generate a new filter if missing. | |||||||||
|
|
| Gets current filter index. | ||||||
|
|
Generic method to get a string version of any filter instance's class name.// list filter in my_mc by name to output window
for (var i:String in my_mc.filters) {
trace( FuseFMP.getFilterName(my_mc.filters[i]) );
} | |||
|
|
| Fast getter for a single filter property with option to generate a new filter if missing. | |||||||||
|
|
| Adds shortcuts to all target objects passed. This enables the getting and setting of BitmapFilter properties directly on targets, using the FuseFMP naming convention [short-filtername+"_"+filterprop]. Like, 'DropShadow_angle'. For a complete list of shortcut properties call FuseFMP.getAllShortcuts or FuseFMP.traceAllFilters. | |||
|
|
| Clears filter. | ||||||
|
|
| Fast setter for a specific filter property. Generates a new filter if needed. Efficiency: Note that when speed is a priority, setFilterProps is faster for setting batches of 3 or more properties.
| |||||||||
|
|
| Power method that handles multiple targets, props, and filters in one call. Generates new filters as needed. This all-purpose method can be used in place of writeFilter and setFilterProp.
| |||||||||
|
|
| Extends MC, Button & TF prototypes with FuseFMP shortcuts. This enables the getting and setting of BitmapFilter properties directly on targets, using the convention short-filtername+"_"+filterprop. For a complete list of shortcut properties call FuseFMP.getAllShortcuts or FuseFMP.traceAllFilters. Also sets _global references to FuseFMP and all filter classes so timeline coders can avoid using import statements. Note that you do not need to call this method if you're using ZigoEngine.simpleSetup, it will be called automatically. |
|
|
| Lists all filters and shortcut properties (Bevel_blurX, etc.) to the Output panel for reference. |
|
|
| Writes a new filter or overwrites an existing filter. Use setFilterProps to update existing filters - this method overwrites an existing instance. | |||||||||
|
short-filtername+"_"+filterprop
DropShadow_distanceBevel_angleetc.
Such pseudonyms are used in various management methods like setFilterProp.
Special Blur handling:
_blursuffix makes it possible to set blurX and blurY at once:Blur_blur, Glow_blur,etc.For a complete list of FuseFMP properties call FuseFMP.getAllShortcuts or FuseFMP.traceAllFilters.
FuseFMP also supports its own optional Shortcuts functionality, which writes all of these pseudo-props into targets or prototypes. This enables the getting and setting of BitmapFilter properties directly on targets, such as
my_mc.Blur_blurX = 10;and, if using ZigoEngine, tween shortcuts likemy_mc.Blur_blurXTo(10);.For a complete list of FuseFMP tweening methods see Shortcuts documentation.
If you're using FuseFMP without ZigoEngine and want to extend prototypes use simpleSetup, or if you want to add & remove shortcuts on specific targets use initialize & deinitialize.
FuseFMP pseudo-properties are also directly tweenable in ZigoEngine and Fuse once registered:
// tween the dropshadow angle 25 degrees ccw, relative to current setting: ZigoEngine.doTween(my_mc, "DropShadow_angle", "-25"); // this fuse action tweens a horizontal blur back to the clip's normal state Fuse.push({ start_Blur_blurX:100 });BitmapFilter tips:
{ scope:FuseFMP, func:"removeFilter", args:"Blur" }