FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
AsyncDisplayKit/AsyncDisplayKit/ASMultiplexImageNode.h at master · yangbogithub/AsyncDisplayKit · GitHub
yangbogithub
/
AsyncDisplayKit
Public
forked from
facebookarchive/AsyncDisplayKit
Notifications
You must be signed in to change notification settings
Fork
0
Star
0
Code
Pull requests
0
Actions
Projects
Wiki
Security and quality
0
Insights
Additional navigation options
Code
Pull requests
Actions
Projects
Wiki
Security and quality
Insights
Expand file tree
Breadcrumbs
AsyncDisplayKit
/
AsyncDisplayKit
/
ASMultiplexImageNode.h
Copy path
More file actions
More file actions
Latest commit
History
History
History
197 lines (167 loc) · 8.16 KB
Breadcrumbs
AsyncDisplayKit
/
AsyncDisplayKit
/
ASMultiplexImageNode.h
Copy path
File metadata and controls
197 lines (167 loc) · 8.16 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
/*
Copyright (c) 2014-present, Facebook, Inc.
* All rights reserved.
*
* This source code is licensed under the BSD-style license found in the
* LICENSE file in the root directory of this source tree. An additional grant
* of patent rights can be found in the PATENTS file in the same directory.
*/
#
import
<
AsyncDisplayKit/ASImageNode.h
>
#
import
<
AsyncDisplayKit/ASImageProtocols.h
>
@protocol
ASMultiplexImageNodeDelegate;
@protocol
ASMultiplexImageNodeDataSource;
extern
NSString
*
const
ASMultiplexImageNodeErrorDomain;
/*
*
* ASMultiplexImageNode error codes.
*/
typedef
NS_ENUM
(
NSUInteger
, ASMultiplexImageNodeErrorCode) {
/*
*
* Indicates that the data source didn't provide a source for an image identifier.
*/
ASMultiplexImageNodeErrorCodeNoSourceForImage =
0
,
/*
*
* Indicates that the best image identifier changed before a download for a worse identifier began.
*/
ASMultiplexImageNodeErrorCodeBestImageIdentifierChanged,
};
/*
*
* @abstract ASMultiplexImageNode is an image node that can load and display multiple versions of an image. For
* example, it can display a low-resolution version of an image while the high-resolution version is loading.
*
* @discussion ASMultiplexImageNode begins loading images when its <imageIdentifiers> property is set. For each image
* identifier, the data source can either return a UIImage directly, or a URL the image node should load.
*/
@interface
ASMultiplexImageNode
:
ASImageNode
/*
*
* @abstract The designated initializer.
* @param cache The object that implements a cache of images for the image node.
* @param downloader The object that implements image downloading for the image node.
* @discussion If `cache` is nil, the receiver will not attempt to retrieve images from a cache before downloading them.
* @returns An initialized ASMultiplexImageNode.
*/
- (
instancetype
)
initWithCache
:
(
id
<ASImageCacheProtocol>)
cache
downloader
:
(
id
<ASImageDownloaderProtocol>)
downloader
;
- (
instancetype
)
init
NS_UNAVAILABLE;
/*
*
* @abstract The delegate, which must conform to the <ASMultiplexImageNodeDelegate> protocol.
*/
@property
(
nonatomic
,
readwrite
,
weak
)
id
<ASMultiplexImageNodeDelegate> delegate;
/*
*
* @abstract The data source, which must conform to the <ASMultiplexImageNodeDataSource> protocol.
* @discussion This value is required for ASMultiplexImageNode to load images.
*/
@property
(
nonatomic
,
readwrite
,
weak
)
id
<ASMultiplexImageNodeDataSource> dataSource;
/*
*
* @abstract Whether the receiver should download more than just its highest-quality image. Defaults to NO.
*
* @discussion ASMultiplexImageNode immediately loads and displays the first image specified in <imageIdentifiers> (its
* highest-quality image). If that image is not immediately available or cached, the node can download and display
* lesser-quality images. Set `downloadsIntermediateImages` to YES to enable this behaviour.
*/
@property
(
nonatomic
,
readwrite
,
assign
)
BOOL
downloadsIntermediateImages;
/*
*
* @abstract An array of identifiers representing various versions of an image for ASMultiplexImageNode to display.
*
* @discussion An identifier can be any object that conforms to NSObject and NSCopying. The array should be in
* decreasing order of image quality -- that is, the first identifier in the array represents the best version.
*
* @see <downloadsIntermediateImages> for more information on the image loading process.
*/
@property
(
nonatomic
,
readwrite
,
copy
)
NSArray
*imageIdentifiers;
/*
*
* @abstract Notify the receiver that its data source has new UIImages or NSURLs available for <imageIdentifiers>.
*
* @discussion If a higher-quality image than is currently displayed is now available, it will be loaded.
*/
- (
void
)
reloadImageIdentifierSources
;
/*
*
* @abstract The identifier for the last image that the receiver loaded, or nil.
*
* @discussion This value may differ from <displayedImageIdentifier> if the image hasn't yet been displayed.
*/
@property
(
nonatomic
,
readonly
)
id
loadedImageIdentifier;
/*
*
* @abstract The identifier for the image that the receiver is currently displaying, or nil.
*/
@property
(
nonatomic
,
readonly
)
id
displayedImageIdentifier;
@end
#
pragma mark
-
@protocol
ASMultiplexImageNodeDelegate
<
NSObject
>
@optional
/*
*
* @abstract Notification that the image node began downloading an image.
* @param imageNode The sender.
* @param imageIdentifier The identifier for the image that is downloading.
*/
- (
void
)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
didStartDownloadOfImageWithIdentifier
:
(
id
)
imageIdentifier
;
/*
*
* @abstract Notification that the image node's download progressed.
* @param imageNode The sender.
* @param downloadProgress The progress of the download. Value is between 0.0 and 1.0.
* @param imageIdentifier The identifier for the image that is downloading.
*/
- (
void
)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
didUpdateDownloadProgress
:
(CGFloat)
downloadProgress
forImageWithIdentifier
:
(
id
)
imageIdentifier
;
/*
*
* @abstract Notification that the image node's download has finished.
* @param imageNode The sender.
* @param imageIdentifier The identifier for the image that finished downloading.
* @param error The error that occurred while downloading, if one occurred; nil otherwise.
*/
- (
void
)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
didFinishDownloadingImageWithIdentifier
:
(
id
)
imageIdentifier
error
:
(
NSError
*)
error
;
/*
*
* @abstract Notification that the image node's image was updated.
* @param imageNode The sender.
* @param image The new image, ready for display.
* @param imageIdentifier The identifier for `image`.
* @param previousImage The old, previously-loaded image.
* @param previousImageIdentifier The identifier for `previousImage`.
* @note This method does not indicate that `image` has been displayed.
* @see <[ASMultiplexImageNodeDelegate multiplexImageNode:didDisplayUpdatedImage:withIdentifier:]>.
*/
- (
void
)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
didUpdateImage
:
(UIImage *)
image
withIdentifier
:
(
id
)
imageIdentifier
fromImage
:
(UIImage *)
previousImage
withIdentifier
:
(
id
)
previousImageIdentifier
;
/*
*
* @abstract Notification that the image node displayed a new image.
* @param imageNode The sender.
* @param image The new image, now being displayed.
* @param imageIdentifier The identifier for `image`.
* @discussion This method is only called when `image` changes, and not on subsequent redisplays of the same image.
*/
- (
void
)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
didDisplayUpdatedImage
:
(UIImage *)
image
withIdentifier
:
(
id
)
imageIdentifier
;
/*
*
* @abstract Notification that the image node finished displaying an image.
* @param imageNode The sender.
* @discussion This method is called every time an image is displayed, whether or not it has changed.
*/
- (
void
)
multiplexImageNodeDidFinishDisplay
:
(ASMultiplexImageNode *)
imageNode
;
@end
#
pragma mark
-
@protocol
ASMultiplexImageNodeDataSource
<
NSObject
>
@optional
/*
*
* @abstract An image for the specified identifier.
* @param imageNode The sender.
* @param imageIdentifier The identifier for the image that should be returned.
* @discussion If the image is already available to the data source, this method should be used in lieu of providing the
* URL to the image via -multiplexImageNode:URLForImageIdentifier:.
* @returns A UIImage corresponding to `imageIdentifier`, or nil if none is available.
*/
- (UIImage *)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
imageForImageIdentifier
:
(
id
)
imageIdentifier
;
/*
*
* @abstract An image URL for the specified identifier.
* @param imageNode The sender.
* @param imageIdentifier The identifier for the image that will be downloaded.
* @discussion Supported URLs include assets-library, Photo framework URLs (ph://), HTTP, HTTPS, and FTP URLs. If the
* image is already available to the data source, it should be provided via <[ASMultiplexImageNodeDataSource
* multiplexImageNode:imageForImageIdentifier:]> instead.
* @returns An NSURL for the image identified by `imageIdentifier`, or nil if none is available.
*/
- (
NSURL
*)
multiplexImageNode
:
(ASMultiplexImageNode *)
imageNode
URLForImageIdentifier
:
(
id
)
imageIdentifier
;
@end
Back
|
FazBrowse Home
|
New Git URL