CPAnimation Class Reference
[AppKit]

List of all members.

Public Member Functions
(id)	- initWithDuration:animationCurve: [implementation]
(void)	- setAnimationCurve: [implementation]
(CPAnimationCurve)	- animationCurve [implementation]
(void)	- setDuration: [implementation]
(CPTimeInterval)	- duration [implementation]
(void)	- setFrameRate: [implementation]
(float)	- frameRate [implementation]
(id)	- delegate [implementation]
(void)	- setDelegate: [implementation]
(void)	- startAnimation [implementation]
(void)	- animationTimerDidFire: [implementation]
(void)	- stopAnimation [implementation]
(BOOL)	- isAnimating [implementation]
(void)	- setCurrentProgress: [implementation]
(float)	- currentProgress [implementation]
(float)	- currentValue [implementation]

---

Detailed Description

Manages an animation. Contains timing and progress information.

Delegate Methods

-(BOOL)animationShouldStart:(CPAnimation)animation; Called at the beginning of startAnimation.

Parameters:

animation

the animation that will start

Returns:

YES allows the animation to start. NO stops the animation.

-(void)animationDidEnd:(CPAnimation)animation; Called when an animation has completed.

Parameters:

animation

the animation that completed

-(void)animationDidStop:(CPAnimation)animation; Called when the animation was stopped (before completing).

Parameters:

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.

Parameters:

	animation	the animation to obtain the curve value for
	progress	the current animation progress

Returns:

the curve value

Definition at line 80 of file CPAnimation.j.

---

Member Function Documentation

- (CPAnimationCurve) animationCurve

[implementation]

Returns the animation's pace

Definition at line 149 of file CPAnimation.j.

- (void) animationTimerDidFire:

(CPTimer)

aTimer

[implementation]

Definition at line 236 of file CPAnimation.j.

- (float) currentProgress

[implementation]

Returns the animation's progress

Definition at line 293 of file CPAnimation.j.

- (float) currentValue

[implementation]

Returns the animation's timing progress.

Definition at line 301 of file CPAnimation.j.

- (id) delegate

[implementation]

Returns the animation's delegate

Definition at line 199 of file CPAnimation.j.

- (CPTimeInterval) duration

[implementation]

Returns the length of the animation.

Definition at line 170 of file CPAnimation.j.

- (float) frameRate

[implementation]

Returns the desired frame rate.

Definition at line 191 of file CPAnimation.j.

- (id) initWithDuration:		(float)	aDuration
animationCurve:		(CPAnimationCurve)	anAnimationCurve
				[implementation]

Initializes the animation with a duration and animation curve.

Parameters:

	aDuration	the length of the animation
	anAnimationCurve	defines the animation's pace

Exceptions:

CPInvalidArgumentException

if an invalid animation curve is specified

Definition at line 101 of file CPAnimation.j.

- (BOOL) isAnimating

[implementation]

Returns YES if the animation is running.

Definition at line 276 of file CPAnimation.j.

- (void) setAnimationCurve:

(CPAnimationCurve)

anAnimationCurve

[implementation]

Sets the animation's pace.

Parameters:

anAnimationCurve

the animation's pace

Exceptions:

CPInvalidArgumentException

if an invalid animation curve is specified

Definition at line 121 of file CPAnimation.j.

- (void) setCurrentProgress:

(float)

aProgress

[implementation]

Sets the animation's progress.

Parameters:

aProgress

the animation's progress

Definition at line 285 of file CPAnimation.j.

- (void) setDelegate:

(id)

aDelegate

[implementation]

Sets the animation's delegate.

Parameters:

aDelegate

the new delegate

Definition at line 208 of file CPAnimation.j.

- (void) setDuration:

(CPTimeInterval)

aDuration

[implementation]

Sets the animation's length.

Parameters:

aDuration

the new animation length

Exceptions:

CPInvalidArgumentException

if aDuration is negative

Definition at line 159 of file CPAnimation.j.

- (void) setFrameRate:

(float)

frameRate

[implementation]

Sets the animation frame rate. This is not a guaranteed frame rate. 0 means to go as fast as possible.

Parameters:

frameRate

the new desired frame rate

Exceptions:

CPInvalidArgumentException

if frameRate is negative

Definition at line 180 of file CPAnimation.j.

- (void) startAnimation

[implementation]

Starts the animation. The method calls animationShouldStart: on the delegate (if it implements it) to see if the animation should begin.

Definition at line 218 of file CPAnimation.j.

- (void) stopAnimation

[implementation]

Stops the animation before it has completed.

Definition at line 260 of file CPAnimation.j.

---

The documentation for this class was generated from the following file:

• AppKit/CPAnimation.j