AWFImageAnimation

Objective-C

@interface AWFImageAnimation : AWFAnimation

Swift

class AWFImageAnimation : AWFAnimation

An AWFImageAnimation object manages the animation of of date-specific images across a period of time.

  • The image view whose image is updated in response to the animation progress.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) UIImageView *_Nonnull imageView;

    Swift

    var imageView: UIImageView { get }

  • The image currently being displayed in the series.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) UIImage *currentImage;

    Swift

    var currentImage: UIImage? { get }

  • Whether or not the animation contains data for future time range periods.

    Declaration

    Objective-C

    @property (nonatomic) BOOL isFutureAnimation;

    Swift

    var isFutureAnimation: Bool { get set }

  • A Boolean value that determines whether the image animation should always remain visible regardless of its past/future state. Default value is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL shouldAlwaysShow;

    Swift

    var shouldAlwaysShow: Bool { get set }

  • A Boolean value indicating whether the animation should crossfade between frames. Default is NO.

    Declaration

    Objective-C

    @property (nonatomic) BOOL crossfade;

    Swift

    var crossfade: Bool { get set }

  • The object that acts as the data source of the receiving animation.

    Declaration

    Objective-C

    @property (nonatomic, weak) id<AWFImageAnimationDelegate> _Nullable delegate;

    Swift

    weak var delegate: AWFImageAnimationDelegate? { get set }

  • Returns the image in the series that is closest to the specified date and time. * This method is called playback of the animation to update the animation’s currently displayed image. If no image is found within the series, nil is returned and the current image is not updated. *

    Declaration

    Objective-C

    - (nullable UIImage *)imageClosestToTime:(nonnull NSDate *)time;

    Swift

    func imageClosest(toTime time: Date) -> UIImage?

    Parameters

    time

    The date and time to return the closest image for. *

    Return Value

    The image closest to the specified date.

  • Sets the animation as ready when there is no data available.

    Declaration

    Objective-C

    - (void)setHasNoAnimationData;

    Swift

    func setHasNoAnimationData()