Skip to content

first commit of Jazzy docs #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

first commit of Jazzy docs #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions .jazzy.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
clean: true
output: docs
min_acl: internal

author: ProjectDent contributors
author_url: https://github.com/ProjectDent/ARKit-CoreLocation/graphs/contributors

module: ARCL
github_url: https://github.com/ProjectDent/ARKit-CoreLocation

readme: readme.md

podspec: ARCL.podspec
432 changes: 432 additions & 0 deletions docs/Classes.html
View file
Open in desktop

Large diffs are not rendered by default.

320 changes: 320 additions & 0 deletions docs/Classes/AnnotationNode.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>AnnotationNode Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>

</head>
<body>
<a name="//apple_ref/swift/Class/AnnotationNode" class="dashAnchor"></a>
<a title="AnnotationNode Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">ARCL Docs</a> (31% documented)</p>
<p class="header-right"><a href="https://github.com/ProjectDent/ARKit-CoreLocation"><img src="../img/gh.png"/>View on GitHub</a></p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html">ARCL Reference</a>
<img id="carat" src="../img/carat.png" />
AnnotationNode Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/AnnotationNode.html">AnnotationNode</a>
</li>
<li class="nav-group-task">
<a href="../Classes/LocationAnnotationNode.html">LocationAnnotationNode</a>
</li>
<li class="nav-group-task">
<a href="../Classes/LocationManager.html">LocationManager</a>
</li>
<li class="nav-group-task">
<a href="../Classes/LocationNode.html">LocationNode</a>
</li>
<li class="nav-group-task">
<a href="../Classes/PolylineNode.html">PolylineNode</a>
</li>
<li class="nav-group-task">
<a href="../Classes/SceneLocationEstimate.html">SceneLocationEstimate</a>
</li>
<li class="nav-group-task">
<a href="../Classes/SceneLocationManager.html">SceneLocationManager</a>
</li>
<li class="nav-group-task">
<a href="../Classes/SceneLocationView.html">SceneLocationView</a>
</li>
<li class="nav-group-task">
<a href="../Classes/SceneLocationView/ARTrackingType.html">– ARTrackingType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/LocationEstimateMethod.html">LocationEstimateMethod</a>
</li>
<li class="nav-group-task">
<a href="../Enums/ScalingScheme.html">ScalingScheme</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/CGPoint.html">CGPoint</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CLLocation.html">CLLocation</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/CLLocationCoordinate2D.html">CLLocationCoordinate2D</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Double.html">Double</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Float.html">Float</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/FloatingPoint.html">FloatingPoint</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/Int.html">Int</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/SCNNode.html">SCNNode</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/SCNVector3.html">SCNVector3</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/UIView.html">UIView</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/LNTouchDelegate.html">LNTouchDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/LocationManagerDelegate.html">LocationManagerDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/SceneLocationManagerDelegate.html">SceneLocationManagerDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/SceneLocationViewDelegate.html">SceneLocationViewDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/SceneLocationViewEstimateDelegate.html">SceneLocationViewEstimateDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/SceneTrackingDelegate.html">SceneTrackingDelegate</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/ARKit_CoreLocation.html">ARKit_CoreLocation</a>
</li>
<li class="nav-group-task">
<a href="../Structs/AttributedType.html">AttributedType</a>
</li>
<li class="nav-group-task">
<a href="../Structs/LocationTranslation.html">LocationTranslation</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Typealiases.html#/s:4ARCL10BoxBuildera">BoxBuilder</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>AnnotationNode</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">AnnotationNode</span> <span class="p">:</span> <span class="kt">SCNNode</span></code></pre>

</div>
</div>
<p>This node type enables the client to have access to the view or image that
was used to initialize the <code><a href="../Classes/LocationAnnotationNode.html">LocationAnnotationNode</a></code>.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:4ARCL14AnnotationNodeC4viewSo6UIViewCSgvp"></a>
<a name="//apple_ref/swift/Property/view" class="dashAnchor"></a>
<a class="token" href="#/s:4ARCL14AnnotationNodeC4viewSo6UIViewCSgvp">view</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">view</span><span class="p">:</span> <span class="kt">UIView</span><span class="p">?</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4ARCL14AnnotationNodeC5imageSo7UIImageCSgvp"></a>
<a name="//apple_ref/swift/Property/image" class="dashAnchor"></a>
<a class="token" href="#/s:4ARCL14AnnotationNodeC5imageSo7UIImageCSgvp">image</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">image</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4ARCL14AnnotationNodeC5layerSo7CALayerCSgvp"></a>
<a name="//apple_ref/swift/Property/layer" class="dashAnchor"></a>
<a class="token" href="#/s:4ARCL14AnnotationNodeC5layerSo7CALayerCSgvp">layer</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">layer</span><span class="p">:</span> <span class="kt">CALayer</span><span class="p">?</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:4ARCL14AnnotationNodeC4view5image5layerACSo6UIViewCSg_So7UIImageCSgSo7CALayerCSgtcfc"></a>
<a name="//apple_ref/swift/Method/init(view:image:layer:)" class="dashAnchor"></a>
<a class="token" href="#/s:4ARCL14AnnotationNodeC4view5image5layerACSo6UIViewCSg_So7UIImageCSgSo7CALayerCSgtcfc">init(view:image:layer:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">view</span><span class="p">:</span> <span class="kt">UIView</span><span class="p">?,</span> <span class="nv">image</span><span class="p">:</span> <span class="kt">UIImage</span><span class="p">?,</span> <span class="nv">layer</span><span class="p">:</span> <span class="kt">CALayer</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/c:@M@ARCL@objc(cs)AnnotationNode(im)initWithCoder:"></a>
<a name="//apple_ref/swift/Method/init(coder:)" class="dashAnchor"></a>
<a class="token" href="#/c:@M@ARCL@objc(cs)AnnotationNode(im)initWithCoder:">init(coder:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">required</span> <span class="kd">public</span> <span class="nf">init</span><span class="p">?(</span><span class="n">coder</span> <span class="nv">aDecoder</span><span class="p">:</span> <span class="kt">NSCoder</span><span class="p">)</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2019 <a class="link" href="https://github.com/ProjectDent/ARKit-CoreLocation/graphs/contributors" target="_blank" rel="external">ProjectDent contributors</a>. All rights reserved. (Last updated: 2019-12-03)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.12.0</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
Loading