-
Notifications
You must be signed in to change notification settings - Fork 13
/
SendHapticData.js
76 lines (70 loc) · 3.29 KB
/
SendHapticData.js
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
/* eslint-disable camelcase */
/*
* Copyright (c) 2022, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium Inc. nor the names of
* its contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
import { FunctionID } from '../enums/FunctionID.js';
import { HapticRect } from '../structs/HapticRect.js';
import { RpcRequest } from '../RpcRequest.js';
/**
* Send 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
*/
class SendHapticData extends RpcRequest {
/**
* Initializes an instance of SendHapticData.
* @class
* @param {object} parameters - An object map of parameters.
* @since SmartDeviceLink 4.5.0
*/
constructor (parameters) {
super(parameters);
this.setFunctionId(FunctionID.SendHapticData);
}
/**
* Set the HapticRectData
* @param {HapticRect[]} data - 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 - The desired HapticRectData.
* {'array_min_size': 0, 'array_max_size': 1000}
* @returns {SendHapticData} - The class instance for method chaining.
*/
setHapticRectData (data) {
this._validateType(HapticRect, data, true);
this.setParameter(SendHapticData.KEY_HAPTIC_RECT_DATA, data);
return this;
}
/**
* Get the HapticRectData
* @returns {HapticRect[]} - the KEY_HAPTIC_RECT_DATA value
*/
getHapticRectData () {
return this.getObject(HapticRect, SendHapticData.KEY_HAPTIC_RECT_DATA);
}
}
SendHapticData.KEY_HAPTIC_RECT_DATA = 'hapticRectData';
export { SendHapticData };