![]() |
API 0.9.5
|
#import <CPAnimation.h>
Instance Methods | |
(CPAnimationCurve) | - animationCurve |
(void) | - animationTimerDidFire: |
(float) | - currentProgress |
(float) | - currentValue |
(id) | - delegate |
(CPTimeInterval) | - duration |
(float) | - frameRate |
(id) | - initWithDuration:animationCurve: |
(BOOL) | - isAnimating |
(void) | - setAnimationCurve: |
(void) | - setCurrentProgress: |
(void) | - setDelegate: |
(void) | - setDuration: |
(void) | - setFrameRate: |
(void) | - startAnimation |
(void) | - stopAnimation |
Manages an animation. Contains timing and progress information.
-(BOOL)animationShouldStart:(CPAnimation)animation; Called at the beginning of -startAnimation
.
animation | the animation that will start |
YES
allows the animation to start. NO
stops the animation.-(void)animationDidEnd:(CPAnimation)animation; Called when an animation has completed.
animation | the animation that completed |
-(void)animationDidStop:(CPAnimation)animation; Called when the animation was stopped (before completing).
animation | the animation that was stopped |
- (float)animation:(CPAnimation)animation valueForProgress:(float)progress; The value from this method will be returned when CPAnimation's currentValue
method is called.
animation | the animation to obtain the curve value for |
progress | the current animation progress |
Definition at line 2 of file CPAnimation.h.
- (CPAnimationCurve) animationCurve |
Returns the animation's pace
Definition at line 148 of file CPAnimation.j.
- (void) animationTimerDidFire: | (CPTimer) | aTimer |
Definition at line 235 of file CPAnimation.j.
- (float) currentProgress |
Returns the animation's progress
Definition at line 292 of file CPAnimation.j.
- (float) currentValue |
Returns the animation's timing progress.
Definition at line 300 of file CPAnimation.j.
- (id) delegate |
Returns the animation's delegate
Definition at line 198 of file CPAnimation.j.
- (CPTimeInterval) duration |
Returns the length of the animation.
Definition at line 169 of file CPAnimation.j.
- (float) frameRate |
Returns the desired frame rate.
Definition at line 190 of file CPAnimation.j.
- (id) initWithDuration: | (float) | aDuration | |
animationCurve: | (CPAnimationCurve) | anAnimationCurve | |
Initializes the animation with a duration and animation curve.
aDuration | the length of the animation |
anAnimationCurve | defines the animation's pace |
CPInvalidArgumentException | if an invalid animation curve is specified |
Definition at line 99 of file CPAnimation.j.
- (BOOL) isAnimating |
Returns YES
if the animation is running.
Definition at line 275 of file CPAnimation.j.
- (void) setAnimationCurve: | (CPAnimationCurve) | anAnimationCurve |
Sets the animation's pace.
anAnimationCurve | the animation's pace |
CPInvalidArgumentException | if an invalid animation curve is specified |
Definition at line 120 of file CPAnimation.j.
- (void) setCurrentProgress: | (float) | aProgress |
Sets the animation's progress.
aProgress | the animation's progress |
Definition at line 284 of file CPAnimation.j.
- (void) setDelegate: | (id) | aDelegate |
Sets the animation's delegate.
aDelegate | the new delegate |
Definition at line 207 of file CPAnimation.j.
- (void) setDuration: | (CPTimeInterval) | aDuration |
Sets the animation's length.
aDuration | the new animation length |
CPInvalidArgumentException | if aDuration is negative |
Definition at line 158 of file CPAnimation.j.
- (void) setFrameRate: | (float) | frameRate |
Sets the animation frame rate. This is not a guaranteed frame rate. 0 means to go as fast as possible.
frameRate | the new desired frame rate |
CPInvalidArgumentException | if frameRate is negative |
Definition at line 179 of file CPAnimation.j.
- (void) startAnimation |
Starts the animation. The method calls -animationShouldStart
: on the delegate (if it implements it) to see if the animation should begin.
Reimplemented in CPViewAnimation.
Definition at line 217 of file CPAnimation.j.
- (void) stopAnimation |
Stops the animation before it has completed.
Reimplemented in CPViewAnimation.
Definition at line 259 of file CPAnimation.j.