PowerUI.AnimatedProperty Class Reference

Detailed Description

A single css property being animated. Note that composite properties such as colours or rotations must be broken down into their inner properties (e.g. rgba, xyz). This is done internally by PowerUI.UIAnimation.

Public Member Functions

 AnimatedProperty (UIAnimation animation, CssProperty property, int innerIndex, Css.Value targetValue, float constantSpeedTime, float timeToAccelerateFor, float timeToDecelerateFor, bool updateCss)
 Creates a new animated property. More...
 
void Animate (UIAnimation animation, string targetValue, float constantSpeedTime, float timeToAccelerateFor, float timeToDecelerateFor, bool updateCss)
 Animates this property now. More...
 
void Animate (UIAnimation animation, Css.Value targetValue, float constantSpeedTime, float timeToAccelerateFor, float timeToDecelerateFor, bool updateCss)
 Animates this property now. More...
 
void Update ()
 
void AddToQueue ()
 
void Stop ()
 

Public Attributes

int Stage
 Which state the animation is at. Stage 0 = Accel, 1 = Constant speed, 2 = Decel. More...
 
float Speed
 The current speed in units per second of the animation. More...
 
float MaxSpeed
 The top speed in units per second of the animation that it will accelerate up to. More...
 
bool UpdateCss
 True if this particular property should flush the output to the screen. This is required if there are multiple inner properties for a particular CSS property. More...
 
int InnerIndex
 The inner index of this value. More...
 
bool Decelerate
 True if this animation should decelerate and generate a smooth stop. More...
 
float CurrentTime
 The current time in seconds that has passed since the animation started. More...
 
float ActiveValue
 The value that should be applied right now in terms of units. More...
 
float TargetValue
 The value that this property will be at the end of the animation. More...
 
float Acceleration
 The acceleration rate in units per second. More...
 
float Deceleration
 The deceleration rate in units per second. More...
 
UIAnimation Animation
 The parent animation that this property belongs to. More...
 
Css.Value ValueObject
 The CSS value object that the current value of this is applied to. More...
 
CssProperty PropertyInfo
 The property being animated. More...
 
Css.Value PropertyValueObject
 The CSS property that this value is a part of. For example, if this property currently being animated is the red component of the colour overlay, the property value object is the colour overlay as a whole. More...
 
AnimatedProperty PropertyAfter
 Currently animated properties are stored in a linked list. This is the next one in the list. More...
 
AnimatedProperty PropertyBefore
 Currently animated properties are stored in a linked list. This is the one before this in the list. More...
 

Properties

string Property [get]
 The prime property being animated. More...
 
Element Animating [get]
 The element being animated. More...
 

Constructor & Destructor Documentation

PowerUI.AnimatedProperty.AnimatedProperty ( UIAnimation  animation,
CssProperty  property,
int  innerIndex,
Css.Value  targetValue,
float  constantSpeedTime,
float  timeToAccelerateFor,
float  timeToDecelerateFor,
bool  updateCss 
)
inline

Creates a new animated property.

Parameters
animationThe animation that this property is a part of.
propertyThe property being animated.
targetValueThe value that this property will be when the animation is over.
constantSpeedTimeHow long the animation will change the value at a constant speed for.
timeToAccelerateForHow long the animation will accelerate for. This produces a smoother animation.
timeToDecelerateForHow long the animation will decelerate for. This produces a smoother animation.
updateCssTrue if this particular property should flush its changes to css/the screen.

Member Function Documentation

void PowerUI.AnimatedProperty.AddToQueue ( )
inline
void PowerUI.AnimatedProperty.Animate ( UIAnimation  animation,
string  targetValue,
float  constantSpeedTime,
float  timeToAccelerateFor,
float  timeToDecelerateFor,
bool  updateCss 
)
inline

Animates this property now.

Parameters
animationThe animation that this property is a part of.
targetValueThe value that this property will be when the animation is over.
constantSpeedTimeHow long the animation will change the value at a constant speed for.
timeToAccelerateForHow long the animation will accelerate for. This produces a smoother animation.
timeToDecelerateForHow long the animation will decelerate for. This produces a smoother animation.
updateCssTrue if this particular property should flush its changes to css/the screen.
void PowerUI.AnimatedProperty.Animate ( UIAnimation  animation,
Css.Value  targetValue,
float  constantSpeedTime,
float  timeToAccelerateFor,
float  timeToDecelerateFor,
bool  updateCss 
)
inline

Animates this property now.

Parameters
animationThe animation that this property is a part of.
targetValueThe parsed value that this property will be when the animation is over.
constantSpeedTimeHow long the animation will change the value at a constant speed for.
timeToAccelerateForHow long the animation will accelerate for. This produces a smoother animation.
timeToDecelerateForHow long the animation will decelerate for. This produces a smoother animation.
updateCssTrue if this particular property should flush its changes to css/the screen.
void PowerUI.AnimatedProperty.Stop ( )
inline
void PowerUI.AnimatedProperty.Update ( )
inline

Member Data Documentation

float PowerUI.AnimatedProperty.Acceleration

The acceleration rate in units per second.

float PowerUI.AnimatedProperty.ActiveValue

The value that should be applied right now in terms of units.

UIAnimation PowerUI.AnimatedProperty.Animation

The parent animation that this property belongs to.

float PowerUI.AnimatedProperty.CurrentTime

The current time in seconds that has passed since the animation started.

bool PowerUI.AnimatedProperty.Decelerate

True if this animation should decelerate and generate a smooth stop.

float PowerUI.AnimatedProperty.Deceleration

The deceleration rate in units per second.

int PowerUI.AnimatedProperty.InnerIndex

The inner index of this value.

float PowerUI.AnimatedProperty.MaxSpeed

The top speed in units per second of the animation that it will accelerate up to.

AnimatedProperty PowerUI.AnimatedProperty.PropertyAfter

Currently animated properties are stored in a linked list. This is the next one in the list.

AnimatedProperty PowerUI.AnimatedProperty.PropertyBefore

Currently animated properties are stored in a linked list. This is the one before this in the list.

CssProperty PowerUI.AnimatedProperty.PropertyInfo

The property being animated.

Css.Value PowerUI.AnimatedProperty.PropertyValueObject

The CSS property that this value is a part of. For example, if this property currently being animated is the red component of the colour overlay, the property value object is the colour overlay as a whole.

float PowerUI.AnimatedProperty.Speed

The current speed in units per second of the animation.

int PowerUI.AnimatedProperty.Stage

Which state the animation is at. Stage 0 = Accel, 1 = Constant speed, 2 = Decel.

float PowerUI.AnimatedProperty.TargetValue

The value that this property will be at the end of the animation.

bool PowerUI.AnimatedProperty.UpdateCss

True if this particular property should flush the output to the screen. This is required if there are multiple inner properties for a particular CSS property.

Css.Value PowerUI.AnimatedProperty.ValueObject

The CSS value object that the current value of this is applied to.

Property Documentation

Element PowerUI.AnimatedProperty.Animating
get

The element being animated.

string PowerUI.AnimatedProperty.Property
get

The prime property being animated.