@3dverse/livelink.core 1.1.12 → 1.1.13

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.
@@ -33,15 +33,15 @@ export type ComponentType<T extends ComponentName = ComponentName> = ComponentsR
33
33
  */
34
34
  export type ComponentsRecord = {
35
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.
36
+ * Drives skeletal animation using an Animation Graph and Animation Set; animates descendant skinned meshes whose skeletons are compatible with the set.
37
37
  */
38
38
  animation_controller: Components.AnimationController;
39
39
  /**
40
- * Animation sequence controller with reference to an animation sequence and assigned entities.
40
+ * Controls playback of an Animation Sequence; assigns tracks to entities.
41
41
  */
42
42
  animation_sequence_controller: Components.AnimationSequenceController;
43
43
  /**
44
- * Links entity to bone in skeleton.
44
+ * Associates this entity with a bone in a skeleton (for attachments and transforms).
45
45
  */
46
46
  bone: Components.Bone;
47
47
  /**
@@ -57,75 +57,79 @@ export type ComponentsRecord = {
57
57
  */
58
58
  capsule_geometry: Components.CapsuleGeometry;
59
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.
60
+ * Kinematic character controller for collision-constrained movement without a rigid body. Uses tuned collision handling for responsive control.
61
61
  */
62
62
  character_controller: Components.CharacterController;
63
63
  /**
64
- * Reference to a collision geometry.
64
+ * Reference to a collision geometry asset used by physics.
65
65
  */
66
66
  collision_geometry_ref: Components.CollisionGeometryRef;
67
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.
68
+ * 6-DoF constraint built on a Joint. Defaults to fixed; selectively unlock translation and rotation on X/Y/Z and configure limits and springs.
69
69
  */
70
70
  constraint: Components.Constraint;
71
71
  /**
72
- *
72
+ * Drives a Constraint toward target position/orientation and velocities using configurable stiffness, damping, and force limits.
73
73
  */
74
74
  constraint_actuator: Components.ConstraintActuator;
75
75
  /**
76
- * Culling geometry. Add this component in addition to another geometry component (e.g. box geometry, sphere geometry, etc.) to enable culling geometry.
76
+ * Enables culling using a simple analytic shape. Add alongside a geometry component (box, cylinder, plane, sphere).
77
77
  */
78
78
  culling_geometry: Components.CullingGeometry;
79
+ /**
80
+ * Custom projection lens using an explicit projection matrix.
81
+ */
82
+ custom_lens: Components.CustomLens;
79
83
  /**
80
84
  * Cylinder geometry.
81
85
  */
82
86
  cylinder_geometry: Components.CylinderGeometry;
83
87
  /**
84
- * Name of the entity.
88
+ * Human-readable name of the entity.
85
89
  */
86
90
  debug_name: Components.DebugName;
87
91
  /**
88
- * Decal Projector.
92
+ * Projects a material onto scene surfaces within the projector's box volume.
89
93
  */
90
94
  decal_projector: Components.DecalProjector;
91
95
  /**
92
- * The environment of a scene. Used to give a scene a skybox.
96
+ * Scene environment settings, including skybox background and precomputed image-based lighting (IBL). This component is only applied in the scene where this entity lives, it is discarded for subscenes.
93
97
  */
94
98
  environment: Components.Environment;
95
99
  /**
96
- * 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.
100
+ * Base joint connecting two bodies. By default locks relative position and orientation between constrainer and constrainee.
97
101
  */
98
102
  joint: Components.Joint;
99
103
  /**
100
- * Display a label in the 3d view.
104
+ * Displays an editor-only label in the 3D view.
101
105
  */
102
106
  label: Components.Label;
103
107
  /**
104
- * Lineage of the entity through linkers.
108
+ * Records the entity's lineage through linkers and parentage.
105
109
  */
106
110
  lineage: Components.Lineage;
107
111
  /**
108
- * Local Axis Aligned Bounding Box of the entity.
112
+ * Local-space axis-aligned bounding box.
109
113
  */
110
114
  local_aabb: Components.LocalAabb;
111
115
  /**
112
- * Local transform of the entity.
116
+ * Local transform of the entity (position, orientation, scale).
113
117
  */
114
118
  local_transform: Components.LocalTransform;
115
119
  /**
116
- * References a shader and specifies input values if needed.
120
+ * Assigns a shader to the entity's mesh and provides its input values and specialization constants.
117
121
  */
118
122
  material: Components.Material;
119
123
  /**
120
- * Reference to a material.
124
+ * Reference to a material to use for rendering.
121
125
  */
122
126
  material_ref: Components.MaterialRef;
123
127
  /**
124
- * Display a measure in the 3d view.
128
+ * Displays editor-only measurement annotations in the 3D view.
125
129
  */
126
130
  measure: Components.Measure;
127
131
  /**
128
- * Reference to a mesh.
132
+ * Reference to a mesh to render (with submesh selection).
129
133
  */
130
134
  mesh_ref: Components.MeshRef;
131
135
  /**
@@ -133,23 +137,23 @@ export type ComponentsRecord = {
133
137
  */
134
138
  morph_targets: Components.MorphTargets;
135
139
  /**
136
- * A lens that applies an orthographic projection.
140
+ * Orthographic projection lens with configurable zoom and depth range.
137
141
  */
138
142
  orthographic_lens: Components.OrthographicLens;
139
143
  /**
140
- * Overrides a given entity in a sub scene.
144
+ * Overrides an entity from a subscene: mark for deletion, replace components, or detach specific components.
141
145
  */
142
146
  overrider: Components.Overrider;
143
147
  /**
144
- * A lens that applies a perspective projection.
148
+ * Perspective projection lens with vertical field of view and near/far clipping planes.
145
149
  */
146
150
  perspective_lens: Components.PerspectiveLens;
147
151
  /**
148
- * Physics material which represents a set of physical surface properties.
152
+ * Physical surface properties used for contact: friction, restitution, optional contact modification, and trigger mode.
149
153
  */
150
154
  physics_material: Components.PhysicsMaterial;
151
155
  /**
152
- * Plane geometry.
156
+ * Infinite plane geometry.
153
157
  */
154
158
  plane_geometry: Components.PlaneGeometry;
155
159
  /**
@@ -157,39 +161,39 @@ export type ComponentsRecord = {
157
161
  */
158
162
  point_cloud_ref: Components.PointCloudRef;
159
163
  /**
160
- * 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.
164
+ * Omnidirectional light source with physically based intensity and falloff. Acts as a point light by default; enable isDirectional to emit parallel rays. Attach a Spot Light component to add a cone cutoff. Can optionally drive the atmosphere sun direction.
161
165
  */
162
166
  point_light: Components.PointLight;
163
167
  /**
164
- * Omni directional reflection probe parameters, used for local cubemap reflection generation.
168
+ * Omnidirectional reflection probe that captures the local environment into a cubemap for specular reflections (IBL).
165
169
  */
166
170
  reflection_probe: Components.ReflectionProbe;
167
171
  /**
168
- * Rigid body parameters.
172
+ * Rigid body parameters for dynamic simulation (mass, damping, limits, CCD, and kinematic/gravity behavior).
169
173
  */
170
174
  rigid_body: Components.RigidBody;
171
175
  /**
172
- * Rigid body actuator. Represent forces and torques that are applied during a simulation step. All values are reset each frame.
176
+ * Frame-by-frame actuator for rigid bodies. Sets velocities and applies forces/impulses/torques; values are reset each frame.
173
177
  */
174
178
  rigid_body_actuator: Components.RigidBodyActuator;
175
179
  /**
176
- * Reference to a scene.
180
+ * Reference to a subscene (linker); used to compose scenes.
177
181
  */
178
182
  scene_ref: Components.SceneRef;
179
183
  /**
180
- * References multiple scripts.
184
+ * Holds a set of script elements keyed by UUID.
181
185
  */
182
186
  script_map: Components.ScriptMap;
183
187
  /**
184
- * Enables a light to cast shadows.
188
+ * Enables a light to cast real-time shadows with configurable map resolution, depth range, and (for directional lights) cascades.
185
189
  */
186
190
  shadow_caster: Components.ShadowCaster;
187
191
  /**
188
- * Reference to a skeleton.
192
+ * Reference to a skeleton asset for skinning and animation.
189
193
  */
190
194
  skeleton_ref: Components.SkeletonRef;
191
195
  /**
192
- * Reference to a sound.
196
+ * Reference to a sound asset with playback and spatialization controls.
193
197
  */
194
198
  sound_ref: Components.SoundRef;
195
199
  /**
@@ -197,19 +201,15 @@ export type ComponentsRecord = {
197
201
  */
198
202
  sphere_geometry: Components.SphereGeometry;
199
203
  /**
200
- * Display a spline in the 3d view.
204
+ * Displays an editor-only spline in the 3D view.
201
205
  */
202
206
  spline: Components.Spline;
203
207
  /**
204
- * Adds a cutoff to a point light to simulate a spot light.
208
+ * Adds a cone cutoff to a light, producing a spotlight. Requires a Point Light component for color/intensity and falloff.
205
209
  */
206
210
  spot_light: Components.SpotLight;
207
211
  /**
208
- * A lens that applies a custom projection.
209
- */
210
- stereoscopic_lens: Components.StereoscopicLens;
211
- /**
212
- * Tags used to filter entities.
212
+ * Free-form tags used to group and filter entities.
213
213
  */
214
214
  tags: Components.Tags;
215
215
  /**
@@ -217,15 +217,15 @@ export type ComponentsRecord = {
217
217
  */
218
218
  vehicle_controller: Components.VehicleController;
219
219
  /**
220
- * Filtering properties applied to the volume.
220
+ * View filtering and display controls applied to the referenced volume.
221
221
  */
222
222
  volume_filter: Components.VolumeFilter;
223
223
  /**
224
- * Reference to a material to use with a volume.
224
+ * Reference to the volume material used for shading and transfer functions.
225
225
  */
226
226
  volume_material_ref: Components.VolumeMaterialRef;
227
227
  /**
228
- * Reference to a volume made of voxels.
228
+ * Reference to a volumetric dataset stored as a 3D texture (voxels).
229
229
  */
230
230
  volume_ref: Components.VolumeRef;
231
231
  };