MiscAppIconAnimator.rtf

This is MiscAppIconAnimator.rtf in view mode; [Download] [Up]

MiscAppIconAnimator

Inherits From: Object

Declared In:

Class Description

MiscAppIconAnimator has been modeled after Fone.app (v1.0) by Jim Million, October 1992.
The MiscAppIconAnimator is a class defining an object that provides a convenient way to animate the icon for an application. Animation requires an array of images/icons to display in the icon, an array indicating the pattern/order to display the images, and the number of times to loop through the pattern . Other information that may be specified include: the image to display when the animation sequence finishes, the image to display when animation is stopped, and the time interval between image changes.

The display of images into the Application Icon will not work until the Application is fully initialized, and the icon is in place.

The animation sequence uses TimerEvents to loop through the animation pattern array. The pattern array contains the order in which to display the images. Each entry in the pattern array is an index into the array of images.

The startAnimation: method starts the animation sequence in the icon. The stopAnimation method is used to stop the animation sequence. The initWithImageArray: animationPattern: andPatternLoops: method is the designated initializer for the MiscAppIconAnimator object.

Instance Variables

NXImage *appTile;

View *appIconContentView;

List *animationPattern;

List *imageArray;

int patternLoops;

float timeInterval;

int indexOfEndIcon;

int indexOfStopIcon;

DPSTimedEntry timedEntry;

int patternIterator;

int loopCount;

int patternEnd;

int offset;

appTile The application's tile "NXAppTile".

appIconContentView The contentView of the application's icon.

animationPattern Array of indices into the imageArray, indicating the order to display the images.

imageArray Array of images to be placed in the icon.

patternLoops The number of times that the animationPattern will be looped through.

timeInterval The time interval between image changes. (default = 0.2 seconds)

indexOfEndIcon Index into the imageArray, indicating what image to display when the animation sequence ends. (default = 1)

indexOfStopIcon Index into the imageArray, indicating what image to display when the animation sequence is stopped. (default = 0)

timedEntry The identifier of the timed entry.

patternIterator The current pattern entry being animated.

loopCount The current number of loops through the pattern.

patternEnd The number of entries in the animation pattern.

offset Used to limit the display of the last image in the pattern to the first loop through.

Method Types

Initializing an MiscAppIconAnimator
- init
- initWithImageArray:animationPattern:andPatternLoops:

Configuring an MiscAppIconAnimator
- imageArray
- setimageArray:
- animationPattern
- setAnimationPattern:
- patternLoops
- setPatternLoops:
- timeInterval
- setTimeInterval:
- indexOfEndIcon
- setIndexOfEndIcon:
- indexOfStopIcon
- setIndexOfStopIcon:

Controlling the animation - startAnimation:
- stopAnimation

Displaying an Image in the icon - displayImage:
- displayImageAtIndex:

Archiving - write:
- read:

Distributed Object methods - encodeRemotelyFor:freeAfterEncoding:isBycopy:
- encodeUsing:
- decodeUsing:

Internal methods - animateIcon
- cornerPointForImage:
- removeTimedEntry

Instance Methods

animateIcon
- (void)animateIcon

Control the animation of images into the application icon. This method is called at the end of each timer interval. The next image from imageArray identified in the animationPattern is displayed, and then processing continues based on the input parameters. The timer may continue, or timing and the animation sequence may end. When the animation sequence ends, a designated image is displayed based on indexOfEndIcon.

See also: - animationPattern, - displayImage:, - imageArray, - indexOfEndIcon, - patternLoops, - removeTimedEntry, - startAnimation:, - stopAnimation

animationPattern

- (List *)animationPattern

Returns the List set by setAnimationPattern:. This array contains the pattern used in determining what order to display images in the animation sequence.