@3dverse/api 0.8.18 → 0.8.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/_prebuild/wrapper.d.ts +1337 -49
- package/dist/index.js +3 -3
- package/dist/index.js.map +2 -2
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +2 -2
- package/package.json +2 -2
|
@@ -30,8 +30,11 @@ type StrictUnion<T> = StrictUnionHelper<T, T>;
|
|
|
30
30
|
export declare const axiosInstance: import("axios").AxiosInstance;
|
|
31
31
|
export declare function setBaseURL(baseURL: string): void;
|
|
32
32
|
export type ListUsers_User_UserInfo = {
|
|
33
|
+
/** User unique identifier */
|
|
33
34
|
user_id: string;
|
|
35
|
+
/** Used only for debug purposes */
|
|
34
36
|
username: string;
|
|
37
|
+
/** The user registration date */
|
|
35
38
|
registered_at: string;
|
|
36
39
|
};
|
|
37
40
|
/**
|
|
@@ -42,19 +45,26 @@ export declare function listUsers({ offset, limit, }: {
|
|
|
42
45
|
limit?: number;
|
|
43
46
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<ListUsers_User_UserInfo>>;
|
|
44
47
|
export type RegisterUser_User_UserInfo = {
|
|
48
|
+
/** User unique identifier */
|
|
45
49
|
user_id: string;
|
|
50
|
+
/** Used only for debug purposes */
|
|
46
51
|
username: string;
|
|
52
|
+
/** The user registration date */
|
|
47
53
|
registered_at: string;
|
|
48
54
|
};
|
|
49
55
|
/**
|
|
50
56
|
* Registers the target user in the current application.
|
|
51
57
|
*/
|
|
52
58
|
export declare function registerUser({ username, }: {
|
|
59
|
+
/** Used only for debug purposes */
|
|
53
60
|
username: string;
|
|
54
61
|
}, headers?: AxiosRequestHeaders): AxiosPromise<RegisterUser_User_UserInfo>;
|
|
55
62
|
export type GetCurrentUser_User_UserInfo = {
|
|
63
|
+
/** User unique identifier */
|
|
56
64
|
user_id: string;
|
|
65
|
+
/** Used only for debug purposes */
|
|
57
66
|
username: string;
|
|
67
|
+
/** The user registration date */
|
|
58
68
|
registered_at: string;
|
|
59
69
|
};
|
|
60
70
|
/**
|
|
@@ -62,8 +72,11 @@ export type GetCurrentUser_User_UserInfo = {
|
|
|
62
72
|
*/
|
|
63
73
|
export declare function getCurrentUser(headers?: AxiosRequestHeaders): AxiosPromise<GetCurrentUser_User_UserInfo>;
|
|
64
74
|
export type GetUser_User_UserInfo = {
|
|
75
|
+
/** User unique identifier */
|
|
65
76
|
user_id: string;
|
|
77
|
+
/** Used only for debug purposes */
|
|
66
78
|
username: string;
|
|
79
|
+
/** The user registration date */
|
|
67
80
|
registered_at: string;
|
|
68
81
|
};
|
|
69
82
|
/**
|
|
@@ -77,10 +90,36 @@ export declare function getUser({ user_id, }: {
|
|
|
77
90
|
*/
|
|
78
91
|
export declare function updateUser({ user_id, username, }: {
|
|
79
92
|
user_id: string;
|
|
93
|
+
/** Used only for debug purposes */
|
|
80
94
|
username: string;
|
|
81
95
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
82
96
|
export type DeleteUser_Object = {
|
|
83
|
-
deleted_assets?:
|
|
97
|
+
deleted_assets?: DeleteUser_AssetList;
|
|
98
|
+
};
|
|
99
|
+
export type DeleteUser_AssetList = {
|
|
100
|
+
action_maps?: Array<DeleteUser_Object>;
|
|
101
|
+
animation_graphs?: Array<DeleteUser_Object>;
|
|
102
|
+
animation_sequences?: Array<DeleteUser_Object>;
|
|
103
|
+
animation_sets?: Array<DeleteUser_Object>;
|
|
104
|
+
animations?: Array<DeleteUser_Object>;
|
|
105
|
+
collision_geometries?: Array<DeleteUser_Object>;
|
|
106
|
+
cubemaps?: Array<DeleteUser_Object>;
|
|
107
|
+
event_maps?: Array<DeleteUser_Object>;
|
|
108
|
+
materials?: Array<DeleteUser_Object>;
|
|
109
|
+
meshes?: Array<DeleteUser_Object>;
|
|
110
|
+
modules?: Array<DeleteUser_Object>;
|
|
111
|
+
point_clouds?: Array<DeleteUser_Object>;
|
|
112
|
+
render_graphs?: Array<DeleteUser_Object>;
|
|
113
|
+
scenes?: Array<DeleteUser_Object>;
|
|
114
|
+
scripts?: Array<DeleteUser_Object>;
|
|
115
|
+
shader_contexts?: Array<DeleteUser_Object>;
|
|
116
|
+
shaders?: Array<DeleteUser_Object>;
|
|
117
|
+
skeletons?: Array<DeleteUser_Object>;
|
|
118
|
+
sounds?: Array<DeleteUser_Object>;
|
|
119
|
+
textures?: Array<DeleteUser_Object>;
|
|
120
|
+
textures_1d?: Array<DeleteUser_Object>;
|
|
121
|
+
textures_3d?: Array<DeleteUser_Object>;
|
|
122
|
+
volume_materials?: Array<DeleteUser_Object>;
|
|
84
123
|
};
|
|
85
124
|
/**
|
|
86
125
|
* Deletes the target user.
|
|
@@ -98,10 +137,13 @@ export type GenerateUserToken_Token = {
|
|
|
98
137
|
*/
|
|
99
138
|
export declare function generateUserToken({ user_id, scope, ttl, }: {
|
|
100
139
|
user_id: string;
|
|
140
|
+
/** Token permission scope */
|
|
101
141
|
scope: 'read' | 'write' | 'manage';
|
|
142
|
+
/** Time to live */
|
|
102
143
|
ttl?: string;
|
|
103
144
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GenerateUserToken_Token>;
|
|
104
145
|
export type GetUserGroups_Group_GroupInfo = {
|
|
146
|
+
/** Group unique identifier */
|
|
105
147
|
group_id: string;
|
|
106
148
|
name: string;
|
|
107
149
|
description?: string;
|
|
@@ -109,7 +151,9 @@ export type GetUserGroups_Group_GroupInfo = {
|
|
|
109
151
|
members: Array<GetUserGroups_GroupMember_GroupAccess>;
|
|
110
152
|
};
|
|
111
153
|
export type GetUserGroups_GroupMember_GroupAccess = {
|
|
154
|
+
/** User unique identifier */
|
|
112
155
|
user_id: string;
|
|
156
|
+
/** Date user joined group */
|
|
113
157
|
joined_at?: string;
|
|
114
158
|
group_access: 'read' | 'write' | 'manage';
|
|
115
159
|
folder_access: 'read' | 'write' | 'manage';
|
|
@@ -121,22 +165,35 @@ export declare function getUserGroups({ user_id, }: {
|
|
|
121
165
|
user_id: string;
|
|
122
166
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetUserGroups_Group_GroupInfo>>;
|
|
123
167
|
export type GetUserUploadTasks_UploadTask = {
|
|
168
|
+
/** Upload task unique identifier */
|
|
124
169
|
upload_task_id: string;
|
|
170
|
+
/** Folder unique identifier */
|
|
125
171
|
folder_id: string;
|
|
172
|
+
/** Date of the upload */
|
|
126
173
|
uploaded_at: string;
|
|
174
|
+
/** User who uploaded the file */
|
|
127
175
|
uploaded_by: GetUserUploadTasks_Object;
|
|
176
|
+
/** The global progress of the conversion tasks */
|
|
128
177
|
progress: number;
|
|
178
|
+
/** The download progress of the source file if the Upload Task specified a URL for the source file.
|
|
179
|
+
This is only available if the source file is being downloaded.
|
|
180
|
+
*/
|
|
129
181
|
download_progress?: number;
|
|
130
182
|
status: StrictUnion<'waiting' | 'downloading' | 'pending' | 'converting' | 'error' | 'success' | 'rejected'> & string;
|
|
131
183
|
conversion_tasks: Array<GetUserUploadTasks_ConversionTask>;
|
|
132
184
|
};
|
|
133
185
|
export type GetUserUploadTasks_Object = {
|
|
186
|
+
/** User unique identifier */
|
|
134
187
|
user_id: string;
|
|
188
|
+
/** Used only for debug purposes */
|
|
135
189
|
username: string;
|
|
136
190
|
};
|
|
137
191
|
export type GetUserUploadTasks_ConversionTask = {
|
|
192
|
+
/** Asset unique identifier */
|
|
138
193
|
asset_id: string;
|
|
194
|
+
/** Source file unique identifier */
|
|
139
195
|
source_file_id: string;
|
|
196
|
+
/** The name of the source file */
|
|
140
197
|
source_file_name: string;
|
|
141
198
|
conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud';
|
|
142
199
|
progress: number;
|
|
@@ -151,11 +208,13 @@ export declare function getUserUploadTasks({ user_id, offset, limit, }: {
|
|
|
151
208
|
limit?: number;
|
|
152
209
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetUserUploadTasks_UploadTask>>;
|
|
153
210
|
export type CreateGroup_GroupMember_GroupAccess = {
|
|
211
|
+
/** User unique identifier */
|
|
154
212
|
user_id: string;
|
|
155
213
|
group_access: 'read' | 'write' | 'manage';
|
|
156
214
|
folder_access: 'read' | 'write' | 'manage';
|
|
157
215
|
};
|
|
158
216
|
export type CreateGroup_Group_GroupInfo = {
|
|
217
|
+
/** Group unique identifier */
|
|
159
218
|
group_id: string;
|
|
160
219
|
name: string;
|
|
161
220
|
description?: string;
|
|
@@ -163,7 +222,9 @@ export type CreateGroup_Group_GroupInfo = {
|
|
|
163
222
|
members: Array<CreateGroup_GroupMember_GroupAccess_Writable>;
|
|
164
223
|
};
|
|
165
224
|
export type CreateGroup_GroupMember_GroupAccess_Writable = {
|
|
225
|
+
/** User unique identifier */
|
|
166
226
|
user_id: string;
|
|
227
|
+
/** Date user joined group */
|
|
167
228
|
joined_at?: string;
|
|
168
229
|
group_access: 'read' | 'write' | 'manage';
|
|
169
230
|
folder_access: 'read' | 'write' | 'manage';
|
|
@@ -177,6 +238,7 @@ export declare function createGroup({ name, description, members, }: {
|
|
|
177
238
|
members: Array<CreateGroup_GroupMember_GroupAccess>;
|
|
178
239
|
}, headers?: AxiosRequestHeaders): AxiosPromise<CreateGroup_Group_GroupInfo>;
|
|
179
240
|
export type GetGroup_Group_GroupInfo = {
|
|
241
|
+
/** Group unique identifier */
|
|
180
242
|
group_id: string;
|
|
181
243
|
name: string;
|
|
182
244
|
description?: string;
|
|
@@ -184,7 +246,9 @@ export type GetGroup_Group_GroupInfo = {
|
|
|
184
246
|
members: Array<GetGroup_GroupMember_GroupAccess>;
|
|
185
247
|
};
|
|
186
248
|
export type GetGroup_GroupMember_GroupAccess = {
|
|
249
|
+
/** User unique identifier */
|
|
187
250
|
user_id: string;
|
|
251
|
+
/** Date user joined group */
|
|
188
252
|
joined_at?: string;
|
|
189
253
|
group_access: 'read' | 'write' | 'manage';
|
|
190
254
|
folder_access: 'read' | 'write' | 'manage';
|
|
@@ -228,8 +292,11 @@ export declare function revokeMemberAccessToGroup({ group_id, member_type, membe
|
|
|
228
292
|
member_id: string;
|
|
229
293
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
230
294
|
export type ListFolders_Folder = {
|
|
295
|
+
/** Folder unique identifier */
|
|
231
296
|
folder_id: string;
|
|
297
|
+
/** Folder unique identifier */
|
|
232
298
|
parent_folder_id?: string;
|
|
299
|
+
/** Folder name */
|
|
233
300
|
name: string;
|
|
234
301
|
created_at?: string;
|
|
235
302
|
created_by?: ListFolders_Object;
|
|
@@ -238,8 +305,11 @@ export type ListFolders_Folder = {
|
|
|
238
305
|
asset_count?: number;
|
|
239
306
|
};
|
|
240
307
|
export type ListFolders_Object = {
|
|
308
|
+
/** User unique identifier */
|
|
241
309
|
user_id: string;
|
|
310
|
+
/** Used only for debug purposes */
|
|
242
311
|
username: string;
|
|
312
|
+
/** The user registration date */
|
|
243
313
|
registered_at: string;
|
|
244
314
|
};
|
|
245
315
|
/**
|
|
@@ -250,12 +320,16 @@ export declare function listFolders({ offset, limit, }: {
|
|
|
250
320
|
limit?: number;
|
|
251
321
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<ListFolders_Folder>>;
|
|
252
322
|
export type CreateFolder_Folder = {
|
|
323
|
+
/** Folder name */
|
|
253
324
|
name: string;
|
|
254
325
|
subfolders?: Array<CreateFolder_Folder>;
|
|
255
326
|
};
|
|
256
327
|
export type CreateFolder_Folder_Writable = {
|
|
328
|
+
/** Folder unique identifier */
|
|
257
329
|
folder_id: string;
|
|
330
|
+
/** Folder unique identifier */
|
|
258
331
|
parent_folder_id?: string;
|
|
332
|
+
/** Folder name */
|
|
259
333
|
name: string;
|
|
260
334
|
created_at?: string;
|
|
261
335
|
created_by?: CreateFolder_Object;
|
|
@@ -264,20 +338,27 @@ export type CreateFolder_Folder_Writable = {
|
|
|
264
338
|
asset_count?: number;
|
|
265
339
|
};
|
|
266
340
|
export type CreateFolder_Object = {
|
|
341
|
+
/** User unique identifier */
|
|
267
342
|
user_id: string;
|
|
343
|
+
/** Used only for debug purposes */
|
|
268
344
|
username: string;
|
|
345
|
+
/** The user registration date */
|
|
269
346
|
registered_at: string;
|
|
270
347
|
};
|
|
271
348
|
/**
|
|
272
349
|
* Creates a folder.
|
|
273
350
|
*/
|
|
274
351
|
export declare function createFolder({ name, subfolders, }: {
|
|
352
|
+
/** Folder name */
|
|
275
353
|
name: string;
|
|
276
354
|
subfolders?: Array<CreateFolder_Folder>;
|
|
277
355
|
}, headers?: AxiosRequestHeaders): AxiosPromise<CreateFolder_Folder_Writable>;
|
|
278
356
|
export type GetFolderInfo_Folder = {
|
|
357
|
+
/** Folder unique identifier */
|
|
279
358
|
folder_id: string;
|
|
359
|
+
/** Folder unique identifier */
|
|
280
360
|
parent_folder_id?: string;
|
|
361
|
+
/** Folder name */
|
|
281
362
|
name: string;
|
|
282
363
|
created_at?: string;
|
|
283
364
|
created_by?: GetFolderInfo_Object;
|
|
@@ -286,8 +367,11 @@ export type GetFolderInfo_Folder = {
|
|
|
286
367
|
asset_count?: number;
|
|
287
368
|
};
|
|
288
369
|
export type GetFolderInfo_Object = {
|
|
370
|
+
/** User unique identifier */
|
|
289
371
|
user_id: string;
|
|
372
|
+
/** Used only for debug purposes */
|
|
290
373
|
username: string;
|
|
374
|
+
/** The user registration date */
|
|
291
375
|
registered_at: string;
|
|
292
376
|
};
|
|
293
377
|
/**
|
|
@@ -308,6 +392,7 @@ export declare function moveFolders({ folder_id, folder_ids, }: {
|
|
|
308
392
|
*/
|
|
309
393
|
export declare function updateFolder({ folder_id, name, }: {
|
|
310
394
|
folder_id: string;
|
|
395
|
+
/** Folder name */
|
|
311
396
|
name?: string;
|
|
312
397
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
313
398
|
/**
|
|
@@ -321,11 +406,14 @@ export type ListFolderAccesses_Object = {
|
|
|
321
406
|
groups?: Array<ListFolderAccesses_GroupInfo_FolderAccess>;
|
|
322
407
|
};
|
|
323
408
|
export type ListFolderAccesses_UserInfo_FolderAccess = {
|
|
409
|
+
/** User unique identifier */
|
|
324
410
|
user_id: string;
|
|
411
|
+
/** Used only for debug purposes */
|
|
325
412
|
username: string;
|
|
326
413
|
access: 'read' | 'write' | 'manage';
|
|
327
414
|
};
|
|
328
415
|
export type ListFolderAccesses_GroupInfo_FolderAccess = {
|
|
416
|
+
/** Group unique identifier */
|
|
329
417
|
group_id: string;
|
|
330
418
|
name: string;
|
|
331
419
|
access: 'read' | 'write' | 'manage';
|
|
@@ -354,12 +442,16 @@ export declare function revokeMemberAccessToFolder({ folder_id, member_type, mem
|
|
|
354
442
|
member_id: string;
|
|
355
443
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
356
444
|
export type CreateSubfolder_Folder = {
|
|
445
|
+
/** Folder name */
|
|
357
446
|
name: string;
|
|
358
447
|
subfolders?: Array<CreateSubfolder_Folder>;
|
|
359
448
|
};
|
|
360
449
|
export type CreateSubfolder_Folder_Writable = {
|
|
450
|
+
/** Folder unique identifier */
|
|
361
451
|
folder_id: string;
|
|
452
|
+
/** Folder unique identifier */
|
|
362
453
|
parent_folder_id?: string;
|
|
454
|
+
/** Folder name */
|
|
363
455
|
name: string;
|
|
364
456
|
created_at?: string;
|
|
365
457
|
created_by?: CreateSubfolder_Object;
|
|
@@ -368,8 +460,11 @@ export type CreateSubfolder_Folder_Writable = {
|
|
|
368
460
|
asset_count?: number;
|
|
369
461
|
};
|
|
370
462
|
export type CreateSubfolder_Object = {
|
|
463
|
+
/** User unique identifier */
|
|
371
464
|
user_id: string;
|
|
465
|
+
/** Used only for debug purposes */
|
|
372
466
|
username: string;
|
|
467
|
+
/** The user registration date */
|
|
373
468
|
registered_at: string;
|
|
374
469
|
};
|
|
375
470
|
/**
|
|
@@ -377,12 +472,16 @@ export type CreateSubfolder_Object = {
|
|
|
377
472
|
*/
|
|
378
473
|
export declare function createSubfolder({ folder_id, name, subfolders, }: {
|
|
379
474
|
folder_id: string;
|
|
475
|
+
/** Folder name */
|
|
380
476
|
name: string;
|
|
381
477
|
subfolders?: Array<CreateSubfolder_Folder>;
|
|
382
478
|
}, headers?: AxiosRequestHeaders): AxiosPromise<CreateSubfolder_Folder_Writable>;
|
|
383
479
|
export type ListFolderSubFolders_Folder = {
|
|
480
|
+
/** Folder unique identifier */
|
|
384
481
|
folder_id: string;
|
|
482
|
+
/** Folder unique identifier */
|
|
385
483
|
parent_folder_id?: string;
|
|
484
|
+
/** Folder name */
|
|
386
485
|
name: string;
|
|
387
486
|
created_at?: string;
|
|
388
487
|
created_by?: ListFolderSubFolders_Object;
|
|
@@ -391,8 +490,11 @@ export type ListFolderSubFolders_Folder = {
|
|
|
391
490
|
asset_count?: number;
|
|
392
491
|
};
|
|
393
492
|
export type ListFolderSubFolders_Object = {
|
|
493
|
+
/** User unique identifier */
|
|
394
494
|
user_id: string;
|
|
495
|
+
/** Used only for debug purposes */
|
|
395
496
|
username: string;
|
|
497
|
+
/** The user registration date */
|
|
396
498
|
registered_at: string;
|
|
397
499
|
};
|
|
398
500
|
/**
|
|
@@ -402,6 +504,7 @@ export declare function listFolderSubFolders({ folder_id, }: {
|
|
|
402
504
|
folder_id: string;
|
|
403
505
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<ListFolderSubFolders_Folder>>;
|
|
404
506
|
export type UploadSourceFiles_Object = {
|
|
507
|
+
/** Upload task unique identifier */
|
|
405
508
|
upload_task_id?: string;
|
|
406
509
|
};
|
|
407
510
|
/**
|
|
@@ -423,9 +526,13 @@ export type GetSourceFilesInFolder_Filters = {
|
|
|
423
526
|
source_file_name?: string;
|
|
424
527
|
};
|
|
425
528
|
export type GetSourceFilesInFolder_SourceFile = {
|
|
529
|
+
/** Source file unique identifier */
|
|
426
530
|
source_file_id: string;
|
|
531
|
+
/** The name of the source file when uploaded */
|
|
427
532
|
source_file_original_name: string;
|
|
533
|
+
/** Source file display name */
|
|
428
534
|
name: string;
|
|
535
|
+
/** Size in bytes */
|
|
429
536
|
size: number;
|
|
430
537
|
};
|
|
431
538
|
/**
|
|
@@ -445,22 +552,35 @@ export declare function moveSourceFiles({ folder_id, source_file_ids, }: {
|
|
|
445
552
|
source_file_ids: Array<string>;
|
|
446
553
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
447
554
|
export type GetUploadTasksInFolder_UploadTask = {
|
|
555
|
+
/** Upload task unique identifier */
|
|
448
556
|
upload_task_id: string;
|
|
557
|
+
/** Folder unique identifier */
|
|
449
558
|
folder_id: string;
|
|
559
|
+
/** Date of the upload */
|
|
450
560
|
uploaded_at: string;
|
|
561
|
+
/** User who uploaded the file */
|
|
451
562
|
uploaded_by: GetUploadTasksInFolder_Object;
|
|
563
|
+
/** The global progress of the conversion tasks */
|
|
452
564
|
progress: number;
|
|
565
|
+
/** The download progress of the source file if the Upload Task specified a URL for the source file.
|
|
566
|
+
This is only available if the source file is being downloaded.
|
|
567
|
+
*/
|
|
453
568
|
download_progress?: number;
|
|
454
569
|
status: StrictUnion<'waiting' | 'downloading' | 'pending' | 'converting' | 'error' | 'success' | 'rejected'> & string;
|
|
455
570
|
conversion_tasks: Array<GetUploadTasksInFolder_ConversionTask>;
|
|
456
571
|
};
|
|
457
572
|
export type GetUploadTasksInFolder_Object = {
|
|
573
|
+
/** User unique identifier */
|
|
458
574
|
user_id: string;
|
|
575
|
+
/** Used only for debug purposes */
|
|
459
576
|
username: string;
|
|
460
577
|
};
|
|
461
578
|
export type GetUploadTasksInFolder_ConversionTask = {
|
|
579
|
+
/** Asset unique identifier */
|
|
462
580
|
asset_id: string;
|
|
581
|
+
/** Source file unique identifier */
|
|
463
582
|
source_file_id: string;
|
|
583
|
+
/** The name of the source file */
|
|
464
584
|
source_file_name: string;
|
|
465
585
|
conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud';
|
|
466
586
|
progress: number;
|
|
@@ -475,15 +595,24 @@ export declare function getUploadTasksInFolder({ folder_id, offset, limit, }: {
|
|
|
475
595
|
limit?: number;
|
|
476
596
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetUploadTasksInFolder_UploadTask>>;
|
|
477
597
|
export type GetFolderAssets_Filters = {
|
|
598
|
+
/** Look for assets containing the given name (case-insensitive) */
|
|
478
599
|
asset_name?: string;
|
|
479
|
-
|
|
600
|
+
/** @deprecated Deprecated. Use asset_types instead. Look for assets of the given type */
|
|
601
|
+
asset_type?: (Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material') & any;
|
|
602
|
+
/** Look for assets of the given types */
|
|
603
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
604
|
+
/** Look for assets associated with or without libraries */
|
|
605
|
+
library?: Array<string> | string | 'exclude';
|
|
606
|
+
/** Look for assets associated with or without source files */
|
|
480
607
|
source_file?: Array<string> | string | 'exclude';
|
|
481
608
|
};
|
|
482
609
|
export type GetFolderAssets_AssetCount = {
|
|
610
|
+
/** Total number of assets in target folder. */
|
|
483
611
|
total: number;
|
|
612
|
+
/** Total number of assets in target folder of specific type. */
|
|
484
613
|
[asset_type: string]: number;
|
|
485
614
|
};
|
|
486
|
-
export type
|
|
615
|
+
export type GetFolderAssets_AssetList = {
|
|
487
616
|
action_maps?: Array<GetFolderAssets_Object>;
|
|
488
617
|
animation_graphs?: Array<GetFolderAssets_Object>;
|
|
489
618
|
animation_sequences?: Array<GetFolderAssets_Object>;
|
|
@@ -499,6 +628,7 @@ export type GetFolderAssets__index_AssetList_AssetList = {
|
|
|
499
628
|
render_graphs?: Array<GetFolderAssets_Object>;
|
|
500
629
|
scenes?: Array<GetFolderAssets_Object>;
|
|
501
630
|
scripts?: Array<GetFolderAssets_Object>;
|
|
631
|
+
shader_contexts?: Array<GetFolderAssets_Object>;
|
|
502
632
|
shaders?: Array<GetFolderAssets_Object>;
|
|
503
633
|
skeletons?: Array<GetFolderAssets_Object>;
|
|
504
634
|
sounds?: Array<GetFolderAssets_Object>;
|
|
@@ -508,6 +638,7 @@ export type GetFolderAssets__index_AssetList_AssetList = {
|
|
|
508
638
|
volume_materials?: Array<GetFolderAssets_Object>;
|
|
509
639
|
};
|
|
510
640
|
export type GetFolderAssets_Object = {
|
|
641
|
+
/** Asset unique identifier */
|
|
511
642
|
asset_id: string;
|
|
512
643
|
name: string;
|
|
513
644
|
};
|
|
@@ -520,24 +651,30 @@ export declare function getFolderAssets({ folder_id, offset, limit, filter, recu
|
|
|
520
651
|
limit?: number;
|
|
521
652
|
filter?: GetFolderAssets_Filters;
|
|
522
653
|
recursive?: boolean;
|
|
523
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<
|
|
654
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<GetFolderAssets_AssetList>;
|
|
524
655
|
export type CreateAsset_NewAsset = {
|
|
525
656
|
asset_type: 'action_map' | 'animation_graph' | 'animation_sequence' | 'cubemap' | 'event_map' | 'material' | 'module' | 'render_graph' | 'scene' | 'script' | 'shader' | 'volume_material';
|
|
526
657
|
name: string;
|
|
527
658
|
};
|
|
528
659
|
export type CreateAsset_AssetDuplication = {
|
|
529
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
660
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
661
|
+
/** Asset unique identifier */
|
|
530
662
|
copy_from_asset_id: string;
|
|
531
663
|
new_asset_name?: string;
|
|
664
|
+
/** Provide options to recursively duplicate asset dependencies. */
|
|
532
665
|
options?: CreateAsset_DuplicationOptions;
|
|
533
666
|
};
|
|
534
667
|
export type CreateAsset_DuplicationOptions = {
|
|
535
|
-
|
|
668
|
+
/** Limits the duplication to the specified asset types */
|
|
669
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
670
|
+
/** Limits the depth level of the duplication process. */
|
|
536
671
|
max_depth?: number;
|
|
537
672
|
};
|
|
538
673
|
export type CreateAsset_AssetDuplicationResult = {
|
|
674
|
+
/** Asset unique identifier */
|
|
539
675
|
asset_id: string;
|
|
540
676
|
name: string;
|
|
677
|
+
/** Map of source asset ids to copied asset ids */
|
|
541
678
|
source_to_copy_asset_id_map?: CreateAsset_SourceToCopyAssetIdMap;
|
|
542
679
|
};
|
|
543
680
|
export type CreateAsset_SourceToCopyAssetIdMap = {
|
|
@@ -558,6 +695,7 @@ export declare function moveAssets({ folder_id, asset_ids, }: {
|
|
|
558
695
|
asset_ids: Array<string>;
|
|
559
696
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
560
697
|
export type CreateMaterial_Object = {
|
|
698
|
+
/** Asset unique identifier */
|
|
561
699
|
asset_id: string;
|
|
562
700
|
};
|
|
563
701
|
/**
|
|
@@ -565,12 +703,17 @@ export type CreateMaterial_Object = {
|
|
|
565
703
|
*/
|
|
566
704
|
export declare function createMaterial({ folder_id, dataJson, isDoubleSided, name, shaderRef, }: {
|
|
567
705
|
folder_id: string;
|
|
706
|
+
/** Data object following the descriptor of the attached shader */
|
|
568
707
|
dataJson: object;
|
|
708
|
+
/** Whether the faces of the geometry are rendered from both sides or not */
|
|
569
709
|
isDoubleSided: boolean;
|
|
710
|
+
/** Name of the asset */
|
|
570
711
|
name: string;
|
|
712
|
+
/** The implemented shader */
|
|
571
713
|
shaderRef: string;
|
|
572
714
|
}, headers?: AxiosRequestHeaders): AxiosPromise<CreateMaterial_Object>;
|
|
573
715
|
export type CreateCubemap_Object = {
|
|
716
|
+
/** Asset unique identifier */
|
|
574
717
|
asset_id: string;
|
|
575
718
|
};
|
|
576
719
|
/**
|
|
@@ -578,16 +721,23 @@ export type CreateCubemap_Object = {
|
|
|
578
721
|
*/
|
|
579
722
|
export declare function createCubemap({ folder_id, faces, name, }: {
|
|
580
723
|
folder_id: string;
|
|
724
|
+
/** The 6 images forming the cube faces */
|
|
581
725
|
faces: Array<string>;
|
|
726
|
+
/** Name of the asset */
|
|
582
727
|
name: string;
|
|
583
728
|
}, headers?: AxiosRequestHeaders): AxiosPromise<CreateCubemap_Object>;
|
|
584
729
|
export type ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse = {
|
|
730
|
+
/** List of asset ids contained in the package */
|
|
585
731
|
asset_ids: ImportAssets_AssetIds;
|
|
732
|
+
/** List of skipped file names in the package */
|
|
586
733
|
skipped_files?: Array<string>;
|
|
587
734
|
};
|
|
588
735
|
export type ImportAssets_AssetIds = {
|
|
736
|
+
/** List of asset ids that were created */
|
|
589
737
|
imported: Array<string>;
|
|
738
|
+
/** List of asset ids that were overwritten */
|
|
590
739
|
overwritten: Array<string>;
|
|
740
|
+
/** List of asset ids that were skipped because they already exist and were not specified in the overwrite.json file */
|
|
591
741
|
skipped: Array<string>;
|
|
592
742
|
};
|
|
593
743
|
/**
|
|
@@ -630,22 +780,36 @@ export declare function importAssets({ folder_id, overwrite, body, }: {
|
|
|
630
780
|
body: ArrayBuffer | ReadableStream;
|
|
631
781
|
}, onUploadProgress?: (progressEvent: AxiosProgressEvent) => void, headers?: AxiosRequestHeaders): AxiosPromise<ImportAssets__index_ImportAssetsResponse_ImportAssetsResponse>;
|
|
632
782
|
export type GetSessionsInFolder_Session = {
|
|
783
|
+
/** Session unique identifier */
|
|
633
784
|
session_id: string;
|
|
785
|
+
/** The main scene identifier of the session */
|
|
634
786
|
scene_id: string;
|
|
787
|
+
/** The main scene name of the session */
|
|
635
788
|
scene_name: string;
|
|
789
|
+
/** The folder identifier of the scene */
|
|
636
790
|
folder_id: string;
|
|
791
|
+
/** Maximum number of users allowed in this session at the same time */
|
|
637
792
|
max_users: number;
|
|
793
|
+
/** User identifier of the creator of the session */
|
|
638
794
|
creator_user_id: string;
|
|
795
|
+
/** Session creation date */
|
|
639
796
|
created_at: string;
|
|
797
|
+
/** Country code of the rendering server location */
|
|
640
798
|
country_code: string;
|
|
799
|
+
/** Continent code of the rendering server location */
|
|
641
800
|
continent_code: string;
|
|
801
|
+
/** Whether the session is transient or not */
|
|
642
802
|
is_transient_session: boolean;
|
|
803
|
+
/** Current clients in session */
|
|
643
804
|
clients: Array<GetSessionsInFolder_Client_UserInfo>;
|
|
644
805
|
};
|
|
645
806
|
export type GetSessionsInFolder_Client_UserInfo = {
|
|
807
|
+
/** Client unique identifier */
|
|
646
808
|
client_id?: string;
|
|
647
809
|
client_type?: 'user' | 'guest';
|
|
810
|
+
/** User unique identifier */
|
|
648
811
|
user_id: string;
|
|
812
|
+
/** Used only for debug purposes */
|
|
649
813
|
username: string;
|
|
650
814
|
};
|
|
651
815
|
/**
|
|
@@ -658,9 +822,13 @@ export type ListSourceFiles_Filters = {
|
|
|
658
822
|
source_file_name?: string;
|
|
659
823
|
};
|
|
660
824
|
export type ListSourceFiles_SourceFile = {
|
|
825
|
+
/** Source file unique identifier */
|
|
661
826
|
source_file_id: string;
|
|
827
|
+
/** The name of the source file when uploaded */
|
|
662
828
|
source_file_original_name: string;
|
|
829
|
+
/** Source file display name */
|
|
663
830
|
name: string;
|
|
831
|
+
/** Size in bytes */
|
|
664
832
|
size: number;
|
|
665
833
|
};
|
|
666
834
|
/**
|
|
@@ -675,7 +843,10 @@ export declare function listSourceFiles({ offset, limit, filters, }: {
|
|
|
675
843
|
* Deletes the target source files. Deleting a source file is permanent.
|
|
676
844
|
*/
|
|
677
845
|
export declare function deleteSourceFiles({ source_file_ids, delete_assets, }: {
|
|
846
|
+
/** List of source files to delete */
|
|
678
847
|
source_file_ids: Array<string>;
|
|
848
|
+
/** If true, delete the assets associated with the source files as well.
|
|
849
|
+
*/
|
|
679
850
|
delete_assets?: boolean;
|
|
680
851
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
681
852
|
/**
|
|
@@ -685,9 +856,13 @@ export declare function downloadSourceFile<T extends 'arraybuffer' | 'stream' |
|
|
|
685
856
|
source_file_id: string;
|
|
686
857
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
687
858
|
export type GetSourceFileDetails_SourceFile = {
|
|
859
|
+
/** Source file unique identifier */
|
|
688
860
|
source_file_id: string;
|
|
861
|
+
/** The name of the source file when uploaded */
|
|
689
862
|
source_file_original_name: string;
|
|
863
|
+
/** Source file display name */
|
|
690
864
|
name: string;
|
|
865
|
+
/** Size in bytes */
|
|
691
866
|
size: number;
|
|
692
867
|
};
|
|
693
868
|
/**
|
|
@@ -701,9 +876,10 @@ export declare function getSourceFileDetails({ source_file_id, }: {
|
|
|
701
876
|
*/
|
|
702
877
|
export declare function updateSourceFileDetails({ source_file_id, name, }: {
|
|
703
878
|
source_file_id: string;
|
|
879
|
+
/** Source file display name */
|
|
704
880
|
name: string;
|
|
705
881
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
706
|
-
export type
|
|
882
|
+
export type GetSourceFileAssets_AssetList = {
|
|
707
883
|
action_maps?: Array<GetSourceFileAssets_Object>;
|
|
708
884
|
animation_graphs?: Array<GetSourceFileAssets_Object>;
|
|
709
885
|
animation_sequences?: Array<GetSourceFileAssets_Object>;
|
|
@@ -719,6 +895,7 @@ export type GetSourceFileAssets__index_AssetList_AssetList = {
|
|
|
719
895
|
render_graphs?: Array<GetSourceFileAssets_Object>;
|
|
720
896
|
scenes?: Array<GetSourceFileAssets_Object>;
|
|
721
897
|
scripts?: Array<GetSourceFileAssets_Object>;
|
|
898
|
+
shader_contexts?: Array<GetSourceFileAssets_Object>;
|
|
722
899
|
shaders?: Array<GetSourceFileAssets_Object>;
|
|
723
900
|
skeletons?: Array<GetSourceFileAssets_Object>;
|
|
724
901
|
sounds?: Array<GetSourceFileAssets_Object>;
|
|
@@ -728,6 +905,7 @@ export type GetSourceFileAssets__index_AssetList_AssetList = {
|
|
|
728
905
|
volume_materials?: Array<GetSourceFileAssets_Object>;
|
|
729
906
|
};
|
|
730
907
|
export type GetSourceFileAssets_Object = {
|
|
908
|
+
/** Asset unique identifier */
|
|
731
909
|
asset_id: string;
|
|
732
910
|
name: string;
|
|
733
911
|
};
|
|
@@ -736,7 +914,7 @@ export type GetSourceFileAssets_Object = {
|
|
|
736
914
|
*/
|
|
737
915
|
export declare function getSourceFileAssets({ source_file_id, }: {
|
|
738
916
|
source_file_id: string;
|
|
739
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<
|
|
917
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<GetSourceFileAssets_AssetList>;
|
|
740
918
|
/**
|
|
741
919
|
* Lists all upload tasks. These upload tasks relate to uploaded source files.
|
|
742
920
|
*/
|
|
@@ -745,22 +923,35 @@ export declare function getUploadTasks({ offset, limit, }: {
|
|
|
745
923
|
limit?: number;
|
|
746
924
|
}, headers?: AxiosRequestHeaders): AxiosPromise<any>;
|
|
747
925
|
export type GetUploadTask_UploadTask = {
|
|
926
|
+
/** Upload task unique identifier */
|
|
748
927
|
upload_task_id: string;
|
|
928
|
+
/** Folder unique identifier */
|
|
749
929
|
folder_id: string;
|
|
930
|
+
/** Date of the upload */
|
|
750
931
|
uploaded_at: string;
|
|
932
|
+
/** User who uploaded the file */
|
|
751
933
|
uploaded_by: GetUploadTask_Object;
|
|
934
|
+
/** The global progress of the conversion tasks */
|
|
752
935
|
progress: number;
|
|
936
|
+
/** The download progress of the source file if the Upload Task specified a URL for the source file.
|
|
937
|
+
This is only available if the source file is being downloaded.
|
|
938
|
+
*/
|
|
753
939
|
download_progress?: number;
|
|
754
940
|
status: StrictUnion<'waiting' | 'downloading' | 'pending' | 'converting' | 'error' | 'success' | 'rejected'> & string;
|
|
755
941
|
conversion_tasks: Array<GetUploadTask_ConversionTask>;
|
|
756
942
|
};
|
|
757
943
|
export type GetUploadTask_Object = {
|
|
944
|
+
/** User unique identifier */
|
|
758
945
|
user_id: string;
|
|
946
|
+
/** Used only for debug purposes */
|
|
759
947
|
username: string;
|
|
760
948
|
};
|
|
761
949
|
export type GetUploadTask_ConversionTask = {
|
|
950
|
+
/** Asset unique identifier */
|
|
762
951
|
asset_id: string;
|
|
952
|
+
/** Source file unique identifier */
|
|
763
953
|
source_file_id: string;
|
|
954
|
+
/** The name of the source file */
|
|
764
955
|
source_file_name: string;
|
|
765
956
|
conversion_pipeline: 'auto-detect' | 'volume' | 'scene' | 'texture' | 'animation' | 'point-cloud';
|
|
766
957
|
progress: number;
|
|
@@ -780,54 +971,84 @@ export declare function getConversionTaskMetadata<T extends 'arraybuffer' | 'str
|
|
|
780
971
|
filename: string;
|
|
781
972
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
782
973
|
export type SchedulePipeline_Object = {
|
|
783
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
974
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
975
|
+
/** Asset unique identifier */
|
|
784
976
|
asset_id: string;
|
|
785
977
|
};
|
|
786
978
|
export type SchedulePipeline_Object_Writable = {
|
|
979
|
+
/** Pipeline unique identifier. A pipeline is an instance of a Data Pipeline. */
|
|
787
980
|
pipeline_id: string;
|
|
788
981
|
};
|
|
789
982
|
/**
|
|
790
983
|
* Schedules a data pipeline to be run.
|
|
791
984
|
*/
|
|
792
985
|
export declare function schedulePipeline({ data_pipeline_id, pipeline_name, folder_id, inputs, asset_refs, }: {
|
|
986
|
+
/** Identifier of the data pipeline to schedule. */
|
|
793
987
|
data_pipeline_id: string;
|
|
988
|
+
/** Optional name for the scheduled pipeline instance. */
|
|
794
989
|
pipeline_name?: string;
|
|
990
|
+
/** Identifier of the folder where the pipeline is scheduled. */
|
|
795
991
|
folder_id: string;
|
|
992
|
+
/** Input parameters for the data pipeline. */
|
|
796
993
|
inputs?: object;
|
|
994
|
+
/** List of assets required by the pipeline. */
|
|
797
995
|
asset_refs?: Array<SchedulePipeline_Object>;
|
|
798
996
|
}, headers?: AxiosRequestHeaders): AxiosPromise<SchedulePipeline_Object_Writable>;
|
|
799
997
|
export type GetPipeline_Pipeline = {
|
|
998
|
+
/** Data Pipeline unique identifier. */
|
|
800
999
|
data_pipeline_id: string;
|
|
1000
|
+
/** Unique identifier of an environment */
|
|
801
1001
|
environment_id: string;
|
|
1002
|
+
/** Date and time when the pipeline was completed, either successfully or with errors. */
|
|
802
1003
|
finished_at?: string;
|
|
1004
|
+
/** Folder unique identifier */
|
|
803
1005
|
folder_id: string;
|
|
804
1006
|
jobs: Array<GetPipeline_Job>;
|
|
1007
|
+
/** Name of the pipeline. */
|
|
805
1008
|
name: string;
|
|
1009
|
+
/** Pipeline unique identifier. A pipeline is an instance of a Data Pipeline. */
|
|
806
1010
|
pipeline_id: string;
|
|
807
1011
|
progress: number;
|
|
1012
|
+
/** Date and time when the pipeline was accepted by the system and queued for processing. */
|
|
808
1013
|
queued_at?: string;
|
|
1014
|
+
/** Possible status of a pipeline. */
|
|
809
1015
|
status: 'created' | 'downloading' | 'extracting' | 'pending-approval' | 'queued' | 'running' | 'passed-with-errors' | 'failed' | 'rejected' | 'succeeded';
|
|
1016
|
+
/** Date and time when the pipeline was triggered. */
|
|
810
1017
|
triggered_at: string;
|
|
1018
|
+
/** User unique identifier */
|
|
811
1019
|
user_id: string;
|
|
812
1020
|
};
|
|
813
1021
|
export type GetPipeline_Job = {
|
|
1022
|
+
/** Date and time when the job was completed, either successfully or with errors. */
|
|
814
1023
|
finished_at?: string;
|
|
1024
|
+
/** Data Pipeline job unique identifier. */
|
|
815
1025
|
job_id: string;
|
|
1026
|
+
/** Name of the job. */
|
|
816
1027
|
name: string;
|
|
1028
|
+
/** Pipeline unique identifier. A pipeline is an instance of a Data Pipeline. */
|
|
817
1029
|
pipeline_id: string;
|
|
818
1030
|
progress: number;
|
|
1031
|
+
/** Date and time when the job was queued for processing. */
|
|
819
1032
|
queued_at?: string;
|
|
1033
|
+
/** Date and time when the job was started. */
|
|
820
1034
|
started_at?: string;
|
|
1035
|
+
/** Possible status of a job. */
|
|
821
1036
|
status: 'created' | 'queued' | 'running' | 'timed-out' | 'failed' | 'succeeded';
|
|
822
1037
|
steps: Array<GetPipeline_Step>;
|
|
823
1038
|
};
|
|
824
1039
|
export type GetPipeline_Step = {
|
|
1040
|
+
/** Date and time when the step was completed, either successfully or with errors. */
|
|
825
1041
|
finished_at?: string;
|
|
1042
|
+
/** Data Pipeline job unique identifier. */
|
|
826
1043
|
job_id: string;
|
|
1044
|
+
/** Name of the step. */
|
|
827
1045
|
name: string;
|
|
828
1046
|
progress: number;
|
|
1047
|
+
/** Date and time when the step was started. */
|
|
829
1048
|
started_at?: string;
|
|
1049
|
+
/** Possible status of a step. */
|
|
830
1050
|
status: 'created' | 'skipped' | 'queued' | 'running' | 'timed-out' | 'failed' | 'succeeded';
|
|
1051
|
+
/** Data Pipeline job step unique identifier. */
|
|
831
1052
|
step_id: string;
|
|
832
1053
|
};
|
|
833
1054
|
/**
|
|
@@ -837,11 +1058,16 @@ export declare function getPipeline({ pipeline_id, }: {
|
|
|
837
1058
|
pipeline_id: string;
|
|
838
1059
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetPipeline_Pipeline>;
|
|
839
1060
|
export type ListAssets_Filter = {
|
|
840
|
-
|
|
1061
|
+
/** @deprecated Deprecated. Use asset_types instead. Look for assets of the given type */
|
|
1062
|
+
asset_type?: (Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'> | 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material') & any;
|
|
1063
|
+
/** Look for assets of the given types */
|
|
1064
|
+
asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1065
|
+
/** Filter by asset name */
|
|
841
1066
|
asset_name?: string;
|
|
1067
|
+
/** Include assets coming from public libraries */
|
|
842
1068
|
include_public_assets?: boolean;
|
|
843
1069
|
};
|
|
844
|
-
export type
|
|
1070
|
+
export type ListAssets_AssetList = {
|
|
845
1071
|
action_maps?: Array<ListAssets_Object>;
|
|
846
1072
|
animation_graphs?: Array<ListAssets_Object>;
|
|
847
1073
|
animation_sequences?: Array<ListAssets_Object>;
|
|
@@ -857,6 +1083,7 @@ export type ListAssets__index_AssetList_AssetList = {
|
|
|
857
1083
|
render_graphs?: Array<ListAssets_Object>;
|
|
858
1084
|
scenes?: Array<ListAssets_Object>;
|
|
859
1085
|
scripts?: Array<ListAssets_Object>;
|
|
1086
|
+
shader_contexts?: Array<ListAssets_Object>;
|
|
860
1087
|
shaders?: Array<ListAssets_Object>;
|
|
861
1088
|
skeletons?: Array<ListAssets_Object>;
|
|
862
1089
|
sounds?: Array<ListAssets_Object>;
|
|
@@ -866,6 +1093,7 @@ export type ListAssets__index_AssetList_AssetList = {
|
|
|
866
1093
|
volume_materials?: Array<ListAssets_Object>;
|
|
867
1094
|
};
|
|
868
1095
|
export type ListAssets_Object = {
|
|
1096
|
+
/** Asset unique identifier */
|
|
869
1097
|
asset_id: string;
|
|
870
1098
|
name: string;
|
|
871
1099
|
};
|
|
@@ -876,7 +1104,7 @@ export declare function listAssets({ offset, limit, filter, }: {
|
|
|
876
1104
|
offset?: number;
|
|
877
1105
|
limit?: number;
|
|
878
1106
|
filter?: ListAssets_Filter;
|
|
879
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<
|
|
1107
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<ListAssets_AssetList>;
|
|
880
1108
|
/**
|
|
881
1109
|
* Batch delete assets. You **MUST NOT** reference assets.
|
|
882
1110
|
*/
|
|
@@ -887,56 +1115,81 @@ export declare function deleteAssets({ asset_ids, }: {
|
|
|
887
1115
|
* Deletes the asset.
|
|
888
1116
|
*/
|
|
889
1117
|
export declare function deleteAsset({ asset_container, asset_id, }: {
|
|
890
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1118
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
891
1119
|
asset_id: string;
|
|
892
1120
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
893
1121
|
export type GetAssetSourceFile_SourceFile = {
|
|
1122
|
+
/** Source file unique identifier */
|
|
894
1123
|
source_file_id: string;
|
|
1124
|
+
/** The name of the source file when uploaded */
|
|
895
1125
|
source_file_original_name: string;
|
|
1126
|
+
/** Source file display name */
|
|
896
1127
|
name: string;
|
|
1128
|
+
/** Size in bytes */
|
|
897
1129
|
size: number;
|
|
898
1130
|
};
|
|
899
1131
|
/**
|
|
900
1132
|
* Gets the source file of the specified asset.
|
|
901
1133
|
*/
|
|
902
1134
|
export declare function getAssetSourceFile({ asset_container, asset_id, }: {
|
|
903
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1135
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
904
1136
|
asset_id: string;
|
|
905
1137
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetSourceFile_SourceFile>;
|
|
906
1138
|
export type GetAssetDetails__index_AssetDetails_AssetDetails = {
|
|
907
1139
|
asset_id: string;
|
|
908
1140
|
contributors?: Array<GetAssetDetails_Contributor>;
|
|
909
1141
|
created_at?: string;
|
|
1142
|
+
/** This object represents a user in a 3dverse project.
|
|
1143
|
+
This object contains group and task information about the user.
|
|
1144
|
+
The user object lets you create or update user tokens that identify the useron the 3dverse platform.
|
|
1145
|
+
*/
|
|
910
1146
|
created_by?: GetAssetDetails_Object;
|
|
911
1147
|
last_edited_at?: string;
|
|
1148
|
+
/** This object represents a user in a 3dverse project.
|
|
1149
|
+
This object contains group and task information about the user.
|
|
1150
|
+
The user object lets you create or update user tokens that identify the useron the 3dverse platform.
|
|
1151
|
+
*/
|
|
912
1152
|
last_edited_by?: GetAssetDetails_LastEditedBy;
|
|
913
1153
|
name: string;
|
|
914
|
-
type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1154
|
+
type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
915
1155
|
};
|
|
916
1156
|
export type GetAssetDetails_Contributor = {
|
|
917
1157
|
contribution_count: number;
|
|
1158
|
+
/** This object represents a user in a 3dverse project.
|
|
1159
|
+
This object contains group and task information about the user.
|
|
1160
|
+
The user object lets you create or update user tokens that identify the useron the 3dverse platform.
|
|
1161
|
+
*/
|
|
918
1162
|
user: GetAssetDetails_Object;
|
|
919
1163
|
};
|
|
920
1164
|
export type GetAssetDetails_Object = {
|
|
1165
|
+
/** The user registration date */
|
|
921
1166
|
registered_at: string;
|
|
1167
|
+
/** User unique identifier */
|
|
922
1168
|
user_id: string;
|
|
1169
|
+
/** The username that will be displayed in monitoring tools. */
|
|
923
1170
|
username: string;
|
|
924
1171
|
};
|
|
925
1172
|
export type GetAssetDetails_LastEditedBy = {
|
|
1173
|
+
/** The user registration date */
|
|
926
1174
|
registered_at: string;
|
|
1175
|
+
/** User unique identifier */
|
|
927
1176
|
user_id: string;
|
|
1177
|
+
/** The username that will be displayed in monitoring tools. */
|
|
928
1178
|
username: string;
|
|
929
1179
|
};
|
|
930
1180
|
/**
|
|
931
1181
|
* Gets the asset details from the specified asset.
|
|
932
1182
|
*/
|
|
933
1183
|
export declare function getAssetDetails({ asset_container, asset_id, }: {
|
|
934
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1184
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
935
1185
|
asset_id: string;
|
|
936
1186
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetDetails__index_AssetDetails_AssetDetails>;
|
|
937
1187
|
export type GetAssetFolder_Folder = {
|
|
1188
|
+
/** Folder unique identifier */
|
|
938
1189
|
folder_id: string;
|
|
1190
|
+
/** Folder unique identifier */
|
|
939
1191
|
parent_folder_id?: string;
|
|
1192
|
+
/** Folder name */
|
|
940
1193
|
name: string;
|
|
941
1194
|
created_at?: string;
|
|
942
1195
|
created_by?: GetAssetFolder_Object;
|
|
@@ -945,49 +1198,67 @@ export type GetAssetFolder_Folder = {
|
|
|
945
1198
|
asset_count?: number;
|
|
946
1199
|
};
|
|
947
1200
|
export type GetAssetFolder_Object = {
|
|
1201
|
+
/** User unique identifier */
|
|
948
1202
|
user_id: string;
|
|
1203
|
+
/** Used only for debug purposes */
|
|
949
1204
|
username: string;
|
|
1205
|
+
/** The user registration date */
|
|
950
1206
|
registered_at: string;
|
|
951
1207
|
};
|
|
952
1208
|
/**
|
|
953
1209
|
* Gets the asset folder from the specified asset.
|
|
954
1210
|
*/
|
|
955
1211
|
export declare function getAssetFolder({ asset_container, asset_id, }: {
|
|
956
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1212
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
957
1213
|
asset_id: string;
|
|
958
1214
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetAssetFolder_Folder>;
|
|
959
1215
|
export type GetAssetDependencies_Filter = {
|
|
960
|
-
|
|
961
|
-
|
|
1216
|
+
/** Filter dependencies by types */
|
|
1217
|
+
with_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1218
|
+
/** Exclude dependencies by types */
|
|
1219
|
+
without_asset_types?: Array<'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material'>;
|
|
1220
|
+
/** Filter assets by public status */
|
|
962
1221
|
public?: 'include' | 'exclude' | 'restrict-to';
|
|
963
1222
|
};
|
|
964
1223
|
export type GetAssetDependencies_Asset = {
|
|
1224
|
+
/** Asset unique identifier */
|
|
965
1225
|
asset_id: string;
|
|
966
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1226
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1227
|
+
/** Additional properties of the asset */
|
|
967
1228
|
properties?: GetAssetDependencies_Object;
|
|
968
1229
|
};
|
|
969
1230
|
export type GetAssetDependencies_Object = {
|
|
970
1231
|
name?: string;
|
|
1232
|
+
/** Number of time that the dependency is needed as direct dependency */
|
|
971
1233
|
direct_count?: number;
|
|
1234
|
+
/** Number of time that the dependency is needed as indirect dependency */
|
|
972
1235
|
indirect_count?: number;
|
|
1236
|
+
/** Whether the asset is public */
|
|
973
1237
|
is_public?: boolean;
|
|
1238
|
+
/** Whether the asset is accessible to the user */
|
|
974
1239
|
is_accessible?: boolean;
|
|
1240
|
+
/** Information about the asset payload */
|
|
975
1241
|
payload_info?: GetAssetDependencies_PayloadInfo;
|
|
1242
|
+
/** Direct dependencies of the asset */
|
|
976
1243
|
dependencies?: Array<GetAssetDependencies_Dependency>;
|
|
977
1244
|
};
|
|
978
1245
|
export type GetAssetDependencies_PayloadInfo = {
|
|
1246
|
+
/** Hash of the asset payload if it exists */
|
|
979
1247
|
hash?: string;
|
|
1248
|
+
/** Storage id of the asset payload */
|
|
980
1249
|
storage_id?: number;
|
|
981
1250
|
};
|
|
982
1251
|
export type GetAssetDependencies_Dependency = {
|
|
1252
|
+
/** Asset unique identifier */
|
|
983
1253
|
asset_id: string;
|
|
1254
|
+
/** Number of time that the dependency is needed */
|
|
984
1255
|
count: number;
|
|
985
1256
|
};
|
|
986
1257
|
/**
|
|
987
1258
|
* Gets the asset dependencies from the specified asset.
|
|
988
1259
|
*/
|
|
989
1260
|
export declare function getAssetDependencies({ asset_container, asset_id, offset, limit, depth, filters, properties, }: {
|
|
990
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1261
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
991
1262
|
asset_id: string;
|
|
992
1263
|
offset?: number;
|
|
993
1264
|
limit?: number;
|
|
@@ -996,20 +1267,24 @@ export declare function getAssetDependencies({ asset_container, asset_id, offset
|
|
|
996
1267
|
properties?: Array<'name' | 'dependencies' | 'count' | 'public' | 'accessible' | 'payload_info'>;
|
|
997
1268
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetDependencies_Asset>>;
|
|
998
1269
|
export type GetAssetReferences_Asset = {
|
|
1270
|
+
/** Asset unique identifier */
|
|
999
1271
|
asset_id: string;
|
|
1000
|
-
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1272
|
+
asset_type: 'action_map' | 'animation' | 'animation_graph' | 'animation_sequence' | 'animation_set' | 'collision_geometry' | 'cubemap' | 'event_map' | 'material' | 'mesh' | 'module' | 'point_cloud' | 'render_graph' | 'scene' | 'script' | 'shader' | 'shader_context' | 'skeleton' | 'sound' | 'texture' | 'texture_1d' | 'texture_3d' | 'volume_material';
|
|
1273
|
+
/** Additional properties of the asset */
|
|
1001
1274
|
properties?: GetAssetReferences_Object;
|
|
1002
1275
|
};
|
|
1003
1276
|
export type GetAssetReferences_Object = {
|
|
1004
1277
|
name?: string;
|
|
1278
|
+
/** Number of time that the dependency is needed as direct dependency */
|
|
1005
1279
|
direct_count?: number;
|
|
1280
|
+
/** Whether the asset is public */
|
|
1006
1281
|
is_public?: boolean;
|
|
1007
1282
|
};
|
|
1008
1283
|
/**
|
|
1009
1284
|
* Gets the asset references from the specified asset.
|
|
1010
1285
|
*/
|
|
1011
1286
|
export declare function getAssetReferences({ asset_container, asset_id, offset, limit, properties, }: {
|
|
1012
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1287
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1013
1288
|
asset_id: string;
|
|
1014
1289
|
offset?: number;
|
|
1015
1290
|
limit?: number;
|
|
@@ -1017,284 +1292,599 @@ export declare function getAssetReferences({ asset_container, asset_id, offset,
|
|
|
1017
1292
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetAssetReferences_Asset>>;
|
|
1018
1293
|
export type GetAssetDescription_ActionMap = {
|
|
1019
1294
|
actions: GetAssetDescription_Object;
|
|
1295
|
+
/** Name of the asset */
|
|
1020
1296
|
name: string;
|
|
1297
|
+
/** Unique identifier for the asset */
|
|
1021
1298
|
uuid: string;
|
|
1022
1299
|
};
|
|
1023
1300
|
export type GetAssetDescription_Object = {
|
|
1024
1301
|
[action_name: string]: object;
|
|
1025
1302
|
};
|
|
1026
1303
|
export type GetAssetDescription_Animation = {
|
|
1304
|
+
/** A track that represents events triggered by the animation */
|
|
1027
1305
|
animationEventTrack: GetAssetDescription_Object;
|
|
1306
|
+
/** Duration of the animation in ms */
|
|
1028
1307
|
durationInMs: number;
|
|
1308
|
+
/** Name of the asset */
|
|
1029
1309
|
name: string;
|
|
1310
|
+
/** Payload size of all channels */
|
|
1030
1311
|
payloadSize: number;
|
|
1312
|
+
/** A reference to the skeleton used by this animation */
|
|
1031
1313
|
skeletonRef?: string;
|
|
1314
|
+
/** Unique identifier for the asset */
|
|
1032
1315
|
uuid: string;
|
|
1033
1316
|
};
|
|
1034
1317
|
export type GetAssetDescription_AnimationGraph = {
|
|
1318
|
+
/** Inputs used by the graph */
|
|
1035
1319
|
inputDescriptor: Array<object>;
|
|
1320
|
+
/** Name of the asset */
|
|
1036
1321
|
name: string;
|
|
1322
|
+
/** Animation state machines */
|
|
1037
1323
|
stateMachines: Array<GetAssetDescription_Object>;
|
|
1324
|
+
/** Unique identifier for the asset */
|
|
1038
1325
|
uuid: string;
|
|
1039
1326
|
};
|
|
1040
1327
|
export type GetAssetDescription_AnimationSequence = {
|
|
1328
|
+
/** Duration of the animation in milliseconds */
|
|
1041
1329
|
durationInMs: number;
|
|
1330
|
+
/** Name of the asset */
|
|
1042
1331
|
name: string;
|
|
1332
|
+
/** Unique identifier for the asset */
|
|
1043
1333
|
uuid: string;
|
|
1044
1334
|
};
|
|
1045
1335
|
export type GetAssetDescription_AnimationSet = {
|
|
1336
|
+
/** Parent animation graph */
|
|
1046
1337
|
animationGraphUUID: string;
|
|
1338
|
+
/** The animation set */
|
|
1047
1339
|
animationSet: Array<GetAssetDescription_Object>;
|
|
1340
|
+
/** The bone mask set */
|
|
1048
1341
|
boneMaskSet?: Array<GetAssetDescription_Object>;
|
|
1342
|
+
/** Name of the asset */
|
|
1049
1343
|
name: string;
|
|
1344
|
+
/** Unique identifier for the asset */
|
|
1050
1345
|
uuid: string;
|
|
1051
1346
|
};
|
|
1052
1347
|
export type GetAssetDescription_CollisionGeometry = {
|
|
1053
1348
|
geometryType: StrictUnion<0 | 1>;
|
|
1349
|
+
/** Name of the asset */
|
|
1054
1350
|
name: string;
|
|
1351
|
+
/** Total size in byte of this mesh's payload. This has to be equal to the sum of each submesh payload size */
|
|
1055
1352
|
payloadSize: number;
|
|
1353
|
+
/** Unique identifier for the asset */
|
|
1056
1354
|
uuid: string;
|
|
1057
1355
|
};
|
|
1058
1356
|
export type GetAssetDescription_Cubemap = {
|
|
1357
|
+
/** The 6 images forming the cube faces */
|
|
1059
1358
|
faces: Array<string>;
|
|
1359
|
+
/** Name of the asset */
|
|
1060
1360
|
name: string;
|
|
1361
|
+
/** Unique identifier for the asset */
|
|
1061
1362
|
uuid: string;
|
|
1062
1363
|
};
|
|
1063
1364
|
export type GetAssetDescription_EventMap = {
|
|
1365
|
+
/** A map of events and their parameters descriptors */
|
|
1064
1366
|
events: GetAssetDescription_Object;
|
|
1367
|
+
/** Name of the asset */
|
|
1065
1368
|
name: string;
|
|
1369
|
+
/** Unique identifier for the asset */
|
|
1066
1370
|
uuid: string;
|
|
1067
1371
|
};
|
|
1068
1372
|
export type GetAssetDescription_Material = {
|
|
1373
|
+
/** Data object following the descriptor of the attached shader */
|
|
1069
1374
|
dataJson: object;
|
|
1375
|
+
/** Whether the faces of the geometry are rendered from both sides or not */
|
|
1070
1376
|
isDoubleSided: boolean;
|
|
1377
|
+
/** Name of the asset */
|
|
1071
1378
|
name: string;
|
|
1379
|
+
/** The implemented shader */
|
|
1072
1380
|
shaderRef: string;
|
|
1381
|
+
/** Unique identifier for the asset */
|
|
1073
1382
|
uuid: string;
|
|
1074
1383
|
};
|
|
1075
1384
|
export type GetAssetDescription_Mesh = {
|
|
1385
|
+
/** Morph targets which contain the deltas from the source submesh */
|
|
1076
1386
|
morphTargets?: Array<GetAssetDescription_MorphTargets>;
|
|
1387
|
+
/** Name of the asset */
|
|
1077
1388
|
name: string;
|
|
1389
|
+
/** Total size in byte of this mesh's payload. This has to be equal to the sum of each submesh payload size */
|
|
1078
1390
|
payloadSize: number;
|
|
1391
|
+
/** A mesh is composed of one or more submeshes */
|
|
1079
1392
|
submeshes: Array<GetAssetDescription_Submesh>;
|
|
1393
|
+
/** Unique identifier for the asset */
|
|
1080
1394
|
uuid: string;
|
|
1081
1395
|
};
|
|
1082
1396
|
export type GetAssetDescription_MorphTargets = {
|
|
1397
|
+
/** Batches of morph targets which share the same index channel */
|
|
1083
1398
|
batches: Array<GetAssetDescription_MorphTargetBatchDescription>;
|
|
1399
|
+
/** Channels that make up the morph targets */
|
|
1084
1400
|
channels: Array<GetAssetDescription_Channel>;
|
|
1085
1401
|
};
|
|
1086
1402
|
export type GetAssetDescription_MorphTargetBatchDescription = {
|
|
1403
|
+
/** Index of the index channel in the channels array */
|
|
1087
1404
|
indexChannelIndex: number;
|
|
1405
|
+
/** Morph targets in the batch */
|
|
1088
1406
|
morphTargets: GetAssetDescription_Object;
|
|
1089
1407
|
};
|
|
1090
1408
|
export type GetAssetDescription_Channel = {
|
|
1409
|
+
/** Offset in bytes from the beginning of the associated buffer where the first element of the first attribute can be found */
|
|
1091
1410
|
dataOffset: number;
|
|
1411
|
+
/** Size of this channel in bytes */
|
|
1092
1412
|
dataSize: number;
|
|
1413
|
+
/** Number of elements that make one attribute. 2 for vec2, 3 for vec3, 16 for mat4, etc. */
|
|
1093
1414
|
elementCount: number;
|
|
1415
|
+
/** Size in bytes of a single element (1, 2, 4, 8) for integers, (4, 8) for floats */
|
|
1094
1416
|
elementSize: number;
|
|
1417
|
+
/** Can be either (signed/unsigned) integer or float */
|
|
1095
1418
|
elementType: StrictUnion<0 | 1 | 2> & number;
|
|
1419
|
+
/** Semantic of the attribute */
|
|
1096
1420
|
semantic: StrictUnion<'index' | 'position' | 'normal' | 'uv' | 'color' | 'bone_id' | 'weight'>;
|
|
1097
1421
|
};
|
|
1098
1422
|
export type GetAssetDescription_Submesh = {
|
|
1423
|
+
/** The axis aligned bounding box that encompasses all the vertices of the submesh */
|
|
1099
1424
|
aabb: GetAssetDescription_BoundingBox;
|
|
1425
|
+
/** Description of the channels in the payload blob */
|
|
1100
1426
|
channels: Array<GetAssetDescription_Channel>;
|
|
1427
|
+
/** Total number of indices, a vertex can be referenced multiple times using its index. Note that this number has to be divisible by 3 as we only deal with triangles. Also, note that if this mesh doesn't use indices, the count will be 0. */
|
|
1101
1428
|
indexCount: number;
|
|
1429
|
+
/** Index of morph targets associated with this submesh */
|
|
1102
1430
|
morphTargetsIndex?: number;
|
|
1431
|
+
/** Total number of vertices. Can't exceed UINT32_MAX because indices are restricted to a uint32 */
|
|
1103
1432
|
vertexCount: number;
|
|
1104
1433
|
};
|
|
1105
1434
|
export type GetAssetDescription_BoundingBox = {
|
|
1435
|
+
/** Maximum point of the box */
|
|
1106
1436
|
max: Array<number>;
|
|
1437
|
+
/** Minimum point of the box */
|
|
1107
1438
|
min: Array<number>;
|
|
1108
1439
|
};
|
|
1109
1440
|
export type GetAssetDescription_Module = {
|
|
1110
1441
|
functions: GetAssetDescription_Object;
|
|
1442
|
+
/** Name of the asset */
|
|
1111
1443
|
name: string;
|
|
1444
|
+
/** Unique identifier for the asset */
|
|
1112
1445
|
uuid: string;
|
|
1113
1446
|
};
|
|
1114
1447
|
export type GetAssetDescription_PointCloud = {
|
|
1115
|
-
|
|
1448
|
+
/** Axis aligned bounding box of the entire point cloud */
|
|
1449
|
+
bounds: GetAssetDescription_Aabb;
|
|
1450
|
+
/** Description of the per-point attributes (position, color, etc.) */
|
|
1451
|
+
channels: Array<GetAssetDescription_Channel>;
|
|
1452
|
+
/** Size in bytes of each layer. A layer is a collection of nodes serialized into a single file. */
|
|
1453
|
+
layerSizes: Array<number>;
|
|
1454
|
+
/** Name of the asset */
|
|
1116
1455
|
name: string;
|
|
1456
|
+
/** Number of nodes in the acceleration structure. */
|
|
1457
|
+
nodeCount: number;
|
|
1458
|
+
/** Number of points in the original point cloud before any spatial partitioning or filtering was applied */
|
|
1459
|
+
originalPointCount: number;
|
|
1460
|
+
/** Page size in bytes used for sparse buffer alignment. Each node occupies a multiple of this size per attribute */
|
|
1461
|
+
pageSize: number;
|
|
1462
|
+
/** Total size in bytes of all attribute layer files. Sum of sizeof(payload.pointCloud.layer<N>-<attribute>.<uuid>) for all layers and attributes */
|
|
1117
1463
|
payloadTotalSize: number;
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1464
|
+
/** Size in bytes of the acceleration structure at bake time. */
|
|
1465
|
+
pcasSize: number;
|
|
1466
|
+
/** Total number of points across all nodes in the tree, including intermediary nodes. Greater than or equal to originalPointCount */
|
|
1467
|
+
totalPointCount: number;
|
|
1468
|
+
/** Unique identifier for the asset */
|
|
1121
1469
|
uuid: string;
|
|
1122
1470
|
};
|
|
1471
|
+
export type GetAssetDescription_Aabb = {
|
|
1472
|
+
/** Maximum point of the box */
|
|
1473
|
+
max: Array<number>;
|
|
1474
|
+
/** Minimum point of the box */
|
|
1475
|
+
min: Array<number>;
|
|
1476
|
+
};
|
|
1123
1477
|
export type GetAssetDescription_RenderGraph = {
|
|
1478
|
+
/** All blend states */
|
|
1124
1479
|
blendStateDescriptions?: Array<GetAssetDescription_Object>;
|
|
1480
|
+
/** Descriptions of all buffers */
|
|
1481
|
+
bufferDescriptions?: Array<GetAssetDescription_Object>;
|
|
1482
|
+
/** Conditions referenced by conditionIndex */
|
|
1125
1483
|
conditions?: Array<string>;
|
|
1484
|
+
/** The index of the render target to blit into the canvas */
|
|
1126
1485
|
defaultRenderTargetIndex?: number;
|
|
1486
|
+
/** The order in which to interpret the nodes */
|
|
1127
1487
|
graphOrder: Array<Array<number>>;
|
|
1488
|
+
/** Input descriptor used to parse input data */
|
|
1128
1489
|
inputDescriptor: Array<GetAssetDescription_Object>;
|
|
1490
|
+
/** Name of the asset */
|
|
1129
1491
|
name: string;
|
|
1130
|
-
|
|
1492
|
+
/** Descriptions of all nodes */
|
|
1493
|
+
nodeDataDescriptions: Array<StrictUnion<GetAssetDescription_Viewport | GetAssetDescription_DrawBatch | GetAssetDescription_DrawBatchWithMaterials | GetAssetDescription_DispatchCompute | GetAssetDescription_BlitImage | GetAssetDescription_DispatchPointClouds | GetAssetDescription_CopyImage | GetAssetDescription_ResolveImage | GetAssetDescription_DrawFullscreen | GetAssetDescription_GenerateMipChain | GetAssetDescription_CopyToCubemapFace | GetAssetDescription_ClearImages | GetAssetDescription_FillBuffer | GetAssetDescription_DrawDebugLines | GetAssetDescription_DispatchDecals | GetAssetDescription_SetDepthBias | GetAssetDescription_DispatchRayTracing> & GetAssetDescription_Object>;
|
|
1494
|
+
/** The index of the render target used for occlusion */
|
|
1131
1495
|
occlusionInputDepthRenderTargetIndex?: number;
|
|
1496
|
+
/** Descriptions of all render passes */
|
|
1132
1497
|
renderPassDescriptions: Array<GetAssetDescription_Object>;
|
|
1498
|
+
/** Descriptions of all render targets */
|
|
1133
1499
|
renderTargetDescriptions: Array<GetAssetDescription_Object>;
|
|
1500
|
+
/** Data descriptors for the shader contexts referenced by shaderContextIndex */
|
|
1501
|
+
shaderContexts?: Array<Array<GetAssetDescription_ParameterDescriptor>>;
|
|
1502
|
+
/** All stencil states */
|
|
1134
1503
|
stencilOpStateDescriptions?: Array<GetAssetDescription_Object>;
|
|
1504
|
+
/** Unique identifier for the asset */
|
|
1135
1505
|
uuid: string;
|
|
1136
1506
|
};
|
|
1137
1507
|
export type GetAssetDescription_Viewport = {
|
|
1138
1508
|
type?: 0;
|
|
1139
1509
|
};
|
|
1140
1510
|
export type GetAssetDescription_DrawBatch = {
|
|
1511
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1141
1512
|
batchType?: number;
|
|
1513
|
+
/** Specialization constants values for the specified shader */
|
|
1514
|
+
constantsJson?: object;
|
|
1515
|
+
/** Data provided to the shader through the node data buffer */
|
|
1142
1516
|
dataJson?: object;
|
|
1517
|
+
/** Description of a shader pipeline */
|
|
1143
1518
|
pipelineDescription?: GetAssetDescription_Object;
|
|
1519
|
+
/** Unique identifier for the asset */
|
|
1144
1520
|
shaderRef?: string;
|
|
1145
1521
|
type?: 1;
|
|
1146
1522
|
};
|
|
1147
1523
|
export type GetAssetDescription_DrawBatchWithMaterials = {
|
|
1524
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1148
1525
|
batchType?: number;
|
|
1526
|
+
/** Data provided to the shader through the node data buffer */
|
|
1149
1527
|
dataJson?: object;
|
|
1528
|
+
/** Description of a shader pipeline */
|
|
1150
1529
|
pipelineDescription?: GetAssetDescription_Object;
|
|
1530
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
1531
|
+
shaderContextIndex: number;
|
|
1151
1532
|
type?: 2;
|
|
1152
1533
|
};
|
|
1153
1534
|
export type GetAssetDescription_DispatchCompute = {
|
|
1535
|
+
/** @deprecated Const data type */
|
|
1154
1536
|
constDataType?: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24> & number;
|
|
1537
|
+
/** Specialization constants values for the specified shader */
|
|
1538
|
+
constantsJson?: object;
|
|
1539
|
+
/** Data provided to the shader through the node data buffer */
|
|
1155
1540
|
dataJson?: object;
|
|
1541
|
+
/** Unique identifier for the asset */
|
|
1156
1542
|
shaderRef?: string;
|
|
1157
1543
|
type?: 3;
|
|
1158
1544
|
};
|
|
1159
1545
|
export type GetAssetDescription_BlitImage = {
|
|
1546
|
+
/** Source render target */
|
|
1160
1547
|
inputRenderTargetIndices?: Array<number>;
|
|
1548
|
+
/** Destination render target */
|
|
1161
1549
|
outputRenderTargetIndices?: Array<number>;
|
|
1162
1550
|
type?: 4;
|
|
1163
1551
|
};
|
|
1552
|
+
export type GetAssetDescription_DispatchPointClouds = {
|
|
1553
|
+
/** Specialization constants values for the specified shader */
|
|
1554
|
+
constantsJson?: object;
|
|
1555
|
+
/** Data provided to the shader through the node data buffer */
|
|
1556
|
+
dataJson?: object;
|
|
1557
|
+
/** Unique identifier for the asset */
|
|
1558
|
+
shaderRef?: string;
|
|
1559
|
+
type?: 5;
|
|
1560
|
+
};
|
|
1164
1561
|
export type GetAssetDescription_CopyImage = {
|
|
1562
|
+
/** Source render target */
|
|
1165
1563
|
inputRenderTargetIndices?: Array<number>;
|
|
1564
|
+
/** Destination render target */
|
|
1166
1565
|
outputRenderTargetIndices?: Array<number>;
|
|
1167
1566
|
type?: 6;
|
|
1168
1567
|
};
|
|
1169
1568
|
export type GetAssetDescription_ResolveImage = {
|
|
1569
|
+
/** Source render target */
|
|
1170
1570
|
inputRenderTargetIndices?: Array<number>;
|
|
1571
|
+
/** Destination render target */
|
|
1171
1572
|
outputRenderTargetIndices?: Array<number>;
|
|
1172
1573
|
type?: 7;
|
|
1173
1574
|
};
|
|
1174
1575
|
export type GetAssetDescription_DrawFullscreen = {
|
|
1576
|
+
/** Specialization constants values for the specified shader */
|
|
1577
|
+
constantsJson?: object;
|
|
1578
|
+
/** Data provided to the shader through the node data buffer */
|
|
1175
1579
|
dataJson?: object;
|
|
1580
|
+
/** Description of a shader pipeline */
|
|
1176
1581
|
pipelineDescription?: GetAssetDescription_Object;
|
|
1582
|
+
/** Unique identifier for the asset */
|
|
1177
1583
|
shaderRef?: string;
|
|
1178
1584
|
type?: 8;
|
|
1179
1585
|
};
|
|
1180
1586
|
export type GetAssetDescription_GenerateMipChain = {
|
|
1587
|
+
/** Source render target */
|
|
1181
1588
|
inputRenderTargetIndices?: Array<number>;
|
|
1182
1589
|
type?: 9;
|
|
1183
1590
|
};
|
|
1184
1591
|
export type GetAssetDescription_CopyToCubemapFace = {
|
|
1592
|
+
/** Source render target */
|
|
1185
1593
|
inputRenderTargetIndices?: Array<number>;
|
|
1186
1594
|
type?: 10;
|
|
1187
1595
|
};
|
|
1188
1596
|
export type GetAssetDescription_ClearImages = {
|
|
1597
|
+
/** Clear colors */
|
|
1189
1598
|
clearColors?: Array<Array<number>>;
|
|
1599
|
+
/** Render targets to clear */
|
|
1190
1600
|
outputRenderTargetIndices?: Array<number>;
|
|
1191
1601
|
type?: 13;
|
|
1192
1602
|
};
|
|
1193
1603
|
export type GetAssetDescription_FillBuffer = {
|
|
1604
|
+
/** Name of the buffer */
|
|
1194
1605
|
bufferName?: string;
|
|
1606
|
+
/** Offset in the buffer */
|
|
1195
1607
|
bufferOffset?: number;
|
|
1608
|
+
/** Size of the buffer; 0 for whole size */
|
|
1196
1609
|
bufferSize?: number;
|
|
1610
|
+
/** Value to fill the buffer with */
|
|
1197
1611
|
bufferValue?: number;
|
|
1198
1612
|
type?: 15;
|
|
1199
1613
|
};
|
|
1200
1614
|
export type GetAssetDescription_DrawDebugLines = {
|
|
1615
|
+
/** Specialization constants values for the specified shader */
|
|
1616
|
+
constantsJson?: object;
|
|
1617
|
+
/** Data provided to the shader through the node data buffer */
|
|
1201
1618
|
dataJson?: object;
|
|
1619
|
+
/** Description of a shader pipeline */
|
|
1202
1620
|
pipelineDescription?: GetAssetDescription_Object;
|
|
1621
|
+
/** Unique identifier for the asset */
|
|
1203
1622
|
shaderRef?: string;
|
|
1204
1623
|
type?: 16;
|
|
1205
1624
|
};
|
|
1206
|
-
export type
|
|
1625
|
+
export type GetAssetDescription_DispatchDecals = {
|
|
1626
|
+
/** Data provided to the shader through the node data buffer */
|
|
1207
1627
|
dataJson?: object;
|
|
1628
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
1629
|
+
shaderContextIndex: number;
|
|
1208
1630
|
type?: 17;
|
|
1209
1631
|
};
|
|
1210
1632
|
export type GetAssetDescription_SetDepthBias = {
|
|
1633
|
+
/** Depth bias clamp */
|
|
1211
1634
|
depthBiasClamp?: number;
|
|
1635
|
+
/** Depth bias constant factor */
|
|
1212
1636
|
depthBiasConstantFactor?: number;
|
|
1637
|
+
/** Depth bias slope factor */
|
|
1213
1638
|
depthBiasSlopeFactor?: number;
|
|
1214
1639
|
type?: 18;
|
|
1215
1640
|
};
|
|
1216
1641
|
export type GetAssetDescription_DispatchRayTracing = {
|
|
1642
|
+
/** Specialization constants values for the specified shader */
|
|
1643
|
+
constantsJson?: object;
|
|
1644
|
+
/** Data provided to the shader through the node data buffer */
|
|
1217
1645
|
dataJson?: object;
|
|
1646
|
+
/** Unique identifier for the asset */
|
|
1218
1647
|
shaderRef?: string;
|
|
1219
1648
|
type?: 19;
|
|
1220
1649
|
};
|
|
1650
|
+
export type GetAssetDescription_ParameterDescriptor = {
|
|
1651
|
+
/** Additional properties for a parameter of type "buffer": how many elements it holds, the size of each element, and how the buffer is used. Absent for every other parameter type */
|
|
1652
|
+
bufferProperties?: GetAssetDescription_BufferProperties;
|
|
1653
|
+
/** Categories */
|
|
1654
|
+
categories?: Array<string>;
|
|
1655
|
+
/** Parameter default value */
|
|
1656
|
+
default?: StrictUnion<number | boolean | Array<number>>;
|
|
1657
|
+
/** Whether this parameter (a render target or buffer) is the resource used to compute the number of dispatched workgroups for a compute shader, i.e. DispatchedGroups = referenceResource.size / workgroupSize (see compute_shader_size_reference's reference_resource) */
|
|
1658
|
+
isReferenceResource?: boolean;
|
|
1659
|
+
/** Parameter name */
|
|
1660
|
+
name: string;
|
|
1661
|
+
/** Parameter native type */
|
|
1662
|
+
nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
|
|
1663
|
+
/** Parameter offset in bytes */
|
|
1664
|
+
offset: number;
|
|
1665
|
+
/** Parameter type */
|
|
1666
|
+
type: 'vec4' | 'ivec4' | 'quat' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
|
|
1667
|
+
};
|
|
1668
|
+
export type GetAssetDescription_BufferProperties = {
|
|
1669
|
+
/** Number of elements in the buffer, or a [x, y] pair of factors applied to the viewport width and height (each rounded up and clamped to a minimum of 1, then multiplied) to compute the element count */
|
|
1670
|
+
elementCount: StrictUnion<number | Array<number>>;
|
|
1671
|
+
/** Size in bytes of a single element in the buffer. If the buffer is declared as `T *buffer`, this is sizeof(T) */
|
|
1672
|
+
elementSize: number;
|
|
1673
|
+
/** How this buffer is going to be used */
|
|
1674
|
+
usage: number;
|
|
1675
|
+
};
|
|
1221
1676
|
export type GetAssetDescription_Scene = {
|
|
1677
|
+
/** Bounding box in local space */
|
|
1222
1678
|
aabb: GetAssetDescription_Aabb;
|
|
1679
|
+
/** Flat list of entities */
|
|
1223
1680
|
entities: Array<object>;
|
|
1681
|
+
/** Name of the asset */
|
|
1224
1682
|
name: string;
|
|
1683
|
+
/** Settings in json format */
|
|
1225
1684
|
settings?: object;
|
|
1685
|
+
/** Total number of direct triangles in the scene */
|
|
1226
1686
|
triangleCount?: number;
|
|
1687
|
+
/** Unique identifier for the asset */
|
|
1227
1688
|
uuid: string;
|
|
1228
1689
|
};
|
|
1229
|
-
export type GetAssetDescription_Aabb = {
|
|
1230
|
-
max: Array<number>;
|
|
1231
|
-
min: Array<number>;
|
|
1232
|
-
};
|
|
1233
1690
|
export type GetAssetDescription_Script = {
|
|
1691
|
+
/** The events that the script listens to, referenced by name */
|
|
1234
1692
|
eventNames: Array<string>;
|
|
1693
|
+
/** The description of the data object that the caller should provide to the script */
|
|
1235
1694
|
inputDescriptor?: Array<GetAssetDescription_Object>;
|
|
1695
|
+
/** Name of the asset */
|
|
1236
1696
|
name: string;
|
|
1697
|
+
/** An optional list of references to other scripts that the current script might call */
|
|
1237
1698
|
subScripts?: Array<string>;
|
|
1699
|
+
/** Unique identifier for the asset */
|
|
1238
1700
|
uuid: string;
|
|
1239
1701
|
};
|
|
1240
1702
|
export type GetAssetDescription_Shader = {
|
|
1703
|
+
/** The blend mode for the shader, used for batching purposes. Only valid for material shaders */
|
|
1241
1704
|
blendMode?: StrictUnion<0 | 1 | 2 | 3>;
|
|
1242
|
-
|
|
1243
|
-
|
|
1705
|
+
/** Compute shader settings. Only valid for compute shaders */
|
|
1706
|
+
computeSettings?: GetAssetDescription_ComputeShaderSettings;
|
|
1707
|
+
/** Data descriptor for specialization constants */
|
|
1708
|
+
constantDescriptor?: Array<GetAssetDescription_SpecializationConstantDescriptor>;
|
|
1709
|
+
/** Data descriptor for material shaders */
|
|
1710
|
+
materialDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
|
|
1711
|
+
/** Descriptions of all modules that compose this shader */
|
|
1712
|
+
moduleDescriptions?: Array<GetAssetDescription_ShaderModuleDescription>;
|
|
1713
|
+
/** Name of the asset */
|
|
1244
1714
|
name: string;
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1715
|
+
/** Data descriptor for render graph node shaders */
|
|
1716
|
+
nodeDataDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
|
|
1717
|
+
/** Hash of the node data descriptor, used to detect changes in the descriptor */
|
|
1718
|
+
nodeDataDescriptorHash?: number;
|
|
1719
|
+
/** The size in byte of the compiled shader code (accumulated size of all modules) */
|
|
1720
|
+
payloadSize?: number;
|
|
1721
|
+
/** Vulkan bit mask of all shader stages present in this shader */
|
|
1249
1722
|
shaderStages?: number;
|
|
1723
|
+
/** Unique identifier for the asset */
|
|
1724
|
+
uuid: string;
|
|
1725
|
+
/** Vertex description. Only valid when a vertex shader module is present */
|
|
1726
|
+
vertexDescriptor?: Array<GetAssetDescription_VertexAttributeDescriptor>;
|
|
1727
|
+
};
|
|
1728
|
+
export type GetAssetDescription_ComputeShaderSettings = {
|
|
1729
|
+
/** Global group reference */
|
|
1730
|
+
sizeReference?: StrictUnion<0 | 1 | 2>;
|
|
1731
|
+
/** Size of the workgroup */
|
|
1732
|
+
workgroupSize?: Array<number>;
|
|
1733
|
+
/** Scaling factor to apply to the total workgroup count */
|
|
1734
|
+
workloadScalingFactor?: Array<number>;
|
|
1735
|
+
};
|
|
1736
|
+
export type GetAssetDescription_SpecializationConstantDescriptor = {
|
|
1737
|
+
/** Constant default value */
|
|
1738
|
+
default: StrictUnion<number | boolean>;
|
|
1739
|
+
/** Description */
|
|
1740
|
+
description?: string;
|
|
1741
|
+
/** Display name */
|
|
1742
|
+
displayName?: string;
|
|
1743
|
+
/** Constant name */
|
|
1744
|
+
name: string;
|
|
1745
|
+
/** Constant type */
|
|
1746
|
+
type: 'bool' | 'int' | 'uint' | 'float';
|
|
1747
|
+
};
|
|
1748
|
+
export type GetAssetDescription_ShaderModuleDescription = {
|
|
1749
|
+
/** Names of the bindings used by this module */
|
|
1750
|
+
bindings?: Array<string>;
|
|
1751
|
+
/** Constants used by this module */
|
|
1752
|
+
constants?: GetAssetDescription_Object;
|
|
1753
|
+
/** Entry point of the shader module */
|
|
1754
|
+
entryPoint?: string;
|
|
1755
|
+
/** Outputs of this shader module (e.g. a fragment shader's color attachments, or the last stage's varying outputs), used to validate the module's compatibility with a render pipeline */
|
|
1756
|
+
outputs?: Array<GetAssetDescription_ShaderModuleOutputDescriptor>;
|
|
1757
|
+
/** Offset in byte in the shader payload buffer */
|
|
1758
|
+
payloadOffset: number;
|
|
1759
|
+
/** Size in byte of the compiled module */
|
|
1760
|
+
payloadSize: number;
|
|
1761
|
+
/** Push constant members used by this module, used to validate push constant layout compatibility across the pipeline's stages */
|
|
1762
|
+
pushConstants?: Array<GetAssetDescription_ShaderModulePushConstantDescriptor>;
|
|
1763
|
+
/** The shader stage */
|
|
1764
|
+
shaderStage: number;
|
|
1765
|
+
};
|
|
1766
|
+
export type GetAssetDescription_ShaderModuleOutputDescriptor = {
|
|
1767
|
+
/** Output location */
|
|
1768
|
+
location: number;
|
|
1769
|
+
/** Output variable name */
|
|
1770
|
+
name: string;
|
|
1771
|
+
/** Output variable type */
|
|
1772
|
+
type: 'bool' | 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'pointer';
|
|
1773
|
+
};
|
|
1774
|
+
export type GetAssetDescription_ShaderModulePushConstantDescriptor = {
|
|
1775
|
+
/** Push constant member name */
|
|
1776
|
+
name: string;
|
|
1777
|
+
/** Offset in byte within the push constant block */
|
|
1778
|
+
offset: number;
|
|
1779
|
+
/** Size in byte of the push constant member */
|
|
1780
|
+
size: number;
|
|
1781
|
+
/** Push constant member type */
|
|
1782
|
+
type: 'bool' | 'int8' | 'int16' | 'int32' | 'int64' | 'uint8' | 'uint16' | 'uint32' | 'uint64' | 'float16' | 'float32' | 'float64' | 'vec2' | 'ivec2' | 'vec3' | 'ivec3' | 'vec4' | 'ivec4' | 'pointer';
|
|
1783
|
+
};
|
|
1784
|
+
export type GetAssetDescription_VertexAttributeDescriptor = {
|
|
1785
|
+
/** Binding number */
|
|
1786
|
+
binding: number;
|
|
1787
|
+
/** Format */
|
|
1788
|
+
format: number;
|
|
1789
|
+
/** Location */
|
|
1790
|
+
location: number;
|
|
1791
|
+
/** Offset */
|
|
1792
|
+
offset: number;
|
|
1793
|
+
/** Semantic */
|
|
1794
|
+
semantic: StrictUnion<1 | 2 | 4 | 8 | 16 | 32> & number;
|
|
1795
|
+
/** Stride between consecutive elements within the buffer */
|
|
1796
|
+
stride: number;
|
|
1797
|
+
};
|
|
1798
|
+
export type GetAssetDescription_ShaderContext = {
|
|
1799
|
+
/** Data descriptor for this shader context */
|
|
1800
|
+
dataDescriptor?: Array<GetAssetDescription_ParameterDescriptor>;
|
|
1801
|
+
/** Name of the asset */
|
|
1802
|
+
name: string;
|
|
1803
|
+
/** Unique identifier for the asset */
|
|
1250
1804
|
uuid: string;
|
|
1251
1805
|
};
|
|
1252
1806
|
export type GetAssetDescription_Skeleton = {
|
|
1807
|
+
/** Descriptions of all bones forming the skeleton */
|
|
1253
1808
|
bones: Array<GetAssetDescription_Object>;
|
|
1809
|
+
/** Name of the asset */
|
|
1254
1810
|
name: string;
|
|
1811
|
+
/** The size in byte of skeleton data */
|
|
1255
1812
|
payloadSize: number;
|
|
1813
|
+
/** Unique identifier for the asset */
|
|
1256
1814
|
uuid: string;
|
|
1257
1815
|
};
|
|
1258
1816
|
export type GetAssetDescription_Sound = {
|
|
1817
|
+
/** The bit depth of the audio data */
|
|
1259
1818
|
bitDepth: number;
|
|
1819
|
+
/** The of audio channels (1 = mono, 2 = stereo, etc.) */
|
|
1260
1820
|
channelCount: number;
|
|
1821
|
+
/** Duration of the track in milliseconds */
|
|
1261
1822
|
durationInMs: number;
|
|
1823
|
+
/** Name of the asset */
|
|
1262
1824
|
name: string;
|
|
1825
|
+
/** The size in byte of the sound data */
|
|
1263
1826
|
payloadSize: number;
|
|
1827
|
+
/** Total number of samples composing the audio track */
|
|
1264
1828
|
sampleCount: number;
|
|
1829
|
+
/** Frequency in Hertz */
|
|
1265
1830
|
sampleFrequencyInHz: number;
|
|
1831
|
+
/** Unique identifier for the asset */
|
|
1266
1832
|
uuid: string;
|
|
1267
1833
|
};
|
|
1268
1834
|
export type GetAssetDescription_Texture = {
|
|
1835
|
+
/** The format of the texture */
|
|
1269
1836
|
format: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14> & number;
|
|
1837
|
+
/** Mip-maps */
|
|
1270
1838
|
mips: Array<GetAssetDescription_Object>;
|
|
1839
|
+
/** Name of the asset */
|
|
1271
1840
|
name: string;
|
|
1841
|
+
/** Total size in bytes of all mip-maps */
|
|
1272
1842
|
payloadTotalSize: number;
|
|
1843
|
+
/** Unique identifier for the asset */
|
|
1273
1844
|
uuid: string;
|
|
1274
1845
|
};
|
|
1275
1846
|
export type GetAssetDescription_Texture_1D = {
|
|
1847
|
+
/** The format of the texture */
|
|
1276
1848
|
format: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14> & number;
|
|
1849
|
+
/** Mip-maps */
|
|
1277
1850
|
mips: Array<GetAssetDescription_Object>;
|
|
1851
|
+
/** Name of the asset */
|
|
1278
1852
|
name: string;
|
|
1853
|
+
/** Total size in bytes of all mip-maps */
|
|
1279
1854
|
payloadTotalSize: number;
|
|
1855
|
+
/** Unique identifier for the asset */
|
|
1280
1856
|
uuid: string;
|
|
1281
1857
|
};
|
|
1282
1858
|
export type GetAssetDescription_Texture_3D = {
|
|
1859
|
+
/** The format of the texture */
|
|
1283
1860
|
format: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14> & number;
|
|
1861
|
+
/** Mip-maps */
|
|
1284
1862
|
mips: Array<GetAssetDescription_Object>;
|
|
1863
|
+
/** Name of the asset */
|
|
1285
1864
|
name: string;
|
|
1865
|
+
/** Total size in bytes of all mip-maps */
|
|
1286
1866
|
payloadTotalSize: number;
|
|
1867
|
+
/** Unique identifier for the asset */
|
|
1287
1868
|
uuid: string;
|
|
1869
|
+
/** The voxel dimensions of the texture */
|
|
1288
1870
|
voxelDimensions?: Array<number>;
|
|
1289
1871
|
};
|
|
1290
1872
|
export type GetAssetDescription_VolumeMaterial = {
|
|
1873
|
+
/** The albedo look up table */
|
|
1291
1874
|
albedoLUT?: Array<GetAssetDescription_Object>;
|
|
1875
|
+
/** The metallic look up table */
|
|
1292
1876
|
metallicLUT?: Array<GetAssetDescription_Object>;
|
|
1877
|
+
/** Name of the asset */
|
|
1293
1878
|
name: string;
|
|
1879
|
+
/** The opacity look up table */
|
|
1294
1880
|
opacityLUT?: Array<GetAssetDescription_Object>;
|
|
1881
|
+
/** The maximum voxel value handled by the material */
|
|
1295
1882
|
rangeMax: number;
|
|
1883
|
+
/** The minimum voxel value handled material */
|
|
1296
1884
|
rangeMin: number;
|
|
1885
|
+
/** The roughness look up table */
|
|
1297
1886
|
roughnessLUT?: Array<GetAssetDescription_Object>;
|
|
1887
|
+
/** Unique identifier for the asset */
|
|
1298
1888
|
uuid: string;
|
|
1299
1889
|
};
|
|
1300
1890
|
/**
|
|
@@ -1302,120 +1892,227 @@ export type GetAssetDescription_VolumeMaterial = {
|
|
|
1302
1892
|
*/
|
|
1303
1893
|
export declare function getAssetDescription({ asset_id, asset_container, }: {
|
|
1304
1894
|
asset_id: string;
|
|
1305
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1306
|
-
}, headers?: AxiosRequestHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
|
|
1895
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1896
|
+
}, headers?: AxiosRequestHeaders): AxiosPromise<StrictUnion<GetAssetDescription_ActionMap | GetAssetDescription_Animation | GetAssetDescription_AnimationGraph | GetAssetDescription_AnimationSequence | GetAssetDescription_AnimationSet | GetAssetDescription_CollisionGeometry | GetAssetDescription_Cubemap | GetAssetDescription_EventMap | GetAssetDescription_Material | GetAssetDescription_Mesh | GetAssetDescription_Module | GetAssetDescription_PointCloud | GetAssetDescription_RenderGraph | GetAssetDescription_Scene | GetAssetDescription_Script | GetAssetDescription_Shader | GetAssetDescription_ShaderContext | GetAssetDescription_Skeleton | GetAssetDescription_Sound | GetAssetDescription_Texture | GetAssetDescription_Texture_1D | GetAssetDescription_Texture_3D | GetAssetDescription_VolumeMaterial>>;
|
|
1307
1897
|
export type UpdateAssetDescription_Cubemap = {
|
|
1898
|
+
/** The 6 images forming the cube faces */
|
|
1308
1899
|
faces: Array<string>;
|
|
1900
|
+
/** Name of the asset */
|
|
1309
1901
|
name: string;
|
|
1310
1902
|
};
|
|
1311
1903
|
export type UpdateAssetDescription_Material = {
|
|
1904
|
+
/** Data object following the descriptor of the attached shader */
|
|
1312
1905
|
dataJson: object;
|
|
1906
|
+
/** Whether the faces of the geometry are rendered from both sides or not */
|
|
1313
1907
|
isDoubleSided: boolean;
|
|
1908
|
+
/** Name of the asset */
|
|
1314
1909
|
name: string;
|
|
1910
|
+
/** The implemented shader */
|
|
1315
1911
|
shaderRef: string;
|
|
1316
1912
|
};
|
|
1317
1913
|
export type UpdateAssetDescription_RenderGraph = {
|
|
1914
|
+
/** All blend states */
|
|
1318
1915
|
blendStateDescriptions?: Array<UpdateAssetDescription_Object>;
|
|
1916
|
+
/** Descriptions of all buffers */
|
|
1917
|
+
bufferDescriptions?: Array<UpdateAssetDescription_Object>;
|
|
1918
|
+
/** Conditions referenced by conditionIndex */
|
|
1319
1919
|
conditions?: Array<string>;
|
|
1920
|
+
/** The index of the render target to blit into the canvas */
|
|
1320
1921
|
defaultRenderTargetIndex?: number;
|
|
1922
|
+
/** The order in which to interpret the nodes */
|
|
1321
1923
|
graphOrder: Array<Array<number>>;
|
|
1924
|
+
/** Input descriptor used to parse input data */
|
|
1322
1925
|
inputDescriptor: Array<UpdateAssetDescription_Object>;
|
|
1926
|
+
/** Name of the asset */
|
|
1323
1927
|
name: string;
|
|
1324
|
-
|
|
1928
|
+
/** Descriptions of all nodes */
|
|
1929
|
+
nodeDataDescriptions: Array<StrictUnion<UpdateAssetDescription_Viewport | UpdateAssetDescription_DrawBatch | UpdateAssetDescription_DrawBatchWithMaterials | UpdateAssetDescription_DispatchCompute | UpdateAssetDescription_BlitImage | UpdateAssetDescription_DispatchPointClouds | UpdateAssetDescription_CopyImage | UpdateAssetDescription_ResolveImage | UpdateAssetDescription_DrawFullscreen | UpdateAssetDescription_GenerateMipChain | UpdateAssetDescription_CopyToCubemapFace | UpdateAssetDescription_ClearImages | UpdateAssetDescription_FillBuffer | UpdateAssetDescription_DrawDebugLines | UpdateAssetDescription_DispatchDecals | UpdateAssetDescription_SetDepthBias | UpdateAssetDescription_DispatchRayTracing> & UpdateAssetDescription_Object>;
|
|
1930
|
+
/** The index of the render target used for occlusion */
|
|
1325
1931
|
occlusionInputDepthRenderTargetIndex?: number;
|
|
1932
|
+
/** Descriptions of all render passes */
|
|
1326
1933
|
renderPassDescriptions: Array<UpdateAssetDescription_Object>;
|
|
1934
|
+
/** Descriptions of all render targets */
|
|
1327
1935
|
renderTargetDescriptions: Array<UpdateAssetDescription_Object>;
|
|
1936
|
+
/** Data descriptors for the shader contexts referenced by shaderContextIndex */
|
|
1937
|
+
shaderContexts?: Array<Array<UpdateAssetDescription_ParameterDescriptor>>;
|
|
1938
|
+
/** All stencil states */
|
|
1328
1939
|
stencilOpStateDescriptions?: Array<UpdateAssetDescription_Object>;
|
|
1329
1940
|
};
|
|
1330
1941
|
export type UpdateAssetDescription_Object = {
|
|
1942
|
+
/** Alpha blend operator */
|
|
1331
1943
|
alphaBlendOp?: number;
|
|
1944
|
+
/** Enable blending */
|
|
1332
1945
|
blendEnable?: boolean;
|
|
1946
|
+
/** Color blend operator */
|
|
1333
1947
|
colorBlendOp?: number;
|
|
1948
|
+
/** Color write mask */
|
|
1334
1949
|
colorWriteMask?: number;
|
|
1950
|
+
/** Destination alpha blend factor */
|
|
1335
1951
|
dstAlphaBlendFactor?: number;
|
|
1952
|
+
/** Destination color blend factor */
|
|
1336
1953
|
dstColorBlendFactor?: number;
|
|
1954
|
+
/** Source alpha blend factor */
|
|
1337
1955
|
srcAlphaBlendFactor?: number;
|
|
1956
|
+
/** Source color blend factor */
|
|
1338
1957
|
srcColorBlendFactor?: number;
|
|
1339
1958
|
};
|
|
1340
1959
|
export type UpdateAssetDescription_Viewport = {
|
|
1341
1960
|
type?: 0;
|
|
1342
1961
|
};
|
|
1343
1962
|
export type UpdateAssetDescription_DrawBatch = {
|
|
1963
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1344
1964
|
batchType?: number;
|
|
1965
|
+
/** Specialization constants values for the specified shader */
|
|
1966
|
+
constantsJson?: object;
|
|
1967
|
+
/** Data provided to the shader through the node data buffer */
|
|
1345
1968
|
dataJson?: object;
|
|
1969
|
+
/** Description of a shader pipeline */
|
|
1346
1970
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
1347
1971
|
type?: 1;
|
|
1348
1972
|
};
|
|
1349
1973
|
export type UpdateAssetDescription_DrawBatchWithMaterials = {
|
|
1974
|
+
/** Batch type bitmask (batch_flags). Combinable flags: opaque=1, transparent=2, static_meshes=4, static_textured_meshes=8, all_static_meshes=16, skinned=32, selected=64, do_not_use_material=128, double_sided=256, single_sided=512, pass_occlusion_test=1024, unselected=2048, cast_shadows=4096, invalid_material=8192 */
|
|
1350
1975
|
batchType?: number;
|
|
1976
|
+
/** Data provided to the shader through the node data buffer */
|
|
1351
1977
|
dataJson?: object;
|
|
1978
|
+
/** Description of a shader pipeline */
|
|
1352
1979
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
1980
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
1981
|
+
shaderContextIndex: number;
|
|
1353
1982
|
type?: 2;
|
|
1354
1983
|
};
|
|
1355
1984
|
export type UpdateAssetDescription_DispatchCompute = {
|
|
1985
|
+
/** @deprecated Const data type */
|
|
1356
1986
|
constDataType?: StrictUnion<0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24> & number;
|
|
1987
|
+
/** Specialization constants values for the specified shader */
|
|
1988
|
+
constantsJson?: object;
|
|
1989
|
+
/** Data provided to the shader through the node data buffer */
|
|
1357
1990
|
dataJson?: object;
|
|
1358
1991
|
type?: 3;
|
|
1359
1992
|
};
|
|
1360
1993
|
export type UpdateAssetDescription_BlitImage = {
|
|
1994
|
+
/** Source render target */
|
|
1361
1995
|
inputRenderTargetIndices?: Array<number>;
|
|
1996
|
+
/** Destination render target */
|
|
1362
1997
|
outputRenderTargetIndices?: Array<number>;
|
|
1363
1998
|
type?: 4;
|
|
1364
1999
|
};
|
|
2000
|
+
export type UpdateAssetDescription_DispatchPointClouds = {
|
|
2001
|
+
/** Specialization constants values for the specified shader */
|
|
2002
|
+
constantsJson?: object;
|
|
2003
|
+
/** Data provided to the shader through the node data buffer */
|
|
2004
|
+
dataJson?: object;
|
|
2005
|
+
type?: 5;
|
|
2006
|
+
};
|
|
1365
2007
|
export type UpdateAssetDescription_CopyImage = {
|
|
2008
|
+
/** Source render target */
|
|
1366
2009
|
inputRenderTargetIndices?: Array<number>;
|
|
2010
|
+
/** Destination render target */
|
|
1367
2011
|
outputRenderTargetIndices?: Array<number>;
|
|
1368
2012
|
type?: 6;
|
|
1369
2013
|
};
|
|
1370
2014
|
export type UpdateAssetDescription_ResolveImage = {
|
|
2015
|
+
/** Source render target */
|
|
1371
2016
|
inputRenderTargetIndices?: Array<number>;
|
|
2017
|
+
/** Destination render target */
|
|
1372
2018
|
outputRenderTargetIndices?: Array<number>;
|
|
1373
2019
|
type?: 7;
|
|
1374
2020
|
};
|
|
1375
2021
|
export type UpdateAssetDescription_DrawFullscreen = {
|
|
2022
|
+
/** Specialization constants values for the specified shader */
|
|
2023
|
+
constantsJson?: object;
|
|
2024
|
+
/** Data provided to the shader through the node data buffer */
|
|
1376
2025
|
dataJson?: object;
|
|
2026
|
+
/** Description of a shader pipeline */
|
|
1377
2027
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
1378
2028
|
type?: 8;
|
|
1379
2029
|
};
|
|
1380
2030
|
export type UpdateAssetDescription_GenerateMipChain = {
|
|
2031
|
+
/** Source render target */
|
|
1381
2032
|
inputRenderTargetIndices?: Array<number>;
|
|
1382
2033
|
type?: 9;
|
|
1383
2034
|
};
|
|
1384
2035
|
export type UpdateAssetDescription_CopyToCubemapFace = {
|
|
2036
|
+
/** Source render target */
|
|
1385
2037
|
inputRenderTargetIndices?: Array<number>;
|
|
1386
2038
|
type?: 10;
|
|
1387
2039
|
};
|
|
1388
2040
|
export type UpdateAssetDescription_ClearImages = {
|
|
2041
|
+
/** Clear colors */
|
|
1389
2042
|
clearColors?: Array<Array<number>>;
|
|
2043
|
+
/** Render targets to clear */
|
|
1390
2044
|
outputRenderTargetIndices?: Array<number>;
|
|
1391
2045
|
type?: 13;
|
|
1392
2046
|
};
|
|
1393
2047
|
export type UpdateAssetDescription_FillBuffer = {
|
|
2048
|
+
/** Name of the buffer */
|
|
1394
2049
|
bufferName?: string;
|
|
2050
|
+
/** Offset in the buffer */
|
|
1395
2051
|
bufferOffset?: number;
|
|
2052
|
+
/** Size of the buffer; 0 for whole size */
|
|
1396
2053
|
bufferSize?: number;
|
|
2054
|
+
/** Value to fill the buffer with */
|
|
1397
2055
|
bufferValue?: number;
|
|
1398
2056
|
type?: 15;
|
|
1399
2057
|
};
|
|
1400
2058
|
export type UpdateAssetDescription_DrawDebugLines = {
|
|
2059
|
+
/** Specialization constants values for the specified shader */
|
|
2060
|
+
constantsJson?: object;
|
|
2061
|
+
/** Data provided to the shader through the node data buffer */
|
|
1401
2062
|
dataJson?: object;
|
|
2063
|
+
/** Description of a shader pipeline */
|
|
1402
2064
|
pipelineDescription?: UpdateAssetDescription_Object;
|
|
1403
2065
|
type?: 16;
|
|
1404
2066
|
};
|
|
1405
|
-
export type
|
|
2067
|
+
export type UpdateAssetDescription_DispatchDecals = {
|
|
2068
|
+
/** Data provided to the shader through the node data buffer */
|
|
1406
2069
|
dataJson?: object;
|
|
2070
|
+
/** Index into shaderContexts of the descriptor providing the shader context data for this node */
|
|
2071
|
+
shaderContextIndex: number;
|
|
1407
2072
|
type?: 17;
|
|
1408
2073
|
};
|
|
1409
2074
|
export type UpdateAssetDescription_SetDepthBias = {
|
|
2075
|
+
/** Depth bias clamp */
|
|
1410
2076
|
depthBiasClamp?: number;
|
|
2077
|
+
/** Depth bias constant factor */
|
|
1411
2078
|
depthBiasConstantFactor?: number;
|
|
2079
|
+
/** Depth bias slope factor */
|
|
1412
2080
|
depthBiasSlopeFactor?: number;
|
|
1413
2081
|
type?: 18;
|
|
1414
2082
|
};
|
|
1415
2083
|
export type UpdateAssetDescription_DispatchRayTracing = {
|
|
2084
|
+
/** Specialization constants values for the specified shader */
|
|
2085
|
+
constantsJson?: object;
|
|
2086
|
+
/** Data provided to the shader through the node data buffer */
|
|
1416
2087
|
dataJson?: object;
|
|
1417
2088
|
type?: 19;
|
|
1418
2089
|
};
|
|
2090
|
+
export type UpdateAssetDescription_ParameterDescriptor = {
|
|
2091
|
+
/** Additional properties for a parameter of type "buffer": how many elements it holds, the size of each element, and how the buffer is used. Absent for every other parameter type */
|
|
2092
|
+
bufferProperties?: UpdateAssetDescription_BufferProperties;
|
|
2093
|
+
/** Categories */
|
|
2094
|
+
categories?: Array<string>;
|
|
2095
|
+
/** Parameter default value */
|
|
2096
|
+
default?: StrictUnion<number | boolean | Array<number>>;
|
|
2097
|
+
/** Whether this parameter (a render target or buffer) is the resource used to compute the number of dispatched workgroups for a compute shader, i.e. DispatchedGroups = referenceResource.size / workgroupSize (see compute_shader_size_reference's reference_resource) */
|
|
2098
|
+
isReferenceResource?: boolean;
|
|
2099
|
+
/** Parameter name */
|
|
2100
|
+
name: string;
|
|
2101
|
+
/** Parameter native type */
|
|
2102
|
+
nativeType: 'vec4' | 'vec3' | 'vec2' | 'float' | 'int32_t' | 'texture2d_ref' | 'render_target_index' | 'buffer_reference';
|
|
2103
|
+
/** Parameter offset in bytes */
|
|
2104
|
+
offset: number;
|
|
2105
|
+
/** Parameter type */
|
|
2106
|
+
type: 'vec4' | 'ivec4' | 'quat' | 'vec3' | 'ivec3' | 'color' | 'vec2' | 'ivec2' | 'float' | 'int' | 'uint' | 'bool' | 'texture' | 'render_target_index' | 'buffer';
|
|
2107
|
+
};
|
|
2108
|
+
export type UpdateAssetDescription_BufferProperties = {
|
|
2109
|
+
/** Number of elements in the buffer, or a [x, y] pair of factors applied to the viewport width and height (each rounded up and clamped to a minimum of 1, then multiplied) to compute the element count */
|
|
2110
|
+
elementCount: StrictUnion<number | Array<number>>;
|
|
2111
|
+
/** Size in bytes of a single element in the buffer. If the buffer is declared as `T *buffer`, this is sizeof(T) */
|
|
2112
|
+
elementSize: number;
|
|
2113
|
+
/** How this buffer is going to be used */
|
|
2114
|
+
usage: number;
|
|
2115
|
+
};
|
|
1419
2116
|
/**
|
|
1420
2117
|
* Updates the description of the specified asset.
|
|
1421
2118
|
*/
|
|
@@ -1429,7 +2126,7 @@ export declare function updateAssetDescription({ asset_id, asset_container, asse
|
|
|
1429
2126
|
*/
|
|
1430
2127
|
export declare function renameAsset({ asset_id, asset_container, name, }: {
|
|
1431
2128
|
asset_id: string;
|
|
1432
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2129
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1433
2130
|
name?: string;
|
|
1434
2131
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
1435
2132
|
/**
|
|
@@ -1441,6 +2138,7 @@ export declare function getAssetPayload<T extends 'arraybuffer' | 'stream' | 'js
|
|
|
1441
2138
|
sub_resource?: StrictUnion<string | 'histogram' | 'position' | 'color'>;
|
|
1442
2139
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
1443
2140
|
export type GetAssetGraph_AssetGraph = {
|
|
2141
|
+
/** Unique identifier for the asset graph. */
|
|
1444
2142
|
uuid: string;
|
|
1445
2143
|
[_additionalproperties_: string]: any;
|
|
1446
2144
|
};
|
|
@@ -1463,14 +2161,14 @@ export declare function updateAssetGraph({ asset_container_with_graph, asset_id,
|
|
|
1463
2161
|
* Gets the asset history from the specified asset.
|
|
1464
2162
|
*/
|
|
1465
2163
|
export declare function getAssetHistory({ asset_container, asset_id, }: {
|
|
1466
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2164
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1467
2165
|
asset_id: string;
|
|
1468
2166
|
}, headers?: AxiosRequestHeaders): AxiosPromise<object>;
|
|
1469
2167
|
/**
|
|
1470
2168
|
* Gets the asset metadata from the specified asset.
|
|
1471
2169
|
*/
|
|
1472
2170
|
export declare function getAssetMeta({ asset_container, asset_id, }: {
|
|
1473
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2171
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1474
2172
|
asset_id: string;
|
|
1475
2173
|
}, headers?: AxiosRequestHeaders): AxiosPromise<object>;
|
|
1476
2174
|
/**
|
|
@@ -1484,7 +2182,7 @@ export declare function getAssetCode({ asset_container_with_code, asset_id, }: {
|
|
|
1484
2182
|
* Gets the asset thumbnail from the specified asset.
|
|
1485
2183
|
*/
|
|
1486
2184
|
export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, size, default_url, }: {
|
|
1487
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2185
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1488
2186
|
asset_id: string;
|
|
1489
2187
|
size: 'large' | 'medium' | 'small' | 'tiny';
|
|
1490
2188
|
default_url?: string;
|
|
@@ -1493,7 +2191,7 @@ export declare function getAssetThumbnail<T extends 'arraybuffer' | 'stream' | '
|
|
|
1493
2191
|
* Assigns a thumbnail to the specified asset.
|
|
1494
2192
|
*/
|
|
1495
2193
|
export declare function setAssetThumbnail({ asset_container, asset_id, body, }: {
|
|
1496
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2194
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1497
2195
|
asset_id: string;
|
|
1498
2196
|
body: ArrayBuffer | ReadableStream;
|
|
1499
2197
|
}, contentType: 'image/jpg' | 'image/png', headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
@@ -1508,7 +2206,7 @@ export declare function getAssetCustomTypes({ asset_container_with_custom_types,
|
|
|
1508
2206
|
* Packages and downloads the target asset.
|
|
1509
2207
|
*/
|
|
1510
2208
|
export declare function packageAsset<T extends 'arraybuffer' | 'stream' | 'json' | 'text' = 'arraybuffer'>({ asset_container, asset_id, }: {
|
|
1511
|
-
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
2209
|
+
asset_container: 'action_maps' | 'animations' | 'animation_graphs' | 'animation_sequences' | 'animation_sets' | 'collision_geometries' | 'cubemaps' | 'event_maps' | 'materials' | 'meshes' | 'modules' | 'point_clouds' | 'render_graphs' | 'scenes' | 'scripts' | 'shaders' | 'shader_contexts' | 'skeletons' | 'sounds' | 'textures' | 'textures_1d' | 'textures_3d' | 'volume_materials';
|
|
1512
2210
|
asset_id: string;
|
|
1513
2211
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
1514
2212
|
/**
|
|
@@ -1522,22 +2220,36 @@ export declare function exportAsset<T extends 'arraybuffer' | 'stream' | 'json'
|
|
|
1522
2220
|
sub_mesh_index?: number;
|
|
1523
2221
|
}, headers?: AxiosRequestHeaders, responseType?: T): AxiosPromise<T extends 'arraybuffer' ? ArrayBuffer : T extends 'json' ? object : T extends 'text' ? string : T extends 'stream' ? ReadableStream : never>;
|
|
1524
2222
|
export type GetSceneSessions_Session = {
|
|
2223
|
+
/** Session unique identifier */
|
|
1525
2224
|
session_id: string;
|
|
2225
|
+
/** The main scene identifier of the session */
|
|
1526
2226
|
scene_id: string;
|
|
2227
|
+
/** The main scene name of the session */
|
|
1527
2228
|
scene_name: string;
|
|
2229
|
+
/** The folder identifier of the scene */
|
|
1528
2230
|
folder_id: string;
|
|
2231
|
+
/** Maximum number of users allowed in this session at the same time */
|
|
1529
2232
|
max_users: number;
|
|
2233
|
+
/** User identifier of the creator of the session */
|
|
1530
2234
|
creator_user_id: string;
|
|
2235
|
+
/** Session creation date */
|
|
1531
2236
|
created_at: string;
|
|
2237
|
+
/** Country code of the rendering server location */
|
|
1532
2238
|
country_code: string;
|
|
2239
|
+
/** Continent code of the rendering server location */
|
|
1533
2240
|
continent_code: string;
|
|
2241
|
+
/** Whether the session is transient or not */
|
|
1534
2242
|
is_transient_session: boolean;
|
|
2243
|
+
/** Current clients in session */
|
|
1535
2244
|
clients: Array<GetSceneSessions_Client_UserInfo>;
|
|
1536
2245
|
};
|
|
1537
2246
|
export type GetSceneSessions_Client_UserInfo = {
|
|
2247
|
+
/** Client unique identifier */
|
|
1538
2248
|
client_id?: string;
|
|
1539
2249
|
client_type?: 'user' | 'guest';
|
|
2250
|
+
/** User unique identifier */
|
|
1540
2251
|
user_id: string;
|
|
2252
|
+
/** Used only for debug purposes */
|
|
1541
2253
|
username: string;
|
|
1542
2254
|
};
|
|
1543
2255
|
/**
|
|
@@ -1547,7 +2259,9 @@ export declare function getSceneSessions({ scene_id, }: {
|
|
|
1547
2259
|
scene_id: string;
|
|
1548
2260
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetSceneSessions_Session>>;
|
|
1549
2261
|
export type GetSceneAabb_Object = {
|
|
2262
|
+
/** Vector3 representing the upper (x, y, z) boundary of the box. */
|
|
1550
2263
|
max: Array<number>;
|
|
2264
|
+
/** Vector3 representing the lower (x, y, z) boundary of the box. */
|
|
1551
2265
|
min: Array<number>;
|
|
1552
2266
|
};
|
|
1553
2267
|
/**
|
|
@@ -1560,10 +2274,15 @@ export type CreateEntity_animation_controller = {
|
|
|
1560
2274
|
animation_controller: CreateEntity_AnimationController;
|
|
1561
2275
|
};
|
|
1562
2276
|
export type CreateEntity_AnimationController = {
|
|
2277
|
+
/** Animation Graph reference. */
|
|
1563
2278
|
animationGraphRef: string;
|
|
2279
|
+
/** Animation Set reference. */
|
|
1564
2280
|
animationSetRef: string;
|
|
2281
|
+
/** Input values as described in the referenced animation graph in their original JSON format. */
|
|
1565
2282
|
dataJSON: object;
|
|
2283
|
+
/** Reference to the entity that is the root bone of the skeleton. */
|
|
1566
2284
|
rootBoneEntityRef: CreateEntity_EntityReference;
|
|
2285
|
+
/** Whether or not root motion is enabled. */
|
|
1567
2286
|
rootMotionEnabled: boolean;
|
|
1568
2287
|
};
|
|
1569
2288
|
export type CreateEntity_EntityReference = {
|
|
@@ -1574,330 +2293,458 @@ export type CreateEntity_bone = {
|
|
|
1574
2293
|
bone: CreateEntity_Bone;
|
|
1575
2294
|
};
|
|
1576
2295
|
export type CreateEntity_Bone = {
|
|
2296
|
+
/** Index of bone in skeleton. */
|
|
1577
2297
|
boneIndex: number;
|
|
1578
2298
|
};
|
|
1579
2299
|
export type CreateEntity_box_geometry = {
|
|
1580
2300
|
box_geometry: CreateEntity_BoxGeometry;
|
|
1581
2301
|
};
|
|
1582
2302
|
export type CreateEntity_BoxGeometry = {
|
|
2303
|
+
/** Width, height and depth of the box */
|
|
1583
2304
|
dimension?: Array<number>;
|
|
2305
|
+
/** True for additive, false for subtractive */
|
|
1584
2306
|
isAdditive?: boolean;
|
|
2307
|
+
/** Geometry offset */
|
|
1585
2308
|
offset?: Array<number>;
|
|
1586
2309
|
};
|
|
1587
2310
|
export type CreateEntity_camera = {
|
|
1588
2311
|
camera: CreateEntity_Camera;
|
|
1589
2312
|
};
|
|
1590
2313
|
export type CreateEntity_Camera = {
|
|
2314
|
+
/** Specifies which render graph this camera should use. */
|
|
1591
2315
|
renderGraphRef: string;
|
|
2316
|
+
/** Index of the render target to blit. */
|
|
1592
2317
|
renderTargetIndex?: number;
|
|
2318
|
+
/** Input values as described in the referenced render graph in their original JSON format. */
|
|
1593
2319
|
dataJSON: object;
|
|
1594
2320
|
};
|
|
1595
2321
|
export type CreateEntity_capsule_geometry = {
|
|
1596
2322
|
capsule_geometry: CreateEntity_CapsuleGeometry;
|
|
1597
2323
|
};
|
|
1598
2324
|
export type CreateEntity_CapsuleGeometry = {
|
|
2325
|
+
/** Radius of the spheres at each end of the capsule */
|
|
1599
2326
|
radius?: number;
|
|
2327
|
+
/** Height of the cylindrical part of the capsule */
|
|
1600
2328
|
height?: number;
|
|
2329
|
+
/** Alignment axis, 0 for X, 1 for Y, 2 for Z */
|
|
1601
2330
|
axis?: number;
|
|
2331
|
+
/** True for additive, false for subtractive */
|
|
1602
2332
|
isAdditive?: boolean;
|
|
2333
|
+
/** Geometry offset */
|
|
1603
2334
|
offset?: Array<number>;
|
|
1604
2335
|
};
|
|
1605
2336
|
export type CreateEntity_character_controller = {
|
|
1606
2337
|
character_controller: CreateEntity_CharacterController;
|
|
1607
2338
|
};
|
|
1608
2339
|
export type CreateEntity_CharacterController = {
|
|
2340
|
+
/** Step Offset in meters */
|
|
1609
2341
|
stepOffset?: number;
|
|
2342
|
+
/** Slope Limit in degrees */
|
|
1610
2343
|
slopeLimit?: number;
|
|
2344
|
+
/** The character's collision skin width */
|
|
1611
2345
|
skinWidth?: number;
|
|
2346
|
+
/** Velocity vector for current frame */
|
|
1612
2347
|
velocity?: Array<number>;
|
|
1613
2348
|
};
|
|
1614
2349
|
export type CreateEntity_collision_geometry_ref = {
|
|
1615
2350
|
collision_geometry_ref: CreateEntity_CollisionGeometryRef;
|
|
1616
2351
|
};
|
|
1617
2352
|
export type CreateEntity_CollisionGeometryRef = {
|
|
2353
|
+
/** UUID of the referenced collision_geometry. */
|
|
1618
2354
|
collisionGeometryRef: string;
|
|
1619
2355
|
};
|
|
1620
2356
|
export type CreateEntity_cylinder_geometry = {
|
|
1621
2357
|
cylinder_geometry: CreateEntity_CylinderGeometry;
|
|
1622
2358
|
};
|
|
1623
2359
|
export type CreateEntity_CylinderGeometry = {
|
|
2360
|
+
/** Radius of the cylinder */
|
|
1624
2361
|
radius?: number;
|
|
2362
|
+
/** Height of the cylinder */
|
|
1625
2363
|
height?: number;
|
|
2364
|
+
/** Alignment axis, 0 for X, 1 for Y, 2 for Z */
|
|
1626
2365
|
axis?: number;
|
|
2366
|
+
/** True for additive, false for subtractive */
|
|
1627
2367
|
isAdditive?: boolean;
|
|
2368
|
+
/** Geometry offset */
|
|
1628
2369
|
offset?: Array<number>;
|
|
1629
2370
|
};
|
|
1630
2371
|
export type CreateEntity_debug_name = {
|
|
1631
2372
|
debug_name: CreateEntity_Name;
|
|
1632
2373
|
};
|
|
1633
2374
|
export type CreateEntity_Name = {
|
|
2375
|
+
/** Name of the entity that will be displayed in various debug tools. */
|
|
1634
2376
|
value: string;
|
|
1635
2377
|
};
|
|
1636
2378
|
export type CreateEntity_decal_projector = {
|
|
1637
2379
|
decal_projector: CreateEntity_DecalProjector;
|
|
1638
2380
|
};
|
|
1639
2381
|
export type CreateEntity_DecalProjector = {
|
|
2382
|
+
/** Z-Index order of the decal projection. The higher index will render on top of the lower ones. */
|
|
1640
2383
|
zIndex?: number;
|
|
1641
2384
|
};
|
|
1642
2385
|
export type CreateEntity_environment = {
|
|
1643
2386
|
environment: CreateEntity_Environment;
|
|
1644
2387
|
};
|
|
1645
2388
|
export type CreateEntity_Environment = {
|
|
2389
|
+
/** Reference to the skybox cubemap. */
|
|
1646
2390
|
skyboxUUID: string;
|
|
2391
|
+
/** Reference to the radiance cubemap. */
|
|
1647
2392
|
radianceUUID: string;
|
|
2393
|
+
/** Reference to the irradiance cubemap. */
|
|
1648
2394
|
irradianceUUID: string;
|
|
1649
2395
|
};
|
|
1650
2396
|
export type CreateEntity_joint = {
|
|
1651
2397
|
joint: CreateEntity_Joint;
|
|
1652
2398
|
};
|
|
1653
2399
|
export type CreateEntity_Joint = {
|
|
2400
|
+
/** An entity that is a dynamic physics body. */
|
|
1654
2401
|
constrainee: CreateEntity_EntityReference;
|
|
2402
|
+
/** An entity that is a dynamic or static physics body, or simply null. */
|
|
1655
2403
|
constrainer: CreateEntity_EntityReference;
|
|
2404
|
+
/** The force that needs to be applied for this joint to break. */
|
|
1656
2405
|
breakForce?: number;
|
|
2406
|
+
/** The torque that needs to be applied for this joint to break. */
|
|
1657
2407
|
breakTorque?: number;
|
|
1658
2408
|
};
|
|
1659
2409
|
export type CreateEntity_lineage = {
|
|
1660
2410
|
lineage: CreateEntity_Lineage;
|
|
1661
2411
|
};
|
|
1662
2412
|
export type CreateEntity_Lineage = {
|
|
2413
|
+
/** UUID of the parent of this entity (default is root). */
|
|
1663
2414
|
parentUUID: string;
|
|
2415
|
+
/** Ordinal number of this entity in respect of its siblings. */
|
|
1664
2416
|
ordinal?: number;
|
|
1665
2417
|
};
|
|
1666
2418
|
export type CreateEntity_local_aabb = {
|
|
1667
2419
|
local_aabb: CreateEntity_LocalAxisAlignedBoundingBox;
|
|
1668
2420
|
};
|
|
1669
2421
|
export type CreateEntity_LocalAxisAlignedBoundingBox = {
|
|
2422
|
+
/** Minimum point of the box. */
|
|
1670
2423
|
min: Array<number>;
|
|
2424
|
+
/** Maximum point of the box. */
|
|
1671
2425
|
max: Array<number>;
|
|
1672
2426
|
};
|
|
1673
2427
|
export type CreateEntity_local_transform = {
|
|
1674
2428
|
local_transform: CreateEntity_Transform;
|
|
1675
2429
|
};
|
|
1676
2430
|
export type CreateEntity_Transform = {
|
|
2431
|
+
/** x, y, z position of the entity */
|
|
1677
2432
|
position?: Array<number>;
|
|
2433
|
+
/** Orientation of the entity expressed as a quaternion */
|
|
1678
2434
|
orientation?: Array<number>;
|
|
2435
|
+
/** x, y, z scale of the entity */
|
|
1679
2436
|
scale?: Array<number>;
|
|
2437
|
+
/** Orientation of the entity expressed as euler angles */
|
|
1680
2438
|
eulerOrientation?: Array<number>;
|
|
2439
|
+
/** Last global orientation of the entity expressed as euler angles submitted by a user. This value may not be valid, and should be checked. */
|
|
1681
2440
|
globalEulerOrientation?: Array<number>;
|
|
1682
2441
|
};
|
|
1683
2442
|
export type CreateEntity_material = {
|
|
1684
2443
|
material: CreateEntity_Material;
|
|
1685
2444
|
};
|
|
1686
2445
|
export type CreateEntity_Material = {
|
|
2446
|
+
/** Reference to a shader graph. */
|
|
1687
2447
|
shaderRef: string;
|
|
2448
|
+
/** Transparency mode */
|
|
1688
2449
|
transparencyMode: number;
|
|
2450
|
+
/** Whether the material is double sided or not. */
|
|
1689
2451
|
isDoubleSided: boolean;
|
|
2452
|
+
/** Input values as described in the referenced shader in their original JSON format. */
|
|
1690
2453
|
dataJSON: object;
|
|
1691
2454
|
};
|
|
1692
2455
|
export type CreateEntity_material_ref = {
|
|
1693
2456
|
material_ref: CreateEntity_MaterialReference;
|
|
1694
2457
|
};
|
|
1695
2458
|
export type CreateEntity_MaterialReference = {
|
|
2459
|
+
/** UUID of the referenced material. */
|
|
1696
2460
|
value: string;
|
|
2461
|
+
/** Face culling mode */
|
|
1697
2462
|
faceCulling?: number;
|
|
1698
2463
|
};
|
|
1699
2464
|
export type CreateEntity_mesh_ref = {
|
|
1700
2465
|
mesh_ref: CreateEntity_MeshReference;
|
|
1701
2466
|
};
|
|
1702
2467
|
export type CreateEntity_MeshReference = {
|
|
2468
|
+
/** UUID of the referenced mesh. */
|
|
1703
2469
|
value: string;
|
|
2470
|
+
/** Index of the submesh inside the submesh array. */
|
|
1704
2471
|
submeshIndex?: number;
|
|
1705
2472
|
};
|
|
1706
2473
|
export type CreateEntity_orthographic_lens = {
|
|
1707
2474
|
orthographic_lens: CreateEntity_OrthographicLens;
|
|
1708
2475
|
};
|
|
1709
2476
|
export type CreateEntity_OrthographicLens = {
|
|
2477
|
+
/** Left plane. */
|
|
1710
2478
|
left?: number;
|
|
2479
|
+
/** Right plane. */
|
|
1711
2480
|
right?: number;
|
|
2481
|
+
/** Top plane. */
|
|
1712
2482
|
top?: number;
|
|
2483
|
+
/** Bottom plane. */
|
|
1713
2484
|
bottom?: number;
|
|
2485
|
+
/** Near plane. */
|
|
1714
2486
|
zNear?: number;
|
|
2487
|
+
/** Far plane. */
|
|
1715
2488
|
zFar?: number;
|
|
1716
2489
|
};
|
|
1717
2490
|
export type CreateEntity_overrider = {
|
|
1718
2491
|
overrider: CreateEntity_Overrider;
|
|
1719
2492
|
};
|
|
1720
2493
|
export type CreateEntity_Overrider = {
|
|
2494
|
+
/** Mark the overridden entity as deleted. */
|
|
1721
2495
|
deleter?: boolean;
|
|
2496
|
+
/** Entity to override. */
|
|
1722
2497
|
entityRef: CreateEntity_EntityReference;
|
|
2498
|
+
/** Hashes of the components to detach from the overridden entity. */
|
|
1723
2499
|
componentsToDetach: Array<number>;
|
|
1724
2500
|
};
|
|
1725
2501
|
export type CreateEntity_perspective_lens = {
|
|
1726
2502
|
perspective_lens: CreateEntity_PerspectiveLens;
|
|
1727
2503
|
};
|
|
1728
2504
|
export type CreateEntity_PerspectiveLens = {
|
|
2505
|
+
/** Specifies the aspect ratio of the viewport, usually equals width/height. */
|
|
1729
2506
|
aspectRatio?: number;
|
|
2507
|
+
/** Specifies the field of view angle in the y direction. */
|
|
1730
2508
|
fovy?: number;
|
|
2509
|
+
/** Specifies the distance from the viewer to the near clipping plane. */
|
|
1731
2510
|
nearPlane?: number;
|
|
2511
|
+
/** Specifies the distance from the viewer to the far clipping plane. */
|
|
1732
2512
|
farPlane?: number;
|
|
1733
2513
|
};
|
|
1734
2514
|
export type CreateEntity_physics_material = {
|
|
1735
2515
|
physics_material: CreateEntity_PhysicsMaterial;
|
|
1736
2516
|
};
|
|
1737
2517
|
export type CreateEntity_PhysicsMaterial = {
|
|
2518
|
+
/** The coefficient of static friction */
|
|
1738
2519
|
staticFriction?: number;
|
|
2520
|
+
/** The coefficient of dynamic friction */
|
|
1739
2521
|
dynamicFriction?: number;
|
|
2522
|
+
/** The coefficient of static restitution */
|
|
1740
2523
|
restitution?: number;
|
|
2524
|
+
/** Whether to consider the collision shape associated to this material as a trigger or not */
|
|
1741
2525
|
isTrigger?: boolean;
|
|
1742
2526
|
};
|
|
1743
2527
|
export type CreateEntity_plane_geometry = {
|
|
1744
2528
|
plane_geometry: CreateEntity_PlaneGeometry;
|
|
1745
2529
|
};
|
|
1746
2530
|
export type CreateEntity_PlaneGeometry = {
|
|
2531
|
+
/** Distance from the origin in the plane's normal direction. */
|
|
1747
2532
|
distance?: number;
|
|
2533
|
+
/** Normal of the plane. */
|
|
1748
2534
|
normal?: Array<number>;
|
|
1749
2535
|
};
|
|
1750
2536
|
export type CreateEntity_point_cloud_ref = {
|
|
1751
2537
|
point_cloud_ref: CreateEntity_PointCloudReference;
|
|
1752
2538
|
};
|
|
1753
2539
|
export type CreateEntity_PointCloudReference = {
|
|
2540
|
+
/** UUID of the referenced point cloud. */
|
|
1754
2541
|
value: string;
|
|
1755
2542
|
};
|
|
1756
2543
|
export type CreateEntity_point_light = {
|
|
1757
2544
|
point_light: CreateEntity_Light;
|
|
1758
2545
|
};
|
|
1759
2546
|
export type CreateEntity_Light = {
|
|
2547
|
+
/** Light color */
|
|
1760
2548
|
color?: Array<number>;
|
|
2549
|
+
/** Light intensity. */
|
|
1761
2550
|
intensity?: number;
|
|
2551
|
+
/** The range for the point light. If the range is 0, then physically correct point light attenuation function is used. */
|
|
1762
2552
|
range?: number;
|
|
2553
|
+
/** Make this light directional, position is ignored in this case. */
|
|
1763
2554
|
isDirectional?: boolean;
|
|
2555
|
+
/** Make this light direction control the atmosphere sun direction. If more than one light is marked to be a sun results are undefined. */
|
|
1764
2556
|
isSun?: boolean;
|
|
1765
2557
|
};
|
|
1766
2558
|
export type CreateEntity_reflection_probe = {
|
|
1767
2559
|
reflection_probe: CreateEntity_ReflectionProbe;
|
|
1768
2560
|
};
|
|
1769
2561
|
export type CreateEntity_ReflectionProbe = {
|
|
2562
|
+
/** x, y, z offset of the probe reflection origin. */
|
|
1770
2563
|
offset?: Array<number>;
|
|
2564
|
+
/** Distance to the near plane. */
|
|
1771
2565
|
nearDist?: number;
|
|
2566
|
+
/** Distance to the far plane. */
|
|
1772
2567
|
farDist?: number;
|
|
2568
|
+
/** Resolution of the reflection map. */
|
|
1773
2569
|
quality?: number;
|
|
1774
2570
|
};
|
|
1775
2571
|
export type CreateEntity_revolute_joint = {
|
|
1776
2572
|
revolute_joint: CreateEntity_RevoluteJoint;
|
|
1777
2573
|
};
|
|
1778
2574
|
export type CreateEntity_RevoluteJoint = {
|
|
2575
|
+
/** The direction of the axis around which the constrainee swings. The direction is defined in the constrainee's local space. */
|
|
1779
2576
|
axis?: Array<number>;
|
|
2577
|
+
/** The position of the axis around which the constrainee swings. The position is defined in the constrainee's local space. */
|
|
1780
2578
|
anchor?: Array<number>;
|
|
1781
2579
|
};
|
|
1782
2580
|
export type CreateEntity_rigid_body = {
|
|
1783
2581
|
rigid_body: CreateEntity_RigidBody;
|
|
1784
2582
|
};
|
|
1785
2583
|
export type CreateEntity_RigidBody = {
|
|
2584
|
+
/** Mass */
|
|
1786
2585
|
mass?: number;
|
|
2586
|
+
/** Linear damping */
|
|
1787
2587
|
linearDamping?: number;
|
|
2588
|
+
/** Angular damping */
|
|
1788
2589
|
angularDamping?: number;
|
|
2590
|
+
/** Friction */
|
|
1789
2591
|
friction?: number;
|
|
2592
|
+
/** Rolling friction */
|
|
1790
2593
|
rollingFriction?: number;
|
|
2594
|
+
/** Spinning friction */
|
|
1791
2595
|
spinningFriction?: number;
|
|
2596
|
+
/** Restitution */
|
|
1792
2597
|
restitution?: number;
|
|
2598
|
+
/** Linear sleeping threshold */
|
|
1793
2599
|
linearSleepingThreshold?: number;
|
|
2600
|
+
/** Angular sleeping threshold */
|
|
1794
2601
|
angularSleepingThreshold?: number;
|
|
2602
|
+
/** Whether the rigid body should use kinematic physics or not */
|
|
1795
2603
|
isKinematic?: boolean;
|
|
1796
2604
|
};
|
|
1797
2605
|
export type CreateEntity_scene_ref = {
|
|
1798
2606
|
scene_ref: CreateEntity_SceneReference;
|
|
1799
2607
|
};
|
|
1800
2608
|
export type CreateEntity_SceneReference = {
|
|
2609
|
+
/** Reference to a scene. */
|
|
1801
2610
|
value: string;
|
|
2611
|
+
/** Maximum number of times a scene appears when it references itself. */
|
|
1802
2612
|
maxRecursionCount?: number;
|
|
1803
2613
|
};
|
|
1804
2614
|
export type CreateEntity_script_element = {
|
|
1805
2615
|
script_element: CreateEntity_ScriptElement;
|
|
1806
2616
|
};
|
|
1807
2617
|
export type CreateEntity_ScriptElement = {
|
|
2618
|
+
/** Reference to a script. */
|
|
1808
2619
|
scriptRef: string;
|
|
2620
|
+
/** Input values as described in the referenced script in their original JSON format. */
|
|
1809
2621
|
dataJSON: object;
|
|
1810
2622
|
};
|
|
1811
2623
|
export type CreateEntity_script_map = {
|
|
1812
2624
|
script_map: CreateEntity_ScriptMap;
|
|
1813
2625
|
};
|
|
1814
2626
|
export type CreateEntity_ScriptMap = {
|
|
2627
|
+
/** List of scripts. */
|
|
1815
2628
|
elements: object;
|
|
1816
2629
|
};
|
|
1817
2630
|
export type CreateEntity_shadow_caster = {
|
|
1818
2631
|
shadow_caster: CreateEntity_ShadowCaster;
|
|
1819
2632
|
};
|
|
1820
2633
|
export type CreateEntity_ShadowCaster = {
|
|
2634
|
+
/** Bias to apply to avoid self shadowing artifacts. */
|
|
1821
2635
|
bias?: number;
|
|
2636
|
+
/** Distance to the near plane. */
|
|
1822
2637
|
nearDist?: number;
|
|
2638
|
+
/** Distance to the far plane. */
|
|
1823
2639
|
farDist?: number;
|
|
2640
|
+
/** Resolution of the shadow map. */
|
|
1824
2641
|
quality?: number;
|
|
2642
|
+
/** Skews the ratio of cascade splits, value ranges from 0 to 1. */
|
|
1825
2643
|
cascadeSplitLambda?: number;
|
|
2644
|
+
/** Distance to the end of the furthest cascade. */
|
|
1826
2645
|
cascadeMaxZ?: number;
|
|
2646
|
+
/** For directional lights, accumulate all shadow cascades. */
|
|
1827
2647
|
accumulateShadowCascades?: boolean;
|
|
1828
2648
|
};
|
|
1829
2649
|
export type CreateEntity_skeleton_ref = {
|
|
1830
2650
|
skeleton_ref: CreateEntity_SkeletonReference;
|
|
1831
2651
|
};
|
|
1832
2652
|
export type CreateEntity_SkeletonReference = {
|
|
2653
|
+
/** UUID of the referenced skeleton. */
|
|
1833
2654
|
value: string;
|
|
1834
2655
|
};
|
|
1835
2656
|
export type CreateEntity_sound_ref = {
|
|
1836
2657
|
sound_ref: CreateEntity_SoundReference;
|
|
1837
2658
|
};
|
|
1838
2659
|
export type CreateEntity_SoundReference = {
|
|
2660
|
+
/** UUID of the referenced sound. */
|
|
1839
2661
|
value: string;
|
|
2662
|
+
/** Volume from 0.0f to 1.0f. */
|
|
1840
2663
|
volume?: number;
|
|
2664
|
+
/** Pan. -1.0f is left, 1.0f is right. */
|
|
1841
2665
|
pan?: number;
|
|
2666
|
+
/** The speed at which the sound will play. 1.0f is normal. */
|
|
1842
2667
|
playSpeed?: number;
|
|
2668
|
+
/** Does the sound loop? */
|
|
1843
2669
|
looping?: boolean;
|
|
1844
2670
|
};
|
|
1845
2671
|
export type CreateEntity_sphere_geometry = {
|
|
1846
2672
|
sphere_geometry: CreateEntity_SphereGeometry;
|
|
1847
2673
|
};
|
|
1848
2674
|
export type CreateEntity_SphereGeometry = {
|
|
2675
|
+
/** Radius of the sphere */
|
|
1849
2676
|
radius?: number;
|
|
2677
|
+
/** True for additive, false for subtractive */
|
|
1850
2678
|
isAdditive?: boolean;
|
|
2679
|
+
/** Geometry offset */
|
|
1851
2680
|
offset?: Array<number>;
|
|
1852
2681
|
};
|
|
1853
2682
|
export type CreateEntity_spot_light = {
|
|
1854
2683
|
spot_light: CreateEntity_SpotLight;
|
|
1855
2684
|
};
|
|
1856
2685
|
export type CreateEntity_SpotLight = {
|
|
2686
|
+
/** Cutoff angle. */
|
|
1857
2687
|
cutoff?: number;
|
|
2688
|
+
/** Reference to a IES 2d texture. */
|
|
1858
2689
|
IESProfile: string;
|
|
1859
2690
|
};
|
|
1860
2691
|
export type CreateEntity_stereoscopic_lens = {
|
|
1861
2692
|
stereoscopic_lens: CreateEntity_StereoscopicPerspectiveLens;
|
|
1862
2693
|
};
|
|
1863
2694
|
export type CreateEntity_StereoscopicPerspectiveLens = {
|
|
2695
|
+
/** Angle of the left side of the field of view (this value is negative). */
|
|
1864
2696
|
angleLeft?: number;
|
|
2697
|
+
/** Angle of the right side of the field of view */
|
|
1865
2698
|
angleRight?: number;
|
|
2699
|
+
/** Angle of the top part of the field of view */
|
|
1866
2700
|
angleUp?: number;
|
|
2701
|
+
/** Angle of the bottom part of the field of view (this value is negative) */
|
|
1867
2702
|
angleDown?: number;
|
|
2703
|
+
/** Specifies the distance from the viewer to the near clipping plane. */
|
|
1868
2704
|
nearPlane?: number;
|
|
2705
|
+
/** Specifies the distance from the viewer to the far clipping plane. */
|
|
1869
2706
|
farPlane?: number;
|
|
2707
|
+
/** Specifies the aspect ratio of the viewport, usually equals width/height. */
|
|
1870
2708
|
aspectRatio?: number;
|
|
1871
2709
|
};
|
|
1872
2710
|
export type CreateEntity_tags = {
|
|
1873
2711
|
tags: CreateEntity_Tags;
|
|
1874
2712
|
};
|
|
1875
2713
|
export type CreateEntity_Tags = {
|
|
2714
|
+
/** Tag list. */
|
|
1876
2715
|
value: Array<string>;
|
|
1877
2716
|
};
|
|
1878
2717
|
export type CreateEntity_volume_filter = {
|
|
1879
2718
|
volume_filter: CreateEntity_VolumeFilter;
|
|
1880
2719
|
};
|
|
1881
2720
|
export type CreateEntity_VolumeFilter = {
|
|
2721
|
+
/** Voxel intensity range displayed, not applicable if outside volume material range */
|
|
1882
2722
|
range?: Array<number>;
|
|
2723
|
+
/** Apply gaussian filtering on voxels */
|
|
1883
2724
|
applyGaussianFiltering?: boolean;
|
|
2725
|
+
/** Are texel values from the voxel texture sampled unfiltered. */
|
|
1884
2726
|
sampleUnfiltered?: boolean;
|
|
2727
|
+
/** Whether or not this volume is visible in the MPR view */
|
|
1885
2728
|
enableMPR?: boolean;
|
|
2729
|
+
/** Whether or not this volume is visible in the 3D view */
|
|
1886
2730
|
enable3D?: boolean;
|
|
1887
2731
|
};
|
|
1888
2732
|
export type CreateEntity_volume_material_ref = {
|
|
1889
2733
|
volume_material_ref: CreateEntity_VolumeMaterialReference;
|
|
1890
2734
|
};
|
|
1891
2735
|
export type CreateEntity_VolumeMaterialReference = {
|
|
2736
|
+
/** UUID of the volume_material. */
|
|
1892
2737
|
value: string;
|
|
1893
2738
|
};
|
|
1894
2739
|
export type CreateEntity_volume_ref = {
|
|
1895
2740
|
volume_ref: CreateEntity_VolumeReference;
|
|
1896
2741
|
};
|
|
1897
2742
|
export type CreateEntity_VolumeReference = {
|
|
2743
|
+
/** Reference to a 3d texture. */
|
|
1898
2744
|
texture3dRef: string;
|
|
1899
2745
|
};
|
|
1900
2746
|
export type CreateEntity_Object = {
|
|
2747
|
+
/** Entity unique identifier */
|
|
1901
2748
|
entity_id: string;
|
|
1902
2749
|
};
|
|
1903
2750
|
/**
|
|
@@ -1911,10 +2758,15 @@ export type GetEntity_animation_controller = {
|
|
|
1911
2758
|
animation_controller: GetEntity_AnimationController;
|
|
1912
2759
|
};
|
|
1913
2760
|
export type GetEntity_AnimationController = {
|
|
2761
|
+
/** Animation Graph reference. */
|
|
1914
2762
|
animationGraphRef: string;
|
|
2763
|
+
/** Animation Set reference. */
|
|
1915
2764
|
animationSetRef: string;
|
|
2765
|
+
/** Input values as described in the referenced animation graph in their original JSON format. */
|
|
1916
2766
|
dataJSON: object;
|
|
2767
|
+
/** Reference to the entity that is the root bone of the skeleton. */
|
|
1917
2768
|
rootBoneEntityRef: GetEntity_EntityReference;
|
|
2769
|
+
/** Whether or not root motion is enabled. */
|
|
1918
2770
|
rootMotionEnabled: boolean;
|
|
1919
2771
|
};
|
|
1920
2772
|
export type GetEntity_EntityReference = {
|
|
@@ -1925,333 +2777,461 @@ export type GetEntity_bone = {
|
|
|
1925
2777
|
bone: GetEntity_Bone;
|
|
1926
2778
|
};
|
|
1927
2779
|
export type GetEntity_Bone = {
|
|
2780
|
+
/** Index of bone in skeleton. */
|
|
1928
2781
|
boneIndex: number;
|
|
1929
2782
|
};
|
|
1930
2783
|
export type GetEntity_box_geometry = {
|
|
1931
2784
|
box_geometry: GetEntity_BoxGeometry;
|
|
1932
2785
|
};
|
|
1933
2786
|
export type GetEntity_BoxGeometry = {
|
|
2787
|
+
/** Width, height and depth of the box */
|
|
1934
2788
|
dimension?: Array<number>;
|
|
2789
|
+
/** True for additive, false for subtractive */
|
|
1935
2790
|
isAdditive?: boolean;
|
|
2791
|
+
/** Geometry offset */
|
|
1936
2792
|
offset?: Array<number>;
|
|
1937
2793
|
};
|
|
1938
2794
|
export type GetEntity_camera = {
|
|
1939
2795
|
camera: GetEntity_Camera;
|
|
1940
2796
|
};
|
|
1941
2797
|
export type GetEntity_Camera = {
|
|
2798
|
+
/** Specifies which render graph this camera should use. */
|
|
1942
2799
|
renderGraphRef: string;
|
|
2800
|
+
/** Index of the render target to blit. */
|
|
1943
2801
|
renderTargetIndex?: number;
|
|
2802
|
+
/** Input values as described in the referenced render graph in their original JSON format. */
|
|
1944
2803
|
dataJSON: object;
|
|
1945
2804
|
};
|
|
1946
2805
|
export type GetEntity_capsule_geometry = {
|
|
1947
2806
|
capsule_geometry: GetEntity_CapsuleGeometry;
|
|
1948
2807
|
};
|
|
1949
2808
|
export type GetEntity_CapsuleGeometry = {
|
|
2809
|
+
/** Radius of the spheres at each end of the capsule */
|
|
1950
2810
|
radius?: number;
|
|
2811
|
+
/** Height of the cylindrical part of the capsule */
|
|
1951
2812
|
height?: number;
|
|
2813
|
+
/** Alignment axis, 0 for X, 1 for Y, 2 for Z */
|
|
1952
2814
|
axis?: number;
|
|
2815
|
+
/** True for additive, false for subtractive */
|
|
1953
2816
|
isAdditive?: boolean;
|
|
2817
|
+
/** Geometry offset */
|
|
1954
2818
|
offset?: Array<number>;
|
|
1955
2819
|
};
|
|
1956
2820
|
export type GetEntity_character_controller = {
|
|
1957
2821
|
character_controller: GetEntity_CharacterController;
|
|
1958
2822
|
};
|
|
1959
2823
|
export type GetEntity_CharacterController = {
|
|
2824
|
+
/** Step Offset in meters */
|
|
1960
2825
|
stepOffset?: number;
|
|
2826
|
+
/** Slope Limit in degrees */
|
|
1961
2827
|
slopeLimit?: number;
|
|
2828
|
+
/** The character's collision skin width */
|
|
1962
2829
|
skinWidth?: number;
|
|
2830
|
+
/** Velocity vector for current frame */
|
|
1963
2831
|
velocity?: Array<number>;
|
|
1964
2832
|
};
|
|
1965
2833
|
export type GetEntity_collision_geometry_ref = {
|
|
1966
2834
|
collision_geometry_ref: GetEntity_CollisionGeometryRef;
|
|
1967
2835
|
};
|
|
1968
2836
|
export type GetEntity_CollisionGeometryRef = {
|
|
2837
|
+
/** UUID of the referenced collision_geometry. */
|
|
1969
2838
|
collisionGeometryRef: string;
|
|
1970
2839
|
};
|
|
1971
2840
|
export type GetEntity_cylinder_geometry = {
|
|
1972
2841
|
cylinder_geometry: GetEntity_CylinderGeometry;
|
|
1973
2842
|
};
|
|
1974
2843
|
export type GetEntity_CylinderGeometry = {
|
|
2844
|
+
/** Radius of the cylinder */
|
|
1975
2845
|
radius?: number;
|
|
2846
|
+
/** Height of the cylinder */
|
|
1976
2847
|
height?: number;
|
|
2848
|
+
/** Alignment axis, 0 for X, 1 for Y, 2 for Z */
|
|
1977
2849
|
axis?: number;
|
|
2850
|
+
/** True for additive, false for subtractive */
|
|
1978
2851
|
isAdditive?: boolean;
|
|
2852
|
+
/** Geometry offset */
|
|
1979
2853
|
offset?: Array<number>;
|
|
1980
2854
|
};
|
|
1981
2855
|
export type GetEntity_debug_name = {
|
|
1982
2856
|
debug_name: GetEntity_Name;
|
|
1983
2857
|
};
|
|
1984
2858
|
export type GetEntity_Name = {
|
|
2859
|
+
/** Name of the entity that will be displayed in various debug tools. */
|
|
1985
2860
|
value: string;
|
|
1986
2861
|
};
|
|
1987
2862
|
export type GetEntity_decal_projector = {
|
|
1988
2863
|
decal_projector: GetEntity_DecalProjector;
|
|
1989
2864
|
};
|
|
1990
2865
|
export type GetEntity_DecalProjector = {
|
|
2866
|
+
/** Z-Index order of the decal projection. The higher index will render on top of the lower ones. */
|
|
1991
2867
|
zIndex?: number;
|
|
1992
2868
|
};
|
|
1993
2869
|
export type GetEntity_environment = {
|
|
1994
2870
|
environment: GetEntity_Environment;
|
|
1995
2871
|
};
|
|
1996
2872
|
export type GetEntity_Environment = {
|
|
2873
|
+
/** Reference to the skybox cubemap. */
|
|
1997
2874
|
skyboxUUID: string;
|
|
2875
|
+
/** Reference to the radiance cubemap. */
|
|
1998
2876
|
radianceUUID: string;
|
|
2877
|
+
/** Reference to the irradiance cubemap. */
|
|
1999
2878
|
irradianceUUID: string;
|
|
2000
2879
|
};
|
|
2001
2880
|
export type GetEntity_joint = {
|
|
2002
2881
|
joint: GetEntity_Joint;
|
|
2003
2882
|
};
|
|
2004
2883
|
export type GetEntity_Joint = {
|
|
2884
|
+
/** An entity that is a dynamic physics body. */
|
|
2005
2885
|
constrainee: GetEntity_EntityReference;
|
|
2886
|
+
/** An entity that is a dynamic or static physics body, or simply null. */
|
|
2006
2887
|
constrainer: GetEntity_EntityReference;
|
|
2888
|
+
/** The force that needs to be applied for this joint to break. */
|
|
2007
2889
|
breakForce?: number;
|
|
2890
|
+
/** The torque that needs to be applied for this joint to break. */
|
|
2008
2891
|
breakTorque?: number;
|
|
2009
2892
|
};
|
|
2010
2893
|
export type GetEntity_lineage = {
|
|
2011
2894
|
lineage: GetEntity_Lineage;
|
|
2012
2895
|
};
|
|
2013
2896
|
export type GetEntity_Lineage = {
|
|
2897
|
+
/** UUID of the parent of this entity (default is root). */
|
|
2014
2898
|
parentUUID: string;
|
|
2899
|
+
/** Ordinal number of this entity in respect of its siblings. */
|
|
2015
2900
|
ordinal?: number;
|
|
2016
2901
|
};
|
|
2017
2902
|
export type GetEntity_local_aabb = {
|
|
2018
2903
|
local_aabb: GetEntity_LocalAxisAlignedBoundingBox;
|
|
2019
2904
|
};
|
|
2020
2905
|
export type GetEntity_LocalAxisAlignedBoundingBox = {
|
|
2906
|
+
/** Minimum point of the box. */
|
|
2021
2907
|
min: Array<number>;
|
|
2908
|
+
/** Maximum point of the box. */
|
|
2022
2909
|
max: Array<number>;
|
|
2023
2910
|
};
|
|
2024
2911
|
export type GetEntity_local_transform = {
|
|
2025
2912
|
local_transform: GetEntity_Transform;
|
|
2026
2913
|
};
|
|
2027
2914
|
export type GetEntity_Transform = {
|
|
2915
|
+
/** x, y, z position of the entity */
|
|
2028
2916
|
position?: Array<number>;
|
|
2917
|
+
/** Orientation of the entity expressed as a quaternion */
|
|
2029
2918
|
orientation?: Array<number>;
|
|
2919
|
+
/** x, y, z scale of the entity */
|
|
2030
2920
|
scale?: Array<number>;
|
|
2921
|
+
/** Orientation of the entity expressed as euler angles */
|
|
2031
2922
|
eulerOrientation?: Array<number>;
|
|
2923
|
+
/** Last global orientation of the entity expressed as euler angles submitted by a user. This value may not be valid, and should be checked. */
|
|
2032
2924
|
globalEulerOrientation?: Array<number>;
|
|
2033
2925
|
};
|
|
2034
2926
|
export type GetEntity_material = {
|
|
2035
2927
|
material: GetEntity_Material;
|
|
2036
2928
|
};
|
|
2037
2929
|
export type GetEntity_Material = {
|
|
2930
|
+
/** Reference to a shader graph. */
|
|
2038
2931
|
shaderRef: string;
|
|
2932
|
+
/** Transparency mode */
|
|
2039
2933
|
transparencyMode: number;
|
|
2934
|
+
/** Whether the material is double sided or not. */
|
|
2040
2935
|
isDoubleSided: boolean;
|
|
2936
|
+
/** Input values as described in the referenced shader in their original JSON format. */
|
|
2041
2937
|
dataJSON: object;
|
|
2042
2938
|
};
|
|
2043
2939
|
export type GetEntity_material_ref = {
|
|
2044
2940
|
material_ref: GetEntity_MaterialReference;
|
|
2045
2941
|
};
|
|
2046
2942
|
export type GetEntity_MaterialReference = {
|
|
2943
|
+
/** UUID of the referenced material. */
|
|
2047
2944
|
value: string;
|
|
2945
|
+
/** Face culling mode */
|
|
2048
2946
|
faceCulling?: number;
|
|
2049
2947
|
};
|
|
2050
2948
|
export type GetEntity_mesh_ref = {
|
|
2051
2949
|
mesh_ref: GetEntity_MeshReference;
|
|
2052
2950
|
};
|
|
2053
2951
|
export type GetEntity_MeshReference = {
|
|
2952
|
+
/** UUID of the referenced mesh. */
|
|
2054
2953
|
value: string;
|
|
2954
|
+
/** Index of the submesh inside the submesh array. */
|
|
2055
2955
|
submeshIndex?: number;
|
|
2056
2956
|
};
|
|
2057
2957
|
export type GetEntity_orthographic_lens = {
|
|
2058
2958
|
orthographic_lens: GetEntity_OrthographicLens;
|
|
2059
2959
|
};
|
|
2060
2960
|
export type GetEntity_OrthographicLens = {
|
|
2961
|
+
/** Left plane. */
|
|
2061
2962
|
left?: number;
|
|
2963
|
+
/** Right plane. */
|
|
2062
2964
|
right?: number;
|
|
2965
|
+
/** Top plane. */
|
|
2063
2966
|
top?: number;
|
|
2967
|
+
/** Bottom plane. */
|
|
2064
2968
|
bottom?: number;
|
|
2969
|
+
/** Near plane. */
|
|
2065
2970
|
zNear?: number;
|
|
2971
|
+
/** Far plane. */
|
|
2066
2972
|
zFar?: number;
|
|
2067
2973
|
};
|
|
2068
2974
|
export type GetEntity_overrider = {
|
|
2069
2975
|
overrider: GetEntity_Overrider;
|
|
2070
2976
|
};
|
|
2071
2977
|
export type GetEntity_Overrider = {
|
|
2978
|
+
/** Mark the overridden entity as deleted. */
|
|
2072
2979
|
deleter?: boolean;
|
|
2980
|
+
/** Entity to override. */
|
|
2073
2981
|
entityRef: GetEntity_EntityReference;
|
|
2982
|
+
/** Hashes of the components to detach from the overridden entity. */
|
|
2074
2983
|
componentsToDetach: Array<number>;
|
|
2075
2984
|
};
|
|
2076
2985
|
export type GetEntity_perspective_lens = {
|
|
2077
2986
|
perspective_lens: GetEntity_PerspectiveLens;
|
|
2078
2987
|
};
|
|
2079
2988
|
export type GetEntity_PerspectiveLens = {
|
|
2989
|
+
/** Specifies the aspect ratio of the viewport, usually equals width/height. */
|
|
2080
2990
|
aspectRatio?: number;
|
|
2991
|
+
/** Specifies the field of view angle in the y direction. */
|
|
2081
2992
|
fovy?: number;
|
|
2993
|
+
/** Specifies the distance from the viewer to the near clipping plane. */
|
|
2082
2994
|
nearPlane?: number;
|
|
2995
|
+
/** Specifies the distance from the viewer to the far clipping plane. */
|
|
2083
2996
|
farPlane?: number;
|
|
2084
2997
|
};
|
|
2085
2998
|
export type GetEntity_physics_material = {
|
|
2086
2999
|
physics_material: GetEntity_PhysicsMaterial;
|
|
2087
3000
|
};
|
|
2088
3001
|
export type GetEntity_PhysicsMaterial = {
|
|
3002
|
+
/** The coefficient of static friction */
|
|
2089
3003
|
staticFriction?: number;
|
|
3004
|
+
/** The coefficient of dynamic friction */
|
|
2090
3005
|
dynamicFriction?: number;
|
|
3006
|
+
/** The coefficient of static restitution */
|
|
2091
3007
|
restitution?: number;
|
|
3008
|
+
/** Whether to consider the collision shape associated to this material as a trigger or not */
|
|
2092
3009
|
isTrigger?: boolean;
|
|
2093
3010
|
};
|
|
2094
3011
|
export type GetEntity_plane_geometry = {
|
|
2095
3012
|
plane_geometry: GetEntity_PlaneGeometry;
|
|
2096
3013
|
};
|
|
2097
3014
|
export type GetEntity_PlaneGeometry = {
|
|
3015
|
+
/** Distance from the origin in the plane's normal direction. */
|
|
2098
3016
|
distance?: number;
|
|
3017
|
+
/** Normal of the plane. */
|
|
2099
3018
|
normal?: Array<number>;
|
|
2100
3019
|
};
|
|
2101
3020
|
export type GetEntity_point_cloud_ref = {
|
|
2102
3021
|
point_cloud_ref: GetEntity_PointCloudReference;
|
|
2103
3022
|
};
|
|
2104
3023
|
export type GetEntity_PointCloudReference = {
|
|
3024
|
+
/** UUID of the referenced point cloud. */
|
|
2105
3025
|
value: string;
|
|
2106
3026
|
};
|
|
2107
3027
|
export type GetEntity_point_light = {
|
|
2108
3028
|
point_light: GetEntity_Light;
|
|
2109
3029
|
};
|
|
2110
3030
|
export type GetEntity_Light = {
|
|
3031
|
+
/** Light color */
|
|
2111
3032
|
color?: Array<number>;
|
|
3033
|
+
/** Light intensity. */
|
|
2112
3034
|
intensity?: number;
|
|
3035
|
+
/** The range for the point light. If the range is 0, then physically correct point light attenuation function is used. */
|
|
2113
3036
|
range?: number;
|
|
3037
|
+
/** Make this light directional, position is ignored in this case. */
|
|
2114
3038
|
isDirectional?: boolean;
|
|
3039
|
+
/** Make this light direction control the atmosphere sun direction. If more than one light is marked to be a sun results are undefined. */
|
|
2115
3040
|
isSun?: boolean;
|
|
2116
3041
|
};
|
|
2117
3042
|
export type GetEntity_reflection_probe = {
|
|
2118
3043
|
reflection_probe: GetEntity_ReflectionProbe;
|
|
2119
3044
|
};
|
|
2120
3045
|
export type GetEntity_ReflectionProbe = {
|
|
3046
|
+
/** x, y, z offset of the probe reflection origin. */
|
|
2121
3047
|
offset?: Array<number>;
|
|
3048
|
+
/** Distance to the near plane. */
|
|
2122
3049
|
nearDist?: number;
|
|
3050
|
+
/** Distance to the far plane. */
|
|
2123
3051
|
farDist?: number;
|
|
3052
|
+
/** Resolution of the reflection map. */
|
|
2124
3053
|
quality?: number;
|
|
2125
3054
|
};
|
|
2126
3055
|
export type GetEntity_revolute_joint = {
|
|
2127
3056
|
revolute_joint: GetEntity_RevoluteJoint;
|
|
2128
3057
|
};
|
|
2129
3058
|
export type GetEntity_RevoluteJoint = {
|
|
3059
|
+
/** The direction of the axis around which the constrainee swings. The direction is defined in the constrainee's local space. */
|
|
2130
3060
|
axis?: Array<number>;
|
|
3061
|
+
/** The position of the axis around which the constrainee swings. The position is defined in the constrainee's local space. */
|
|
2131
3062
|
anchor?: Array<number>;
|
|
2132
3063
|
};
|
|
2133
3064
|
export type GetEntity_rigid_body = {
|
|
2134
3065
|
rigid_body: GetEntity_RigidBody;
|
|
2135
3066
|
};
|
|
2136
3067
|
export type GetEntity_RigidBody = {
|
|
3068
|
+
/** Mass */
|
|
2137
3069
|
mass?: number;
|
|
3070
|
+
/** Linear damping */
|
|
2138
3071
|
linearDamping?: number;
|
|
3072
|
+
/** Angular damping */
|
|
2139
3073
|
angularDamping?: number;
|
|
3074
|
+
/** Friction */
|
|
2140
3075
|
friction?: number;
|
|
3076
|
+
/** Rolling friction */
|
|
2141
3077
|
rollingFriction?: number;
|
|
3078
|
+
/** Spinning friction */
|
|
2142
3079
|
spinningFriction?: number;
|
|
3080
|
+
/** Restitution */
|
|
2143
3081
|
restitution?: number;
|
|
3082
|
+
/** Linear sleeping threshold */
|
|
2144
3083
|
linearSleepingThreshold?: number;
|
|
3084
|
+
/** Angular sleeping threshold */
|
|
2145
3085
|
angularSleepingThreshold?: number;
|
|
3086
|
+
/** Whether the rigid body should use kinematic physics or not */
|
|
2146
3087
|
isKinematic?: boolean;
|
|
2147
3088
|
};
|
|
2148
3089
|
export type GetEntity_scene_ref = {
|
|
2149
3090
|
scene_ref: GetEntity_SceneReference;
|
|
2150
3091
|
};
|
|
2151
3092
|
export type GetEntity_SceneReference = {
|
|
3093
|
+
/** Reference to a scene. */
|
|
2152
3094
|
value: string;
|
|
3095
|
+
/** Maximum number of times a scene appears when it references itself. */
|
|
2153
3096
|
maxRecursionCount?: number;
|
|
2154
3097
|
};
|
|
2155
3098
|
export type GetEntity_script_element = {
|
|
2156
3099
|
script_element: GetEntity_ScriptElement;
|
|
2157
3100
|
};
|
|
2158
3101
|
export type GetEntity_ScriptElement = {
|
|
3102
|
+
/** Reference to a script. */
|
|
2159
3103
|
scriptRef: string;
|
|
3104
|
+
/** Input values as described in the referenced script in their original JSON format. */
|
|
2160
3105
|
dataJSON: object;
|
|
2161
3106
|
};
|
|
2162
3107
|
export type GetEntity_script_map = {
|
|
2163
3108
|
script_map: GetEntity_ScriptMap;
|
|
2164
3109
|
};
|
|
2165
3110
|
export type GetEntity_ScriptMap = {
|
|
3111
|
+
/** List of scripts. */
|
|
2166
3112
|
elements: object;
|
|
2167
3113
|
};
|
|
2168
3114
|
export type GetEntity_shadow_caster = {
|
|
2169
3115
|
shadow_caster: GetEntity_ShadowCaster;
|
|
2170
3116
|
};
|
|
2171
3117
|
export type GetEntity_ShadowCaster = {
|
|
3118
|
+
/** Bias to apply to avoid self shadowing artifacts. */
|
|
2172
3119
|
bias?: number;
|
|
3120
|
+
/** Distance to the near plane. */
|
|
2173
3121
|
nearDist?: number;
|
|
3122
|
+
/** Distance to the far plane. */
|
|
2174
3123
|
farDist?: number;
|
|
3124
|
+
/** Resolution of the shadow map. */
|
|
2175
3125
|
quality?: number;
|
|
3126
|
+
/** Skews the ratio of cascade splits, value ranges from 0 to 1. */
|
|
2176
3127
|
cascadeSplitLambda?: number;
|
|
3128
|
+
/** Distance to the end of the furthest cascade. */
|
|
2177
3129
|
cascadeMaxZ?: number;
|
|
3130
|
+
/** For directional lights, accumulate all shadow cascades. */
|
|
2178
3131
|
accumulateShadowCascades?: boolean;
|
|
2179
3132
|
};
|
|
2180
3133
|
export type GetEntity_skeleton_ref = {
|
|
2181
3134
|
skeleton_ref: GetEntity_SkeletonReference;
|
|
2182
3135
|
};
|
|
2183
3136
|
export type GetEntity_SkeletonReference = {
|
|
3137
|
+
/** UUID of the referenced skeleton. */
|
|
2184
3138
|
value: string;
|
|
2185
3139
|
};
|
|
2186
3140
|
export type GetEntity_sound_ref = {
|
|
2187
3141
|
sound_ref: GetEntity_SoundReference;
|
|
2188
3142
|
};
|
|
2189
3143
|
export type GetEntity_SoundReference = {
|
|
3144
|
+
/** UUID of the referenced sound. */
|
|
2190
3145
|
value: string;
|
|
3146
|
+
/** Volume from 0.0f to 1.0f. */
|
|
2191
3147
|
volume?: number;
|
|
3148
|
+
/** Pan. -1.0f is left, 1.0f is right. */
|
|
2192
3149
|
pan?: number;
|
|
3150
|
+
/** The speed at which the sound will play. 1.0f is normal. */
|
|
2193
3151
|
playSpeed?: number;
|
|
3152
|
+
/** Does the sound loop? */
|
|
2194
3153
|
looping?: boolean;
|
|
2195
3154
|
};
|
|
2196
3155
|
export type GetEntity_sphere_geometry = {
|
|
2197
3156
|
sphere_geometry: GetEntity_SphereGeometry;
|
|
2198
3157
|
};
|
|
2199
3158
|
export type GetEntity_SphereGeometry = {
|
|
3159
|
+
/** Radius of the sphere */
|
|
2200
3160
|
radius?: number;
|
|
3161
|
+
/** True for additive, false for subtractive */
|
|
2201
3162
|
isAdditive?: boolean;
|
|
3163
|
+
/** Geometry offset */
|
|
2202
3164
|
offset?: Array<number>;
|
|
2203
3165
|
};
|
|
2204
3166
|
export type GetEntity_spot_light = {
|
|
2205
3167
|
spot_light: GetEntity_SpotLight;
|
|
2206
3168
|
};
|
|
2207
3169
|
export type GetEntity_SpotLight = {
|
|
3170
|
+
/** Cutoff angle. */
|
|
2208
3171
|
cutoff?: number;
|
|
3172
|
+
/** Reference to a IES 2d texture. */
|
|
2209
3173
|
IESProfile: string;
|
|
2210
3174
|
};
|
|
2211
3175
|
export type GetEntity_stereoscopic_lens = {
|
|
2212
3176
|
stereoscopic_lens: GetEntity_StereoscopicPerspectiveLens;
|
|
2213
3177
|
};
|
|
2214
3178
|
export type GetEntity_StereoscopicPerspectiveLens = {
|
|
3179
|
+
/** Angle of the left side of the field of view (this value is negative). */
|
|
2215
3180
|
angleLeft?: number;
|
|
3181
|
+
/** Angle of the right side of the field of view */
|
|
2216
3182
|
angleRight?: number;
|
|
3183
|
+
/** Angle of the top part of the field of view */
|
|
2217
3184
|
angleUp?: number;
|
|
3185
|
+
/** Angle of the bottom part of the field of view (this value is negative) */
|
|
2218
3186
|
angleDown?: number;
|
|
3187
|
+
/** Specifies the distance from the viewer to the near clipping plane. */
|
|
2219
3188
|
nearPlane?: number;
|
|
3189
|
+
/** Specifies the distance from the viewer to the far clipping plane. */
|
|
2220
3190
|
farPlane?: number;
|
|
3191
|
+
/** Specifies the aspect ratio of the viewport, usually equals width/height. */
|
|
2221
3192
|
aspectRatio?: number;
|
|
2222
3193
|
};
|
|
2223
3194
|
export type GetEntity_tags = {
|
|
2224
3195
|
tags: GetEntity_Tags;
|
|
2225
3196
|
};
|
|
2226
3197
|
export type GetEntity_Tags = {
|
|
3198
|
+
/** Tag list. */
|
|
2227
3199
|
value: Array<string>;
|
|
2228
3200
|
};
|
|
2229
3201
|
export type GetEntity_volume_filter = {
|
|
2230
3202
|
volume_filter: GetEntity_VolumeFilter;
|
|
2231
3203
|
};
|
|
2232
3204
|
export type GetEntity_VolumeFilter = {
|
|
3205
|
+
/** Voxel intensity range displayed, not applicable if outside volume material range */
|
|
2233
3206
|
range?: Array<number>;
|
|
3207
|
+
/** Apply gaussian filtering on voxels */
|
|
2234
3208
|
applyGaussianFiltering?: boolean;
|
|
3209
|
+
/** Are texel values from the voxel texture sampled unfiltered. */
|
|
2235
3210
|
sampleUnfiltered?: boolean;
|
|
3211
|
+
/** Whether or not this volume is visible in the MPR view */
|
|
2236
3212
|
enableMPR?: boolean;
|
|
3213
|
+
/** Whether or not this volume is visible in the 3D view */
|
|
2237
3214
|
enable3D?: boolean;
|
|
2238
3215
|
};
|
|
2239
3216
|
export type GetEntity_volume_material_ref = {
|
|
2240
3217
|
volume_material_ref: GetEntity_VolumeMaterialReference;
|
|
2241
3218
|
};
|
|
2242
3219
|
export type GetEntity_VolumeMaterialReference = {
|
|
3220
|
+
/** UUID of the volume_material. */
|
|
2243
3221
|
value: string;
|
|
2244
3222
|
};
|
|
2245
3223
|
export type GetEntity_volume_ref = {
|
|
2246
3224
|
volume_ref: GetEntity_VolumeReference;
|
|
2247
3225
|
};
|
|
2248
3226
|
export type GetEntity_VolumeReference = {
|
|
3227
|
+
/** Reference to a 3d texture. */
|
|
2249
3228
|
texture3dRef: string;
|
|
2250
3229
|
};
|
|
2251
3230
|
export type GetEntity_Entity = {
|
|
2252
3231
|
euid: GetEntity_EntityUid;
|
|
2253
3232
|
};
|
|
2254
3233
|
export type GetEntity_EntityUid = {
|
|
3234
|
+
/** Unique identifier value. */
|
|
2255
3235
|
value: string;
|
|
2256
3236
|
};
|
|
2257
3237
|
/**
|
|
@@ -2266,10 +3246,15 @@ export type UpdateEntity_animation_controller = {
|
|
|
2266
3246
|
animation_controller: UpdateEntity_AnimationController;
|
|
2267
3247
|
};
|
|
2268
3248
|
export type UpdateEntity_AnimationController = {
|
|
3249
|
+
/** Animation Graph reference. */
|
|
2269
3250
|
animationGraphRef: string;
|
|
3251
|
+
/** Animation Set reference. */
|
|
2270
3252
|
animationSetRef: string;
|
|
3253
|
+
/** Input values as described in the referenced animation graph in their original JSON format. */
|
|
2271
3254
|
dataJSON: object;
|
|
3255
|
+
/** Reference to the entity that is the root bone of the skeleton. */
|
|
2272
3256
|
rootBoneEntityRef: UpdateEntity_EntityReference;
|
|
3257
|
+
/** Whether or not root motion is enabled. */
|
|
2273
3258
|
rootMotionEnabled: boolean;
|
|
2274
3259
|
};
|
|
2275
3260
|
export type UpdateEntity_EntityReference = {
|
|
@@ -2280,327 +3265,454 @@ export type UpdateEntity_bone = {
|
|
|
2280
3265
|
bone: UpdateEntity_Bone;
|
|
2281
3266
|
};
|
|
2282
3267
|
export type UpdateEntity_Bone = {
|
|
3268
|
+
/** Index of bone in skeleton. */
|
|
2283
3269
|
boneIndex: number;
|
|
2284
3270
|
};
|
|
2285
3271
|
export type UpdateEntity_box_geometry = {
|
|
2286
3272
|
box_geometry: UpdateEntity_BoxGeometry;
|
|
2287
3273
|
};
|
|
2288
3274
|
export type UpdateEntity_BoxGeometry = {
|
|
3275
|
+
/** Width, height and depth of the box */
|
|
2289
3276
|
dimension?: Array<number>;
|
|
3277
|
+
/** True for additive, false for subtractive */
|
|
2290
3278
|
isAdditive?: boolean;
|
|
3279
|
+
/** Geometry offset */
|
|
2291
3280
|
offset?: Array<number>;
|
|
2292
3281
|
};
|
|
2293
3282
|
export type UpdateEntity_camera = {
|
|
2294
3283
|
camera: UpdateEntity_Camera;
|
|
2295
3284
|
};
|
|
2296
3285
|
export type UpdateEntity_Camera = {
|
|
3286
|
+
/** Specifies which render graph this camera should use. */
|
|
2297
3287
|
renderGraphRef: string;
|
|
3288
|
+
/** Index of the render target to blit. */
|
|
2298
3289
|
renderTargetIndex?: number;
|
|
3290
|
+
/** Input values as described in the referenced render graph in their original JSON format. */
|
|
2299
3291
|
dataJSON: object;
|
|
2300
3292
|
};
|
|
2301
3293
|
export type UpdateEntity_capsule_geometry = {
|
|
2302
3294
|
capsule_geometry: UpdateEntity_CapsuleGeometry;
|
|
2303
3295
|
};
|
|
2304
3296
|
export type UpdateEntity_CapsuleGeometry = {
|
|
3297
|
+
/** Radius of the spheres at each end of the capsule */
|
|
2305
3298
|
radius?: number;
|
|
3299
|
+
/** Height of the cylindrical part of the capsule */
|
|
2306
3300
|
height?: number;
|
|
3301
|
+
/** Alignment axis, 0 for X, 1 for Y, 2 for Z */
|
|
2307
3302
|
axis?: number;
|
|
3303
|
+
/** True for additive, false for subtractive */
|
|
2308
3304
|
isAdditive?: boolean;
|
|
3305
|
+
/** Geometry offset */
|
|
2309
3306
|
offset?: Array<number>;
|
|
2310
3307
|
};
|
|
2311
3308
|
export type UpdateEntity_character_controller = {
|
|
2312
3309
|
character_controller: UpdateEntity_CharacterController;
|
|
2313
3310
|
};
|
|
2314
3311
|
export type UpdateEntity_CharacterController = {
|
|
3312
|
+
/** Step Offset in meters */
|
|
2315
3313
|
stepOffset?: number;
|
|
3314
|
+
/** Slope Limit in degrees */
|
|
2316
3315
|
slopeLimit?: number;
|
|
3316
|
+
/** The character's collision skin width */
|
|
2317
3317
|
skinWidth?: number;
|
|
3318
|
+
/** Velocity vector for current frame */
|
|
2318
3319
|
velocity?: Array<number>;
|
|
2319
3320
|
};
|
|
2320
3321
|
export type UpdateEntity_collision_geometry_ref = {
|
|
2321
3322
|
collision_geometry_ref: UpdateEntity_CollisionGeometryRef;
|
|
2322
3323
|
};
|
|
2323
3324
|
export type UpdateEntity_CollisionGeometryRef = {
|
|
3325
|
+
/** UUID of the referenced collision_geometry. */
|
|
2324
3326
|
collisionGeometryRef: string;
|
|
2325
3327
|
};
|
|
2326
3328
|
export type UpdateEntity_cylinder_geometry = {
|
|
2327
3329
|
cylinder_geometry: UpdateEntity_CylinderGeometry;
|
|
2328
3330
|
};
|
|
2329
3331
|
export type UpdateEntity_CylinderGeometry = {
|
|
3332
|
+
/** Radius of the cylinder */
|
|
2330
3333
|
radius?: number;
|
|
3334
|
+
/** Height of the cylinder */
|
|
2331
3335
|
height?: number;
|
|
3336
|
+
/** Alignment axis, 0 for X, 1 for Y, 2 for Z */
|
|
2332
3337
|
axis?: number;
|
|
3338
|
+
/** True for additive, false for subtractive */
|
|
2333
3339
|
isAdditive?: boolean;
|
|
3340
|
+
/** Geometry offset */
|
|
2334
3341
|
offset?: Array<number>;
|
|
2335
3342
|
};
|
|
2336
3343
|
export type UpdateEntity_debug_name = {
|
|
2337
3344
|
debug_name: UpdateEntity_Name;
|
|
2338
3345
|
};
|
|
2339
3346
|
export type UpdateEntity_Name = {
|
|
3347
|
+
/** Name of the entity that will be displayed in various debug tools. */
|
|
2340
3348
|
value: string;
|
|
2341
3349
|
};
|
|
2342
3350
|
export type UpdateEntity_decal_projector = {
|
|
2343
3351
|
decal_projector: UpdateEntity_DecalProjector;
|
|
2344
3352
|
};
|
|
2345
3353
|
export type UpdateEntity_DecalProjector = {
|
|
3354
|
+
/** Z-Index order of the decal projection. The higher index will render on top of the lower ones. */
|
|
2346
3355
|
zIndex?: number;
|
|
2347
3356
|
};
|
|
2348
3357
|
export type UpdateEntity_environment = {
|
|
2349
3358
|
environment: UpdateEntity_Environment;
|
|
2350
3359
|
};
|
|
2351
3360
|
export type UpdateEntity_Environment = {
|
|
3361
|
+
/** Reference to the skybox cubemap. */
|
|
2352
3362
|
skyboxUUID: string;
|
|
3363
|
+
/** Reference to the radiance cubemap. */
|
|
2353
3364
|
radianceUUID: string;
|
|
3365
|
+
/** Reference to the irradiance cubemap. */
|
|
2354
3366
|
irradianceUUID: string;
|
|
2355
3367
|
};
|
|
2356
3368
|
export type UpdateEntity_joint = {
|
|
2357
3369
|
joint: UpdateEntity_Joint;
|
|
2358
3370
|
};
|
|
2359
3371
|
export type UpdateEntity_Joint = {
|
|
3372
|
+
/** An entity that is a dynamic physics body. */
|
|
2360
3373
|
constrainee: UpdateEntity_EntityReference;
|
|
3374
|
+
/** An entity that is a dynamic or static physics body, or simply null. */
|
|
2361
3375
|
constrainer: UpdateEntity_EntityReference;
|
|
3376
|
+
/** The force that needs to be applied for this joint to break. */
|
|
2362
3377
|
breakForce?: number;
|
|
3378
|
+
/** The torque that needs to be applied for this joint to break. */
|
|
2363
3379
|
breakTorque?: number;
|
|
2364
3380
|
};
|
|
2365
3381
|
export type UpdateEntity_lineage = {
|
|
2366
3382
|
lineage: UpdateEntity_Lineage;
|
|
2367
3383
|
};
|
|
2368
3384
|
export type UpdateEntity_Lineage = {
|
|
3385
|
+
/** UUID of the parent of this entity (default is root). */
|
|
2369
3386
|
parentUUID: string;
|
|
3387
|
+
/** Ordinal number of this entity in respect of its siblings. */
|
|
2370
3388
|
ordinal?: number;
|
|
2371
3389
|
};
|
|
2372
3390
|
export type UpdateEntity_local_aabb = {
|
|
2373
3391
|
local_aabb: UpdateEntity_LocalAxisAlignedBoundingBox;
|
|
2374
3392
|
};
|
|
2375
3393
|
export type UpdateEntity_LocalAxisAlignedBoundingBox = {
|
|
3394
|
+
/** Minimum point of the box. */
|
|
2376
3395
|
min: Array<number>;
|
|
3396
|
+
/** Maximum point of the box. */
|
|
2377
3397
|
max: Array<number>;
|
|
2378
3398
|
};
|
|
2379
3399
|
export type UpdateEntity_local_transform = {
|
|
2380
3400
|
local_transform: UpdateEntity_Transform;
|
|
2381
3401
|
};
|
|
2382
3402
|
export type UpdateEntity_Transform = {
|
|
3403
|
+
/** x, y, z position of the entity */
|
|
2383
3404
|
position?: Array<number>;
|
|
3405
|
+
/** Orientation of the entity expressed as a quaternion */
|
|
2384
3406
|
orientation?: Array<number>;
|
|
3407
|
+
/** x, y, z scale of the entity */
|
|
2385
3408
|
scale?: Array<number>;
|
|
3409
|
+
/** Orientation of the entity expressed as euler angles */
|
|
2386
3410
|
eulerOrientation?: Array<number>;
|
|
3411
|
+
/** Last global orientation of the entity expressed as euler angles submitted by a user. This value may not be valid, and should be checked. */
|
|
2387
3412
|
globalEulerOrientation?: Array<number>;
|
|
2388
3413
|
};
|
|
2389
3414
|
export type UpdateEntity_material = {
|
|
2390
3415
|
material: UpdateEntity_Material;
|
|
2391
3416
|
};
|
|
2392
3417
|
export type UpdateEntity_Material = {
|
|
3418
|
+
/** Reference to a shader graph. */
|
|
2393
3419
|
shaderRef: string;
|
|
3420
|
+
/** Transparency mode */
|
|
2394
3421
|
transparencyMode: number;
|
|
3422
|
+
/** Whether the material is double sided or not. */
|
|
2395
3423
|
isDoubleSided: boolean;
|
|
3424
|
+
/** Input values as described in the referenced shader in their original JSON format. */
|
|
2396
3425
|
dataJSON: object;
|
|
2397
3426
|
};
|
|
2398
3427
|
export type UpdateEntity_material_ref = {
|
|
2399
3428
|
material_ref: UpdateEntity_MaterialReference;
|
|
2400
3429
|
};
|
|
2401
3430
|
export type UpdateEntity_MaterialReference = {
|
|
3431
|
+
/** UUID of the referenced material. */
|
|
2402
3432
|
value: string;
|
|
3433
|
+
/** Face culling mode */
|
|
2403
3434
|
faceCulling?: number;
|
|
2404
3435
|
};
|
|
2405
3436
|
export type UpdateEntity_mesh_ref = {
|
|
2406
3437
|
mesh_ref: UpdateEntity_MeshReference;
|
|
2407
3438
|
};
|
|
2408
3439
|
export type UpdateEntity_MeshReference = {
|
|
3440
|
+
/** UUID of the referenced mesh. */
|
|
2409
3441
|
value: string;
|
|
3442
|
+
/** Index of the submesh inside the submesh array. */
|
|
2410
3443
|
submeshIndex?: number;
|
|
2411
3444
|
};
|
|
2412
3445
|
export type UpdateEntity_orthographic_lens = {
|
|
2413
3446
|
orthographic_lens: UpdateEntity_OrthographicLens;
|
|
2414
3447
|
};
|
|
2415
3448
|
export type UpdateEntity_OrthographicLens = {
|
|
3449
|
+
/** Left plane. */
|
|
2416
3450
|
left?: number;
|
|
3451
|
+
/** Right plane. */
|
|
2417
3452
|
right?: number;
|
|
3453
|
+
/** Top plane. */
|
|
2418
3454
|
top?: number;
|
|
3455
|
+
/** Bottom plane. */
|
|
2419
3456
|
bottom?: number;
|
|
3457
|
+
/** Near plane. */
|
|
2420
3458
|
zNear?: number;
|
|
3459
|
+
/** Far plane. */
|
|
2421
3460
|
zFar?: number;
|
|
2422
3461
|
};
|
|
2423
3462
|
export type UpdateEntity_overrider = {
|
|
2424
3463
|
overrider: UpdateEntity_Overrider;
|
|
2425
3464
|
};
|
|
2426
3465
|
export type UpdateEntity_Overrider = {
|
|
3466
|
+
/** Mark the overridden entity as deleted. */
|
|
2427
3467
|
deleter?: boolean;
|
|
3468
|
+
/** Entity to override. */
|
|
2428
3469
|
entityRef: UpdateEntity_EntityReference;
|
|
3470
|
+
/** Hashes of the components to detach from the overridden entity. */
|
|
2429
3471
|
componentsToDetach: Array<number>;
|
|
2430
3472
|
};
|
|
2431
3473
|
export type UpdateEntity_perspective_lens = {
|
|
2432
3474
|
perspective_lens: UpdateEntity_PerspectiveLens;
|
|
2433
3475
|
};
|
|
2434
3476
|
export type UpdateEntity_PerspectiveLens = {
|
|
3477
|
+
/** Specifies the aspect ratio of the viewport, usually equals width/height. */
|
|
2435
3478
|
aspectRatio?: number;
|
|
3479
|
+
/** Specifies the field of view angle in the y direction. */
|
|
2436
3480
|
fovy?: number;
|
|
3481
|
+
/** Specifies the distance from the viewer to the near clipping plane. */
|
|
2437
3482
|
nearPlane?: number;
|
|
3483
|
+
/** Specifies the distance from the viewer to the far clipping plane. */
|
|
2438
3484
|
farPlane?: number;
|
|
2439
3485
|
};
|
|
2440
3486
|
export type UpdateEntity_physics_material = {
|
|
2441
3487
|
physics_material: UpdateEntity_PhysicsMaterial;
|
|
2442
3488
|
};
|
|
2443
3489
|
export type UpdateEntity_PhysicsMaterial = {
|
|
3490
|
+
/** The coefficient of static friction */
|
|
2444
3491
|
staticFriction?: number;
|
|
3492
|
+
/** The coefficient of dynamic friction */
|
|
2445
3493
|
dynamicFriction?: number;
|
|
3494
|
+
/** The coefficient of static restitution */
|
|
2446
3495
|
restitution?: number;
|
|
3496
|
+
/** Whether to consider the collision shape associated to this material as a trigger or not */
|
|
2447
3497
|
isTrigger?: boolean;
|
|
2448
3498
|
};
|
|
2449
3499
|
export type UpdateEntity_plane_geometry = {
|
|
2450
3500
|
plane_geometry: UpdateEntity_PlaneGeometry;
|
|
2451
3501
|
};
|
|
2452
3502
|
export type UpdateEntity_PlaneGeometry = {
|
|
3503
|
+
/** Distance from the origin in the plane's normal direction. */
|
|
2453
3504
|
distance?: number;
|
|
3505
|
+
/** Normal of the plane. */
|
|
2454
3506
|
normal?: Array<number>;
|
|
2455
3507
|
};
|
|
2456
3508
|
export type UpdateEntity_point_cloud_ref = {
|
|
2457
3509
|
point_cloud_ref: UpdateEntity_PointCloudReference;
|
|
2458
3510
|
};
|
|
2459
3511
|
export type UpdateEntity_PointCloudReference = {
|
|
3512
|
+
/** UUID of the referenced point cloud. */
|
|
2460
3513
|
value: string;
|
|
2461
3514
|
};
|
|
2462
3515
|
export type UpdateEntity_point_light = {
|
|
2463
3516
|
point_light: UpdateEntity_Light;
|
|
2464
3517
|
};
|
|
2465
3518
|
export type UpdateEntity_Light = {
|
|
3519
|
+
/** Light color */
|
|
2466
3520
|
color?: Array<number>;
|
|
3521
|
+
/** Light intensity. */
|
|
2467
3522
|
intensity?: number;
|
|
3523
|
+
/** The range for the point light. If the range is 0, then physically correct point light attenuation function is used. */
|
|
2468
3524
|
range?: number;
|
|
3525
|
+
/** Make this light directional, position is ignored in this case. */
|
|
2469
3526
|
isDirectional?: boolean;
|
|
3527
|
+
/** Make this light direction control the atmosphere sun direction. If more than one light is marked to be a sun results are undefined. */
|
|
2470
3528
|
isSun?: boolean;
|
|
2471
3529
|
};
|
|
2472
3530
|
export type UpdateEntity_reflection_probe = {
|
|
2473
3531
|
reflection_probe: UpdateEntity_ReflectionProbe;
|
|
2474
3532
|
};
|
|
2475
3533
|
export type UpdateEntity_ReflectionProbe = {
|
|
3534
|
+
/** x, y, z offset of the probe reflection origin. */
|
|
2476
3535
|
offset?: Array<number>;
|
|
3536
|
+
/** Distance to the near plane. */
|
|
2477
3537
|
nearDist?: number;
|
|
3538
|
+
/** Distance to the far plane. */
|
|
2478
3539
|
farDist?: number;
|
|
3540
|
+
/** Resolution of the reflection map. */
|
|
2479
3541
|
quality?: number;
|
|
2480
3542
|
};
|
|
2481
3543
|
export type UpdateEntity_revolute_joint = {
|
|
2482
3544
|
revolute_joint: UpdateEntity_RevoluteJoint;
|
|
2483
3545
|
};
|
|
2484
3546
|
export type UpdateEntity_RevoluteJoint = {
|
|
3547
|
+
/** The direction of the axis around which the constrainee swings. The direction is defined in the constrainee's local space. */
|
|
2485
3548
|
axis?: Array<number>;
|
|
3549
|
+
/** The position of the axis around which the constrainee swings. The position is defined in the constrainee's local space. */
|
|
2486
3550
|
anchor?: Array<number>;
|
|
2487
3551
|
};
|
|
2488
3552
|
export type UpdateEntity_rigid_body = {
|
|
2489
3553
|
rigid_body: UpdateEntity_RigidBody;
|
|
2490
3554
|
};
|
|
2491
3555
|
export type UpdateEntity_RigidBody = {
|
|
3556
|
+
/** Mass */
|
|
2492
3557
|
mass?: number;
|
|
3558
|
+
/** Linear damping */
|
|
2493
3559
|
linearDamping?: number;
|
|
3560
|
+
/** Angular damping */
|
|
2494
3561
|
angularDamping?: number;
|
|
3562
|
+
/** Friction */
|
|
2495
3563
|
friction?: number;
|
|
3564
|
+
/** Rolling friction */
|
|
2496
3565
|
rollingFriction?: number;
|
|
3566
|
+
/** Spinning friction */
|
|
2497
3567
|
spinningFriction?: number;
|
|
3568
|
+
/** Restitution */
|
|
2498
3569
|
restitution?: number;
|
|
3570
|
+
/** Linear sleeping threshold */
|
|
2499
3571
|
linearSleepingThreshold?: number;
|
|
3572
|
+
/** Angular sleeping threshold */
|
|
2500
3573
|
angularSleepingThreshold?: number;
|
|
3574
|
+
/** Whether the rigid body should use kinematic physics or not */
|
|
2501
3575
|
isKinematic?: boolean;
|
|
2502
3576
|
};
|
|
2503
3577
|
export type UpdateEntity_scene_ref = {
|
|
2504
3578
|
scene_ref: UpdateEntity_SceneReference;
|
|
2505
3579
|
};
|
|
2506
3580
|
export type UpdateEntity_SceneReference = {
|
|
3581
|
+
/** Reference to a scene. */
|
|
2507
3582
|
value: string;
|
|
3583
|
+
/** Maximum number of times a scene appears when it references itself. */
|
|
2508
3584
|
maxRecursionCount?: number;
|
|
2509
3585
|
};
|
|
2510
3586
|
export type UpdateEntity_script_element = {
|
|
2511
3587
|
script_element: UpdateEntity_ScriptElement;
|
|
2512
3588
|
};
|
|
2513
3589
|
export type UpdateEntity_ScriptElement = {
|
|
3590
|
+
/** Reference to a script. */
|
|
2514
3591
|
scriptRef: string;
|
|
3592
|
+
/** Input values as described in the referenced script in their original JSON format. */
|
|
2515
3593
|
dataJSON: object;
|
|
2516
3594
|
};
|
|
2517
3595
|
export type UpdateEntity_script_map = {
|
|
2518
3596
|
script_map: UpdateEntity_ScriptMap;
|
|
2519
3597
|
};
|
|
2520
3598
|
export type UpdateEntity_ScriptMap = {
|
|
3599
|
+
/** List of scripts. */
|
|
2521
3600
|
elements: object;
|
|
2522
3601
|
};
|
|
2523
3602
|
export type UpdateEntity_shadow_caster = {
|
|
2524
3603
|
shadow_caster: UpdateEntity_ShadowCaster;
|
|
2525
3604
|
};
|
|
2526
3605
|
export type UpdateEntity_ShadowCaster = {
|
|
3606
|
+
/** Bias to apply to avoid self shadowing artifacts. */
|
|
2527
3607
|
bias?: number;
|
|
3608
|
+
/** Distance to the near plane. */
|
|
2528
3609
|
nearDist?: number;
|
|
3610
|
+
/** Distance to the far plane. */
|
|
2529
3611
|
farDist?: number;
|
|
3612
|
+
/** Resolution of the shadow map. */
|
|
2530
3613
|
quality?: number;
|
|
3614
|
+
/** Skews the ratio of cascade splits, value ranges from 0 to 1. */
|
|
2531
3615
|
cascadeSplitLambda?: number;
|
|
3616
|
+
/** Distance to the end of the furthest cascade. */
|
|
2532
3617
|
cascadeMaxZ?: number;
|
|
3618
|
+
/** For directional lights, accumulate all shadow cascades. */
|
|
2533
3619
|
accumulateShadowCascades?: boolean;
|
|
2534
3620
|
};
|
|
2535
3621
|
export type UpdateEntity_skeleton_ref = {
|
|
2536
3622
|
skeleton_ref: UpdateEntity_SkeletonReference;
|
|
2537
3623
|
};
|
|
2538
3624
|
export type UpdateEntity_SkeletonReference = {
|
|
3625
|
+
/** UUID of the referenced skeleton. */
|
|
2539
3626
|
value: string;
|
|
2540
3627
|
};
|
|
2541
3628
|
export type UpdateEntity_sound_ref = {
|
|
2542
3629
|
sound_ref: UpdateEntity_SoundReference;
|
|
2543
3630
|
};
|
|
2544
3631
|
export type UpdateEntity_SoundReference = {
|
|
3632
|
+
/** UUID of the referenced sound. */
|
|
2545
3633
|
value: string;
|
|
3634
|
+
/** Volume from 0.0f to 1.0f. */
|
|
2546
3635
|
volume?: number;
|
|
3636
|
+
/** Pan. -1.0f is left, 1.0f is right. */
|
|
2547
3637
|
pan?: number;
|
|
3638
|
+
/** The speed at which the sound will play. 1.0f is normal. */
|
|
2548
3639
|
playSpeed?: number;
|
|
3640
|
+
/** Does the sound loop? */
|
|
2549
3641
|
looping?: boolean;
|
|
2550
3642
|
};
|
|
2551
3643
|
export type UpdateEntity_sphere_geometry = {
|
|
2552
3644
|
sphere_geometry: UpdateEntity_SphereGeometry;
|
|
2553
3645
|
};
|
|
2554
3646
|
export type UpdateEntity_SphereGeometry = {
|
|
3647
|
+
/** Radius of the sphere */
|
|
2555
3648
|
radius?: number;
|
|
3649
|
+
/** True for additive, false for subtractive */
|
|
2556
3650
|
isAdditive?: boolean;
|
|
3651
|
+
/** Geometry offset */
|
|
2557
3652
|
offset?: Array<number>;
|
|
2558
3653
|
};
|
|
2559
3654
|
export type UpdateEntity_spot_light = {
|
|
2560
3655
|
spot_light: UpdateEntity_SpotLight;
|
|
2561
3656
|
};
|
|
2562
3657
|
export type UpdateEntity_SpotLight = {
|
|
3658
|
+
/** Cutoff angle. */
|
|
2563
3659
|
cutoff?: number;
|
|
3660
|
+
/** Reference to a IES 2d texture. */
|
|
2564
3661
|
IESProfile: string;
|
|
2565
3662
|
};
|
|
2566
3663
|
export type UpdateEntity_stereoscopic_lens = {
|
|
2567
3664
|
stereoscopic_lens: UpdateEntity_StereoscopicPerspectiveLens;
|
|
2568
3665
|
};
|
|
2569
3666
|
export type UpdateEntity_StereoscopicPerspectiveLens = {
|
|
3667
|
+
/** Angle of the left side of the field of view (this value is negative). */
|
|
2570
3668
|
angleLeft?: number;
|
|
3669
|
+
/** Angle of the right side of the field of view */
|
|
2571
3670
|
angleRight?: number;
|
|
3671
|
+
/** Angle of the top part of the field of view */
|
|
2572
3672
|
angleUp?: number;
|
|
3673
|
+
/** Angle of the bottom part of the field of view (this value is negative) */
|
|
2573
3674
|
angleDown?: number;
|
|
3675
|
+
/** Specifies the distance from the viewer to the near clipping plane. */
|
|
2574
3676
|
nearPlane?: number;
|
|
3677
|
+
/** Specifies the distance from the viewer to the far clipping plane. */
|
|
2575
3678
|
farPlane?: number;
|
|
3679
|
+
/** Specifies the aspect ratio of the viewport, usually equals width/height. */
|
|
2576
3680
|
aspectRatio?: number;
|
|
2577
3681
|
};
|
|
2578
3682
|
export type UpdateEntity_tags = {
|
|
2579
3683
|
tags: UpdateEntity_Tags;
|
|
2580
3684
|
};
|
|
2581
3685
|
export type UpdateEntity_Tags = {
|
|
3686
|
+
/** Tag list. */
|
|
2582
3687
|
value: Array<string>;
|
|
2583
3688
|
};
|
|
2584
3689
|
export type UpdateEntity_volume_filter = {
|
|
2585
3690
|
volume_filter: UpdateEntity_VolumeFilter;
|
|
2586
3691
|
};
|
|
2587
3692
|
export type UpdateEntity_VolumeFilter = {
|
|
3693
|
+
/** Voxel intensity range displayed, not applicable if outside volume material range */
|
|
2588
3694
|
range?: Array<number>;
|
|
3695
|
+
/** Apply gaussian filtering on voxels */
|
|
2589
3696
|
applyGaussianFiltering?: boolean;
|
|
3697
|
+
/** Are texel values from the voxel texture sampled unfiltered. */
|
|
2590
3698
|
sampleUnfiltered?: boolean;
|
|
3699
|
+
/** Whether or not this volume is visible in the MPR view */
|
|
2591
3700
|
enableMPR?: boolean;
|
|
3701
|
+
/** Whether or not this volume is visible in the 3D view */
|
|
2592
3702
|
enable3D?: boolean;
|
|
2593
3703
|
};
|
|
2594
3704
|
export type UpdateEntity_volume_material_ref = {
|
|
2595
3705
|
volume_material_ref: UpdateEntity_VolumeMaterialReference;
|
|
2596
3706
|
};
|
|
2597
3707
|
export type UpdateEntity_VolumeMaterialReference = {
|
|
3708
|
+
/** UUID of the volume_material. */
|
|
2598
3709
|
value: string;
|
|
2599
3710
|
};
|
|
2600
3711
|
export type UpdateEntity_volume_ref = {
|
|
2601
3712
|
volume_ref: UpdateEntity_VolumeReference;
|
|
2602
3713
|
};
|
|
2603
3714
|
export type UpdateEntity_VolumeReference = {
|
|
3715
|
+
/** Reference to a 3d texture. */
|
|
2604
3716
|
texture3dRef: string;
|
|
2605
3717
|
};
|
|
2606
3718
|
/**
|
|
@@ -2619,106 +3731,171 @@ export declare function deleteEntity({ scene_id, entity_id, }: {
|
|
|
2619
3731
|
entity_id: string;
|
|
2620
3732
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2621
3733
|
export type GetSceneSettings__index_SceneSettings_SceneSettings = {
|
|
3734
|
+
/** Settings for debug lines */
|
|
2622
3735
|
debug_lines?: GetSceneSettings_DebugLines;
|
|
3736
|
+
/** Default camera component of the scene, used to create default cameras. */
|
|
2623
3737
|
default_camera_component?: GetSceneSettings_DefaultCameraComponent;
|
|
3738
|
+
/** Default camera global transform of the scene, used to create default cameras. */
|
|
2624
3739
|
default_camera_transform?: GetSceneSettings_DefaultCameraTransform;
|
|
3740
|
+
/** Settings for the display */
|
|
2625
3741
|
display?: GetSceneSettings_Display;
|
|
3742
|
+
/** Settings for the encoder */
|
|
2626
3743
|
encoder?: GetSceneSettings_Encoder;
|
|
3744
|
+
/** Settings for the environment */
|
|
2627
3745
|
environment?: GetSceneSettings_Environment;
|
|
3746
|
+
/** Miscellaneous settings */
|
|
2628
3747
|
misc?: GetSceneSettings_Miscellaneous;
|
|
3748
|
+
/** Settings for the network */
|
|
2629
3749
|
network?: GetSceneSettings_Network;
|
|
3750
|
+
/** Settings for the physics engine. */
|
|
2630
3751
|
physics?: GetSceneSettings_Physics;
|
|
3752
|
+
/** Renderer settings */
|
|
2631
3753
|
renderer?: GetSceneSettings_Renderer;
|
|
3754
|
+
/** Settings to apply whenever simulation is active */
|
|
2632
3755
|
simulation?: GetSceneSettings_Simulation;
|
|
3756
|
+
/** Sound settings */
|
|
2633
3757
|
sound?: GetSceneSettings_Sound;
|
|
3758
|
+
/** Settings for the scene streaming */
|
|
2634
3759
|
streaming?: GetSceneSettings_Streaming;
|
|
3760
|
+
/** Settings for voxel rendering */
|
|
2635
3761
|
voxel?: GetSceneSettings_Voxel;
|
|
2636
3762
|
};
|
|
2637
3763
|
export type GetSceneSettings_DebugLines = {
|
|
3764
|
+
/** Whether to draw the bouding boxes of entities */
|
|
2638
3765
|
drawBoundingBoxes?: boolean;
|
|
3766
|
+
/** Whether to draw camera frustums */
|
|
2639
3767
|
drawCameraFrustums?: boolean;
|
|
3768
|
+
/** Whether to draw the center of mass of physics bodies */
|
|
2640
3769
|
drawCenterOfMass?: boolean;
|
|
3770
|
+
/** Whether to draw contacts between physics bodies */
|
|
2641
3771
|
drawContacts?: boolean;
|
|
3772
|
+
/** Whether to draw debug lines */
|
|
2642
3773
|
drawDebugLines?: boolean;
|
|
3774
|
+
/** Whether to draw certain IK parameters like the forward and up vector of an IK Aim node, or the pole vector of an IK Two Bone node */
|
|
2643
3775
|
drawIK?: boolean;
|
|
3776
|
+
/** Whether to draw joint-related debug lines */
|
|
2644
3777
|
drawJoints?: boolean;
|
|
3778
|
+
/** Whether to draw light-related debug lines */
|
|
2645
3779
|
drawLights?: boolean;
|
|
3780
|
+
/** Whether to draw geometry of physics bodies */
|
|
2646
3781
|
drawPhysicsBodies?: boolean;
|
|
3782
|
+
/** Whether to draw physics body axes */
|
|
2647
3783
|
drawPhysicsBodyAxes?: boolean;
|
|
3784
|
+
/** Whether to draw reflection probes */
|
|
2648
3785
|
drawReflectionProbes?: boolean;
|
|
3786
|
+
/** Whether to draw the skeletons of rigged characters */
|
|
2649
3787
|
drawSkeletons?: boolean;
|
|
2650
3788
|
};
|
|
2651
3789
|
export type GetSceneSettings_DefaultCameraComponent = {
|
|
3790
|
+
/** Input values as described in the referenced render graph in their original JSON format. */
|
|
2652
3791
|
dataJSON?: object;
|
|
3792
|
+
/** Specifies which render graph this camera should use. */
|
|
2653
3793
|
renderGraphRef?: string;
|
|
3794
|
+
/** Index of the render target to blit. */
|
|
2654
3795
|
renderTargetIndex?: number;
|
|
2655
3796
|
};
|
|
2656
3797
|
export type GetSceneSettings_DefaultCameraTransform = {
|
|
3798
|
+
/** Orientation of the camera expressed as a quaternion */
|
|
2657
3799
|
orientation?: Array<number>;
|
|
3800
|
+
/** x, y, z position of the camera */
|
|
2658
3801
|
position?: Array<number>;
|
|
2659
3802
|
};
|
|
2660
3803
|
export type GetSceneSettings_Display = {
|
|
3804
|
+
/** Draw frame without input events */
|
|
2661
3805
|
forceRedraw?: boolean;
|
|
3806
|
+
/** When 'Force Redraw' is off, this setting controls the number of frames the renderer will draw before going back to idle */
|
|
2662
3807
|
framePersistence?: number;
|
|
3808
|
+
/** Maximum number of Frames Per Second the renderer is allowed to produce */
|
|
2663
3809
|
maxFPS?: StrictUnion<15 | 30 | 60 | 90> & number;
|
|
3810
|
+
/** Maximum resolution of loaded textures */
|
|
2664
3811
|
maxTextureSize?: StrictUnion<4294967295 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192> & number;
|
|
2665
3812
|
};
|
|
2666
3813
|
export type GetSceneSettings_Encoder = {
|
|
3814
|
+
/** Encoder type. */
|
|
2667
3815
|
encoderType?: string;
|
|
2668
3816
|
};
|
|
2669
3817
|
export type GetSceneSettings_Environment = {
|
|
3818
|
+
/** Color of the spherical gradient at the bottom of the sphere. */
|
|
2670
3819
|
ambientColorBottom?: Array<number>;
|
|
3820
|
+
/** Color of the spherical gradient at the top of the sphere. */
|
|
2671
3821
|
ambientColorTop?: Array<number>;
|
|
3822
|
+
/** Solid color used to clear the screen before drawing. */
|
|
2672
3823
|
clearColor?: Array<number>;
|
|
2673
3824
|
};
|
|
2674
3825
|
export type GetSceneSettings_Miscellaneous = {
|
|
3826
|
+
/** The maximum number of time a linker can reference itself. */
|
|
2675
3827
|
maxLinkersRecursionCount?: number;
|
|
3828
|
+
/** The maximum time a script can run before getting aborted. */
|
|
2676
3829
|
maxScriptExecutionTimeInMs?: number;
|
|
3830
|
+
/** Plugins to load at startup */
|
|
2677
3831
|
plugins?: Array<string>;
|
|
2678
3832
|
};
|
|
2679
3833
|
export type GetSceneSettings_Network = {
|
|
3834
|
+
/** Time to wait in seconds with no client before closing the session. */
|
|
2680
3835
|
clientConnectionTimeout?: number;
|
|
2681
3836
|
sendSimulationUpdates?: boolean;
|
|
3837
|
+
/** Time to maintain the session alive without any active client in seconds. */
|
|
2682
3838
|
timeToLiveWithInactiveUsersInSeconds?: number;
|
|
2683
3839
|
waitForDefaultAssetsTimeoutInSeconds?: number;
|
|
2684
3840
|
};
|
|
2685
3841
|
export type GetSceneSettings_Physics = {
|
|
3842
|
+
/** The engine that is powering the physics of the scene. */
|
|
2686
3843
|
engine?: StrictUnion<'physx' | 'xde'>;
|
|
3844
|
+
/** The epsilon used to mark whether the transform of an entity has changed and so whether to notify the physics engine. */
|
|
2687
3845
|
epsilon?: number;
|
|
3846
|
+
/** Global gravity applied throughout the scene. */
|
|
2688
3847
|
gravity?: Array<number>;
|
|
3848
|
+
/** The bigger LMD Max is, the greater the area that is searched for future contacts, and so the greater time taken per iteration. Note that XDE resolves contacts pre-collision, not once collision has taken place, like the majority of physics engines. Displacement of any object per iteration should not exceed LMD Max. */
|
|
2689
3849
|
lmdMax?: number;
|
|
3850
|
+
/** A frame-rate-independent interval that dictates when physics calculations are performed. */
|
|
2690
3851
|
timestepInS?: number;
|
|
3852
|
+
/** The approximate size of objects in the simulation. This is used to estimate certain length-related tolerances. */
|
|
2691
3853
|
toleranceLength?: number;
|
|
3854
|
+
/** The typical magnitude of velocities of objects in simulation. This is used to estimate whether a contact should be treated as bouncing or resting based on its impact velocity, and a kinetic energy threshold below which the simulation may put objects to sleep. For normal physical environments, a good choice is the approximate speed of an object falling under gravity for one second. */
|
|
2692
3855
|
toleranceSpeed?: number;
|
|
2693
3856
|
};
|
|
2694
3857
|
export type GetSceneSettings_Renderer = {
|
|
3858
|
+
/** Enable occlusion culling. */
|
|
2695
3859
|
cpuOcclusionCulling?: boolean;
|
|
3860
|
+
/** Toggle frustum culling */
|
|
2696
3861
|
enableFrustumCulling?: boolean;
|
|
3862
|
+
/** Enables geometry culling. */
|
|
2697
3863
|
enableGeometryCulling?: boolean;
|
|
3864
|
+
/** Enables ray tracing. */
|
|
2698
3865
|
enableRayTracing?: boolean;
|
|
3866
|
+
/** Toggle texture streaming */
|
|
2699
3867
|
enableTextureStreaming?: boolean;
|
|
3868
|
+
/** Time to wait for the GPU in milliseconds. */
|
|
2700
3869
|
endFrameTimeoutInMilliseconds?: number;
|
|
2701
3870
|
};
|
|
2702
3871
|
export type GetSceneSettings_Simulation = {
|
|
3872
|
+
/** Scripts which the client will be automatically attached */
|
|
2703
3873
|
clientScripts?: Array<GetSceneSettings_Object>;
|
|
3874
|
+
/** Camera used when starting the simulation */
|
|
2704
3875
|
mainCamera?: GetSceneSettings_MainCamera;
|
|
2705
3876
|
};
|
|
2706
3877
|
export type GetSceneSettings_Object = {
|
|
2707
3878
|
linkage: Array<string>;
|
|
3879
|
+
/** A unique identifier for an entity. It should be unique across all entities in the scene, but it is not guaranteed to be unique across all scenes. */
|
|
2708
3880
|
originalEUID: string;
|
|
2709
3881
|
};
|
|
2710
3882
|
export type GetSceneSettings_MainCamera = {
|
|
2711
3883
|
linkage: Array<string>;
|
|
3884
|
+
/** A unique identifier for an entity. It should be unique across all entities in the scene, but it is not guaranteed to be unique across all scenes. */
|
|
2712
3885
|
originalEUID: string;
|
|
2713
3886
|
};
|
|
2714
3887
|
export type GetSceneSettings_Sound = {
|
|
3888
|
+
/** Enable 3dverse sound. */
|
|
2715
3889
|
enabled?: boolean;
|
|
2716
3890
|
};
|
|
2717
3891
|
export type GetSceneSettings_Streaming = {
|
|
3892
|
+
/** Scenes that enter this radius around the camera get loaded. */
|
|
2718
3893
|
streamingLoadingRadius?: number;
|
|
3894
|
+
/** Scenes that exit this radius around the camera get unloaded. */
|
|
2719
3895
|
streamingUnloadingRadius?: number;
|
|
2720
3896
|
};
|
|
2721
3897
|
export type GetSceneSettings_Voxel = {
|
|
3898
|
+
/** Maximum number of color samples used to compute the color LUT. */
|
|
2722
3899
|
maxNumberAlbedoValues?: number;
|
|
2723
3900
|
};
|
|
2724
3901
|
/**
|
|
@@ -2728,106 +3905,171 @@ export declare function getSceneSettings({ scene_id, }: {
|
|
|
2728
3905
|
scene_id: string;
|
|
2729
3906
|
}, headers?: AxiosRequestHeaders): AxiosPromise<GetSceneSettings__index_SceneSettings_SceneSettings>;
|
|
2730
3907
|
export type UpdateSceneSettings_SceneSettings = {
|
|
3908
|
+
/** Settings for debug lines */
|
|
2731
3909
|
debug_lines?: UpdateSceneSettings_DebugLines;
|
|
3910
|
+
/** Default camera component of the scene, used to create default cameras. */
|
|
2732
3911
|
default_camera_component?: UpdateSceneSettings_DefaultCameraComponent;
|
|
3912
|
+
/** Default camera global transform of the scene, used to create default cameras. */
|
|
2733
3913
|
default_camera_transform?: UpdateSceneSettings_DefaultCameraTransform;
|
|
3914
|
+
/** Settings for the display */
|
|
2734
3915
|
display?: UpdateSceneSettings_Display;
|
|
3916
|
+
/** Settings for the encoder */
|
|
2735
3917
|
encoder?: UpdateSceneSettings_Encoder;
|
|
3918
|
+
/** Settings for the environment */
|
|
2736
3919
|
environment?: UpdateSceneSettings_Environment;
|
|
3920
|
+
/** Miscellaneous settings */
|
|
2737
3921
|
misc?: UpdateSceneSettings_Miscellaneous;
|
|
3922
|
+
/** Settings for the network */
|
|
2738
3923
|
network?: UpdateSceneSettings_Network;
|
|
3924
|
+
/** Settings for the physics engine. */
|
|
2739
3925
|
physics?: UpdateSceneSettings_Physics;
|
|
3926
|
+
/** Renderer settings */
|
|
2740
3927
|
renderer?: UpdateSceneSettings_Renderer;
|
|
3928
|
+
/** Settings to apply whenever simulation is active */
|
|
2741
3929
|
simulation?: UpdateSceneSettings_Simulation;
|
|
3930
|
+
/** Sound settings */
|
|
2742
3931
|
sound?: UpdateSceneSettings_Sound;
|
|
3932
|
+
/** Settings for the scene streaming */
|
|
2743
3933
|
streaming?: UpdateSceneSettings_Streaming;
|
|
3934
|
+
/** Settings for voxel rendering */
|
|
2744
3935
|
voxel?: UpdateSceneSettings_Voxel;
|
|
2745
3936
|
};
|
|
2746
3937
|
export type UpdateSceneSettings_DebugLines = {
|
|
3938
|
+
/** Whether to draw the bouding boxes of entities */
|
|
2747
3939
|
drawBoundingBoxes?: boolean;
|
|
3940
|
+
/** Whether to draw camera frustums */
|
|
2748
3941
|
drawCameraFrustums?: boolean;
|
|
3942
|
+
/** Whether to draw the center of mass of physics bodies */
|
|
2749
3943
|
drawCenterOfMass?: boolean;
|
|
3944
|
+
/** Whether to draw contacts between physics bodies */
|
|
2750
3945
|
drawContacts?: boolean;
|
|
3946
|
+
/** Whether to draw debug lines */
|
|
2751
3947
|
drawDebugLines?: boolean;
|
|
3948
|
+
/** Whether to draw certain IK parameters like the forward and up vector of an IK Aim node, or the pole vector of an IK Two Bone node */
|
|
2752
3949
|
drawIK?: boolean;
|
|
3950
|
+
/** Whether to draw joint-related debug lines */
|
|
2753
3951
|
drawJoints?: boolean;
|
|
3952
|
+
/** Whether to draw light-related debug lines */
|
|
2754
3953
|
drawLights?: boolean;
|
|
3954
|
+
/** Whether to draw geometry of physics bodies */
|
|
2755
3955
|
drawPhysicsBodies?: boolean;
|
|
3956
|
+
/** Whether to draw physics body axes */
|
|
2756
3957
|
drawPhysicsBodyAxes?: boolean;
|
|
3958
|
+
/** Whether to draw reflection probes */
|
|
2757
3959
|
drawReflectionProbes?: boolean;
|
|
3960
|
+
/** Whether to draw the skeletons of rigged characters */
|
|
2758
3961
|
drawSkeletons?: boolean;
|
|
2759
3962
|
};
|
|
2760
3963
|
export type UpdateSceneSettings_DefaultCameraComponent = {
|
|
3964
|
+
/** Input values as described in the referenced render graph in their original JSON format. */
|
|
2761
3965
|
dataJSON?: object;
|
|
3966
|
+
/** Specifies which render graph this camera should use. */
|
|
2762
3967
|
renderGraphRef?: string;
|
|
3968
|
+
/** Index of the render target to blit. */
|
|
2763
3969
|
renderTargetIndex?: number;
|
|
2764
3970
|
};
|
|
2765
3971
|
export type UpdateSceneSettings_DefaultCameraTransform = {
|
|
3972
|
+
/** Orientation of the camera expressed as a quaternion */
|
|
2766
3973
|
orientation?: Array<number>;
|
|
3974
|
+
/** x, y, z position of the camera */
|
|
2767
3975
|
position?: Array<number>;
|
|
2768
3976
|
};
|
|
2769
3977
|
export type UpdateSceneSettings_Display = {
|
|
3978
|
+
/** Draw frame without input events */
|
|
2770
3979
|
forceRedraw?: boolean;
|
|
3980
|
+
/** When 'Force Redraw' is off, this setting controls the number of frames the renderer will draw before going back to idle */
|
|
2771
3981
|
framePersistence?: number;
|
|
3982
|
+
/** Maximum number of Frames Per Second the renderer is allowed to produce */
|
|
2772
3983
|
maxFPS?: StrictUnion<15 | 30 | 60 | 90> & number;
|
|
3984
|
+
/** Maximum resolution of loaded textures */
|
|
2773
3985
|
maxTextureSize?: StrictUnion<4294967295 | 4 | 8 | 16 | 32 | 64 | 128 | 256 | 512 | 1024 | 2048 | 4096 | 8192> & number;
|
|
2774
3986
|
};
|
|
2775
3987
|
export type UpdateSceneSettings_Encoder = {
|
|
3988
|
+
/** Encoder type. */
|
|
2776
3989
|
encoderType?: string;
|
|
2777
3990
|
};
|
|
2778
3991
|
export type UpdateSceneSettings_Environment = {
|
|
3992
|
+
/** Color of the spherical gradient at the bottom of the sphere. */
|
|
2779
3993
|
ambientColorBottom?: Array<number>;
|
|
3994
|
+
/** Color of the spherical gradient at the top of the sphere. */
|
|
2780
3995
|
ambientColorTop?: Array<number>;
|
|
3996
|
+
/** Solid color used to clear the screen before drawing. */
|
|
2781
3997
|
clearColor?: Array<number>;
|
|
2782
3998
|
};
|
|
2783
3999
|
export type UpdateSceneSettings_Miscellaneous = {
|
|
4000
|
+
/** The maximum number of time a linker can reference itself. */
|
|
2784
4001
|
maxLinkersRecursionCount?: number;
|
|
4002
|
+
/** The maximum time a script can run before getting aborted. */
|
|
2785
4003
|
maxScriptExecutionTimeInMs?: number;
|
|
4004
|
+
/** Plugins to load at startup */
|
|
2786
4005
|
plugins?: Array<string>;
|
|
2787
4006
|
};
|
|
2788
4007
|
export type UpdateSceneSettings_Network = {
|
|
4008
|
+
/** Time to wait in seconds with no client before closing the session. */
|
|
2789
4009
|
clientConnectionTimeout?: number;
|
|
2790
4010
|
sendSimulationUpdates?: boolean;
|
|
4011
|
+
/** Time to maintain the session alive without any active client in seconds. */
|
|
2791
4012
|
timeToLiveWithInactiveUsersInSeconds?: number;
|
|
2792
4013
|
waitForDefaultAssetsTimeoutInSeconds?: number;
|
|
2793
4014
|
};
|
|
2794
4015
|
export type UpdateSceneSettings_Physics = {
|
|
4016
|
+
/** The engine that is powering the physics of the scene. */
|
|
2795
4017
|
engine?: StrictUnion<'physx' | 'xde'>;
|
|
4018
|
+
/** The epsilon used to mark whether the transform of an entity has changed and so whether to notify the physics engine. */
|
|
2796
4019
|
epsilon?: number;
|
|
4020
|
+
/** Global gravity applied throughout the scene. */
|
|
2797
4021
|
gravity?: Array<number>;
|
|
4022
|
+
/** The bigger LMD Max is, the greater the area that is searched for future contacts, and so the greater time taken per iteration. Note that XDE resolves contacts pre-collision, not once collision has taken place, like the majority of physics engines. Displacement of any object per iteration should not exceed LMD Max. */
|
|
2798
4023
|
lmdMax?: number;
|
|
4024
|
+
/** A frame-rate-independent interval that dictates when physics calculations are performed. */
|
|
2799
4025
|
timestepInS?: number;
|
|
4026
|
+
/** The approximate size of objects in the simulation. This is used to estimate certain length-related tolerances. */
|
|
2800
4027
|
toleranceLength?: number;
|
|
4028
|
+
/** The typical magnitude of velocities of objects in simulation. This is used to estimate whether a contact should be treated as bouncing or resting based on its impact velocity, and a kinetic energy threshold below which the simulation may put objects to sleep. For normal physical environments, a good choice is the approximate speed of an object falling under gravity for one second. */
|
|
2801
4029
|
toleranceSpeed?: number;
|
|
2802
4030
|
};
|
|
2803
4031
|
export type UpdateSceneSettings_Renderer = {
|
|
4032
|
+
/** Enable occlusion culling. */
|
|
2804
4033
|
cpuOcclusionCulling?: boolean;
|
|
4034
|
+
/** Toggle frustum culling */
|
|
2805
4035
|
enableFrustumCulling?: boolean;
|
|
4036
|
+
/** Enables geometry culling. */
|
|
2806
4037
|
enableGeometryCulling?: boolean;
|
|
4038
|
+
/** Enables ray tracing. */
|
|
2807
4039
|
enableRayTracing?: boolean;
|
|
4040
|
+
/** Toggle texture streaming */
|
|
2808
4041
|
enableTextureStreaming?: boolean;
|
|
4042
|
+
/** Time to wait for the GPU in milliseconds. */
|
|
2809
4043
|
endFrameTimeoutInMilliseconds?: number;
|
|
2810
4044
|
};
|
|
2811
4045
|
export type UpdateSceneSettings_Simulation = {
|
|
4046
|
+
/** Scripts which the client will be automatically attached */
|
|
2812
4047
|
clientScripts?: Array<UpdateSceneSettings_Object>;
|
|
4048
|
+
/** Camera used when starting the simulation */
|
|
2813
4049
|
mainCamera?: UpdateSceneSettings_MainCamera;
|
|
2814
4050
|
};
|
|
2815
4051
|
export type UpdateSceneSettings_Object = {
|
|
2816
4052
|
linkage: Array<string>;
|
|
4053
|
+
/** A unique identifier for an entity. It should be unique across all entities in the scene, but it is not guaranteed to be unique across all scenes. */
|
|
2817
4054
|
originalEUID: string;
|
|
2818
4055
|
};
|
|
2819
4056
|
export type UpdateSceneSettings_MainCamera = {
|
|
2820
4057
|
linkage: Array<string>;
|
|
4058
|
+
/** A unique identifier for an entity. It should be unique across all entities in the scene, but it is not guaranteed to be unique across all scenes. */
|
|
2821
4059
|
originalEUID: string;
|
|
2822
4060
|
};
|
|
2823
4061
|
export type UpdateSceneSettings_Sound = {
|
|
4062
|
+
/** Enable 3dverse sound. */
|
|
2824
4063
|
enabled?: boolean;
|
|
2825
4064
|
};
|
|
2826
4065
|
export type UpdateSceneSettings_Streaming = {
|
|
4066
|
+
/** Scenes that enter this radius around the camera get loaded. */
|
|
2827
4067
|
streamingLoadingRadius?: number;
|
|
4068
|
+
/** Scenes that exit this radius around the camera get unloaded. */
|
|
2828
4069
|
streamingUnloadingRadius?: number;
|
|
2829
4070
|
};
|
|
2830
4071
|
export type UpdateSceneSettings_Voxel = {
|
|
4072
|
+
/** Maximum number of color samples used to compute the color LUT. */
|
|
2831
4073
|
maxNumberAlbedoValues?: number;
|
|
2832
4074
|
};
|
|
2833
4075
|
/**
|
|
@@ -2838,27 +4080,44 @@ export declare function updateSceneSettings({ scene_id, body, }: {
|
|
|
2838
4080
|
body: UpdateSceneSettings_SceneSettings;
|
|
2839
4081
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2840
4082
|
export type GetRunningSessions_Filter = {
|
|
4083
|
+
/** Filter sessions created by the specified user. Only available while using an api key. */
|
|
2841
4084
|
user_id?: string;
|
|
4085
|
+
/** Filter sessions running a specified scene. */
|
|
2842
4086
|
scene_id?: string;
|
|
4087
|
+
/** Filter sessions running scenes located in the specified folder. */
|
|
2843
4088
|
folder_id?: string;
|
|
2844
4089
|
};
|
|
2845
4090
|
export type GetRunningSessions_Session = {
|
|
4091
|
+
/** Session unique identifier */
|
|
2846
4092
|
session_id: string;
|
|
4093
|
+
/** The main scene identifier of the session */
|
|
2847
4094
|
scene_id: string;
|
|
4095
|
+
/** The main scene name of the session */
|
|
2848
4096
|
scene_name: string;
|
|
4097
|
+
/** The folder identifier of the scene */
|
|
2849
4098
|
folder_id: string;
|
|
4099
|
+
/** Maximum number of users allowed in this session at the same time */
|
|
2850
4100
|
max_users: number;
|
|
4101
|
+
/** User identifier of the creator of the session */
|
|
2851
4102
|
creator_user_id: string;
|
|
4103
|
+
/** Session creation date */
|
|
2852
4104
|
created_at: string;
|
|
4105
|
+
/** Country code of the rendering server location */
|
|
2853
4106
|
country_code: string;
|
|
4107
|
+
/** Continent code of the rendering server location */
|
|
2854
4108
|
continent_code: string;
|
|
4109
|
+
/** Whether the session is transient or not */
|
|
2855
4110
|
is_transient_session: boolean;
|
|
4111
|
+
/** Current clients in session */
|
|
2856
4112
|
clients: Array<GetRunningSessions_Client_UserInfo>;
|
|
2857
4113
|
};
|
|
2858
4114
|
export type GetRunningSessions_Client_UserInfo = {
|
|
4115
|
+
/** Client unique identifier */
|
|
2859
4116
|
client_id?: string;
|
|
2860
4117
|
client_type?: 'user' | 'guest';
|
|
4118
|
+
/** User unique identifier */
|
|
2861
4119
|
user_id: string;
|
|
4120
|
+
/** Used only for debug purposes */
|
|
2862
4121
|
username: string;
|
|
2863
4122
|
};
|
|
2864
4123
|
/**
|
|
@@ -2868,34 +4127,53 @@ export declare function getRunningSessions({ filters, }: {
|
|
|
2868
4127
|
filters?: GetRunningSessions_Filter;
|
|
2869
4128
|
}, headers?: AxiosRequestHeaders): AxiosPromise<Array<GetRunningSessions_Session>>;
|
|
2870
4129
|
export type CreateSession_Object = {
|
|
4130
|
+
/** Session unique identifier */
|
|
2871
4131
|
session_id: string;
|
|
2872
4132
|
};
|
|
2873
4133
|
/**
|
|
2874
4134
|
* Create a new rendering session.
|
|
2875
4135
|
*/
|
|
2876
4136
|
export declare function createSession({ scene_id, renderer_version, is_transient, options, }: {
|
|
4137
|
+
/** Asset unique identifier */
|
|
2877
4138
|
scene_id: string;
|
|
4139
|
+
/** The version of the renderer to use. */
|
|
2878
4140
|
renderer_version?: string;
|
|
4141
|
+
/** Whether the session should be created as transient or not. */
|
|
2879
4142
|
is_transient?: boolean;
|
|
4143
|
+
/** Additional options for the session. For internal use. */
|
|
2880
4144
|
options?: object;
|
|
2881
4145
|
}, headers?: AxiosRequestHeaders): AxiosPromise<CreateSession_Object>;
|
|
2882
4146
|
export type GetSession_Session = {
|
|
4147
|
+
/** Session unique identifier */
|
|
2883
4148
|
session_id: string;
|
|
4149
|
+
/** The main scene identifier of the session */
|
|
2884
4150
|
scene_id: string;
|
|
4151
|
+
/** The main scene name of the session */
|
|
2885
4152
|
scene_name: string;
|
|
4153
|
+
/** The folder identifier of the scene */
|
|
2886
4154
|
folder_id: string;
|
|
4155
|
+
/** Maximum number of users allowed in this session at the same time */
|
|
2887
4156
|
max_users: number;
|
|
4157
|
+
/** User identifier of the creator of the session */
|
|
2888
4158
|
creator_user_id: string;
|
|
4159
|
+
/** Session creation date */
|
|
2889
4160
|
created_at: string;
|
|
4161
|
+
/** Country code of the rendering server location */
|
|
2890
4162
|
country_code: string;
|
|
4163
|
+
/** Continent code of the rendering server location */
|
|
2891
4164
|
continent_code: string;
|
|
4165
|
+
/** Whether the session is transient or not */
|
|
2892
4166
|
is_transient_session: boolean;
|
|
4167
|
+
/** Current clients in session */
|
|
2893
4168
|
clients: Array<GetSession_Client_UserInfo>;
|
|
2894
4169
|
};
|
|
2895
4170
|
export type GetSession_Client_UserInfo = {
|
|
4171
|
+
/** Client unique identifier */
|
|
2896
4172
|
client_id?: string;
|
|
2897
4173
|
client_type?: 'user' | 'guest';
|
|
4174
|
+
/** User unique identifier */
|
|
2898
4175
|
user_id: string;
|
|
4176
|
+
/** Used only for debug purposes */
|
|
2899
4177
|
username: string;
|
|
2900
4178
|
};
|
|
2901
4179
|
/**
|
|
@@ -2911,7 +4189,9 @@ export declare function killSession({ session_id, }: {
|
|
|
2911
4189
|
session_id: string;
|
|
2912
4190
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2913
4191
|
export type JoinSession_SessionToken = {
|
|
4192
|
+
/** The token used to join the requested session */
|
|
2914
4193
|
session_token: string;
|
|
4194
|
+
/** The endpoint to connect to */
|
|
2915
4195
|
endpoint_info: JoinSession_Object;
|
|
2916
4196
|
};
|
|
2917
4197
|
export type JoinSession_Object = {
|
|
@@ -2924,12 +4204,17 @@ export type JoinSession_Object = {
|
|
|
2924
4204
|
*/
|
|
2925
4205
|
export declare function joinSession({ session_id, is_headless, }: {
|
|
2926
4206
|
session_id: string;
|
|
4207
|
+
/** Declare that the client is headless and will not receive any frames. Useful for clients running on servers or in the background.
|
|
4208
|
+
*/
|
|
2927
4209
|
is_headless?: boolean;
|
|
2928
4210
|
}, headers?: AxiosRequestHeaders): AxiosPromise<JoinSession_SessionToken>;
|
|
2929
4211
|
export type GetClient_Client_UserInfo = {
|
|
4212
|
+
/** Client unique identifier */
|
|
2930
4213
|
client_id?: string;
|
|
2931
4214
|
client_type?: 'user' | 'guest';
|
|
4215
|
+
/** User unique identifier */
|
|
2932
4216
|
user_id: string;
|
|
4217
|
+
/** Used only for debug purposes */
|
|
2933
4218
|
username: string;
|
|
2934
4219
|
};
|
|
2935
4220
|
/**
|
|
@@ -2947,7 +4232,9 @@ export declare function kickClientFromSession({ session_id, client_id, }: {
|
|
|
2947
4232
|
client_id: string;
|
|
2948
4233
|
}, headers?: AxiosRequestHeaders): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
2949
4234
|
export type JoinSessionAsGuest_SessionToken = {
|
|
4235
|
+
/** The token used to join the requested session */
|
|
2950
4236
|
session_token: string;
|
|
4237
|
+
/** The endpoint to connect to */
|
|
2951
4238
|
endpoint_info: JoinSessionAsGuest_Object;
|
|
2952
4239
|
};
|
|
2953
4240
|
export type JoinSessionAsGuest_Object = {
|
|
@@ -2960,6 +4247,7 @@ export type JoinSessionAsGuest_Object = {
|
|
|
2960
4247
|
*/
|
|
2961
4248
|
export declare function joinSessionAsGuest(headers?: AxiosRequestHeaders): AxiosPromise<JoinSessionAsGuest_SessionToken>;
|
|
2962
4249
|
export type GenerateGuestToken_GuestToken = {
|
|
4250
|
+
/** The token used to join the requested session as a guest */
|
|
2963
4251
|
guest_token?: string;
|
|
2964
4252
|
};
|
|
2965
4253
|
/**
|