The GradientBevelFilter Class
The GradientBevelFilter class is designed to create beveled gradient effects on objects at runtime, both inner and outer.It is important when using this class to import it first at the beginning of your script, like this:
To instantiate a new instance of the GradientBevelFilter class, use this code as a template:
import flash.filters.GradientBevelFilter;
[View full width]var myFilter:GradientBevelFilter = new GradientBevelFilter(dist, angle, colors, alphas,ratios, blurX, blurY, strength, quality, type, knockout);
- dist
The distance in pixels for the bevel to be offset between 08. Default value of 4.0. - colors
An array of colors to use in the gradient. - alphas
An array of alphas to use in the gradient. - ratios
An array of ratios to use in the gradient. - blurX
The total amount of horizontal blur from 0255. Default value of 4.0. - blurY
The total amount of vertical blur from 0255. Default value of 4.0. - strength [d]This number represents the strength of the bevel imprint. From 05, the higher this number, the more contrast. Default value of 1.0.
- quality
This number represents the number of times to apply the filter ranging from 015. Default value of 1. - type
This string represents the type of bevel to apply: inner, outer, or full. Default value of inner. - knockout
The Boolean value controls whether the object having the filter applied to will be transparent, TRue, or not, false.
Example :This example will create a small blue square using the drawing API and apply the filter to it:
[View full width]import flash.filters.GradientBevelFilter;Because the properties of this object match the parameters identically, they will be skipped.
//the arrays we need
var colors:Array = [0x00ccff, 0x397dce, 0x000033];
var alphas:Array = [1, 0, 1];
var ratios:Array = [0, 125, 255];
//create the movie clip to display the filter
var rec_mc:MovieClip = this.createEmptyMovieClip("rec_mc", 1);
//move the rectangle towards the center of the stage
rec_mc._x = rec_mc._y = 200;
//draw a squar inside the movie clip
rec_mc.lineStyle(0,0x000000,0);
rec_mc.beginFill(0x397dce, 100);
rec_mc.lineTo(100,0);
rec_mc.lineTo(100,100);
rec_mc.lineTo(0,100);
rec_mc.lineTo(0,0);
rec_mc.endFill();
//create the filter
var myFilter:GradientBevelFilter = new GradientBevelFilter (5, 45, colors, alphas, ratios,10, 10, 2, 3, "inner");
//apply the filter
rec_mc.filters = new Array(myFilter);
Methods
clone
Availability :
FP:8, AS:1.0 Generic Template :
myFilter.clone()Returns :
GradientBevelFilterAn exact copy of the GradientBevelFilter will be returned.Description: This method will create a duplicate copy of the GradientBevelFilter it is called on.Example: This example will create a filter, clone it, then walk through all the properties to see that they match:
[View full width]import flash.filters.GradientBevelFilter;
//the arrays we need
var colors:Array = [0xFFFFFF, 0xCCCCCC, 0x000000];
var alphas:Array = [1, 0, 1];
var ratios:Array = [0, 128, 255];
//create the filter
var myFilter:GradientBevelFilter = new GradientBevelFilter (5, 45, colors, alphas, ratios,10, 10, 2, 3, "inner");
//apply the filter
img_mc.filters = new Array(myFilter);
//create a copy
var myNewFilter:GradientBevelFilter = myFilter.clone();
//walk through and display each property
for(each in myNewFilter){
trace(each + ": " + myNewFilter[each]);
}
//output:clone: [type Function]
//type: inner
//knockout: false
//strength: 2
//quality: 3
//blurY: 10
//blurX: 10
//ratios: 0,128,255
//alphas: 1,0,1
//colors: 16777215,13421772,0
//angle: 45
//distance: 5