summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLSendHapticData.h
blob: 5c6b9ec6c79006e6bd88d93440708f3d173d7b07 (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
//
//  SDLSendHapticData.h
//  SmartDeviceLink-iOS
//
//  Created by Nicole on 8/3/17.
//  Copyright © 2017 smartdevicelink. All rights reserved.
//

#import <Foundation/Foundation.h>
#import "SDLRPCRequest.h"

@class SDLSpatialStruct;

NS_ASSUME_NONNULL_BEGIN

/**
 *   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.
 */
@interface SDLSendHapticData : SDLRPCRequest

/**
 *  Constructs a new SDLSendHapticData object indicated by the hapticSpatialData parameter
 *
 *  @param hapticSpatialData Array of spatial data structures
 */
- (instancetype)initWithHapticSpatialData:(NSArray<SDLSpatialStruct *> *)hapticSpatialData;

/**
 *  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
 *
 *  Optional, Array of SDLSpatialStruct, Array size 0 - 1,000
 */
@property (strong, nonatomic, nullable) NSArray<SDLSpatialStruct *> *hapticSpatialData;

@end

NS_ASSUME_NONNULL_END