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