Skip to content

Commit

Permalink
Additional documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bradhowes committed Aug 12, 2021
1 parent 853e38d commit c2e19a3
Show file tree
Hide file tree
Showing 2 changed files with 364 additions and 0 deletions.
182 changes: 182 additions & 0 deletions docs/Classes/JoyStickView/HandlePositionMode.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>HandlePositionMode Enumeration 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>

<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Enum/HandlePositionMode" class="dashAnchor"></a>
<a title="HandlePositionMode Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">JoyStickView 3.1.1 Docs</a> (100% documented)</p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fbradhowes.github.io%2FJoystick%2Fdocsets%2FJoyStickView.xml"><img src="../../img/dash.png"/>Install in Dash</a></p>
<p class="header-right">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../../index.html">JoyStickView Reference</a>
<img id="carat" src="../../img/carat.png" />
HandlePositionMode Enumeration 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/JoyStickView.html">JoyStickView</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/JoyStickView/HandlePositionMode.html">– HandlePositionMode</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/JoyStickViewMonitorKind.html">JoyStickViewMonitorKind</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/CGRect.html">CGRect</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/CGSize.html">CGSize</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/CGVector.html">CGVector</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/JoyStickViewPolarReport.html">JoyStickViewPolarReport</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/JoyStickViewXYReport.html">JoyStickViewXYReport</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:12JoyStickView0abC12PolarMonitora">JoyStickViewPolarMonitor</a>
</li>
<li class="nav-group-task">
<a href="../../Typealiases.html#/s:12JoyStickView0abC9XYMonitora">JoyStickViewXYMonitor</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>HandlePositionMode</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">HandlePositionMode</span></code></pre>

</div>
</div>
<p>Position mode for a joystick handle. The default (original) is <code>absolute</code> mode.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:12JoyStickViewAAC18HandlePositionModeO8absoluteyA2DmF"></a>
<a name="//apple_ref/swift/Element/absolute" class="dashAnchor"></a>
<a class="token" href="#/s:12JoyStickViewAAC18HandlePositionModeO8absoluteyA2DmF">absolute</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Center of joystick handle moves to actual touch position (limited by base constraints)</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">absolute</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12JoyStickViewAAC18HandlePositionModeO8relativeyA2DmF"></a>
<a name="//apple_ref/swift/Element/relative" class="dashAnchor"></a>
<a class="token" href="#/s:12JoyStickViewAAC18HandlePositionModeO8relativeyA2DmF">relative</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Center of joystick handle moves to delta between current touch position and first touch position</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">relative</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/bradhowes/Joystick" target="_blank" rel="external">bradhowes</a>. All rights reserved. (Last updated: 2021-08-12)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,182 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>HandlePositionMode Enumeration 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>

<script src="../../js/lunr.min.js" defer></script>
<script src="../../js/typeahead.jquery.js" defer></script>
<script src="../../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Enum/HandlePositionMode" class="dashAnchor"></a>
<a title="HandlePositionMode Enumeration Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html">JoyStickView 3.1.1 Docs</a> (100% documented)</p>
<p class="header-right"><a href="dash-feed://https%3A%2F%2Fbradhowes.github.io%2FJoystick%2Fdocsets%2FJoyStickView.xml"><img src="../../img/dash.png"/>Install in Dash</a></p>
<p class="header-right">
<form role="search" action="../../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../../index.html">JoyStickView Reference</a>
<img id="carat" src="../../img/carat.png" />
HandlePositionMode Enumeration 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/JoyStickView.html">JoyStickView</a>
</li>
<li class="nav-group-task">
<a href="../../Classes/JoyStickView/HandlePositionMode.html">– HandlePositionMode</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/JoyStickViewMonitorKind.html">JoyStickViewMonitorKind</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/CGRect.html">CGRect</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/CGSize.html">CGSize</a>
</li>
<li class="nav-group-task">
<a href="../../Extensions/CGVector.html">CGVector</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/JoyStickViewPolarReport.html">JoyStickViewPolarReport</a>
</li>
<li class="nav-group-task">
<a href="../../Structs/JoyStickViewXYReport.html">JoyStickViewXYReport</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:12JoyStickView0abC12PolarMonitora">JoyStickViewPolarMonitor</a>
</li>
<li class="nav-group-task">
<a href="../../Typealiases.html#/s:12JoyStickView0abC9XYMonitora">JoyStickViewXYMonitor</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>HandlePositionMode</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">HandlePositionMode</span></code></pre>

</div>
</div>
<p>Position mode for a joystick handle. The default (original) is <code>absolute</code> mode.</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:12JoyStickViewAAC18HandlePositionModeO8absoluteyA2DmF"></a>
<a name="//apple_ref/swift/Element/absolute" class="dashAnchor"></a>
<a class="token" href="#/s:12JoyStickViewAAC18HandlePositionModeO8absoluteyA2DmF">absolute</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Center of joystick handle moves to actual touch position (limited by base constraints)</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">absolute</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:12JoyStickViewAAC18HandlePositionModeO8relativeyA2DmF"></a>
<a name="//apple_ref/swift/Element/relative" class="dashAnchor"></a>
<a class="token" href="#/s:12JoyStickViewAAC18HandlePositionModeO8relativeyA2DmF">relative</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Center of joystick handle moves to delta between current touch position and first touch position</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="k">case</span> <span class="n">relative</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="https://github.com/bradhowes/Joystick" target="_blank" rel="external">bradhowes</a>. All rights reserved. (Last updated: 2021-08-12)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
</div>
</body>
</div>
</html>

0 comments on commit c2e19a3

Please sign in to comment.