Up
Authors
- Generated by Gregory John Casamento,,,
-
Date: Generated at 2023-12-22 15:07:50 -0500
- Declared in:
- AppKit/NSAnimation.h
- Conforms to:
- NSCopying
- NSCoding
- GSAnimation
Availability: MacOS-X 10.4.0
Objects of the NSAnimation class manage the timing
and progress of animations in the user interface. The
class also lets you link together multiple animations
so that when one animation ends another one starts. It
does not provide any drawing support for animation and
does not directly deal with views, targets, or actions.
Instance Variables
Method summary
- (void)
addProgressMark: (
NSAnimationProgress)progress;
Availability: MacOS-X 10.4.0
Adds the progress mark to the receiver.
- (
NSAnimationBlockingMode)
animationBlockingMode;
Availability: MacOS-X 10.4.0
Returns the blocking mode the receiver is next
scheduled to run under.
- (
NSAnimationCurve)
animationCurve;
Availability: MacOS-X 10.4.0
Returns the animation curve the receiver is running
under.
- (void)
clearStartAnimation;
Availability: MacOS-X 10.4.0
Clears linkage to another animation that causes the
receiver to start.
- (void)
clearStopAnimation;
Availability: MacOS-X 10.4.0
Clears linkage to another animation that causes the
receiver to stop.
- (
NSAnimationProgress)
currentProgress;
Availability: MacOS-X 10.4.0
Returns the current progress of the receiver.
- (float)
currentValue;
Availability: MacOS-X 10.4.0
Returns the current value of the effect based on
the current progress.
- (id)
delegate;
Availability: MacOS-X 10.4.0
Returns the delegate of the receiver.
- (NSTimeInterval)
duration;
Availability: MacOS-X 10.4.0
Returns the duration of the animation, in seconds.
- (float)
frameRate;
Availability: MacOS-X 10.4.0
Returns the frame rate of the animation.
- (id)
initWithDuration: (NSTimeInterval)duration
animationCurve: (
NSAnimationCurve)curve;
Availability: MacOS-X 10.4.0
Returns an NSAnimation object initialized with the
specified duration and animation-curve
values.
- (BOOL)
isAnimating;
Availability: MacOS-X 10.4.0
Returns a Boolean value that indicates whether the
receiver is currently animating.
- (NSArray*)
progressMarks;
Availability: MacOS-X 10.4.0
Returns the receiver's progress marks.
- (void)
removeProgressMark: (
NSAnimationProgress)progress;
Availability: MacOS-X 10.4.0
Removes a progress mark from the
receiver. A value that does not correspond to a
progress mark is ignored.
- (NSArray*)
runLoopModesForAnimating;
Availability: MacOS-X 10.4.0
Overridden to return the run-loop modes that the
receiver uses to run the animation timer in.
- (void)
setAnimationBlockingMode: (
NSAnimationBlockingMode)mode;
Availability: MacOS-X 10.4.0
Sets the blocking mode of the receiver. The
new blocking mode takes effect the next time
the receiver is started.
- (void)
setAnimationCurve: (
NSAnimationCurve)curve;
Availability: MacOS-X 10.4.0
Sets the receiver's animation curve. The
new value affects the animation already in progress :
the actual curve smoothly changes from the
old curve to the new one.
- (void)
setCurrentProgress: (
NSAnimationProgress)progress;
Availability: MacOS-X 10.4.0
Sets the current progress of the receiver.
In the case of a forward jump the marks between the
previous progress value and the new
(excluded) progress value are
ignored. In the case of a backward jump (rewind)
the marks will be reached again.
- (void)
setDelegate: (id)delegate;
Availability: MacOS-X 10.4.0
Sets the delegate of the receiver. The new
delegate takes effect the next time the
receiver is started.
- (void)
setDuration: (NSTimeInterval)duration;
Availability: MacOS-X 10.4.0
Sets the duration of the animation to a
specified number of seconds. If the
duration is changed while the animation is
running the speed of the animation is not
changed but the current progress value is (see
-setCurrentprogress
). The new value takes effect at the next frame.
- (void)
setFrameRate: (float)fps;
Availability: MacOS-X 10.4.0
Sets the frame rate of the receiver. The new frame
rate takes effect at the next frame.
- (void)
setProgressMarks: (NSArray*)progress;
Availability: MacOS-X 10.4.0
Sets the receiver's progress marks to the
values specified in the passed-in array. The new
marks are t
- (void)
startAnimation;
Availability: MacOS-X 10.4.0
Starts the animation represented by the receiver. If
the animation is already running the method has no
effect.
- (void)
startWhenAnimation: (
NSAnimation*)animation
reachesProgress: (
NSAnimationProgress)start;
Availability: MacOS-X 10.4.0
Starts running the animation represented
by the receiver when another animation
reaches a specific progress mark.
- (void)
stopAnimation;
Availability: MacOS-X 10.4.0
Stops the animation represented by the receiver. If
the animation is not running the method has no effect.
- (void)
stopWhenAnimation: (
NSAnimation*)animation
reachesProgress: (
NSAnimationProgress)stop;
Availability: MacOS-X 10.4.0
Stops running the animation represented by
the receiver when another animation reaches
a specific progress mark.
Instance Variables for NSAnimation Class
@protected GSAnimator* _animator;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimationBlockingMode _blockingMode;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected unsigned int _cachedProgressMarkNumberCount;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSNumber** _cachedProgressMarkNumbers;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected id _currentDelegate;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimationProgress _currentProgress;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimationCurve _curve;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected _NSAnimationCurveDesc _curveDesc;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimationProgress _curveProgressShift;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected id _delegate;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected void(* _delegate_animationDidEnd;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected void(* _delegate_animationDidReachProgressMark;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected void(* _delegate_animationDidStop;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected BOOL(* _delegate_animationShouldStart;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected float(* _delegate_animationValueForProgress;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSTimeInterval _duration;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected float _frameRate;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected BOOL _isANewAnimatorNeeded;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSRecursiveLock* _isAnimatingLock;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected BOOL _isCachedProgressMarkNumbersValid;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected BOOL _isThreaded;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected unsigned int _nextMark;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected void* _progressMarks;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimation* _startAnimation;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimationProgress _startMark;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimation* _stopAnimation;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSAnimationProgress _stopMark;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
- Declared in:
- AppKit/NSAnimation.h
Availability: MacOS-X 10.4.0
The NSViewAnimation class, a public subclass of
NSAnimation, offers a convenient way to animate
multiple views and windows. The animation effects
you can achieve are limited to changes in frame location
and size, and to fade-in and fade-out effects.
Instance Variables
Method summary
- (id)
initWithViewAnimations: (NSArray*)animations;
Availability: MacOS-X 10.4.0
Returns an NSViewAnimation object initialized with
the supplied information.
- (void)
setViewAnimations: (NSArray*)animations;
Availability: MacOS-X 10.4.0
Sets the dictionaries defining the objects to animate.
- (NSArray*)
viewAnimations;
Availability: MacOS-X 10.4.0
Returns the array of dictionaries defining the
objects to animate.
Instance Variables for NSViewAnimation Class
@protected NSMutableArray* _viewAnimationDesc;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
@protected NSArray* _viewAnimations;
Availability: MacOS-X 10.4.0
Warning the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically private, it is
intended for internal use within the package, and
you should not use the variable in other code.
- Declared in:
- AppKit/NSAnimation.h
Availability: MacOS-X 10.4.0
Description forthcoming.
Method summary
- (float)
actualFrameRate;
Availability: MacOS-X 10.4.0
Returns the current the actual (mesured) frame rate
value
- (unsigned int)
frameCount;
Availability: MacOS-X 10.4.0
Returns the current value of the frame counter
- (void)
resetCounters;
Availability: MacOS-X 10.4.0
Resets all stats
- Declared in:
- AppKit/NSAnimation.h
Availability: MacOS-X 10.4.0
Description forthcoming.
Method summary
- (void)
animation: (
NSAnimation*)animation
didReachProgressMark: (
NSAnimationProgress)progress;
Availability: MacOS-X 10.4.0
NSAnimation delegate method. Sent to the
delegate when an animation reaches a
specific progress mark.
- (float)
animation: (
NSAnimation*)animation
valueForProgress: (
NSAnimationProgress)progress;
Availability: MacOS-X 10.4.0
NSAnimation delegate method. Requests a custom
curve value for the current progress
value.
- (void)
animationDidEnd: (
NSAnimation*)animation;
Availability: MacOS-X 10.4.0
NSAnimation delegate method. Sent to the
delegate when the specified animation
completes its run.
- (void)
animationDidStop: (
NSAnimation*)animation;
Availability: MacOS-X 10.4.0
NSAnimation delegate method. Sent to the
delegate when the specified animation
is stopped before it completes its run.
- (BOOL)
animationShouldStart: (
NSAnimation*)animation;
Availability: MacOS-X 10.4.0
NSAnimation delegate method. Sent to the
delegate just after an animation is
started.
- Declared in:
- AppKit/NSAnimation.h
- Conforms to:
- NSObject
Availability: MacOS-X 10.4.0
Description forthcoming.
Up