Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/include/GNUstep/AppKit/
Upload File :
Current File : //usr/include/GNUstep/AppKit/NSAnimation.h
/*
NSAnimation.h
Created by Dr. H. Nikolaus Schaller on Sat Jan 07 2006.
Copyright (c) 2007 Free Software Foundation, Inc.
Author: Xavier Glattard (xgl) <xavier.glattard@online.fr>
This file used to be part of the mySTEP Library.
This file now is part of the GNUstep GUI Library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; see the file COPYING.LIB.
If not, see <http://www.gnu.org/licenses/> or write to the
Free Software Foundation, 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef _GNUstep_H_NSAnimation_
#define _GNUstep_H_NSAnimation_
#import <GNUstepBase/GSVersionMacros.h>
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4, GS_API_LATEST)
#import <Foundation/NSObject.h>
#import <AppKit/AppKitDefines.h>
#import <GNUstepGUI/GSAnimator.h>
@class NSString;
@class NSArray;
@class NSMutableArray;
@class NSNumber;
@class NSRecursiveLock;
/** These constants describe the curve of an animation,
that is, the relative speed of an animation from start to finish. */
enum _NSAnimationCurve
{
NSAnimationEaseInOut = 0, // default
NSAnimationEaseIn,
NSAnimationEaseOut,
NSAnimationLinear,
NSAnimationSpeedInOut // GNUstep only
};
typedef NSUInteger NSAnimationCurve;
/** These constants indicate the blocking mode of an NSAnimation object when it is running. */
enum _NSAnimationBlockingMode
{
NSAnimationBlocking,
NSAnimationNonblocking,
NSAnimationNonblockingThreaded
};
typedef NSUInteger NSAnimationBlockingMode;
typedef float NSAnimationProgress;
// Bezier curve parameters
typedef struct __GSBezierDesc
{
float p[4]; // control points
BOOL areCoefficientsComputed;
float a[4]; // coefficients
} _GSBezierDesc;
// Rational Bezier curve parameters
typedef struct __GSRationalBezierDesc
{
float w[4]; // weights
float p[4]; // control points
BOOL areBezierDescComputed;
_GSBezierDesc n; // numerator
_GSBezierDesc d; // denumerator
} _GSRationalBezierDesc;
// Animation curve parameters
typedef struct __NSAnimationCurveDesc
{
float s,e; // start & end values
float sg,eg; // start & end gradients
_GSRationalBezierDesc rb;
BOOL isRBezierComputed;
} _NSAnimationCurveDesc;
/** Posted when the current progress of a running animation reaches one of its progress marks. */
APPKIT_EXPORT NSString *NSAnimationProgressMarkNotification;
/** Key used in the [NSNotification-userInfo] disctionary to access the current progress mark. */
APPKIT_EXPORT NSString *NSAnimationProgressMark;
APPKIT_EXPORT NSString *NSAnimationTriggerOrderIn;
APPKIT_EXPORT NSString *NSAnimationTriggerOrderOut;
/**
* 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.
*/
@interface NSAnimation : NSObject < NSCopying, NSCoding, GSAnimation >
{
// FIXME ... all these ivars should be hidden inside a pointer to an
// FIXME ... opaque data structure, so that layout etc can be changed
// FIXME ... without breaking binary compatibility.
NSTimeInterval _duration; // Duration of the animation
float _frameRate; // Wanted frame rate
NSAnimationCurve _curve; // Id of progres->value function
_NSAnimationCurveDesc _curveDesc; // The curve as a rat. Bezier
NSAnimationProgress _curveProgressShift;// Shift used for switching
// from a curve to an other
NSAnimationProgress _currentProgress; // Progress of the animation
/* GSIArray<NSAnimationProgress> */ void *_progressMarks; // Array
unsigned int _nextMark; // The next mark to be reached
// = count if no next mark
__strong NSNumber **_cachedProgressMarkNumbers; // Cached values used by
unsigned _cachedProgressMarkNumberCount;// [-progressMarks]
BOOL _isCachedProgressMarkNumbersValid;
NSAnimation *_startAnimation, *_stopAnimation; // Animations used as
NSAnimationProgress _startMark, _stopMark; // trigger, and marks
NSAnimationBlockingMode _blockingMode; // Blocking mode
GSAnimator *_animator; // The animator
BOOL _isANewAnimatorNeeded; // Some parameters have changed...
id _delegate; // The delegate, and the cached delegation methods...
void (*_delegate_animationDidReachProgressMark)(id,SEL,NSAnimation*,NSAnimationProgress);
float (*_delegate_animationValueForProgress )(id,SEL,NSAnimation*,NSAnimationProgress);
void (*_delegate_animationDidEnd )(id,SEL,NSAnimation*);
void (*_delegate_animationDidStop )(id,SEL,NSAnimation*);
BOOL (*_delegate_animationShouldStart )(id,SEL,NSAnimation*);
id _currentDelegate; // The delegate when the animation is running
BOOL _isThreaded;
NSRecursiveLock *_isAnimatingLock;
}
/** Adds the progress mark to the receiver. */
- (void) addProgressMark: (NSAnimationProgress)progress;
/** Returns the blocking mode the receiver is next scheduled to run under. */
- (NSAnimationBlockingMode) animationBlockingMode;
/** Returns the animation curve the receiver is running under. */
- (NSAnimationCurve) animationCurve;
/** Clears linkage to another animation that causes the receiver to start. */
- (void) clearStartAnimation;
/** Clears linkage to another animation that causes the receiver to stop. */
- (void) clearStopAnimation;
/** Returns the current progress of the receiver. */
- (NSAnimationProgress) currentProgress;
/** Returns the current value of the effect based on the current progress. */
- (float) currentValue;
/** Returns the delegate of the receiver. */
- (id) delegate;
/** Returns the duration of the animation, in seconds. */
- (NSTimeInterval) duration;
/** Returns the frame rate of the animation. */
- (float) frameRate;
/** Returns an NSAnimation object initialized with the specified duration and animation-curve values. */
- (id) initWithDuration: (NSTimeInterval)duration
animationCurve: (NSAnimationCurve)curve;
/** Returns a Boolean value that indicates whether the receiver is currently animating. */
- (BOOL) isAnimating;
/** Returns the receiver's progress marks. */
- (NSArray*) progressMarks;
/** Removes a progress mark from the receiver.
A value that does not correspond to a progress mark is ignored.*/
- (void) removeProgressMark: (NSAnimationProgress)progress;
/** Overridden to return the run-loop modes that the receiver uses to run the
animation timer in. */
- (NSArray*) runLoopModesForAnimating;
/** Sets the blocking mode of the receiver.
The new blocking mode takes effect the next time the receiver is started. */
- (void) setAnimationBlockingMode: (NSAnimationBlockingMode)mode;
/** 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) setAnimationCurve: (NSAnimationCurve)curve;
/** 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) setCurrentProgress: (NSAnimationProgress)progress;
/** Sets the delegate of the receiver.
The new delegate takes effect the next time the receiver is started. */
- (void) setDelegate: (id)delegate;
/** Sets the duration of the animation to a specified number of seconds.
If the duration is changed while the animation is running the <i>speed</i>
of the animation is not changed but the current progress value is
(see [-setCurrentprogress]). The new value takes effect at the next
frame. */
- (void) setDuration: (NSTimeInterval)duration;
/** Sets the frame rate of the receiver.
The new frame rate takes effect at the next frame. */
- (void) setFrameRate: (float)fps;
/** Sets the receiver's progress marks to the values specified in the
passed-in array. The new marks are t*/
- (void) setProgressMarks: (NSArray*)progress;
/** Starts the animation represented by the receiver.
If the animation is already running the method has no effect.*/
- (void) startAnimation;
/** Starts running the animation represented by the receiver when another
animation reaches a specific progress mark. */
- (void) startWhenAnimation: (NSAnimation*)animation
reachesProgress: (NSAnimationProgress)start;
/** Stops the animation represented by the receiver.
If the animation is not running the method has no effect.*/
- (void) stopAnimation;
/** Stops running the animation represented by the receiver when another
animation reaches a specific progress mark. */
- (void) stopWhenAnimation: (NSAnimation*)animation
reachesProgress: (NSAnimationProgress)stop;
@end
@interface NSAnimation (GNUstep)
/** Returns the current value of the frame counter */
- (unsigned int) frameCount;
/** Resets all stats */
- (void) resetCounters;
/** Returns the current the actual (mesured) frame rate value */
- (float) actualFrameRate;
@end
@protocol NSAnimationDelegate <NSObject>
#if OS_API_VERSION(MAC_OS_X_VERSION_10_6, GS_API_LATEST) && GS_PROTOCOLS_HAVE_OPTIONAL
@optional
#else
@end
@interface NSObject (NSAnimation)
#endif
/** NSAnimation delegate method.
* Sent to the delegate when an animation reaches a specific progress mark. */
- (void) animation: (NSAnimation*)animation
didReachProgressMark: (NSAnimationProgress)progress;
/** NSAnimation delegate method.
* Requests a custom curve value for the current progress value. */
- (float) animation: (NSAnimation*)animation
valueForProgress: (NSAnimationProgress)progress;
/** NSAnimation delegate method.
* Sent to the delegate when the specified animation completes its run. */
- (void) animationDidEnd: (NSAnimation*)animation;
/** NSAnimation delegate method.
* Sent to the delegate when the specified animation is stopped before it completes its run. */
- (void) animationDidStop: (NSAnimation*)animation;
/** NSAnimation delegate method.
* Sent to the delegate just after an animation is started. */
- (BOOL) animationShouldStart: (NSAnimation*)animation;
@end
APPKIT_EXPORT NSString *NSViewAnimationTargetKey;
APPKIT_EXPORT NSString *NSViewAnimationStartFrameKey;
APPKIT_EXPORT NSString *NSViewAnimationEndFrameKey;
APPKIT_EXPORT NSString *NSViewAnimationEffectKey;
APPKIT_EXPORT NSString *NSViewAnimationFadeInEffect;
APPKIT_EXPORT NSString *NSViewAnimationFadeOutEffect;
/**
* 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.
*/
@interface NSViewAnimation : NSAnimation
{
NSArray *_viewAnimations;
NSMutableArray *_viewAnimationDesc;
}
/** Returns an NSViewAnimation object initialized with the supplied information. */
- (id) initWithViewAnimations: (NSArray*)animations;
/** Sets the dictionaries defining the objects to animate. */
- (void) setViewAnimations: (NSArray*)animations;
/** Returns the array of dictionaries defining the objects to animate. */
- (NSArray*) viewAnimations;
@end
#endif /* OS_API_VERSION */
#endif /* _GNUstep_H_NSAnimation_ */
Server : Apache/2.4.41 (Ubuntu)