Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
AnimateFilter

Package | spark.effects
Class | public class AnimateFilter
Inheritance | AnimateFilter Animate Effect flash.events.EventDispatcher

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The AnimateFilter effect applies an mx.filters.IBitmapFilter instance to the target and allows you to animate properties of the filter between values. Unlike effects that animate properties of the target, the AnimateFilter effect animates properties of the filter applied to the target.

The filters that you can use with this effect are defined in the spark.filters. package. Common filters include the DropShadowFilter, GlowFilter, BlurFilter, and ShaderFilter.

To define the properties of the filter to animate, pass an Array of SimpleMotionPath objects to the to the `motionPath` property of the AnimateFilter effect. Each SimpleMotionPath object defines a property on the filer, the starting value of the property, and the ending value of the property.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<s:AnimateFilter>` tag inherits all of the tag attributes of its superclass, and adds the following tag attributes:

      <s:AnimateFilter
        Properties
        id="ID"
        bitmapFilter="no default"
      />

Default MXML Property `motionPaths`

View the examples

See also

spark.effects.supportClasses.AnimateFilterInstance

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | bitmapFilter : IBitmapFilter IBitmapFilter instance to apply and animate. | AnimateFilter
|  | className : String [read-only] The name of the effect class, such as "Fade". | Effect
|  | customFilter : EffectTargetFilter Specifies a custom filter object, of type EffectTargetFilter, used by the effect to determine the targets on which to play the effect. | Effect
|  | disableLayout : Boolean If true, the effect disables layout on its targets' parent containers, setting the containers autoLayout property to false, and also disables any layout constraints on the target objects. | Animate
|  | duration : Number Duration of the effect in milliseconds. | Effect
|  | easer : IEaser The easing behavior for this effect. | Animate
|  | effectTargetHost : IEffectTargetHost A property that lets you access the target list-based control of a data effect. | Effect
|  | filter : String Specifies an algorithm for filtering targets for an effect. | Effect
|  | hideFocusRing : Boolean Determines whether the effect should hide the focus ring when starting the effect. | Effect
|  | instanceClass : Class An object of type Class that specifies the effect instance class class for this effect class. | Effect
|  | interpolator : IInterpolator The interpolator used by this effect to calculate values between the start and end values of a property. | Animate
|  | isPlaying : Boolean [read-only] A read-only flag which is true if any instances of the effect are currently playing, and false if none are. | Effect
|  | motionPaths : Vector.<MotionPath> A Vector of MotionPath objects, each of which holds the name of a property being animated and the values that the property takes during the animation. | Animate
|  | perElementOffset : Number Additional delay, in milliseconds, for effect targets after the first target of the effect. | Effect
|  | playheadTime : Number Current time position of the effect. | Effect
|  | relevantProperties : Array An Array of property names to use when performing filtering. | Effect
|  | relevantStyles : Array An Array of style names to use when performing filtering. | Effect
|  | repeatBehavior : String The behavior of a repeating effect, which means an effect with repeatCount equal to either 0 or > 1. | Animate
|  | repeatCount : int = 1 Number of times to repeat the effect. | Effect
|  | repeatDelay : int = 0 Amount of time, in milliseconds, to wait before repeating the effect. | Effect
|  | startDelay : int = 0 Amount of time, in milliseconds, to wait before starting the effect. | Effect
|  | target : Object The object to which this effect is applied. | Effect
|  | targets : Array An Array of objects that are targets for the effect. | Effect
|  | triggerEvent : Event The Event object passed to this Effect by the EffectManager when an effect is triggered, or null if the effect is not being played by the EffectManager. | Effect

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | applyTransitionEndProperties : Boolean This flag controls whether the effect, when run in a transition, automatically applies the property values according to the end state, as opposed to leaving values as set by the effect itself. | Effect
|  | endValuesCaptured : Boolean = false A flag containing true if the end values of an effect have already been determined, or false if they should be acquired from the current properties of the effect targets when the effect runs. | Effect

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | AnimateFilter(target:Object = null, filter:IBitmapFilter = null) Constructor. | AnimateFilter
|  | captureEndValues():void Captures the current values of the relevant properties on the effect's targets and saves them as end values. | Effect
|  | captureMoreStartValues(targets:Array):void Captures the current values of the relevant properties of an additional set of targets Flex uses this function when a data change effect is run. | Effect
|  | captureStartValues():void Captures the current values of the relevant properties on the effect's targets. | Effect
|  | createInstance(target:Object = null):IEffectInstance Creates a single effect instance and initializes it. | Effect
|  | createInstances(targets:Array = null):Array Takes an Array of target objects and invokes the createInstance() method on each target. | Effect
|  | deleteInstance(instance:IEffectInstance):void Removes event listeners from an instance and removes it from the list of instances. | Effect
|  | end(effectInstance:IEffectInstance = null):void Interrupts an effect that is currently playing, and jumps immediately to the end of the effect. | Effect
|  | getAffectedProperties():Array Returns an Array of Strings, where each String is the name of a property changed by this effect. | Effect
|  | pause():void Pauses the effect until you call the resume() method. | Effect
|  | play(targets:Array = null, playReversedFromEnd:Boolean = false):Array Begins playing the effect. | Effect
|  | resume():void Resumes the effect after it has been paused by a call to the pause() method. | Effect
|  | reverse():void Plays the effect in reverse, if the effect is currently playing, starting from the current position of the effect. | Effect
|  | stop():void Stops the effect, leaving the effect targets in their current state. | Effect

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | applyValueToTarget(target:Object, property:String, value:*, props:Object):void Used internally by the Effect infrastructure. | Effect
|  | effectEndHandler(event:EffectEvent):void Called when an effect instance has finished playing. | Effect
|  | effectStartHandler(event:EffectEvent):void This method is called when the effect instance starts playing. | Effect
|  | effectStopHandler(event:EffectEvent):void Called when an effect instance has stopped by a call to the stop() method. | Effect
|  | filterInstance(propChanges:Array, target:Object):Boolean Determines the logic for filtering out an effect instance. | Effect
|  | getValueFromTarget(target:Object, property:String):* Called by the captureStartValues() method to get the value of a property from the target. | Effect
|  | initInstance(instance:IEffectInstance):void Copies properties of the effect to the effect instance. | Effect

Events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | effectEnd | Dispatched when one of the effect's instances finishes playing, either when the instance finishes playing or when the effect is interrupted by a call to the end() method. | Effect
|  | effectRepeat | Dispatched when the effect begins a new repetition, for any effect that is repeated more than once. | Animate
|  | effectStart | Dispatched when the effect starts playing. | Effect
|  | effectStop | Dispatched when the effect has been stopped, which only occurs when the effect is interrupted by a call to the stop() method. | Effect
|  | effectUpdate | Dispatched every time the effect updates the target. | Animate

Property Detail

bitmapFilter | property

`public var bitmapFilter:IBitmapFilter`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

IBitmapFilter instance to apply and animate.

The filters that you can use with this effect are defined in the spark.filters. package. Common filters include the DropShadowFilter, GlowFilter, BlurFilter, and ShaderFilter.

Constructor Detail

AnimateFilter | () | Constructor

`public function AnimateFilter(target:Object = null, filter:IBitmapFilter = null)`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Parameters

| `target:Object` (default = `null`)`` — The Object to animate with this effect.
| `filter:IBitmapFilter` (default = `null`)`` — The filter to apply to the target. The filters that you can use with this effect are defined in the spark.filters. package.

Examples
AnimateFilterEffectExample.mxml

    <?xml version="1.0"?>
    <!--

      Licensed to the Apache Software Foundation (ASF) under one or more
      contributor license agreements.  See the NOTICE file distributed with
      this work for additional information regarding copyright ownership.
      The ASF licenses this file to You under the Apache License, Version 2.0
      (the "License"); you may not use this file except in compliance with
      the License.  You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

    -->
    <s:Application
        xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:mx="library://ns.adobe.com/flex/mx"
        xmlns:s="library://ns.adobe.com/flex/spark">

        <fx:Declarations>
            <s:DropShadowFilter id="myDSF"
                color="0x0000FF"
                distance="5"
                angle="315"/>

            <s:AnimateFilter id="myFilter"
                target="{myB2}"
                repeatCount="0"
                duration="500"
                repeatBehavior="reverse"
                bitmapFilter="{new spark.filters.DropShadowFilter()}">
                <s:SimpleMotionPath property="color" valueFrom="0" valueTo="0x0000FF"/>
                <s:SimpleMotionPath property="distance" valueFrom="0" valueTo="10"/>
                <s:SimpleMotionPath property="angle" valueFrom="270" valueTo="360"/>
            </s:AnimateFilter>
        </fx:Declarations>

        <s:Panel title="Animate Filter Effect Example"
            width="75%" height="75%">

            <s:Button id="myB1"
                x="50" y="50"
                label="Show a DropShadowFilter"
                filters="{[myDSF]}"/>

            <s:Button id="myB2"
                x="50" y="95"
                label="Animate a DropShadowFilter"
                click="myFilter.end();myFilter.play();"/>
        </s:Panel>
    </s:Application>

Wed Nov 15 2017, 09:50 AM +01:00