@3dverse/livelink.core 0.7.13 → 1.0.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 (101) hide show
  1. package/README.md +61 -17
  2. package/dist/_prebuild/EditorConnection.d.ts +1 -29
  3. package/dist/_prebuild/EditorMessageHandler.d.ts +1 -139
  4. package/dist/_prebuild/GatewayConnection.d.ts +1 -58
  5. package/dist/_prebuild/GatewayMessageHandler.d.ts +1 -194
  6. package/dist/_prebuild/engine_types/ComponentsHashes.d.ts +5 -0
  7. package/dist/_prebuild/engine_types/ComponentsRecord.d.ts +207 -0
  8. package/dist/_prebuild/engine_types/SceneSettingsRecord.d.ts +50 -0
  9. package/dist/_prebuild/engine_types/assets.d.ts +96 -0
  10. package/dist/_prebuild/{types → engine_types}/components.d.ts +221 -159
  11. package/dist/_prebuild/{types/settings.d.ts → engine_types/sceneSettings.d.ts} +85 -70
  12. package/dist/_prebuild/messages/editor/ConnectConfirmation.d.ts +1 -70
  13. package/dist/_prebuild/messages/editor/EditorEntity.d.ts +0 -25
  14. package/dist/_prebuild/messages/editor/EntityUpdatedEvent.d.ts +1 -7
  15. package/dist/_prebuild/messages/editor/EntityVisibilityChangedEvent.d.ts +1 -5
  16. package/dist/_prebuild/messages/editor/UpdateComponentsCommand.d.ts +1 -6
  17. package/dist/_prebuild/messages/editor/index.d.ts +0 -1
  18. package/dist/_prebuild/messages/gateway/commands/AssignClientToScriptCommand.d.ts +9 -0
  19. package/dist/_prebuild/messages/gateway/commands/AuthenticationCommand.d.ts +1 -0
  20. package/dist/_prebuild/messages/gateway/{ClientConfig.d.ts → commands/ConfigureClientCommand.d.ts} +11 -13
  21. package/dist/_prebuild/messages/gateway/commands/FireEventCommand.d.ts +11 -0
  22. package/dist/_prebuild/messages/gateway/commands/HighlightEntitiesCommand.d.ts +8 -0
  23. package/dist/_prebuild/messages/gateway/commands/InputStateCommand.d.ts +8 -0
  24. package/dist/_prebuild/messages/gateway/commands/RemoveComponentsCommand.d.ts +1 -0
  25. package/dist/_prebuild/messages/gateway/commands/RemoveFilterCommand.d.ts +7 -0
  26. package/dist/_prebuild/messages/gateway/commands/ResizeCommand.d.ts +13 -0
  27. package/dist/_prebuild/messages/gateway/commands/SendSkeletonPoseCommand.d.ts +25 -0
  28. package/dist/_prebuild/messages/gateway/commands/SetFilterCommand.d.ts +8 -0
  29. package/dist/_prebuild/messages/gateway/commands/ToggleFilterCommand.d.ts +8 -0
  30. package/dist/_prebuild/messages/gateway/commands/UpdateEntitiesFromBytesCommand.d.ts +1 -0
  31. package/dist/_prebuild/messages/gateway/commands/UpdateEntitiesFromJsonCommand.d.ts +1 -0
  32. package/dist/_prebuild/messages/gateway/commands/ViewportConfigCommand.d.ts +16 -0
  33. package/dist/_prebuild/messages/gateway/commands/index.d.ts +15 -0
  34. package/dist/_prebuild/messages/gateway/enums.d.ts +4 -111
  35. package/dist/_prebuild/messages/gateway/events/AssetLoadingEvent.d.ts +1 -0
  36. package/dist/_prebuild/messages/gateway/{FrameData.d.ts → events/FrameDataEvent.d.ts} +1 -17
  37. package/dist/_prebuild/messages/gateway/events/ScriptEvent.d.ts +10 -0
  38. package/dist/_prebuild/messages/gateway/events/index.d.ts +3 -0
  39. package/dist/_prebuild/messages/gateway/index.d.ts +16 -22
  40. package/dist/_prebuild/messages/gateway/queries/ScreenSpaceRayQuery.d.ts +18 -0
  41. package/dist/_prebuild/messages/gateway/queries/index.d.ts +1 -0
  42. package/dist/_prebuild/messages/index.d.ts +2 -0
  43. package/dist/library.cjs +1 -1
  44. package/dist/library.cjs.map +4 -4
  45. package/dist/library.mjs +1 -1
  46. package/dist/library.mjs.map +4 -4
  47. package/dist/sources/ActivityWatcher.d.ts +63 -0
  48. package/dist/sources/CoreEvents.d.ts +35 -0
  49. package/dist/sources/DynamicLoader.d.ts +38 -0
  50. package/dist/sources/EntityUtils.d.ts +117 -0
  51. package/dist/sources/LivelinkCore.d.ts +133 -128
  52. package/dist/sources/SessionInterface.d.ts +20 -0
  53. package/dist/sources/TypedEventTarget.d.ts +14 -0
  54. package/dist/sources/controllers/EditorController.d.ts +1 -21
  55. package/dist/sources/controllers/EditorEvents.d.ts +27 -0
  56. package/dist/sources/controllers/GatewayController.d.ts +1 -53
  57. package/dist/sources/controllers/GatewayEvents.d.ts +54 -0
  58. package/dist/sources/core.d.ts +29 -8
  59. package/dist/sources/internal/RequestHandler.d.ts +1 -0
  60. package/dist/sources/internal/Serializer.d.ts +1 -0
  61. package/dist/sources/library.d.ts +1 -1
  62. package/dist/sources/types/RTID.d.ts +6 -20
  63. package/dist/sources/types/UUID.d.ts +7 -17
  64. package/dist/sources/types/dataObjects.d.ts +52 -0
  65. package/dist/sources/types/index.d.ts +3 -5
  66. package/dist/sources/types/math.d.ts +8 -91
  67. package/dist/sources/types/nativeTypes.d.ts +25 -86
  68. package/dist/sources/types/utils.d.ts +19 -0
  69. package/package.json +13 -3
  70. package/dist/_prebuild/enums.d.ts +0 -3
  71. package/dist/_prebuild/messages/editor/EntityCreationCoreOptions.d.ts +0 -6
  72. package/dist/_prebuild/messages/gateway/AssetLoadingEvent.d.ts +0 -14
  73. package/dist/_prebuild/messages/gateway/AssignClientToScriptMessage.d.ts +0 -21
  74. package/dist/_prebuild/messages/gateway/AuthenticationResponse.d.ts +0 -31
  75. package/dist/_prebuild/messages/gateway/ClientConfigResponse.d.ts +0 -16
  76. package/dist/_prebuild/messages/gateway/FireEventMessage.d.ts +0 -23
  77. package/dist/_prebuild/messages/gateway/HighlightEntitiesMessage.d.ts +0 -22
  78. package/dist/_prebuild/messages/gateway/InputState.d.ts +0 -22
  79. package/dist/_prebuild/messages/gateway/RemoveComponentsCommand.d.ts +0 -23
  80. package/dist/_prebuild/messages/gateway/RemoveFilterMessage.d.ts +0 -18
  81. package/dist/_prebuild/messages/gateway/ResizeResponse.d.ts +0 -14
  82. package/dist/_prebuild/messages/gateway/ScreenSpaceRayQuery.d.ts +0 -29
  83. package/dist/_prebuild/messages/gateway/ScreenSpaceRayResult.d.ts +0 -16
  84. package/dist/_prebuild/messages/gateway/ScriptEvent.d.ts +0 -17
  85. package/dist/_prebuild/messages/gateway/SendSkeletonPoseMessage.d.ts +0 -28
  86. package/dist/_prebuild/messages/gateway/SessionAuth.d.ts +0 -8
  87. package/dist/_prebuild/messages/gateway/SetFilterMessage.d.ts +0 -19
  88. package/dist/_prebuild/messages/gateway/ToggleFilterMessage.d.ts +0 -19
  89. package/dist/_prebuild/messages/gateway/UpdateEntitiesFromBytesMessage.d.ts +0 -25
  90. package/dist/_prebuild/messages/gateway/UpdateEntitiesFromJsonMessage.d.ts +0 -23
  91. package/dist/_prebuild/messages/gateway/ViewportConfig.d.ts +0 -30
  92. package/dist/_prebuild/types/assets.d.ts +0 -23
  93. package/dist/sources/LivelinkCoreModule.d.ts +0 -39
  94. package/dist/sources/RequestHandler.d.ts +0 -47
  95. package/dist/sources/Serializer.d.ts +0 -34
  96. package/dist/sources/controllers/ActivityWatcher.d.ts +0 -42
  97. package/dist/sources/interfaces/ClientInterface.d.ts +0 -7
  98. package/dist/sources/interfaces/EntityInterface.d.ts +0 -9
  99. package/dist/sources/interfaces/SessionInterface.d.ts +0 -19
  100. package/dist/sources/interfaces/index.d.ts +0 -3
  101. /package/dist/sources/{types/constants.d.ts → constants.d.ts} +0 -0
@@ -0,0 +1,207 @@
1
+ /**
2
+ * DO NOT EDIT THIS FILE MANUALLY.
3
+ * This file has been generated automatically from ftl-schemas
4
+ */
5
+ import { UUID } from "../../sources/types";
6
+ import * as Components from "./components";
7
+ /**
8
+ * @category Engine Schemas
9
+ */
10
+ export type ComponentName = keyof ComponentsRecord;
11
+ /**
12
+ * @category Engine Schemas
13
+ */
14
+ export type EntityCore = {
15
+ euid: Components.Euid;
16
+ } & Partial<ComponentsRecord>;
17
+ /**
18
+ * @category Engine Schemas
19
+ */
20
+ export type ComponentsManifest = {
21
+ euid?: {
22
+ value: UUID;
23
+ };
24
+ } & {
25
+ [K in keyof ComponentsRecord]?: Partial<ComponentsRecord[K]>;
26
+ };
27
+ /**
28
+ * @category Engine Schemas
29
+ */
30
+ export type ComponentType<T extends ComponentName = ComponentName> = ComponentsRecord[T];
31
+ /**
32
+ * @category Engine Schemas
33
+ */
34
+ export type ComponentsRecord = {
35
+ /**
36
+ * 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.
37
+ */
38
+ animation_controller: Components.AnimationController;
39
+ /**
40
+ * Animation sequence controller with reference to an animation sequence and assigned entities.
41
+ */
42
+ animation_sequence_controller: Components.AnimationSequenceController;
43
+ /**
44
+ * Links entity to bone in skeleton.
45
+ */
46
+ bone: Components.Bone;
47
+ /**
48
+ * Box geometry.
49
+ */
50
+ box_geometry: Components.BoxGeometry;
51
+ /**
52
+ * Virtual camera.
53
+ */
54
+ camera: Components.Camera;
55
+ /**
56
+ * Capsule geometry.
57
+ */
58
+ capsule_geometry: Components.CapsuleGeometry;
59
+ /**
60
+ * 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.
61
+ */
62
+ character_controller: Components.CharacterController;
63
+ /**
64
+ * Reference to a collision geometry.
65
+ */
66
+ collision_geometry_ref: Components.CollisionGeometryRef;
67
+ /**
68
+ * 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.
69
+ */
70
+ constraint: Components.Constraint;
71
+ /**
72
+ * Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.
73
+ */
74
+ culling_geometry: Components.CullingGeometry;
75
+ /**
76
+ * Cylinder geometry.
77
+ */
78
+ cylinder_geometry: Components.CylinderGeometry;
79
+ /**
80
+ * Name of the entity.
81
+ */
82
+ debug_name: Components.DebugName;
83
+ /**
84
+ * Decal Projector.
85
+ */
86
+ decal_projector: Components.DecalProjector;
87
+ /**
88
+ * The environment of a scene. Used to give a scene a skybox.
89
+ */
90
+ environment: Components.Environment;
91
+ /**
92
+ * 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.
93
+ */
94
+ joint: Components.Joint;
95
+ /**
96
+ * Lineage of the entity through linkers.
97
+ */
98
+ lineage: Components.Lineage;
99
+ /**
100
+ * Local Axis Aligned Bounding Box of the entity.
101
+ */
102
+ local_aabb: Components.LocalAabb;
103
+ /**
104
+ * Local transform of the entity.
105
+ */
106
+ local_transform: Components.LocalTransform;
107
+ /**
108
+ * References a shader and specifies input values if needed.
109
+ */
110
+ material: Components.Material;
111
+ /**
112
+ * Reference to a material.
113
+ */
114
+ material_ref: Components.MaterialRef;
115
+ /**
116
+ * Reference to a mesh.
117
+ */
118
+ mesh_ref: Components.MeshRef;
119
+ /**
120
+ * A lens that applies an orthographic projection.
121
+ */
122
+ orthographic_lens: Components.OrthographicLens;
123
+ /**
124
+ * Overrides a given entity in a sub scene.
125
+ */
126
+ overrider: Components.Overrider;
127
+ /**
128
+ * A lens that applies a perspective projection.
129
+ */
130
+ perspective_lens: Components.PerspectiveLens;
131
+ /**
132
+ * Physics material which represents a set of physical surface properties.
133
+ */
134
+ physics_material: Components.PhysicsMaterial;
135
+ /**
136
+ * Plane geometry.
137
+ */
138
+ plane_geometry: Components.PlaneGeometry;
139
+ /**
140
+ * Reference to a point cloud.
141
+ */
142
+ point_cloud_ref: Components.PointCloudRef;
143
+ /**
144
+ * 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.
145
+ */
146
+ point_light: Components.PointLight;
147
+ /**
148
+ * Omni directional reflection probe parameters, used for local cubemap reflection generation.
149
+ */
150
+ reflection_probe: Components.ReflectionProbe;
151
+ /**
152
+ * Rigid body parameters.
153
+ */
154
+ rigid_body: Components.RigidBody;
155
+ /**
156
+ * Reference to a scene.
157
+ */
158
+ scene_ref: Components.SceneRef;
159
+ /**
160
+ * References multiple scripts.
161
+ */
162
+ script_map: Components.ScriptMap;
163
+ /**
164
+ * Enables a light to cast shadows.
165
+ */
166
+ shadow_caster: Components.ShadowCaster;
167
+ /**
168
+ * Reference to a skeleton.
169
+ */
170
+ skeleton_ref: Components.SkeletonRef;
171
+ /**
172
+ * Reference to a sound.
173
+ */
174
+ sound_ref: Components.SoundRef;
175
+ /**
176
+ * Sphere geometry.
177
+ */
178
+ sphere_geometry: Components.SphereGeometry;
179
+ /**
180
+ * Adds a cutoff to a point light to simulate a spot light.
181
+ */
182
+ spot_light: Components.SpotLight;
183
+ /**
184
+ * A lens that applies a custom projection.
185
+ */
186
+ stereoscopic_lens: Components.StereoscopicLens;
187
+ /**
188
+ * Tags used to filter entities.
189
+ */
190
+ tags: Components.Tags;
191
+ /**
192
+ * Vehicle Controller parameters.
193
+ */
194
+ vehicle_controller: Components.VehicleController;
195
+ /**
196
+ * Filtering properties applied to the volume.
197
+ */
198
+ volume_filter: Components.VolumeFilter;
199
+ /**
200
+ * Reference to a material to use with a volume.
201
+ */
202
+ volume_material_ref: Components.VolumeMaterialRef;
203
+ /**
204
+ * Reference to a volume made of voxels.
205
+ */
206
+ volume_ref: Components.VolumeRef;
207
+ };
@@ -0,0 +1,50 @@
1
+ /**
2
+ * DO NOT EDIT THIS FILE MANUALLY.
3
+ * This file has been generated automatically from ftl-schemas
4
+ */
5
+ import * as SceneSettings from "./sceneSettings";
6
+ /**
7
+ * @category Engine Schemas
8
+ */
9
+ export type SceneSettingType = keyof SceneSettingsRecord;
10
+ /**
11
+ * @category Engine Schemas
12
+ */
13
+ export type SceneSettingsRecord = {
14
+ /**
15
+ * Settings for debug lines
16
+ */
17
+ debug_lines?: SceneSettings.DebugLines;
18
+ /**
19
+ * Settings for the display
20
+ */
21
+ display?: SceneSettings.Display;
22
+ /**
23
+ * Settings for the environment
24
+ */
25
+ environment?: SceneSettings.Environment;
26
+ /**
27
+ * Miscellaneous settings
28
+ */
29
+ misc?: SceneSettings.Misc;
30
+ /**
31
+ * Settings for the physics engine.
32
+ */
33
+ physics?: SceneSettings.Physics;
34
+ /**
35
+ * Renderer settings
36
+ */
37
+ renderer?: SceneSettings.Renderer;
38
+ /**
39
+ * Sound settings
40
+ */
41
+ sound?: SceneSettings.Sound;
42
+ /**
43
+ * Settings for the scene streaming
44
+ */
45
+ streaming?: SceneSettings.Streaming;
46
+ /**
47
+ * Settings for voxel rendering
48
+ */
49
+ voxel?: SceneSettings.Voxel;
50
+ };
@@ -0,0 +1,96 @@
1
+ /**
2
+ * DO NOT EDIT THIS FILE MANUALLY.
3
+ * This file has been generated automatically from ftl-schemas
4
+ */
5
+ /**
6
+ *
7
+ */
8
+ export type ActionMap = object;
9
+ /**
10
+ *
11
+ */
12
+ export type Algorithm = object;
13
+ /**
14
+ *
15
+ */
16
+ export type Animation = object;
17
+ /**
18
+ *
19
+ */
20
+ export type AnimationGraph = object;
21
+ /**
22
+ *
23
+ */
24
+ export type AnimationSequence = object;
25
+ /**
26
+ *
27
+ */
28
+ export type AnimationSet = object;
29
+ /**
30
+ *
31
+ */
32
+ export type CollisionGeometry = object;
33
+ /**
34
+ *
35
+ */
36
+ export type Cubemap = object;
37
+ /**
38
+ *
39
+ */
40
+ export type EventMap = object;
41
+ /**
42
+ *
43
+ */
44
+ export type Material = object;
45
+ /**
46
+ *
47
+ */
48
+ export type Mesh = object;
49
+ /**
50
+ *
51
+ */
52
+ export type Module = object;
53
+ /**
54
+ *
55
+ */
56
+ export type PointCloud = object;
57
+ /**
58
+ *
59
+ */
60
+ export type RenderGraph = object;
61
+ /**
62
+ *
63
+ */
64
+ export type Scene = object;
65
+ /**
66
+ *
67
+ */
68
+ export type Script = object;
69
+ /**
70
+ *
71
+ */
72
+ export type Shader = object;
73
+ /**
74
+ *
75
+ */
76
+ export type Skeleton = object;
77
+ /**
78
+ *
79
+ */
80
+ export type Sound = object;
81
+ /**
82
+ *
83
+ */
84
+ export type Texture = object;
85
+ /**
86
+ *
87
+ */
88
+ export type Texture1D = object;
89
+ /**
90
+ *
91
+ */
92
+ export type Texture3D = object;
93
+ /**
94
+ *
95
+ */
96
+ export type VolumeMaterial = object;