summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLSendHapticData.html
blob: 7553f3ba7f56fa21aacfbc3942d06a7fccf2c9b1 (plain)
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
<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 objective_c"><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">&lt;</span><span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*&gt;</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 swift"><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 objective_c"><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">&lt;</span><span class="n"><a href="../Classes/SDLHapticRect.html">SDLHapticRect</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">hapticRectData</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><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>