-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
HeightReference.js
85 lines (76 loc) · 1.87 KB
/
HeightReference.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
77
78
79
80
81
82
83
84
85
/**
* Represents the position relative to the terrain.
*
* @enum {number}
*/
const HeightReference = {
/**
* The position is absolute.
* @type {number}
* @constant
*/
NONE: 0,
/**
* The position is clamped to the terrain and 3D Tiles.
* @type {number}
* @constant
*/
CLAMP_TO_GROUND: 1,
/**
* The position height is the height above the terrain and 3D Tiles.
* @type {number}
* @constant
*/
RELATIVE_TO_GROUND: 2,
/**
* The position is clamped to terain.
* @type {number}
* @constant
*/
CLAMP_TO_TERRAIN: 3,
/**
* The position height is the height above terrain.
* @type {number}
* @constant
*/
RELATIVE_TO_TERRAIN: 4,
/**
* The position is clamped to 3D Tiles.
* @type {number}
* @constant
*/
CLAMP_TO_3D_TILE: 5,
/**
* The position height is the height above 3D Tiles.
* @type {number}
* @constant
*/
RELATIVE_TO_3D_TILE: 6,
};
export default Object.freeze(HeightReference);
/**
* Returns true if the height should be clamped to the surface
* @param {HeightReference} heightReference
* @returns true if the height should be clamped to the surface
* @private
*/
export function isHeightReferenceClamp(heightReference) {
return (
heightReference === HeightReference.CLAMP_TO_GROUND ||
heightReference === HeightReference.CLAMP_TO_3D_TILE ||
heightReference === HeightReference.CLAMP_TO_TERRAIN
);
}
/**
* Returns true if the height should be offset relative to the surface
* @param {HeightReference} heightReference
* @returns true if the height should be offset relative to the surface
* @private
*/
export function isHeightReferenceRelative(heightReference) {
return (
heightReference === HeightReference.RELATIVE_TO_GROUND ||
heightReference === HeightReference.RELATIVE_TO_3D_TILE ||
heightReference === HeightReference.RELATIVE_TO_TERRAIN
);
}