BrightnessAnimation

BrightnessAnimation

The ‘BrightnessAnimation’ class animates the brightness of any colorable display object.

See Also

com.boostworthy.animation.management.types.abstract.Animation, com.boostworthy.animation.management.types.abstract.IAnimation, com.boostworthy.core.IColorable

Summary
BrightnessAnimationThe ‘BrightnessAnimation’ class animates the brightness of any colorable display object.
Constants
PROPERTYMeta data for representing the property being animated.
Variables
m_nStartValueHolds the starting value for the ‘brightness’ property.
m_nTargetValueHolds the target value for the ‘brightness’ property.
m_nChangeValueHolds the change in value for the ‘brightness’ property.
m_nDurationHolds the duration of the animation in milliseconds.
m_nStartTimeHolds the starting time of the animation in milliseconds.
m_fncTransitionHolds a reference to the transition function being used for this animation.
Functions
BrightnessAnimationConstructor.
renderRenders the animation.

Constants

PROPERTY

public static const PROPERTY: String

Meta data for representing the property being animated.

Variables

m_nStartValue

protected var m_nStartValue: Number

Holds the starting value for the ‘brightness’ property.

m_nTargetValue

protected var m_nTargetValue: Number

Holds the target value for the ‘brightness’ property.

m_nChangeValue

protected var m_nChangeValue: Number

Holds the change in value for the ‘brightness’ property.

m_nDuration

protected var m_nDuration: Number

Holds the duration of the animation in milliseconds.

m_nStartTime

protected var m_nStartTime: Number

Holds the starting time of the animation in milliseconds.

m_fncTransition

protected var m_fncTransition: Function

Holds a reference to the transition function being used for this animation.

Functions

BrightnessAnimation

public function BrightnessAnimation(objTarget: IColorable,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)

Constructor.

Parameters

param objTarget The target object being animated.
param nTargetValue The value the brightness is being animated to.
param nDuration The duration of the animation in milliseconds.
param strTransition The transition to be used for the animation.
param uRenderMethod The method being used to render this animation. 

See Also

com.boostworthy.animation.easing.Transitions, com.boostworthy.animation.rendering.RenderMethod

render

public override function render():Boolean

Renders the animation.

Returns

A boolean value that is ‘true’ if the animation was updated successfully, ‘false’ if it was not. 

The ‘Animation’ class is the base class for all animation objects.
public static const PROPERTY: String
Meta data for representing the property being animated.
protected var m_nStartValue: Number
Holds the starting value for the ‘brightness’ property.
protected var m_nTargetValue: Number
Holds the target value for the ‘brightness’ property.
protected var m_nChangeValue: Number
Holds the change in value for the ‘brightness’ property.
protected var m_nDuration: Number
Holds the duration of the animation in milliseconds.
protected var m_nStartTime: Number
Holds the starting time of the animation in milliseconds.
protected var m_fncTransition: Function
Holds a reference to the transition function being used for this animation.
public function BrightnessAnimation(objTarget: IColorable,
nTargetValue: Number,
nDuration: Number,
strTransition: String,
uRenderMethod: uint)
Constructor.
public override function render():Boolean
Renders the animation.
Close