forked from TextureGroup/Texture
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathASImageNode.html
More file actions
executable file
·674 lines (350 loc) · 16.2 KB
/
Copy pathASImageNode.html
File metadata and controls
executable file
·674 lines (350 loc) · 16.2 KB
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
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASImageNode Class Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html"> </a>
</h1>
<p id="developer-home">
<a href="../index.html">AsyncDisplayKit</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To…</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Properties">
<option value="//api/name/cropEnabled">cropEnabled</option>
<option value="//api/name/cropRect">cropRect</option>
<option value="//api/name/forceUpscaling">forceUpscaling</option>
<option value="//api/name/forcedSize">forcedSize</option>
<option value="//api/name/image">image</option>
<option value="//api/name/imageModificationBlock">imageModificationBlock</option>
<option value="//api/name/isDefaultFocusAppearance">isDefaultFocusAppearance</option>
<option value="//api/name/placeholderColor">placeholderColor</option>
</optgroup>
<optgroup label="Instance Methods">
<option value="//api/name/setCropEnabled:recropImmediately:inBounds:">- setCropEnabled:recropImmediately:inBounds:</option>
<option value="//api/name/setNeedsDisplayWithCompletion:">- setNeedsDisplayWithCompletion:</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">ASImageNode Class Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td><a href="../Classes/ASControlNode.html">ASControlNode</a> : <a href="../Classes/ASDisplayNode.html">ASDisplayNode</a> : ASDealloc2MainObject</td>
</tr><tr>
<th>Declared in</th>
<td>ASImageNode.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>Supports cropping, tinting, and arbitrary image modification blocks.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/image" title="image"></a>
<h3 class="method-title"><code><a href="#//api/name/image"> image</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The image to display.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, strong) UIImage *image</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The node will efficiently display stretchable images by using
the layer’s contentsCenter property. Non-stretchable images work too, of
course.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/placeholderColor" title="placeholderColor"></a>
<h3 class="method-title"><code><a href="#//api/name/placeholderColor"> placeholderColor</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The placeholder color.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, strong) UIColor *placeholderColor</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/cropEnabled" title="cropEnabled"></a>
<h3 class="method-title"><code><a href="#//api/name/cropEnabled"> cropEnabled</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Indicates whether efficient cropping of the receiver is enabled.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, getter=isCropEnabled) BOOL cropEnabled</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Defaults to YES. See -setCropEnabled:recropImmediately:inBounds: for more
information.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/forceUpscaling" title="forceUpscaling"></a>
<h3 class="method-title"><code><a href="#//api/name/forceUpscaling"> forceUpscaling</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Indicates that efficient downsizing of backing store should <em>not</em> be enabled.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL forceUpscaling</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Defaults to NO. @see ASCroppedImageBackingSizeAndDrawRectInBounds for more
information.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/forcedSize" title="forcedSize"></a>
<h3 class="method-title"><code><a href="#//api/name/forcedSize"> forcedSize</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Forces image to be rendered at forcedSize.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) CGSize forcedSize</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Defaults to CGSizeZero to indicate that the forcedSize should not be used.
Setting forcedSize to non-CGSizeZero will force the backing of the layer contents to
be forcedSize (automatically adjusted for contentsSize).</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/setCropEnabled:recropImmediately:inBounds:" title="setCropEnabled:recropImmediately:inBounds:"></a>
<h3 class="method-title"><code><a href="#//api/name/setCropEnabled:recropImmediately:inBounds:">– setCropEnabled:recropImmediately:inBounds:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Enables or disables efficient cropping.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)setCropEnabled:(BOOL)<em>cropEnabled</em> recropImmediately:(BOOL)<em>recropImmediately</em> inBounds:(CGRect)<em>cropBounds</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>cropEnabled</code></th>
<td><p>YES to efficiently crop the receiver’s contents such that
contents outside of its bounds are not included; NO otherwise.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>recropImmediately</code></th>
<td><p>If the receiver has an image, YES to redisplay the
receiver immediately; NO otherwise.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>cropBounds</code></th>
<td><p>The bounds into which the receiver will be cropped. Useful
if bounds are to change in response to cropping (but have not yet done so).</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Efficient cropping is only performed when the receiver’s view’s
contentMode is UIViewContentModeScaleAspectFill. By default, cropping is
enabled. The crop alignment may be controlled via cropAlignmentFactor.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/cropRect" title="cropRect"></a>
<h3 class="method-title"><code><a href="#//api/name/cropRect"> cropRect</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>A value that controls how the receiver’s efficient cropping is aligned.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite, assign) CGRect cropRect</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This value defines a rectangle that is to be featured by the
receiver. The rectangle is specified as a “unit rectangle,” using
fractions of the source image’s width and height, e.g. CGRectMake(0.5, 0,
0.5, 1.0) will feature the full right half a photo. If the cropRect is
empty, the content mode of the receiver will be used to determine its
dimensions, and only the cropRect’s origin will be used for positioning. The
default value of this property is CGRectMake(0.5, 0.5, 0.0, 0.0).</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/imageModificationBlock" title="imageModificationBlock"></a>
<h3 class="method-title"><code><a href="#//api/name/imageModificationBlock"> imageModificationBlock</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>An optional block which can perform drawing operations on image
during the display phase.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, readwrite, copy) asimagenode_modification_block_t imageModificationBlock</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Can be used to add image effects (such as rounding, adding
borders, or other pattern overlays) without extraneous display calls.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/setNeedsDisplayWithCompletion:" title="setNeedsDisplayWithCompletion:"></a>
<h3 class="method-title"><code><a href="#//api/name/setNeedsDisplayWithCompletion:">– setNeedsDisplayWithCompletion:</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Marks the receiver as needing display and performs a block after
display has finished.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)setNeedsDisplayWithCompletion:(nullable void ( ^ ) ( BOOL canceled ))<em>displayCompletionBlock</em></code></div>
<div class="method-subsection arguments-section parameters">
<h4 class="method-subtitle parameter-title">Parameters</h4>
<table class="argument-def parameter-def">
<tr>
<th scope="row" class="argument-name"><code>displayCompletionBlock</code></th>
<td><p>The block to be performed after display has
finished. Its <code>canceled</code> property will be YES if display was prevented or
canceled (via displaySuspended); NO otherwise.</p></td>
</tr>
</table>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>displayCompletionBlock will be performed on the main-thread. If
<code>displaySuspended</code> is YES, <code>displayCompletionBlock</code> is will be
performed immediately and <code>YES</code> will be passed for <code>canceled</code>.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/isDefaultFocusAppearance" title="isDefaultFocusAppearance"></a>
<h3 class="method-title"><code><a href="#//api/name/isDefaultFocusAppearance"> isDefaultFocusAppearance</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>A bool to track if the current appearance of the node
is the default focus appearance.
Exposed here so the category methods can set it.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) BOOL isDefaultFocusAppearance</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASImageNode.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright © 2016 AsyncDisplayKit. All rights reserved. Updated: 2016-11-05</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>