diff options
author | Joel Fischer <joeljfischer@gmail.com> | 2017-10-30 17:17:52 -0400 |
---|---|---|
committer | Joel Fischer <joeljfischer@gmail.com> | 2017-10-30 17:17:52 -0400 |
commit | 4233b570952751945a3f066f35595fbcaec2b0ae (patch) | |
tree | 7888256d1be523dfcb3f4343c59b64b1b516a644 /docs/Classes/SDLSendHapticData.html | |
parent | 43f6367aa18724143032f3624887b0f867c5cc47 (diff) | |
download | sdl_ios-4233b570952751945a3f066f35595fbcaec2b0ae.tar.gz |
Update for 5.0.0 releaserelease/5.0.0
Diffstat (limited to 'docs/Classes/SDLSendHapticData.html')
-rw-r--r-- | docs/Classes/SDLSendHapticData.html | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/Classes/SDLSendHapticData.html b/docs/Classes/SDLSendHapticData.html new file mode 100644 index 000000000..770e142b7 --- /dev/null +++ b/docs/Classes/SDLSendHapticData.html @@ -0,0 +1,61 @@ +<h1>SDLSendHapticData Class Reference</h1> + +<h3>Section Contents</h3> + +<ul> + <li><a href="#section--initWithHapticRectData:">-initWithHapticRectData:</a></li> + <li><a href="#section-hapticRectData">hapticRectData</a></li> +</ul> + +<h3>Overview</h3> + +<p>Sends the spatial data gathered from SDLCarWindow or VirtualDisplayEncoder to the HMI. This data will be utilized by the HMI to determine how and when haptic events should occur.</p> + + +<section class="section task-group-section"> + <h3 id="section--initWithHapticRectData:"> + -initWithHapticRectData: + </h3> + + <p>Constructs a new SDLSendHapticData object indicated by the hapticSpatialData parameter</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithHapticRectData</span><span class="p">:</span> + <span class="p">(</span><span class="n">nonnull</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">hapticRectData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="nf">init</span><span class="p">(</span><span class="nv">hapticRectData</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span><span class="p">])</span></code></pre> + + + + <h4>Parameters</h4> + <dl> + <dt>hapticRectData</dt> + <dd><p>Array of spatial data structures</p></dd> + </dl> + + <h3 id="section-hapticRectData"> + hapticRectData + </h3> + + <p>Array of spatial data structures that represent the locations of all user controls present on the HMI. This data should be updated if/when the application presents a new screen. When a request is sent, if successful, it will replace all spatial data previously sent through RPC. If an empty array is sent, the existing spatial data will be cleared</p> + +<p>Optional, Array of SDLHapticRect, Array size 0 - 1,000</p> + + + + <h4>Objective-C</h4> + <pre class="highlight"><code><span class="k">@property</span> <span class="p">(</span><span class="n">readwrite</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> + <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">hapticRectData</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight"><code><span class="k">var</span> <span class="nv">hapticRectData</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span><span class="p">]?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre> + + + + +</section> |