View source

class ActuateEffectContext

package feathers.motion.effects.actuate

extends BaseEffectContext

@:directlyUsed

A Feathers UI effect context that uses the Actuate library.

To create actuators for use with ActuateEffectContext, use the static functions from the ActuateForEffects class instead of the standard Actuate class. ActuateEffectContext requires special actuators with several extra properties that don't exist on the default IGenericActuator interface returned by the methods on Actuate.

In the following example, a custom effect is created with ActuateForEffects and ActuateEffectContext:

var customFadeOutEffect = function(target:Dynamic):IEffectContext
{
	var actuator = ActuateForEffects.tween(target, 1.0, {alpha: 0.0});
	return new ActuateEffectContext(target, actuator);
};

@jgranick/actuate on Github](https://github.com/jgranick/actuate)

Available since

1.0.0

.

See also:

Constructor

@:value({ interruptBehavior : END })new(target:Dynamic, actuator:IReadableGenericActuator, interruptBehavior:EffectInterruptBehavior = END)

Creates a new ActuateEffectContext object from the given arguments.

Available since

1.0.0

.

Variables

read onlyactuator:IReadableGenericActuator

The actuator that is controlled by the effect.

Available since

1.0.0

.

See also:

interruptBehavior:EffectInterruptBehavior

Indicates how the effect behaves when it is interrupted. Interrupted effects can either advance directly to the end or stop at the current position.

Available since

1.0.0

.

See also:

Methods

Inherited Variables

Defined by BaseEffectContext

read onlyduration:Float

The total running time of the effect, measured in seconds.

Available since

1.0.0

.

read onlyease:IEasing

The easing function to use for animation.

Available since

1.0.0

.

position:Float

The current position of the effect, in the range of 0.0 to 1.0.

Available since

1.0.0

.

See also:

read onlytarget:Dynamic

The effect's target object, which may be modified in some way, such as animating one of the target's properties.

Available since

1.0.0

.

Inherited Methods

Defined by BaseEffectContext

private@:dox(show)cleanupEffect():Void

Called when the effect completes or is interrupted. Subclasses may override this method to customize the effect's behavior.

Available since

1.0.0

.

pause():Void

Pauses an effect that is playing at the current position.

Available since

1.0.0

.

play():Void

Starts playing the effect from the current position.

Available since

1.0.0

.

playReverse():Void

Starts playing the effect from its current position back to the beginning (completing at a position of 0.0).

Available since

1.0.0

.

private@:dox(show)prepareEffect():Void

Called when the effect is initialized. Subclasses may override this method to customize the effect's behavior.

Available since

1.0.0

.

stop():Void

Stops the effect at its current position and forces Event.COMPLETE to be dispatched.

Available since

1.0.0

.

See also:

toEnd():Void

Advances the effect immediately to the end and forces Event.COMPLETE to be dispatched.

Available since

1.0.0

.

See also:

private@:dox(show)updateEffect():Void

Called when the effect's position is updated. Subclasses may override this method to customize the effect's behavior.

Available since

1.0.0

.