DrawKit
Vector and illustration framework for Mac OS X
Class Methods | List of all members
GCOneShotEffectTimer Class Reference

This class wraps up a very simple piece of timer functionality. More...

Inheritance diagram for GCOneShotEffectTimer:
Inheritance graph
[legend]

Class Methods

(id+ oneShotWithStandardFadeTimeForDelegate:
 
(id+ oneShotWithTime:forDelegate:
 
- Class Methods inherited from NSObject
(id+ alloc
 
(Class+ class
 
(void) + initialize
 
(void) + load
 
(id+ new
 
- Class Methods inherited from <NSKeyValueBindingCreation>
(void) + exposeBinding:
 

Additional Inherited Members

- Instance Methods inherited from NSObject
(NSString *) - address
 
(DKStyleRegistry *) - applicationWillReturnStyleRegistry
 
(BOOL- canBeUsedWithSelectionTool
 
(id- categoryManager:shouldReplaceObject:withObject:
 
(Class- classForCoder
 
(NSColor *) - colorValue
 
(NSColor *) - colourValue
 
(id- copy
 
(void) - dealloc
 
(id- deepCopy
 
(NSDictionary *) - dimensionValuesForArrowStroke:
 
(CGFloat- drawing:convertDistanceToExternalCoordinates:
 
(NSPoint) - drawing:convertLocationToExternalCoordinates:
 
(void) - drawing:didDrawRect:inView:
 
(void) - drawing:willDrawRect:inView:
 
(NSString *) - drawing:willReturnAbbreviationForUnit:
 
(NSString *) - drawing:willReturnFormattedCoordinateForDistance:
 
(CGFloat- drawingWillReturnUnitToPointsConversonFactor:
 
(void) - finalize
 
(NSString *) - hexString
 
(void) - hotspot:didEndTrackingWithEvent:inView:
 
(void) - hotspot:isTrackingWithEvent:inView:
 
(void) - hotspot:willBeginTrackingWithEvent:inView:
 
(NSData *) - imageData
 
(NSImage *) - imageResourceNamed:
 
(id- init
 
(id- initWithExpression:
 
(id- instantiateObjectWithShortName:parameters:
 
(BOOL- isLiteralValue
 
(void) - layoutManager:willPlaceGlyphAtIndex:atLocation:pathAngle:yOffset:
 
(void) - menuItem:wasAddedForObject:inCategory:
 
(BOOL- moveObjectTo:position:slope:userInfo:
 
(id- mutableCopy
 
(void) - oneShotComplete
 
(void) - oneShotHasReached:
 
(void) - oneShotWillBegin
 
(void) - path:elementIndex:type:points:subPathIndex:subPathClosed:contextInfo:
 
(id- placeLinkFromPoint:toPoint:onPath:linkNumber:userInfo:
 
(id- placeObjectAtPoint:onPath:position:slope:userInfo:
 
(NSPoint) - point
 
(NSPoint) - pointForTextLayout
 
(DKStyle *) - registry:shouldReplaceStyle:withStyle:
 
(NSBezierPath *) - renderer:willRenderPath:
 
(void) - routeFinder:progressHasReached:
 
(void) - setValue:forNumericParameter:
 
(NSString *) - stringValue
 
(CGFloat- taperFactorAtDistance:onPath:ofLength:
 
(void) - toolDidPerformUndoableAction:
 
(void) - toolWillPerformUndoableAction:
 
(NSURL *) - url
 
- Instance Methods inherited from <NSObject>
(NSString *) - description
 
(NSUInteger- hash
 
(BOOL- isEqual:
 
- Instance Methods inherited from <NSKeyValueBindingCreation>
(void) - bind:toObject:withKeyPath:options:
 
(NSArray *) - exposedBindings
 
(NSDictionary *) - infoForBinding:
 
(NSArray *) - optionDescriptionsForBinding:
 
(void) - unbind:
 
(Class- valueClassForBinding:
 

Detailed Description

This class wraps up a very simple piece of timer functionality.

Author
Contributions from the community; see CONTRIBUTORS.md
Date
2005-2015

This class wraps up a very simple piece of timer functionality. It sets up a timer that will call the delegate frequently with a value from 0..1. Once 1 is reached, it stops. The total time interval to complete the action is set by the caller.

This is useful for one-shot type animations such as fading out a window or similar.

The timer starts as soon as it is created.

The timer attempts to maintain a 60fps rate, and is capped at this value. On slower systems, it will drop frames as needed.

The oneshot effectively retains and releases itself, so there is nothing to do - just call the class method. You can generally ignore the return value. The oneshot retains the delegate, and releases it when it releases itself at the end of the effect, so the caller can happily release the delegate if it wishes after setting up the timer without worrying about what happens during the effect. It is also an error to release self (the delegate) when the completion method is called. Short version: it just works - don't try and retain/release anything in any different way from usual.

Method Documentation

+ (id) oneShotWithStandardFadeTimeForDelegate: (id del
+ (id) oneShotWithTime: (NSTimeInterval)  t
forDelegate: (id del