FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
AsyncDisplayKit/AsyncDisplayKit/ASDisplayNode.h at master · theewind/AsyncDisplayKit · GitHub
theewind
/
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
/
ASDisplayNode.h
Copy path
More file actions
More file actions
Latest commit
History
History
History
518 lines (436 loc) · 20.6 KB
Breadcrumbs
AsyncDisplayKit
/
AsyncDisplayKit
/
ASDisplayNode.h
Copy path
File metadata and controls
518 lines (436 loc) · 20.6 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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
/*
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
<
UIKit/UIKit.h
>
#
import
"
_ASAsyncTransactionContainer.h
"
#
import
"
ASBaseDefines.h
"
#
import
"
ASDealloc2MainObject.h
"
/*
*
* An `ASDisplayNode` is an abstraction over `UIView` and `CALayer` that allows you to perform calculations about a view
* hierarchy off the main thread, and could do rendering off the main thread as well.
*
* The node API is designed to be as similar as possible to `UIView`. See the README for examples.
*
* ## Subclassing
*
* `ASDisplayNode` can be subclassed to create a new UI element. The subclass header `ASDisplayNode+Subclasses` provides
* necessary declarations and conveniences.
*
* Commons reasons to subclass includes making a `UIView` property available and receiving a callback after async
* display.
*
*/
@interface
ASDisplayNode
:
ASDealloc2MainObject
/*
* @name Initializing a node object
*/
/*
*
* @abstract Designated initializer.
*
* @return An ASDisplayNode instance whose view will be a subclass that enables asynchronous rendering, and passes
* through -layout and touch handling methods.
*/
- (
id
)
init
;
/*
*
* @abstract Alternative initializer with a view class.
*
* @param viewClass Any UIView subclass, such as UIScrollView.
*
* @return An ASDisplayNode instance whose view will be of class viewClass.
*
* @discussion If viewClass is not a subclass of _ASDisplayView, it will still render synchronously and -layout and
* touch handling methods on the node will not be called.
* The view instance will be created with alloc/init.
*/
- (
id
)
initWithViewClass
:
(
Class
)
viewClass
;
/*
*
* @abstract Alternative initializer with a layer class.
*
* @param layerClass Any CALayer subclass, such as CATransformLayer.
*
* @return An ASDisplayNode instance whose layer will be of class layerClass.
*
* @discussion If layerClass is not a subclass of _ASDisplayLayer, it will still render synchronously and -layout on the
* node will not be called.
* The layer instance will be created with alloc/init.
*/
- (
id
)
initWithLayerClass
:
(
Class
)
layerClass
;
/*
* @name Properties
*/
/*
*
* @abstract Returns whether the view is synchronous.
*
* @return NO if the node wraps a _ASDisplayView, YES otherwise.
*/
@property
(
nonatomic
,
readonly
,
assign
,
getter
=isSynchronous)
BOOL
synchronous;
/*
* @name Getting view and layer
*/
/*
*
* @abstract Returns a view.
*
* @discussion The view property is lazily initialized, similar to UIViewController.
* To go the other direction, use ASViewToDisplayNode() in ASDisplayNodeExtras.h.
*
* @warning The first access to it must be on the main thread, and should only be used on the main thread thereafter as
* well.
*/
@property
(
nonatomic
,
readonly
,
retain
) UIView *view;
/*
*
* @abstract Returns whether a node's backing view or layer is loaded.
*
* @return YES if a view is loaded, or if isLayerBacked is YES and layer is not nil; NO otherwise.
*/
@property
(
atomic
,
readonly
,
assign
,
getter
=isNodeLoaded)
BOOL
nodeLoaded;
/*
*
* @abstract Returns whether the node rely on a layer instead of a view.
*
* @return YES if the node rely on a layer, NO otherwise.
*/
@property
(
nonatomic
,
assign
,
getter
=isLayerBacked)
BOOL
layerBacked;
/*
*
* @abstract Returns a layer.
*
* @discussion The layer property is lazily initialized, similar to the view property.
* To go the other direction, use ASLayerToDisplayNode() in ASDisplayNodeExtras.h.
*
* @warning The first access to it must be on the main thread, and should only be used on the main thread thereafter as
* well.
*/
@property
(
nonatomic
,
readonly
,
retain
)
CALayer
*layer;
/*
* @name Managing dimensions
*/
/*
*
* @abstract Asks the node to calculate and return the size that best fits its subnodes.
*
* @param constrainedSize The maximum size the receiver should fit in.
*
* @return A new size that fits the receiver's subviews.
*
* @discussion Though this method does not set the bounds of the view, it does have side effects--caching both the
* constraint and the result.
*
* @warning Subclasses must not override this; it caches results from -calculateSizeThatFits:. Calling this method may
* be expensive if result is not cached.
*
* @see [ASDisplayNode(Subclassing) calculateSizeThatFits:]
*/
- (CGSize)
measure
:
(CGSize)
constrainedSize
;
/*
*
* @abstract Return the calculated size.
*
* @discussion Ideal for use by subclasses in -layout, having already prompted their subnodes to calculate their size by
* calling -measure: on them in -calculateSizeThatFits:.
*
* @return Size already calculated by calculateSizeThatFits:.
*
* @warning Subclasses must not override this; it returns the last cached size calculated and is never expensive.
*/
@property
(
nonatomic
,
readonly
,
assign
) CGSize calculatedSize;
/*
*
* @abstract Return the constrained size used for calculating size.
*
* @return The constrained size used by calculateSizeThatFits:.
*/
@property
(
nonatomic
,
readonly
,
assign
) CGSize constrainedSizeForCalculatedSize;
/*
* @name Managing the nodes hierarchy
*/
/*
*
* @abstract Add a node as a subnode to this node.
*
* @param subnode The node to be added.
*
* @discussion The subnode's view will automatically be added to this node's view, lazily if the views are not created
* yet.
*/
- (
void
)
addSubnode
:
(ASDisplayNode *)
subnode
;
/*
*
* @abstract Insert a subnode before a given subnode in the list.
*
* @param subnode The node to insert below another node.
* @param below The sibling node that will be above the inserted node.
*
* @discussion If the views are loaded, the subnode's view will be inserted below the given node's view in the hierarchy
* even if there are other non-displaynode views.
*/
- (
void
)
insertSubnode
:
(ASDisplayNode *)
subnode
belowSubnode
:
(ASDisplayNode *)
below
;
/*
*
* @abstract Insert a subnode after a given subnode in the list.
*
* @param subnode The node to insert below another node.
* @param above The sibling node that will be behind the inserted node.
*
* @discussion If the views are loaded, the subnode's view will be inserted above the given node's view in the hierarchy
* even if there are other non-displaynode views.
*/
- (
void
)
insertSubnode
:
(ASDisplayNode *)
subnode
aboveSubnode
:
(ASDisplayNode *)
above
;
/*
*
* @abstract Insert a subnode at a given index in subnodes.
*
* @param subnode The node to insert.
* @param idx The index in the array of the subnodes property at which to insert the node. Subnodes indices start at 0
* and cannot be greater than the number of subnodes.
*
* @discussion If this node's view is loaded, ASDisplayNode insert the subnode's view after the subnode at index - 1's
* view even if there are other non-displaynode views.
*/
- (
void
)
insertSubnode
:
(ASDisplayNode *)
subnode
atIndex
:
(
NSInteger
)
idx
;
/*
*
* @abstract Replace subnode with replacementSubnode.
*
* @param subnode A subnode of self.
* @param replacementSubnode A node with which to replace subnode.
*
* @discussion Should both subnode and replacementSubnode already be subnodes of self, subnode is removed and
* replacementSubnode inserted in its place.
* If subnode is not a subnode of self, this method will throw an exception.
* If replacementSubnode is nil, this method will throw an exception
*/
- (
void
)
replaceSubnode
:
(ASDisplayNode *)
subnode
withSubnode
:
(ASDisplayNode *)
replacementSubnode
;
/*
*
* @abstract Remove this node from its supernode.
*
* @discussion The node's view will be automatically removed from the supernode's view.
*/
- (
void
)
removeFromSupernode
;
/*
*
* @abstract The receiver's immediate subnodes.
*/
@property
(
nonatomic
,
readonly
,
retain
)
NSArray
*subnodes;
/*
*
* @abstract The receiver's supernode.
*/
@property
(
nonatomic
,
readonly
,
weak
) ASDisplayNode *supernode;
/*
* @name Drawing and Updating the View
*/
/*
*
* @abstract Whether this node's view performs asynchronous rendering.
*
* @return Defaults to YES, except for synchronous views (ie, those created with -initWithViewClass: /
* -initWithLayerClass:), which are always NO.
*
* @discussion If this flag is set, then the node will participate in the current asyncdisplaykit_async_transaction and
* do its rendering on the displayQueue instead of the main thread.
*
* Asynchronous rendering proceeds as follows:
*
* When the view is initially added to the hierarchy, it has -needsDisplay true.
* After layout, Core Animation will call -display on the _ASDisplayLayer
* -display enqueues a rendering operation on the displayQueue
* When the render block executes, it calls the delegate display method (-drawRect:... or -display)
* The delegate provides contents via this method and an operation is added to the asyncdisplaykit_async_transaction
* Once all rendering is complete for the current asyncdisplaykit_async_transaction,
* the completion for the block sets the contents on all of the layers in the same frame
*
* If asynchronous rendering is disabled:
*
* When the view is initially added to the hierarchy, it has -needsDisplay true.
* After layout, Core Animation will call -display on the _ASDisplayLayer
* -display calls delegate display method (-drawRect:... or -display) immediately
* -display sets the layer contents immediately with the result
*
* Note: this has nothing to do with -[CALayer drawsAsynchronously].
*/
@property
(
nonatomic
,
assign
)
BOOL
displaysAsynchronously;
/*
*
* @abstract Whether to draw all descendant nodes' layers/views into this node's layer/view's backing store.
*
* @discussion
* When set to YES, causes all descendant nodes' layers/views to be drawn directly into this node's layer/view's backing
* store. Defaults to NO.
*
* If a node's descendants are static (never animated or never change attributes after creation) then that node is a
* good candidate for rasterization. Rasterizing descendants has two main benefits:
* 1) Backing stores for descendant layers are not created. Instead the layers are drawn directly into the rasterized
* container. This can save a great deal of memory.
* 2) Since the entire subtree is drawn into one backing store, compositing and blending are eliminated in that subtree
* which can help improve animation/scrolling/etc performance.
*
* Rasterization does not currently support descendants with transform, sublayerTransform, or alpha. Those properties
* will be ignored when rasterizing descendants.
*
* Note: this has nothing to do with -[CALayer shouldRasterize], which doesn't work with ASDisplayNode's asynchronous
* rendering model.
*/
@property
(
nonatomic
,
assign
)
BOOL
shouldRasterizeDescendants;
/*
*
* @abstract Display the node's view/layer immediately on the current thread, bypassing the background thread rendering.
*/
- (
void
)
displayImmediately
;
/*
*
* @abstract Prevent the node's layer from displaying.
*
* @discussion A subclass may check this flag during -display or -drawInContext: to cancel a display that is already in
* progress.
*
* Defaults to NO. Does not control display for any child or descendant nodes; for that, use
* -recursiveSetPreventOrCancelDisplay:.
*
* If a setNeedsDisplay occurs while preventOrCancelDisplay is YES, and preventOrCancelDisplay is set to NO, then the
* layer will be automatically displayed.
*/
@property
(
nonatomic
,
assign
)
BOOL
preventOrCancelDisplay;
/*
*
* @abstract Prevent the node and its descendants' layer from displaying.
*
* @param flag YES if display should be prevented or cancelled; NO otherwise.
*
* @see preventOrCancelDisplay
*/
- (
void
)
recursiveSetPreventOrCancelDisplay
:
(
BOOL
)
flag
;
/*
*
* @abstract Calls -reclaimMemory on the receiver and its subnode hierarchy.
*
* @discussion Clears backing stores and other memory-intensive intermediates.
* If the node is removed from a visible hierarchy and then re-added, it will automatically trigger a new asynchronous display,
* as long as preventOrCancelDisplay is not set.
* If the node remains in the hierarchy throughout, -setNeedsDisplay is required to trigger a new asynchronous display.
*
* @see preventOrCancelDisplay and setNeedsDisplay
*/
- (
void
)
recursivelyReclaimMemory
;
/*
* @name Hit Testing
*/
/*
*
* @abstract Bounds insets for hit testing.
*
* @discussion When set to a non-zero inset, increases the bounds for hit testing to make it easier to tap or perform
* gestures on this node. Default is UIEdgeInsetsZero.
*
* This affects the default implementation of -hitTest and -pointInside, so subclasses should call super if you override
* it and want hitTestSlop applied.
*/
@property
(
nonatomic
,
assign
) UIEdgeInsets hitTestSlop;
/*
*
* @abstract Returns a Boolean value indicating whether the receiver contains the specified point.
*
* @discussion Includes the "slop" factor specified with hitTestSlop.
*
* @param point A point that is in the receiver's local coordinate system (bounds).
* @param event The event that warranted a call to this method.
*
* @return YES if point is inside the receiver's bounds; otherwise, NO.
*/
- (
BOOL
)
pointInside
:
(CGPoint)
point
withEvent
:
(UIEvent *)
event
;
/*
* @name Converting Between View Coordinate Systems
*/
/*
*
* @abstract Converts a point from the receiver's coordinate system to that of the specified node.
*
* @param point A point specified in the local coordinate system (bounds) of the receiver.
* @param node The node into whose coordinate system point is to be converted.
*
* @return The point converted to the coordinate system of node.
*/
- (CGPoint)
convertPoint
:
(CGPoint)
point
toNode
:
(ASDisplayNode *)
node
;
/*
*
* @abstract Converts a point from the coordinate system of a given node to that of the receiver.
*
* @param point A point specified in the local coordinate system (bounds) of node.
* @param node The node with point in its coordinate system.
*
* @return The point converted to the local coordinate system (bounds) of the receiver.
*/
- (CGPoint)
convertPoint
:
(CGPoint)
point
fromNode
:
(ASDisplayNode *)
node
;
/*
*
* @abstract Converts a rectangle from the receiver's coordinate system to that of another view.
*
* @param rect A rectangle specified in the local coordinate system (bounds) of the receiver.
* @param node The node that is the target of the conversion operation.
*
* @return The converted rectangle.
*/
- (CGRect)
convertRect
:
(CGRect)
rect
toNode
:
(ASDisplayNode *)
node
;
/*
*
* @abstract Converts a rectangle from the coordinate system of another node to that of the receiver.
*
* @param rect A rectangle specified in the local coordinate system (bounds) of node.
* @param node The node with rect in its coordinate system.
*
* @return The converted rectangle.
*/
- (CGRect)
convertRect
:
(CGRect)
rect
fromNode
:
(ASDisplayNode *)
node
;
@end
/*
*
* Convenience methods for debugging.
*/
@interface
ASDisplayNode
(Debugging)
/*
*
* @abstract Return a description of the node hierarchy.
*
* @discussion For debugging: (lldb) po [node displayNodeRecursiveDescription]
*/
- (
NSString
*)
displayNodeRecursiveDescription
;
@end
/*
*
* ## UIView bridge
*
* ASDisplayNode provides thread-safe access to most of UIView and CALayer properties and methods, traditionally unsafe.
*
* Using them will not cause the actual view/layer to be created, and will be applied when it is created (when the view
* or layer property is accessed).
*
* After the view is created, the properties pass through to the view directly as if called on the main thread.
*
* See UIView and CALayer for documentation on these common properties.
*/
@interface
ASDisplayNode
(UIViewBridge)
- (
void
)
setNeedsDisplay
;
//
Marks the view as needing display. Convenience for use whether view is created or not, or from a background thread.
- (
void
)
setNeedsLayout
;
//
Marks the view as needing layout. Convenience for use whether view is created or not, or from a background thread.
@property
(
atomic
,
retain
)
id
contents;
//
default=nil
@property
(
atomic
,
assign
)
BOOL
clipsToBounds;
//
default==NO
@property
(
atomic
,
getter
=isOpaque)
BOOL
opaque;
//
default==YES
@property
(
atomic
,
assign
)
BOOL
allowsEdgeAntialiasing;
@property
(
atomic
,
assign
)
unsigned
int
edgeAntialiasingMask;
//
default==all values from CAEdgeAntialiasingMask
@property
(
atomic
,
getter
=isHidden)
BOOL
hidden;
//
default==NO
@property
(
atomic
,
assign
)
BOOL
needsDisplayOnBoundsChange;
//
default==NO
@property
(
atomic
,
assign
)
BOOL
autoresizesSubviews;
//
default==YES (undefined for layer-backed nodes)
@property
(
atomic
,
assign
) UIViewAutoresizing autoresizingMask;
//
default==UIViewAutoresizingNone (undefined for layer-backed nodes)
@property
(
atomic
,
assign
) CGFloat alpha;
//
default=1.0f
@property
(
atomic
,
assign
) CGRect bounds;
//
default=CGRectZero
@property
(
atomic
,
assign
) CGRect frame;
//
default=CGRectZero
@property
(
atomic
,
assign
) CGPoint anchorPoint;
//
default={0.5, 0.5}
@property
(
atomic
,
assign
) CGFloat zPosition;
//
default=0.0
@property
(
atomic
,
assign
) CGPoint position;
//
default=CGPointZero
@property
(
atomic
,
assign
) CGFloat contentsScale;
//
default=1.0f. See @contentsScaleForDisplay for more info
@property
(
atomic
,
assign
) CATransform3D transform;
//
default=CATransform3DIdentity
@property
(
atomic
,
assign
) CATransform3D subnodeTransform;
//
default=CATransform3DIdentity
@property
(
atomic
,
copy
)
NSString
*name;
//
default=nil. Use this to tag your layers in the server-recurse-description / pca or for your own purposes
/*
*
* @abstract The node view's background color.
*
* @discussion In contrast to UIView, setting a transparent color will not set opaque = NO.
* This only affects nodes that implement +drawRect like ASTextNode.
*/
@property
(
atomic
,
retain
) UIColor *backgroundColor;
//
default=nil
@property
(
atomic
,
retain
) UIColor *tintColor;
//
default=Blue
- (
void
)
tintColorDidChange
;
//
Notifies the node when the tintColor has changed.
/*
*
* @abstract A flag used to determine how a node lays out its content when its bounds change.
*
* @discussion This is like UIView's contentMode property, but better. We do our own mapping to layer.contentsGravity in
* _ASDisplayView. You can set needsDisplayOnBoundsChange independently.
* Thus, UIViewContentModeRedraw is not allowed; use needsDisplayOnBoundsChange = YES instead, and pick an appropriate
* contentMode for your content while it's being re-rendered.
*/
@property
(
atomic
,
assign
) UIViewContentMode contentMode;
//
default=UIViewContentModeScaleToFill
@property
(
atomic
,
assign
,
getter
=isUserInteractionEnabled)
BOOL
userInteractionEnabled;
//
default=YES (NO for layer-backed nodes)
@property
(
atomic
,
assign
,
getter
=isExclusiveTouch)
BOOL
exclusiveTouch;
//
default=NO
@property
(
atomic
,
assign
) CGColorRef shadowColor;
//
default=opaque rgb black
@property
(
atomic
,
assign
) CGFloat shadowOpacity;
//
default=0.0
@property
(
atomic
,
assign
) CGSize shadowOffset;
//
default=(0, -3)
@property
(
atomic
,
assign
) CGFloat shadowRadius;
//
default=3
@property
(
atomic
,
assign
) CGFloat borderWidth;
//
default=0
@property
(
atomic
,
assign
) CGColorRef borderColor;
//
default=opaque rgb black
//
Accessibility support
@property
(
atomic
,
assign
)
BOOL
isAccessibilityElement;
@property
(
atomic
,
copy
)
NSString
*accessibilityLabel;
@property
(
atomic
,
copy
)
NSString
*accessibilityHint;
@property
(
atomic
,
copy
)
NSString
*accessibilityValue;
@property
(
atomic
,
assign
) UIAccessibilityTraits accessibilityTraits;
@property
(
atomic
,
assign
) CGRect accessibilityFrame;
@property
(
atomic
,
retain
)
NSString
*accessibilityLanguage;
@property
(
atomic
,
assign
)
BOOL
accessibilityElementsHidden;
@property
(
atomic
,
assign
)
BOOL
accessibilityViewIsModal;
@property
(
atomic
,
assign
)
BOOL
shouldGroupAccessibilityChildren;
@end
/*
ASDisplayNode participates in ASAsyncTransactions, so you can determine when your subnodes are done rendering.
See: -(void)asyncdisplaykit_asyncTransactionContainerStateDidChange in ASDisplayNodeSubclass.h
*/
@interface
ASDisplayNode
(ASDisplayNodeAsyncTransactionContainer) <ASDisplayNodeAsyncTransactionContainer>
@end
Back
|
FazBrowse Home
|
New Git URL