C# Class System.Windows.Media.Glitz.ProceduralAnimation

The base class for procedural animations.
Inheritance: IDisposable
Datei anzeigen Open project: nikhilk/silverlightfx Class Usage Examples

Private Properties

Property Type Description
OnPlay void
OnProgress bool
OnStop void

Public Methods

Method Description
Dispose ( ) : void

Disposes the animation instance.

Play ( FrameworkElement associatedElement ) : void

Schedules the animation to be played.

Stop ( ProceduralAnimationStopState stopState ) : void

Stops playing the animation mid-way. The specified stopState determines the state in which the element being animated is left in.

Protected Methods

Method Description
PerformCleanup ( ) : void

Allows the animation to perform any cleanup work once the animation is complete.

PerformSetup ( ) : void

Allows the animation to perform any setup work before the animation is started.

PlayCore ( ) : void

Plays the animation when it has been scheduled and started.

ProceduralAnimation ( ) : System

Initializes an instance of an Animation class.

ProgressCore ( bool startRepetition, bool startReverse, System.DateTime timeStamp ) : bool

Progresses the animation to the new current time.

Repeat ( bool reverse ) : void

Indicates the animation is being repeated.

StopCore ( bool completed, ProceduralAnimationStopState stopState ) : void

Stops the animation when it is no longer scheduled to continue playing.

Private Methods

Method Description
OnPlay ( bool reversed ) : void
OnProgress ( System.DateTime timeStamp ) : bool
OnStop ( bool completed, ProceduralAnimationStopState stopState ) : void

Method Details

Dispose() public method

Disposes the animation instance.
public Dispose ( ) : void
return void

PerformCleanup() protected method

Allows the animation to perform any cleanup work once the animation is complete.
protected PerformCleanup ( ) : void
return void

PerformSetup() protected method

Allows the animation to perform any setup work before the animation is started.
protected PerformSetup ( ) : void
return void

Play() public method

Schedules the animation to be played.
public Play ( FrameworkElement associatedElement ) : void
associatedElement System.Windows.FrameworkElement The element to use to control the animation.
return void

PlayCore() protected abstract method

Plays the animation when it has been scheduled and started.
protected abstract PlayCore ( ) : void
return void

ProceduralAnimation() protected method

Initializes an instance of an Animation class.
protected ProceduralAnimation ( ) : System
return System

ProgressCore() protected abstract method

Progresses the animation to the new current time.
protected abstract ProgressCore ( bool startRepetition, bool startReverse, System.DateTime timeStamp ) : bool
startRepetition bool Whether the animation is starting a repetition.
startReverse bool Whether the animation is starting a reverse run.
timeStamp System.DateTime The time stamp to progress the animation through.
return bool

Repeat() protected method

Indicates the animation is being repeated.
protected Repeat ( bool reverse ) : void
reverse bool Whether the next repetition will happen in reverse direction.
return void

Stop() public method

Stops playing the animation mid-way. The specified stopState determines the state in which the element being animated is left in.
public Stop ( ProceduralAnimationStopState stopState ) : void
stopState ProceduralAnimationStopState The state of the element upon stopping the animation.
return void

StopCore() protected abstract method

Stops the animation when it is no longer scheduled to continue playing.
protected abstract StopCore ( bool completed, ProceduralAnimationStopState stopState ) : void
completed bool Whether the animation has completed naturally.
stopState ProceduralAnimationStopState The state in which the animation should end if it was interrupted.
return void