Peter 9bc996374f Add 'submodules/AsyncDisplayKit/' from commit '02bedc12816e251ad71777f9d2578329b6d2bef6'
git-subtree-dir: submodules/AsyncDisplayKit
git-subtree-mainline: d06f423e0ed3df1fed9bd10d79ee312a9179b632
git-subtree-split: 02bedc12816e251ad71777f9d2578329b6d2bef6
2019-06-11 18:42:43 +01:00

651 lines
16 KiB
HTML
Executable File

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>ASMultiplexImageNode 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&#133;</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Properties">
<option value="//api/name/dataSource">dataSource</option>
<option value="//api/name/delegate">delegate</option>
<option value="//api/name/displayedImageIdentifier">displayedImageIdentifier</option>
<option value="//api/name/downloadsIntermediateImages">downloadsIntermediateImages</option>
<option value="//api/name/imageIdentifiers">imageIdentifiers</option>
<option value="//api/name/imageManager">imageManager</option>
<option value="//api/name/loadedImageIdentifier">loadedImageIdentifier</option>
<option value="//api/name/shouldRenderProgressImages">shouldRenderProgressImages</option>
</optgroup>
<optgroup label="Instance Methods">
<option value="//api/name/initWithCache:downloader:">- initWithCache:downloader:</option>
<option value="//api/name/reloadImageIdentifierSources">- reloadImageIdentifierSources</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">ASMultiplexImageNode Class Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td><a href="../Classes/ASImageNode.html">ASImageNode</a> : <a href="../Classes/ASControlNode.html">ASControlNode</a> : <a href="../Classes/ASDisplayNode.html">ASDisplayNode</a> : ASDealloc2MainObject</td>
</tr><tr>
<th>Declared in</th>
<td>ASMultiplexImageNode.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>ASMultiplexImageNode begins loading images when its resource can either return a UIImage directly, or a URL the image node should load.</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/initWithCache:downloader:" title="initWithCache:downloader:"></a>
<h3 class="method-title"><code><a href="#//api/name/initWithCache:downloader:">&ndash;&nbsp;initWithCache:downloader:</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 designated initializer.</p>
</div>
<div class="method-subsection method-declaration"><code>- (instancetype)initWithCache:(nullable id&lt;ASImageCacheProtocol&gt;)<em>cache</em> downloader:(nullable id&lt;ASImageDownloaderProtocol&gt;)<em>downloader</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>cache</code></th>
<td><p>The object that implements a cache of images for the image node.</p></td>
</tr>
<tr>
<th scope="row" class="argument-name"><code>downloader</code></th>
<td><p>The object that implements image downloading for the image node.</p></td>
</tr>
</table>
</div>
<div class="method-subsection return">
<h4 class="method-subtitle parameter-title">Return Value</h4>
<p>An initialized ASMultiplexImageNode.</p>
</div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If <code>cache</code> is nil, the receiver will not attempt to retrieve images from a cache before downloading them.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/delegate" title="delegate"></a>
<h3 class="method-title"><code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</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 delegate, which must conform to the <a href="../Protocols/ASMultiplexImageNodeDelegate.html">ASMultiplexImageNodeDelegate</a> protocol.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite, weak) id&lt;ASMultiplexImageNodeDelegate&gt; delegate</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/dataSource" title="dataSource"></a>
<h3 class="method-title"><code><a href="#//api/name/dataSource">&nbsp;&nbsp;dataSource</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 data source, which must conform to the <a href="../Protocols/ASMultiplexImageNodeDataSource.html">ASMultiplexImageNodeDataSource</a> protocol.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite, weak) id&lt;ASMultiplexImageNodeDataSource&gt; dataSource</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This value is required for ASMultiplexImageNode to load images.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/downloadsIntermediateImages" title="downloadsIntermediateImages"></a>
<h3 class="method-title"><code><a href="#//api/name/downloadsIntermediateImages">&nbsp;&nbsp;downloadsIntermediateImages</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Whether the receiver should download more than just its highest-quality image. Defaults to NO.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite, assign) BOOL downloadsIntermediateImages</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>ASMultiplexImageNode immediately loads and displays the first image specified in <a href="#//api/name/imageIdentifiers">imageIdentifiers</a> (its
highest-quality image). If that image is not immediately available or cached, the node can download and display
lesser-quality images. Set <code>downloadsIntermediateImages</code> to YES to enable this behaviour.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/imageIdentifiers" title="imageIdentifiers"></a>
<h3 class="method-title"><code><a href="#//api/name/imageIdentifiers">&nbsp;&nbsp;imageIdentifiers</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 array of identifiers representing various versions of an image for ASMultiplexImageNode to display.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, readwrite, copy) NSArray&lt;ASImageIdentifier&gt; *imageIdentifiers</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>An identifier can be any object that conforms to NSObject and NSCopying. The array should be in
decreasing order of image quality &ndash; that is, the first identifier in the array represents the best version.</p>
</div>
<div class="method-subsection see-also-section">
<h4 class="method-subtitle">See Also</h4>
<ul>
<li><code><p>&lt;<a href="#//api/name/downloadsIntermediateImages">@property downloadsIntermediateImages</a>> for more information on the image loading process.</p></code></li>
</ul>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/reloadImageIdentifierSources" title="reloadImageIdentifierSources"></a>
<h3 class="method-title"><code><a href="#//api/name/reloadImageIdentifierSources">&ndash;&nbsp;reloadImageIdentifierSources</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Notify the receiver SSAA that its data source has new UIImages or NSURLs available for <a href="#//api/name/imageIdentifiers">imageIdentifiers</a>.</p>
</div>
<div class="method-subsection method-declaration"><code>- (void)reloadImageIdentifierSources</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If a higher-quality image than is currently displayed is now available, it will be loaded.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/loadedImageIdentifier" title="loadedImageIdentifier"></a>
<h3 class="method-title"><code><a href="#//api/name/loadedImageIdentifier">&nbsp;&nbsp;loadedImageIdentifier</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 identifier for the last image that the receiver loaded, or nil.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, readonly) ASImageIdentifier loadedImageIdentifier</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>This value may differ from <a href="#//api/name/displayedImageIdentifier">displayedImageIdentifier</a> if the image hasn&rsquo;t yet been displayed.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/displayedImageIdentifier" title="displayedImageIdentifier"></a>
<h3 class="method-title"><code><a href="#//api/name/displayedImageIdentifier">&nbsp;&nbsp;displayedImageIdentifier</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 identifier for the image that the receiver is currently displaying, or nil.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, readonly) ASImageIdentifier displayedImageIdentifier</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/shouldRenderProgressImages" title="shouldRenderProgressImages"></a>
<h3 class="method-title"><code><a href="#//api/name/shouldRenderProgressImages">&nbsp;&nbsp;shouldRenderProgressImages</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>If the downloader implements progressive image rendering and this value is YES progressive renders of the
image will be displayed as the image downloads. Regardless of this properties value, progress renders will
only occur when the node is visible. Defaults to YES.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readwrite) BOOL shouldRenderProgressImages</code></div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/imageManager" title="imageManager"></a>
<h3 class="method-title"><code><a href="#//api/name/imageManager">&nbsp;&nbsp;imageManager</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<ul>
<li>@abstract The image manager that this image node should use when requesting images from the Photos framework. If this is <code>nil</code> (the default), then <code>PHImageManager.defaultManager</code> is used.</li>
</ul>
</div>
<div class="method-subsection method-declaration"><code>@property (nullable, nonatomic, strong) PHImageManager *imageManager</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<ul>
<li>@see <code>+[NSURL URLWithAssetLocalIdentifier:targetSize:contentMode:options:]</code> below.</li>
</ul>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">ASMultiplexImageNode.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright &copy; 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>