/
MetadataType.js
200 lines (191 loc) · 4.59 KB
/
MetadataType.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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
import Check from "../Core/Check.js";
import Cartesian2 from "../Core/Cartesian2.js";
import Cartesian3 from "../Core/Cartesian3.js";
import Cartesian4 from "../Core/Cartesian4.js";
import DeveloperError from "../Core/DeveloperError.js";
import Matrix2 from "../Core/Matrix2.js";
import Matrix3 from "../Core/Matrix3.js";
import Matrix4 from "../Core/Matrix4.js";
/**
* An enum of metadata types. These metadata types are containers containing
* one or more components of type {@link MetadataComponentType}
*
* @enum {string}
* @experimental This feature is using part of the 3D Tiles spec that is not final and is subject to change without Cesium's standard deprecation policy.
*/
const MetadataType = {
/**
* A single component
*
* @type {string}
* @constant
*/
SCALAR: "SCALAR",
/**
* A vector with two components
*
* @type {string}
* @constant
*/
VEC2: "VEC2",
/**
* A vector with three components
*
* @type {string}
* @constant
*/
VEC3: "VEC3",
/**
* A vector with four components
*
* @type {string}
* @constant
*/
VEC4: "VEC4",
/**
* A 2x2 matrix, stored in column-major format.
*
* @type {string}
* @constant
*/
MAT2: "MAT2",
/**
* A 3x3 matrix, stored in column-major format.
*
* @type {string}
* @constant
*/
MAT3: "MAT3",
/**
* A 4x4 matrix, stored in column-major format.
*
* @type {string}
* @constant
*/
MAT4: "MAT4",
/**
* A boolean (true/false) value
*
* @type {string}
* @constant
*/
BOOLEAN: "BOOLEAN",
/**
* A UTF-8 encoded string value
*
* @type {string}
* @constant
*/
STRING: "STRING",
/**
* An enumerated value. This type is used in conjunction with a {@link MetadataEnum} to describe the valid values.
*
* @see MetadataEnum
*
* @type {string}
* @constant
*/
ENUM: "ENUM",
};
/**
* Check if a type is VEC2, VEC3 or VEC4
*
* @param {MetadataType} type The type
* @return {boolean} <code>true</code> if the type is a vector, <code>false</code> otherwise
* @private
*/
MetadataType.isVectorType = function (type) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
//>>includeEnd('debug');
switch (type) {
case MetadataType.VEC2:
case MetadataType.VEC3:
case MetadataType.VEC4:
return true;
default:
return false;
}
};
/**
* Check if a type is MAT2, MAT3 or MAT4
*
* @param {MetadataType} type The type
* @return {boolean} <code>true</code> if the type is a matrix, <code>false</code> otherwise
* @private
*/
MetadataType.isMatrixType = function (type) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
//>>includeEnd('debug');
switch (type) {
case MetadataType.MAT2:
case MetadataType.MAT3:
case MetadataType.MAT4:
return true;
default:
return false;
}
};
/**
* Get the number of components for a vector or matrix type. e.g.
* a VECN returns N, and a MATN returns N*N. All other types return 1.
*
* @param {MetadataType} type The type to get the component count for
* @return {number} The number of components
* @private
*/
MetadataType.getComponentCount = function (type) {
//>>includeStart('debug', pragmas.debug);
Check.typeOf.string("type", type);
//>>includeEnd('debug');
switch (type) {
case MetadataType.SCALAR:
case MetadataType.STRING:
case MetadataType.ENUM:
case MetadataType.BOOLEAN:
return 1;
case MetadataType.VEC2:
return 2;
case MetadataType.VEC3:
return 3;
case MetadataType.VEC4:
return 4;
case MetadataType.MAT2:
return 4;
case MetadataType.MAT3:
return 9;
case MetadataType.MAT4:
return 16;
//>>includeStart('debug', pragmas.debug);
default:
throw new DeveloperError(`Invalid metadata type ${type}`);
//>>includeEnd('debug');
}
};
/**
* Get the corresponding vector or matrix class. This is used to simplify
* packing and unpacking code.
* @param {MetadataType} type The metadata type
* @return {object} The appropriate CartesianN class for vector types, MatrixN class for matrix types, or undefined otherwise.
* @private
*/
MetadataType.getMathType = function (type) {
switch (type) {
case MetadataType.VEC2:
return Cartesian2;
case MetadataType.VEC3:
return Cartesian3;
case MetadataType.VEC4:
return Cartesian4;
case MetadataType.MAT2:
return Matrix2;
case MetadataType.MAT3:
return Matrix3;
case MetadataType.MAT4:
return Matrix4;
default:
return undefined;
}
};
export default Object.freeze(MetadataType);