Gugga Flash Framework

Distributed under MIT Open Source License, see Fuse-Kit-License.html (in fuse package directory) Easing Equations (c) 2003 Robert Penner used by permission, see PennerEasing Visit http://www.mosessupposes.com/Fuse

Provides easy Flash8 BitmapFilter handling. Can be used as a standalone utility or in conjunction with ZigoEngine & Fuse to animate filters.

FuseFMP uses a unique naming convention for addressing BitmapFilter properties:
short-filtername+"_"+filterprop
DropShadow_distance
Bevel_angle
etc.

To blur both X and Y to the same value you may use the special suffix _blur, such as Blur_blur, Glow_blur, etc.

Such pseudonyms are used in various management methods like setFilterProps.

For a complete list of FuseFMP properties call com.mosesSupposes.fuse.FuseFMP#getAllShortcuts or com.mosesSupposes.fuse.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 like my_mc.Blur_blurXTo(10);.
For a complete list of FuseFMP tweening methods see com.mosesSupposes.fuse.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:

Definition at line 53 of file FuseFMP.as.


Static Public Member Functions
static function	simpleSetup ()
static function	initialize (target:Object)
static function	deinitialize ()
static function	getFilterName ($myFilter:BitmapFilter)
static function	getFilterIndex ($obj:Object, $myFilter:Object)
static function	getFilter ($obj:Object, $myFilter:Object, $createNew:Boolean)
static function	writeFilter ($obj:Object, $myFilter:Object, $propsObj:Object)
static function	removeFilter ($obj:Object, $myFilter:Object)
static function	getFilterProp ($obj:Object, $filtername:String, $createNew:Boolean)
static function	setFilterProp ($obj:Object, $propname:Object, $val:Object)
static function	setFilterProps ($obj:Object, $filterOrPropsObj:Object, $propsObj:Object)
static function	getAllShortcuts ()
static function	traceAllFilters ()
Static Public Attributes
static var	registryKey:String = 'fuseFMP'
static var	VERSION:String = FuseKitCommon.VERSION
Static Private Member Functions
static function	$getInstance ($myFilter:Object)
Static Private Attributes
static var	$fclasses:Object
static var	$shortcuts:Object
static var	$gro:Object
static var	$sro:Object

Member Function Documentation

static function com.mosesSupposes.fuse.FuseFMP.simpleSetup ( ) [static]

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 com.mosesSupposes.fuse.FuseFMP#getAllShortcuts or com.mosesSupposes.fuse.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 com.mosesSupposes.fuse.ZigoEngine#simpleSetup, it will be called automatically.

See also:: com.mosesSupposes.fuse.ZigoEngine.simpleSetup
com.mosesSupposes.fuse.ZigoEngine.register

Definition at line 75 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.initialize ( target:Object ) [static]

Adds shortcuts to all target objects passed. 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 com.mosesSupposes.fuse.FuseFMP#getAllShortcuts or com.mosesSupposes.fuse.FuseFMP#traceAllFilters.

Parameters:

accepts

one or more MovieClips, TextFields, or Buttons to initialize with shortcuts.

See also:: deinitialize

Definition at line 107 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.deinitialize ( ) [static]

Removes shortcuts from specific targets or from MC, Button & TF prototypes if no targets are passed.

Parameters:

accepts

one or more MovieClips, TextFields, or Buttons to strip FusFMP shortcuts from, or pass nothing/null to undo simpleSetup.

See also:: initialize

Definition at line 202 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.getFilterName ( $myFilter:BitmapFilter ) [static]

Quick way to get a 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]) );
 }

Parameters:

$myFilter

BitmapFilter instance

Returns:: BitmapFilter instance name

See also:: getAllShortcuts
traceAllFilters

Definition at line 245 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.getFilterIndex	(	$obj:Object	,
		$myFilter:Object
	)			`[static]`

Gets current filter index.

Parameters:

	$obj	parent object of filters
	$myFilter	BitmapFilter instance, String (like "BlurFilter" or "Blur"), or class constructor

Returns:: index of filter in filters Array or -1 if filter doesn't exist.

See also:: getFilter

Definition at line 264 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.getFilter	(	$obj:Object	,
		$myFilter:Object	,
		$createNew:Boolean
	)			`[static]`

Returns an existing filter from targ's filters Array or null if doesn't exist, or use createNew if you want a new instance to be created regardless.

Parameters:

	$obj	target filter's parent
	$myFilter	BitmapFilter instance, String (like "BlurFilter" or "Blur"), or class constructor
	$createNew	Boolean variable to set whether or not to create new filter instance

Returns:: existing filter from targ's filters array or null

See also:: getFilterIndex

Definition at line 289 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.writeFilter	(	$obj:Object	,
		$myFilter:Object	,
		$propsObj:Object
	)			`[static]`

Applies or overwrites an existing filter. NOTE: Use setFilterProps to update existing filters. writeFilter overwrites existing.

Parameters:

	$obj	target filter's parent
	$myFilter	BitmapFilter instance, String (like "BlurFilter" or "Blur"), or class constructor
	$propsObj	optional, a generic object customizing the new filter, like `{blurX:50,quality:1}`

Returns:: index in target's filters array (or -1 if fails)

See also:

Definition at line 314 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.removeFilter	(	$obj:Object	,
		$myFilter:Object
	)			`[static]`

Clears filter.

Parameters:

	$obj	target filter's parent
	$myFilter	BitmapFilter instance, String (like "BlurFilter" or "Blur"), or class constructor

Returns:: true or false for success.

See also:

Definition at line 347 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.getFilterProp	(	$obj:Object	,
		$filtername:String	,
		$createNew:Boolean
	)			`[static]`

Queries properties from MovieClips that have not been initialized.

Parameters:

	$obj	target filter's parent
	$filtername	BitmapFilter instance name
	$createNew	Boolean variable to set whether or not to create new filter instance

Returns:: the value of the property, usually a number

See also:

Definition at line 373 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.setFilterProp	(	$obj:Object	,
		$propname:Object	,
		$val:Object
	)			`[static]`

Sets properties for filter.

Parameters:

	$obj	target filter's parent
	$propname	BitmapFilter property
	$val	Properties and values Support for multiple targets and multiple properties. There are two distinct syntaxes. examples: `FuseFMP.setFilterProps([my_mc,my_txt], { Blur_blurX:50, Bevel_blurX:1 }); // multiple targs, multiple filters FuseFMP.setFilterProps(my_mc, 'Blur', { blurX:50, blurY:0, quality:3 }); // write a customized blur filter to my_mc`

See also:

Definition at line 393 of file FuseFMP.as.

static function com.mosesSupposes.fuse.FuseFMP.setFilterProps	(	$obj:Object	,
		$filterOrPropsObj:Object	,
		$propsObj:Object
	)			`[static]`

Sets properties for one or more filters.

Parameters:

	$obj	target filter's parent
	$propname	BitmapFilter property
	$val	Properties and values Support for multiple targets and multiple properties. There are two distinct syntaxes. examples: `FuseFMP.setFilterProps([my_mc,my_txt], { Blur_blurX:50, Bevel_blurX:1 }); // multiple targs, multiple filters FuseFMP.setFilterProps(my_mc, 'Blur', { blurX:50, blurY:0, quality:3 }); // write a customized blur filter to my_mc`