@3dverse/livelink.core 0.1.0

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.
Files changed (99) hide show
  1. package/LICENSE +4 -0
  2. package/README.md +81 -0
  3. package/dist/_prebuild/EditorConnection.d.ts +54 -0
  4. package/dist/_prebuild/EditorConnection.d.ts.map +1 -0
  5. package/dist/_prebuild/EditorMessageHandler.d.ts +102 -0
  6. package/dist/_prebuild/EditorMessageHandler.d.ts.map +1 -0
  7. package/dist/_prebuild/GatewayConnection.d.ts +63 -0
  8. package/dist/_prebuild/GatewayConnection.d.ts.map +1 -0
  9. package/dist/_prebuild/GatewayMessageHandler.d.ts +179 -0
  10. package/dist/_prebuild/GatewayMessageHandler.d.ts.map +1 -0
  11. package/dist/_prebuild/enums.d.ts +4 -0
  12. package/dist/_prebuild/enums.d.ts.map +1 -0
  13. package/dist/_prebuild/messages/editor/ConnectConfirmation.d.ts +55 -0
  14. package/dist/_prebuild/messages/editor/ConnectConfirmation.d.ts.map +1 -0
  15. package/dist/_prebuild/messages/editor/EditorEntity.d.ts +27 -0
  16. package/dist/_prebuild/messages/editor/EditorEntity.d.ts.map +1 -0
  17. package/dist/_prebuild/messages/editor/EntityCreationOptions.d.ts +7 -0
  18. package/dist/_prebuild/messages/editor/EntityCreationOptions.d.ts.map +1 -0
  19. package/dist/_prebuild/messages/editor/EntityUpdatedEvent.d.ts +8 -0
  20. package/dist/_prebuild/messages/editor/EntityUpdatedEvent.d.ts.map +1 -0
  21. package/dist/_prebuild/messages/editor/UpdateComponentsCommand.d.ts +7 -0
  22. package/dist/_prebuild/messages/editor/UpdateComponentsCommand.d.ts.map +1 -0
  23. package/dist/_prebuild/messages/editor/index.d.ts +6 -0
  24. package/dist/_prebuild/messages/editor/index.d.ts.map +1 -0
  25. package/dist/_prebuild/messages/gateway/AssignClientToScriptMessage.d.ts +22 -0
  26. package/dist/_prebuild/messages/gateway/AssignClientToScriptMessage.d.ts.map +1 -0
  27. package/dist/_prebuild/messages/gateway/AuthenticationResponse.d.ts +32 -0
  28. package/dist/_prebuild/messages/gateway/AuthenticationResponse.d.ts.map +1 -0
  29. package/dist/_prebuild/messages/gateway/ClientConfig.d.ts +38 -0
  30. package/dist/_prebuild/messages/gateway/ClientConfig.d.ts.map +1 -0
  31. package/dist/_prebuild/messages/gateway/ClientConfigResponse.d.ts +17 -0
  32. package/dist/_prebuild/messages/gateway/ClientConfigResponse.d.ts.map +1 -0
  33. package/dist/_prebuild/messages/gateway/FireEventMessage.d.ts +23 -0
  34. package/dist/_prebuild/messages/gateway/FireEventMessage.d.ts.map +1 -0
  35. package/dist/_prebuild/messages/gateway/FrameData.d.ts +48 -0
  36. package/dist/_prebuild/messages/gateway/FrameData.d.ts.map +1 -0
  37. package/dist/_prebuild/messages/gateway/HighlightEntitiesMessage.d.ts +23 -0
  38. package/dist/_prebuild/messages/gateway/HighlightEntitiesMessage.d.ts.map +1 -0
  39. package/dist/_prebuild/messages/gateway/InputState.d.ts +23 -0
  40. package/dist/_prebuild/messages/gateway/InputState.d.ts.map +1 -0
  41. package/dist/_prebuild/messages/gateway/RemoveComponentsCommand.d.ts +24 -0
  42. package/dist/_prebuild/messages/gateway/RemoveComponentsCommand.d.ts.map +1 -0
  43. package/dist/_prebuild/messages/gateway/ResizeResponse.d.ts +15 -0
  44. package/dist/_prebuild/messages/gateway/ResizeResponse.d.ts.map +1 -0
  45. package/dist/_prebuild/messages/gateway/ScreenSpaceRayQuery.d.ts +30 -0
  46. package/dist/_prebuild/messages/gateway/ScreenSpaceRayQuery.d.ts.map +1 -0
  47. package/dist/_prebuild/messages/gateway/ScreenSpaceRayResult.d.ts +17 -0
  48. package/dist/_prebuild/messages/gateway/ScreenSpaceRayResult.d.ts.map +1 -0
  49. package/dist/_prebuild/messages/gateway/ScriptEvent.d.ts +18 -0
  50. package/dist/_prebuild/messages/gateway/ScriptEvent.d.ts.map +1 -0
  51. package/dist/_prebuild/messages/gateway/SessionAuth.d.ts +9 -0
  52. package/dist/_prebuild/messages/gateway/SessionAuth.d.ts.map +1 -0
  53. package/dist/_prebuild/messages/gateway/UpdateAnimationSequenceStateMessage.d.ts +26 -0
  54. package/dist/_prebuild/messages/gateway/UpdateAnimationSequenceStateMessage.d.ts.map +1 -0
  55. package/dist/_prebuild/messages/gateway/UpdateEntitiesFromJsonMessage.d.ts +24 -0
  56. package/dist/_prebuild/messages/gateway/UpdateEntitiesFromJsonMessage.d.ts.map +1 -0
  57. package/dist/_prebuild/messages/gateway/ViewportConfig.d.ts +24 -0
  58. package/dist/_prebuild/messages/gateway/ViewportConfig.d.ts.map +1 -0
  59. package/dist/_prebuild/messages/gateway/enums.d.ts +120 -0
  60. package/dist/_prebuild/messages/gateway/enums.d.ts.map +1 -0
  61. package/dist/_prebuild/messages/gateway/index.d.ts +18 -0
  62. package/dist/_prebuild/messages/gateway/index.d.ts.map +1 -0
  63. package/dist/_prebuild/types/assets.d.ts +24 -0
  64. package/dist/_prebuild/types/assets.d.ts.map +1 -0
  65. package/dist/_prebuild/types/components.d.ts +950 -0
  66. package/dist/_prebuild/types/components.d.ts.map +1 -0
  67. package/dist/sources/ComponentSerializer.d.ts +20 -0
  68. package/dist/sources/ComponentSerializer.d.ts.map +1 -0
  69. package/dist/sources/LivelinkCore.d.ts +161 -0
  70. package/dist/sources/LivelinkCore.d.ts.map +1 -0
  71. package/dist/sources/RequestHandler.d.ts +48 -0
  72. package/dist/sources/RequestHandler.d.ts.map +1 -0
  73. package/dist/sources/controllers/EditorController.d.ts +22 -0
  74. package/dist/sources/controllers/EditorController.d.ts.map +1 -0
  75. package/dist/sources/controllers/GatewayController.d.ts +31 -0
  76. package/dist/sources/controllers/GatewayController.d.ts.map +1 -0
  77. package/dist/sources/index.d.ts +11 -0
  78. package/dist/sources/index.d.ts.map +1 -0
  79. package/dist/sources/interfaces/ClientInterface.d.ts +8 -0
  80. package/dist/sources/interfaces/ClientInterface.d.ts.map +1 -0
  81. package/dist/sources/interfaces/EntityInterface.d.ts +8 -0
  82. package/dist/sources/interfaces/EntityInterface.d.ts.map +1 -0
  83. package/dist/sources/interfaces/SessionInterface.d.ts +20 -0
  84. package/dist/sources/interfaces/SessionInterface.d.ts.map +1 -0
  85. package/dist/sources/interfaces/index.d.ts +4 -0
  86. package/dist/sources/interfaces/index.d.ts.map +1 -0
  87. package/dist/sources/types/RTID.d.ts +24 -0
  88. package/dist/sources/types/RTID.d.ts.map +1 -0
  89. package/dist/sources/types/UUID.d.ts +24 -0
  90. package/dist/sources/types/UUID.d.ts.map +1 -0
  91. package/dist/sources/types/constants.d.ts +8 -0
  92. package/dist/sources/types/constants.d.ts.map +1 -0
  93. package/dist/sources/types/index.d.ts +5 -0
  94. package/dist/sources/types/index.d.ts.map +1 -0
  95. package/dist/sources/types/math.d.ts +87 -0
  96. package/dist/sources/types/math.d.ts.map +1 -0
  97. package/dist/sources/types/nativeTypes.d.ts +11 -0
  98. package/dist/sources/types/nativeTypes.d.ts.map +1 -0
  99. package/package.json +23 -0
@@ -0,0 +1,950 @@
1
+ /**
2
+ * DO NOT EDIT THIS FILE MANUALLY.
3
+ * This file has been generated automatically from ftl-schemas
4
+ */
5
+ import type { RTID, UUID, Quat, Vec3, Vec2, Int32, UInt32, Float, Int8 } from "../../sources/types";
6
+ import type * as Assets from "./assets";
7
+ /**
8
+ *
9
+ */
10
+ export type ComponentType = keyof typeof ComponentHash;
11
+ /**
12
+ *
13
+ */
14
+ export type AssetRef<T> = UUID;
15
+ /**
16
+ *
17
+ */
18
+ export type EntityRef = {
19
+ originalEUID: UUID;
20
+ linkage: Array<UUID>;
21
+ };
22
+ /**
23
+ *
24
+ */
25
+ export type Euid = {
26
+ value: UUID;
27
+ rtid: RTID;
28
+ };
29
+ /**
30
+ * Animation controller with reference to an animation graph and an animation set. Enables skeletal animation on its skinned mesh descendents whose skeleton is compatible with the animations in the animation set.
31
+ */
32
+ export type AnimationController = Partial<{
33
+ /**
34
+ * UUID of the referenced animation graph.
35
+ */
36
+ animationGraphRef: AssetRef<Assets.AnimationGraph>;
37
+ /**
38
+ * UUID of the referenced animation set.
39
+ */
40
+ animationSetRef: AssetRef<Assets.AnimationSet>;
41
+ /**
42
+ * Input values as described in the referenced animation graph in their original JSON format.
43
+ */
44
+ dataJSON: Record<string, unknown>;
45
+ /**
46
+ * Reference to the entity with the bone component that corresponds the root bone of the skeleton.
47
+ */
48
+ rootBoneEntityRef: EntityRef;
49
+ /**
50
+ * Whether or not root motion is enabled.
51
+ */
52
+ rootMotionEnabled: boolean;
53
+ }>;
54
+ /**
55
+ * Links entity to bone in skeleton.
56
+ */
57
+ export type Bone = Partial<{
58
+ /**
59
+ * Index of bone in skeleton.
60
+ */
61
+ boneIndex: UInt32;
62
+ }>;
63
+ /**
64
+ * Box geometry.
65
+ */
66
+ export type BoxGeometry = Partial<{
67
+ /**
68
+ * Width, height and depth of the box.
69
+ */
70
+ dimension: Vec3;
71
+ /**
72
+ * Geometry offset.
73
+ */
74
+ offset: Vec3;
75
+ }>;
76
+ /**
77
+ * Virtual camera.
78
+ */
79
+ export type Camera = Partial<{
80
+ /**
81
+ * UUID of the referenced render graph this camera should use.
82
+ */
83
+ renderGraphRef: AssetRef<Assets.RenderGraph>;
84
+ /**
85
+ * Index of the render target to blit.
86
+ */
87
+ renderTargetIndex: Int32;
88
+ /**
89
+ * Input values as described in the referenced render graph in their original JSON format.
90
+ */
91
+ dataJSON: Record<string, unknown>;
92
+ }>;
93
+ /**
94
+ * Capsule geometry.
95
+ */
96
+ export type CapsuleGeometry = Partial<{
97
+ /**
98
+ * Radius of the spheres at each end of the capsule.
99
+ */
100
+ radius: Float;
101
+ /**
102
+ * Height of the cylindrical part of the capsule.
103
+ */
104
+ height: Float;
105
+ /**
106
+ * Alignment axis. 0 for X, 1 for Y, 2 for Z.
107
+ */
108
+ axis: Int32;
109
+ /**
110
+ * Geometry offset.
111
+ */
112
+ offset: Vec3;
113
+ }>;
114
+ /**
115
+ * Character controller used for movement constrained by collisions without having to deal with a rigid body. A character controller is kinematic, and so is not affected by forces. It uses its own tweaked collision algorithm to give a good feeling while controlling the character.
116
+ */
117
+ export type CharacterController = Partial<{
118
+ /**
119
+ * Step offset. If the height of a step is greater than stepOffset, the controller cannot climb automatically and gets stuck.
120
+ */
121
+ stepOffset: Float;
122
+ /**
123
+ * Slope limit in degrees. A slope steeper than the slopeLimit will not be walkable by the controller.
124
+ */
125
+ slopeLimit: Float;
126
+ /**
127
+ * The character's collision skin width.
128
+ */
129
+ skinWidth: Float;
130
+ /**
131
+ * Displacement vector for current frame.
132
+ */
133
+ displacement: Vec3;
134
+ }>;
135
+ /**
136
+ * Reference to a collision geometry.
137
+ */
138
+ export type CollisionGeometryRef = Partial<{
139
+ /**
140
+ * UUID of the referenced collision geometry.
141
+ */
142
+ collisionGeometryRef: AssetRef<Assets.CollisionGeometry>;
143
+ }>;
144
+ /**
145
+ * A physics constraint that can be configured along 6 degrees of freedom. In its default state it behaves as a fixed constraint - that is, it rigidly fixes the constraint frames of its two entities. However, individual degrees of freedom may be unlocked to permit any combination of rotation around the x-, y- and z- axes, and translation along these axes.
146
+ */
147
+ export type Constraint = Partial<{
148
+ /**
149
+ * Motion along the X axis
150
+ */
151
+ motionAlongX: Int32;
152
+ /**
153
+ * Motion along the Y axis
154
+ */
155
+ motionAlongY: Int32;
156
+ /**
157
+ * Motion along the Z axis
158
+ */
159
+ motionAlongZ: Int32;
160
+ /**
161
+ * Motion around the X axis
162
+ */
163
+ motionAroundX: Int32;
164
+ /**
165
+ * Motion around the Y axis
166
+ */
167
+ motionAroundY: Int32;
168
+ /**
169
+ * Motion around the Z axis
170
+ */
171
+ motionAroundZ: Int32;
172
+ /**
173
+ * The lower distance of the limit.
174
+ */
175
+ motionLowerLimit: Vec3;
176
+ /**
177
+ * The upper distance of the limit.
178
+ */
179
+ motionUpperLimit: Vec3;
180
+ /**
181
+ * If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
182
+ */
183
+ motionLimitSpringStiffness: Vec3;
184
+ /**
185
+ * If greater than zero, this is the damping of the limit spring.
186
+ */
187
+ motionLimitSpringDamping: Vec3;
188
+ /**
189
+ * The limit angle from the Y-axis and the Z-axis of the constraint frame. The cone limit is used if either or both swing axes are limited. The extents are symmetrical and measured in the frame of the parent. If only one swing degree of freedom is limited, the corresponding value from the cone limit defines the limit range.
190
+ */
191
+ swingLimitAngle: Vec2;
192
+ /**
193
+ * If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
194
+ */
195
+ swingSpringStiffness: Float;
196
+ /**
197
+ * If greater than zero, this is the damping of the limit spring.
198
+ */
199
+ swingSpringDamping: Float;
200
+ /**
201
+ * The twist limit controls the range of motion around the twist axis. The limit angle range is (-360, 360).
202
+ */
203
+ twistLimitAngle: Vec2;
204
+ /**
205
+ * If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
206
+ */
207
+ twistSpringStiffness: Float;
208
+ /**
209
+ * If greater than zero, this is the damping of the limit spring.
210
+ */
211
+ twistSpringDamping: Float;
212
+ /**
213
+ * If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
214
+ */
215
+ linearDriveStiffness: Vec3;
216
+ /**
217
+ * If greater than zero, this is the damping of the limit spring.
218
+ */
219
+ linearDriveDamping: Vec3;
220
+ /**
221
+ * The maximum impulse or force that can be exerted by the drive. -1 for no limit.
222
+ */
223
+ linearDriveForceLimit: Vec3;
224
+ /**
225
+ * If greater than zero, the limit is soft, i.e. a spring pulls the joint back to the limit.
226
+ */
227
+ angularDriveStiffness: Vec3;
228
+ /**
229
+ * If greater than zero, this is the damping of the limit spring.
230
+ */
231
+ angularDriveDamping: Vec3;
232
+ /**
233
+ * The maximum impulse or force that can be exerted by the drive. -1 for no limit.
234
+ */
235
+ angularDriveForceLimit: Vec3;
236
+ /**
237
+ * The drive type
238
+ */
239
+ driveType: Int8;
240
+ /**
241
+ * The goal velocity for linear drive.
242
+ */
243
+ driveLinearVelocity: Vec3;
244
+ /**
245
+ * The goal velocity for angular drive.
246
+ */
247
+ driveAngularVelocity: Vec3;
248
+ }>;
249
+ /**
250
+ * Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.
251
+ */
252
+ export type CullingGeometry = Partial<{
253
+ /**
254
+ * Additive geometry will only display elements (vertices or voxels) inside the geometry. Subtractive will only display elements outside the geometry.
255
+ */
256
+ isAdditive: boolean;
257
+ }>;
258
+ /**
259
+ * Cylinder geometry.
260
+ */
261
+ export type CylinderGeometry = Partial<{
262
+ /**
263
+ * Radius of the cylinder.
264
+ */
265
+ radius: Float;
266
+ /**
267
+ * Height of the cylinder.
268
+ */
269
+ height: Float;
270
+ /**
271
+ * Alignment axis. 0 for X, 1 for Y, 2 for Z.
272
+ */
273
+ axis: Int32;
274
+ /**
275
+ * Geometry offset.
276
+ */
277
+ offset: Vec3;
278
+ }>;
279
+ /**
280
+ * Name of the entity.
281
+ */
282
+ export type DebugName = Partial<{
283
+ /**
284
+ * Entity name.
285
+ */
286
+ value: string;
287
+ }>;
288
+ /**
289
+ * Decal Projector.
290
+ */
291
+ export type DecalProjector = Partial<{
292
+ /**
293
+ * Z-Index order of the decal projection. The higher index will render on top of the lower ones.
294
+ */
295
+ zIndex: Int32;
296
+ }>;
297
+ /**
298
+ * The environment of a scene. Used to give a scene a skybox.
299
+ */
300
+ export type Environment = Partial<{
301
+ /**
302
+ * UUID of the skybox cubemap.
303
+ */
304
+ skyboxUUID: AssetRef<Assets.Cubemap>;
305
+ /**
306
+ * Reference to the radiance cubemap.
307
+ */
308
+ radianceUUID: AssetRef<Assets.Cubemap>;
309
+ /**
310
+ * Reference to the irradiance cubemap.
311
+ */
312
+ irradianceUUID: AssetRef<Assets.Cubemap>;
313
+ }>;
314
+ /**
315
+ * Base component of all the other joint components (revolute_joint, etc.). By itself it will lock the orientations and distances of the constrainer and constrainee.
316
+ */
317
+ export type Joint = Partial<{
318
+ /**
319
+ * An entity that is a rigid body.
320
+ */
321
+ constrainee: EntityRef;
322
+ /**
323
+ * An entity that is a rigid or static body, or simply null.
324
+ */
325
+ constrainer: EntityRef;
326
+ /**
327
+ * The force that needs to be applied for this joint to break.
328
+ */
329
+ breakForce: Float;
330
+ /**
331
+ * The torque that needs to be applied for this joint to break.
332
+ */
333
+ breakTorque: Float;
334
+ /**
335
+ * Whether to enable collision between constrainer and constrainee.
336
+ */
337
+ enableCollision: boolean;
338
+ }>;
339
+ /**
340
+ * Lineage of the entity through linkers.
341
+ */
342
+ export type Lineage = Partial<{
343
+ /**
344
+ * UUID of the parent of this entity (default is root).
345
+ */
346
+ parentUUID: UUID;
347
+ /**
348
+ * Ordinal number of this entity in respect of its siblings.
349
+ */
350
+ ordinal: Int32;
351
+ }>;
352
+ /**
353
+ * Local Axis Aligned Bounding Box of the entity.
354
+ */
355
+ export type LocalAabb = Partial<{
356
+ /**
357
+ * Minimum point of the box.
358
+ */
359
+ min: Vec3;
360
+ /**
361
+ * Maximum point of the box.
362
+ */
363
+ max: Vec3;
364
+ }>;
365
+ /**
366
+ * Local transform of the entity.
367
+ */
368
+ export type LocalTransform = Partial<{
369
+ /**
370
+ * x, y, z position of the entity.
371
+ */
372
+ position: Vec3;
373
+ /**
374
+ * Orientation of the entity expressed as a quaternion.
375
+ */
376
+ orientation: Quat;
377
+ /**
378
+ * x, y, z scale of the entity.
379
+ */
380
+ scale: Vec3;
381
+ /**
382
+ * Orientation of the entity expressed as euler angles.
383
+ */
384
+ eulerOrientation: Vec3;
385
+ /**
386
+ * Last global orientation of the entity expressed as euler angles submitted by a user. This value may not be valid, and should be checked.
387
+ */
388
+ globalEulerOrientation: Vec3;
389
+ }>;
390
+ /**
391
+ * References a shader and specifies input values if needed.
392
+ */
393
+ export type Material = Partial<{
394
+ /**
395
+ * UUID of the referenced shader.
396
+ */
397
+ shaderRef: AssetRef<Assets.Shader>;
398
+ /**
399
+ * Whether the material is double sided or not.
400
+ */
401
+ isDoubleSided: boolean;
402
+ /**
403
+ * Input values as described in the referenced shader in their original JSON format.
404
+ */
405
+ dataJSON: Record<string, unknown>;
406
+ /**
407
+ * Specialization constants values as described in the referenced shader in their original JSON format.
408
+ */
409
+ constantsJSON: Record<string, unknown>;
410
+ }>;
411
+ /**
412
+ * Reference to a material.
413
+ */
414
+ export type MaterialRef = Partial<{
415
+ /**
416
+ * UUID of the referenced material.
417
+ */
418
+ value: AssetRef<Assets.Material>;
419
+ /**
420
+ * Face culling mode. 0 to inherit from material, 1 for single sided, 2 for double sided.
421
+ */
422
+ faceCulling: Int32;
423
+ }>;
424
+ /**
425
+ * Reference to a mesh.
426
+ */
427
+ export type MeshRef = Partial<{
428
+ /**
429
+ * UUID of the referenced mesh.
430
+ */
431
+ value: AssetRef<Assets.Mesh>;
432
+ /**
433
+ * Index of the submesh inside the mesh's submesh array.
434
+ */
435
+ submeshIndex: Int32;
436
+ }>;
437
+ /**
438
+ * A lens that applies an orthographic projection.
439
+ */
440
+ export type OrthographicLens = Partial<{
441
+ /**
442
+ * Left plane.
443
+ */
444
+ left: Float;
445
+ /**
446
+ * Right plane.
447
+ */
448
+ right: Float;
449
+ /**
450
+ * Top plane.
451
+ */
452
+ top: Float;
453
+ /**
454
+ * Bottom plane.
455
+ */
456
+ bottom: Float;
457
+ /**
458
+ * Near plane.
459
+ */
460
+ zNear: Float;
461
+ /**
462
+ * Far plane.
463
+ */
464
+ zFar: Float;
465
+ }>;
466
+ /**
467
+ * Overrides a given entity in a sub scene.
468
+ */
469
+ export type Overrider = Partial<{
470
+ /**
471
+ * Mark the overridden entity as deleted.
472
+ */
473
+ deleter: boolean;
474
+ /**
475
+ * Entity to override.
476
+ */
477
+ entityRef: EntityRef;
478
+ /**
479
+ * Hashes of the components to detach from the overridden entity.
480
+ */
481
+ componentsToDetach: Array<Int32>;
482
+ }>;
483
+ /**
484
+ * A lens that applies a perspective projection.
485
+ */
486
+ export type PerspectiveLens = Partial<{
487
+ /**
488
+ * Aspect ratio of the viewport, usually equals width/height.
489
+ */
490
+ aspectRatio: Float;
491
+ /**
492
+ * Field of view angle in the y direction.
493
+ */
494
+ fovy: Float;
495
+ /**
496
+ * Distance from the viewer to the near clipping plane.
497
+ */
498
+ nearPlane: Float;
499
+ /**
500
+ * Distance from the viewer to the far clipping plane.
501
+ */
502
+ farPlane: Float;
503
+ }>;
504
+ /**
505
+ * Physics material which represents a set of physical surface properties.
506
+ */
507
+ export type PhysicsMaterial = Partial<{
508
+ /**
509
+ * The friction coefficient applied between this surface and another surface if they are not moving lateral to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. Resulting static friction of a physics body colliding with another is determined by the average of both bodies' static friction coefficient.
510
+ */
511
+ staticFriction: Float;
512
+ /**
513
+ * The friction coefficient applied between this surface and another surface if they are moving relative to each other. Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving. If set to greater than staticFriction, the effective value of staticFriction will be increased to match. Resulting dynamic friction of a physics body colliding with another is determined by the average of both bodies' dynamic friction coefficient.
514
+ */
515
+ dynamicFriction: Float;
516
+ /**
517
+ * Restitution coefficient, or bounciness of surface. A coefficient of 0 indicates as little bounce as possible, higher values up to 1.0 result in more bounce. Should be in the range [0,1]. Resulting bounciness of a physics body colliding with another is determined by the average of both bodies' restitution.
518
+ */
519
+ restitution: Float;
520
+ /**
521
+ * The velocity applied to the contact between this physics body and another body. Only applies if modifyContact is true.
522
+ */
523
+ contactVelocity: Vec3;
524
+ /**
525
+ * Whether to modify the contact when this physics body collides with another body.
526
+ */
527
+ modifyContact: boolean;
528
+ /**
529
+ * Whether to consider the geometry associated to this physics material as a trigger or not.
530
+ */
531
+ isTrigger: boolean;
532
+ }>;
533
+ /**
534
+ * Plane geometry.
535
+ */
536
+ export type PlaneGeometry = Partial<{
537
+ /**
538
+ * Distance from the origin in the plane's normal direction.
539
+ */
540
+ distance: Float;
541
+ /**
542
+ * Normal of the plane.
543
+ */
544
+ normal: Vec3;
545
+ }>;
546
+ /**
547
+ * Reference to a point cloud.
548
+ */
549
+ export type PointCloudRef = Partial<{
550
+ /**
551
+ * UUID of the referenced point cloud.
552
+ */
553
+ value: AssetRef<Assets.PointCloud>;
554
+ }>;
555
+ /**
556
+ * A light with color and intensity. A point light by default, add a spot light component to add a cutoff. Can be parameterized to simulate the atmosphere sun.
557
+ */
558
+ export type PointLight = Partial<{
559
+ /**
560
+ * Light color.
561
+ */
562
+ color: Vec3;
563
+ /**
564
+ * Light intensity.
565
+ */
566
+ intensity: Float;
567
+ /**
568
+ * The range for the point light. If the range is 0, then physically correct point light attenuation function is used.
569
+ */
570
+ range: Float;
571
+ /**
572
+ * Make this light directional, position is ignored in this case.
573
+ */
574
+ isDirectional: boolean;
575
+ /**
576
+ * Make this light direction control the atmosphere sun direction. If more than one light is marked to be a sun results are undefined.
577
+ */
578
+ isSun: boolean;
579
+ }>;
580
+ /**
581
+ * Omni directional reflection probe parameters, used for local cubemap reflection generation.
582
+ */
583
+ export type ReflectionProbe = Partial<{
584
+ /**
585
+ * x, y, z offset of the probe reflection origin.
586
+ */
587
+ offset: Vec3;
588
+ /**
589
+ * Distance to the near plane.
590
+ */
591
+ nearDist: Float;
592
+ /**
593
+ * Distance to the far plane.
594
+ */
595
+ farDist: Float;
596
+ /**
597
+ * Resolution of the reflection map.
598
+ */
599
+ quality: Int32;
600
+ }>;
601
+ /**
602
+ * Revolute joint which keeps the origins and x-axes of the frames together, and allows free rotation around this common axis.
603
+ */
604
+ export type RevoluteJoint = Partial<{
605
+ /**
606
+ * The minimum angle the rotation can go (in degrees).
607
+ */
608
+ minRotation: Float;
609
+ /**
610
+ * The maximum angle the rotation can go (in degrees).
611
+ */
612
+ maxRotation: Float;
613
+ /**
614
+ * If greater than zero, the rotation limits (minRotation, maxRotation) are soft, i.e. a spring pulls the joint back to the limit.
615
+ */
616
+ stiffness: Float;
617
+ /**
618
+ * If stiffness is greater than zero, this is the damping of the limit spring.
619
+ */
620
+ damping: Float;
621
+ }>;
622
+ /**
623
+ * Rigid body parameters.
624
+ */
625
+ export type RigidBody = Partial<{
626
+ /**
627
+ * Mass of the rigid body. A value of 0 is interpreted as infinite mass.
628
+ */
629
+ mass: Float;
630
+ /**
631
+ * Center of mass. Relative to the entity's transform.
632
+ */
633
+ centerOfMass: Vec3;
634
+ /**
635
+ * Linear damping coefficient. Used to slow down the rigid body's linear velocity. Zero represents no damping. Must be non-negative.
636
+ */
637
+ linearDamping: Float;
638
+ /**
639
+ * Angular damping coefficient. Used to slow down the rigid body's angular velocity, i.e. how much it rotates. Zero represents no damping. Must be non-negative.
640
+ */
641
+ angularDamping: Float;
642
+ /**
643
+ *
644
+ */
645
+ force: Vec3;
646
+ /**
647
+ *
648
+ */
649
+ torque: Vec3;
650
+ /**
651
+ * The type of collision detection to use for this rigid body.
652
+ */
653
+ collisionDetection: Int32;
654
+ /**
655
+ * Controls whether rigid body is affected by gravity.
656
+ */
657
+ useGravity: boolean;
658
+ /**
659
+ * Specifies if rigid body is kinematic. Kinematic rigid bodies are not affected by forces such as gravity.
660
+ */
661
+ isKinematic: boolean;
662
+ }>;
663
+ /**
664
+ * Reference to a scene.
665
+ */
666
+ export type SceneRef = Partial<{
667
+ /**
668
+ * UUID of the referenced scene.
669
+ */
670
+ value: AssetRef<Assets.Scene>;
671
+ /**
672
+ * Maximum number of times a scene appears when it references itself.
673
+ */
674
+ maxRecursionCount: UInt32;
675
+ }>;
676
+ /**
677
+ * References a script and specifies input values if needed.
678
+ */
679
+ export type ScriptElement = Partial<{
680
+ /**
681
+ * UUID of the referenced script.
682
+ */
683
+ scriptRef: AssetRef<Assets.Script>;
684
+ /**
685
+ * Input values as described in the referenced script in their original JSON format.
686
+ */
687
+ dataJSON: Record<string, unknown>;
688
+ }>;
689
+ /**
690
+ * References multiple scripts.
691
+ */
692
+ export type ScriptMap = Partial<{
693
+ /**
694
+ * List of scripts.
695
+ */
696
+ elements: Record<UUID, ScriptElement>;
697
+ }>;
698
+ /**
699
+ * Enables a light to cast shadows.
700
+ */
701
+ export type ShadowCaster = Partial<{
702
+ /**
703
+ * Bias to apply to avoid self shadowing artifacts.
704
+ */
705
+ bias: Float;
706
+ /**
707
+ * Distance to the near plane.
708
+ */
709
+ nearDist: Float;
710
+ /**
711
+ * Distance to the far plane.
712
+ */
713
+ farDist: Float;
714
+ /**
715
+ * Resolution of the shadow map.
716
+ */
717
+ quality: Int32;
718
+ /**
719
+ * Skews the ratio of cascade splits, value ranges from 0 to 1.
720
+ */
721
+ cascadeSplitLambda: Float;
722
+ /**
723
+ * Distance to the end of the furthest cascade.
724
+ */
725
+ cascadeMaxZ: Float;
726
+ /**
727
+ * For directional lights, accumulate all shadow cascades.
728
+ */
729
+ accumulateShadowCascades: boolean;
730
+ }>;
731
+ /**
732
+ * Reference to a skeleton.
733
+ */
734
+ export type SkeletonRef = Partial<{
735
+ /**
736
+ * UUID of the referenced skeleton.
737
+ */
738
+ value: AssetRef<Assets.Skeleton>;
739
+ }>;
740
+ /**
741
+ * Reference to a sound.
742
+ */
743
+ export type SoundRef = Partial<{
744
+ /**
745
+ * UUID of the referenced sound.
746
+ */
747
+ value: AssetRef<Assets.Sound>;
748
+ /**
749
+ * Volume from 0.0f to 1.0f.
750
+ */
751
+ volume: Float;
752
+ /**
753
+ * Pan. -1.0f is left, 1.0f is right.
754
+ */
755
+ pan: Float;
756
+ /**
757
+ * The speed at which the sound will play. 1.0f is normal.
758
+ */
759
+ playSpeed: Float;
760
+ /**
761
+ * Whether or not the sound loops.
762
+ */
763
+ looping: boolean;
764
+ }>;
765
+ /**
766
+ * Sphere geometry.
767
+ */
768
+ export type SphereGeometry = Partial<{
769
+ /**
770
+ * Radius of the sphere.
771
+ */
772
+ radius: Float;
773
+ /**
774
+ * Geometry offset.
775
+ */
776
+ offset: Vec3;
777
+ }>;
778
+ /**
779
+ * Adds a cutoff to a point light to simulate a spot light.
780
+ */
781
+ export type SpotLight = Partial<{
782
+ /**
783
+ * Cutoff angle.
784
+ */
785
+ cutoff: Float;
786
+ /**
787
+ * Reference to a IES 2d texture.
788
+ */
789
+ IESProfile: AssetRef<Assets.Texture>;
790
+ }>;
791
+ /**
792
+ * A lens that applies an off-center perspective projection.
793
+ */
794
+ export type StereoscopicLens = Partial<{
795
+ /**
796
+ * Angle of the left side of the field of view (this value is negative).
797
+ */
798
+ angleLeft: Float;
799
+ /**
800
+ * Angle of the right side of the field of view.
801
+ */
802
+ angleRight: Float;
803
+ /**
804
+ * Angle of the top part of the field of view.
805
+ */
806
+ angleUp: Float;
807
+ /**
808
+ * Angle of the bottom part of the field of view (this value is negative).
809
+ */
810
+ angleDown: Float;
811
+ /**
812
+ * Specifies the distance from the viewer to the near clipping plane.
813
+ */
814
+ nearPlane: Float;
815
+ /**
816
+ * Specifies the distance from the viewer to the far clipping plane.
817
+ */
818
+ farPlane: Float;
819
+ /**
820
+ * Specifies the aspect ratio of the viewport, usually equals width/height.
821
+ */
822
+ aspectRatio: Float;
823
+ }>;
824
+ /**
825
+ * Tags used to filter entities.
826
+ */
827
+ export type Tags = Partial<{
828
+ /**
829
+ * Tag list.
830
+ */
831
+ value: Array<string>;
832
+ }>;
833
+ /**
834
+ * Vehicle Controller parameters.
835
+ */
836
+ export type VehicleController = Partial<{
837
+ /**
838
+ * The chassis.
839
+ */
840
+ chassis: EntityRef;
841
+ /**
842
+ * The front left wheel.
843
+ */
844
+ frontLeftWheel: EntityRef;
845
+ /**
846
+ * The front right wheel.
847
+ */
848
+ frontRightWheel: EntityRef;
849
+ /**
850
+ * The rear left wheel.
851
+ */
852
+ rearLeftWheel: EntityRef;
853
+ /**
854
+ * The rear right wheel.
855
+ */
856
+ rearRightWheel: EntityRef;
857
+ }>;
858
+ /**
859
+ * Filtering properties applied to the volume.
860
+ */
861
+ export type VolumeFilter = Partial<{
862
+ /**
863
+ * Voxel intensity range displayed, not applicable if outside volume material range.
864
+ */
865
+ range: Vec2;
866
+ /**
867
+ * Apply gaussian filtering on voxels.
868
+ */
869
+ applyGaussianFiltering: boolean;
870
+ /**
871
+ * Are texel values from the voxel texture sampled unfiltered.
872
+ */
873
+ sampleUnfiltered: boolean;
874
+ /**
875
+ * Whether or not this volume is visible in the MPR view.
876
+ */
877
+ enableMPR: boolean;
878
+ /**
879
+ * Whether or not this volume is visible in the 3D view.
880
+ */
881
+ enable3D: boolean;
882
+ }>;
883
+ /**
884
+ * Reference to a material to use with a volume.
885
+ */
886
+ export type VolumeMaterialRef = Partial<{
887
+ /**
888
+ * UUID of the referenced volume material.
889
+ */
890
+ value: AssetRef<Assets.VolumeMaterial>;
891
+ }>;
892
+ /**
893
+ * Reference to a volume made of voxels.
894
+ */
895
+ export type VolumeRef = Partial<{
896
+ /**
897
+ * UUID of the referenced 3D texture.
898
+ */
899
+ texture3dRef: AssetRef<Assets.Texture3D>;
900
+ }>;
901
+ /**
902
+ *
903
+ */
904
+ export declare enum ComponentHash {
905
+ animation_controller = 2978761622,
906
+ bone = 1352454807,
907
+ box_geometry = 3718707752,
908
+ camera = 1515175333,
909
+ capsule_geometry = 3996568839,
910
+ character_controller = 304568171,
911
+ collision_geometry_ref = 3193374355,
912
+ constraint = 3735282166,
913
+ culling_geometry = 611599156,
914
+ cylinder_geometry = 2497701877,
915
+ debug_name = 2737255849,
916
+ decal_projector = 2842087135,
917
+ environment = 227427331,
918
+ joint = 2286235554,
919
+ lineage = 2698448560,
920
+ local_aabb = 4132624459,
921
+ local_transform = 64958624,
922
+ material = 4100970527,
923
+ material_ref = 2816861126,
924
+ mesh_ref = 1660697531,
925
+ orthographic_lens = 3326403741,
926
+ overrider = 2758112134,
927
+ perspective_lens = 1113360699,
928
+ physics_material = 1550394949,
929
+ plane_geometry = 4075752378,
930
+ point_cloud_ref = 457361603,
931
+ point_light = 3624222817,
932
+ reflection_probe = 3879689944,
933
+ revolute_joint = 1364947094,
934
+ rigid_body = 3452128059,
935
+ scene_ref = 371342060,
936
+ script_element = 3574396804,
937
+ script_map = 3291722836,
938
+ shadow_caster = 3403528636,
939
+ skeleton_ref = 36879215,
940
+ sound_ref = 369352309,
941
+ sphere_geometry = 1159992935,
942
+ spot_light = 1508811228,
943
+ stereoscopic_lens = 698679321,
944
+ tags = 163258925,
945
+ vehicle_controller = 1287796174,
946
+ volume_filter = 2625356468,
947
+ volume_material_ref = 3229245461,
948
+ volume_ref = 2808449574
949
+ }
950
+ //# sourceMappingURL=components.d.ts.map