@needle-tools/engine 4.11.5-next.d9019e4 → 4.11.5-next.dedc70b

package/src/engine-components/Light.ts

@@ -75,6 +75,7 @@ enum LightShadows {
  * Debug mode can be enabled with the URL parameter `?debuglights`, which shows
  * additional console output and visual helpers for lights.
  * 
+ * @summary Light component for various light types and shadow settings
  * @category Rendering
  * @group Components
  */

package/src/engine-components/LookAtConstraint.ts

@@ -8,6 +8,7 @@ import type { OrbitControls } from "./OrbitControls.js";
  * A LookAtConstraint is used by OrbitControls to make the camera look at a target.  
  * This component is used by {@link OrbitControls} internally.
  * 
+ * @summary Look At Constraint for OrbitControls
  * @category Camera Controls
  * @group Components
  */

package/src/engine-components/NeedleMenu.ts

@@ -10,6 +10,7 @@ import { Behaviour } from './Component.js';
  * Controls display options, button visibility, and menu positioning.
  * From code, you can access the menu via {@link Context.menu}. 
  * 
+ * @summary Configuration component for the Needle Menu
  * @category User Interface
  * @group Components
  **/

package/src/engine-components/NestedGltf.ts

@@ -11,6 +11,7 @@ const debug = getParam("debugnestedgltf");
 /** The nested gltf is a component that is used to load a gltf file when the component becomes active (start)  
  * It will load the gltf file and instantiate it as a child of the parent of the GameObject that has this component
  * 
+ * @summary Loads and instantiates a nested glTF file
  * @category Asset Management
  * @group Components
  */

package/src/engine-components/Networking.ts

@@ -11,6 +11,7 @@ const debug = getParam("debugnet");
  * This component supplies websocket URLs for establishing connections.
  * It implements the {@link INetworkingWebsocketUrlProvider} interface.
  * 
+ * @summary Networking configuration component
  * @category Networking
  * @group Components
  */

package/src/engine-components/OffsetConstraint.ts

@@ -4,6 +4,13 @@ import { serializable } from "../engine/engine_serialization_decorator.js";
 import * as utils from "./../engine/engine_three_utils.js";
 import { Behaviour, GameObject } from "./Component.js";
 
+/**
+ * OffsetConstraint component allows an object to maintain a specified positional and rotational offset 
+ * relative to another object, with options for alignment and leveling.
+ * @summary Maintains positional and rotational offset relative to another object
+ * @category Constraints
+ * @group Components
+ */
 export class OffsetConstraint extends Behaviour {
 
     @serializable(GameObject)

package/src/engine-components/OrbitControls.ts

@@ -63,6 +63,7 @@ declare module 'three/examples/jsm/controls/OrbitControls.js' {
 /** The OrbitControls component is used to control a camera using the [OrbitControls from three.js](https://threejs.org/docs/#examples/en/controls/OrbitControls) library.  
  * The three OrbitControls object can be accessed via the `controls` property.  
  * The object being controlled by the OrbitControls (usually the camera) can be accessed via the `controllerObject` property.
+ * @summary Camera controller using three.js OrbitControls
  * @category Camera
  * @group Components
  */

package/src/engine-components/PlayerColor.ts

@@ -9,6 +9,8 @@ import { AvatarMarker } from "./webxr/WebXRAvatar.js";
 /**
  * PlayerColor assigns a unique color for each user in the room to the object it is attached to.  
  * The color is generated based on the user's ID.
+ * 
+ * @summary Assigns a unique color to the player object
  * @category Networking
  * @group Components
  */

package/src/engine-components/ReflectionProbe.ts

@@ -19,6 +19,7 @@ const $originalMaterial = Symbol("original material");
  * 
  * - Sample: http://samples.needle.tools/reflection-probes
  * 
+ * @summary Provides reflection data to materials
  * @category Rendering
  * @group Components
  */

package/src/engine-components/RigidBody.ts

@@ -140,6 +140,7 @@ class TransformWatch {
  * - Example: https://samples.needle.tools/physics-playground
  * - Example: https://samples.needle.tools/physics-&-animation
  * 
+ * @summary Rigidbody for physical interactions
  * @category Physics 
  * @group Components
  */

package/src/engine-components/SceneSwitcher.ts

@@ -108,6 +108,7 @@ export interface ISceneEventListener {
  * });
  * ```
  * 
+ * @summary Dynamically loads and switches between multiple scenes
  * @category Asset Management
  * @group Components
  */

package/src/engine-components/ScreenCapture.ts

@@ -70,6 +70,7 @@ export declare type ScreenCaptureOptions = {
  * By default the component will start sharing the screen when the user clicks on the object this component is attached to. You can set {@link device} This behaviour can be disabled by setting `allowStartOnClick` to false.  
  * It is also possible to start the stream manually from your code by calling the {@link share} method.
  * 
+ * @summary Share screen, camera or microphone in a networked room
  * @category Networking
  * @group Components
 */

package/src/engine-components/SeeThrough.ts

@@ -40,6 +40,7 @@ let i = 0;
  * 
  * - Example https://see-through-walls-z23hmxbz1kjfjn.needle.run/
  * 
+ * @summary Makes objects fade out when obscuring a reference point from the camera
  * @category Rendering
  * @group Components
  */

package/src/engine-components/ShadowCatcher.ts

@@ -22,6 +22,8 @@ enum ShadowMode {
  * If the GameObject is a Mesh, it will apply a shadow-catching material to it - otherwise it will create a quad with the shadow-catching material.  
  * 
  * Note that ShadowCatcher meshes are not raycastable by default; if you want them to be raycastable, change the layers in `onEnable()`.
+ * 
+ * @summary Renders shadows or light on the object
  * @category Rendering
  * @group Components
  */

package/src/engine-components/Skybox.ts

@@ -143,6 +143,7 @@ ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, () => {
  * skybox.setSkybox("https://example.com/skybox.hdr");
  * ```
  * 
+ * @summary Sets the skybox or environment texture of a scene
  * @category Rendering
  * @group Components
  */

package/src/engine-components/SmoothFollow.ts

@@ -9,6 +9,7 @@ import { Behaviour } from "./Component.js";
 /**
  * SmoothFollow makes the {@link Object3D} (`GameObject`) smoothly follow another target {@link Object3D}.  
  * It can follow the target's position, rotation, or both.   
+ * @summary Smoothly follows a target object
  * @category Interactivity
  * @group Components
  */

package/src/engine-components/SpatialTrigger.ts

@@ -26,6 +26,7 @@ function testMask(mask1, mask2) {
 /**
  * Component that receives and responds to spatial events, like entering or exiting a trigger zone.
  * Used in conjunction with {@link SpatialTrigger} to create interactive spatial events.
+ * @summary Receives spatial trigger events
  * @category Interactivity
  * @group Components
  */

package/src/engine-components/SpectatorCamera.ts

@@ -35,6 +35,7 @@ const debug = getParam("debugspectator");
  * 
  * Debug mode can be enabled with the URL parameter `?debugspectator`, which provides additional console output.
  * 
+ * @summary Follow other users in a networked room
  * @category Networking
  * @group Components
  */

package/src/engine-components/SpriteRenderer.ts

@@ -86,6 +86,7 @@ function updateTextureIfNecessary(tex: Texture) {
 
 /**
  * A sprite is a mesh that represents a 2D image. Used by the {@link SpriteRenderer} to render 2D images in the scene.
+ * @summary 2D image renderer 
  * @category Rendering
  * @group Components
  */

package/src/engine-components/SyncedCamera.ts

@@ -63,6 +63,8 @@ declare type UserCamInfo = {
 /**
  * SyncedCamera is a component that syncs the camera position and rotation of all users in the room.  
  * A prefab can be set to represent the remote cameras visually in the scene.
+ * 
+ * @summary Syncs camera position and rotation of users in a networked room
  * @category Networking
  * @group Components
  */

package/src/engine-components/SyncedRoom.ts

@@ -33,6 +33,7 @@ const debug = utils.getParam("debugsyncedroom");
  * myObject.addComponent(SyncedRoom, { joinRandomRoom: true, roomPrefix: "myApp_" });
  * ```
  * 
+ * @summary Joins a networked room based on URL parameters or a random room
  * @category Networking
  * @group Components
  */

package/src/engine-components/SyncedTransform.ts

@@ -57,6 +57,8 @@ onUpdate((ctx) => {
 /**
  * SyncedTransform synchronizes the position and rotation of a game object over the network.
  * It handles ownership transfer, interpolation, and network state updates automatically.
+ * 
+ * @summary Synchronizes object transform over the network with ownership management
  * @category Networking
  * @group Components
  */

package/src/engine-components/TransformGizmo.ts

@@ -10,6 +10,8 @@ import { SyncedTransform } from "./SyncedTransform.js";
 /**
  * TransformGizmo displays manipulation controls for translating, rotating, and scaling objects in the scene.
  * It wraps three.js {@link TransformControls} and provides keyboard shortcuts for changing modes and settings.
+ * 
+ * @summary Object manipulation gizmo for translating, rotating, and scaling
  * @category Helpers
  * @group Components
  */

package/src/engine-components/VideoPlayer.ts

@@ -54,6 +54,7 @@ export enum VideoRenderMode {
  *    playOnAwake: true,
  * });
  * ```
+ * @summary Plays video clips from URLs or streams
  * @category Multimedia
  * @group Components
  */

package/src/engine-components/Voip.ts

@@ -14,6 +14,7 @@ const debugParam = getParam("debugvoip");
 /**
  * The Voice over IP component (VoIP) allows you to send and receive audio streams to other users in the same networked room.  
  * It requires a networking connection to be working (e.g. by having an active SyncedRoom component in the scene or by connecting to a room manually).  
+ * @summary Voice over IP (VoIP) for networked audio communication
  * @category Networking
  * @group Components
  */

package/src/engine-components/export/usdz/extensions/behavior/BehaviourComponents.ts

@@ -31,6 +31,8 @@ function ensureRaycaster(obj: GameObject) {
 }
 
 /**
+ * Make the object move to the target object's transform when clicked.
+ * @summary Moves an object to a target transform upon click
  * @category Everywhere Actions
  * @group Components
  */
@@ -176,6 +178,8 @@ export class ChangeTransformOnClick extends Behaviour implements IPointerClickHa
 }
 
 /**
+ * Change the material of objects when clicked.
+ * @summary Changes the material of objects when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -366,6 +370,8 @@ export class ChangeMaterialOnClick extends Behaviour implements IPointerClickHan
 }
 
 /**
+ * Set the active state of an object when clicked.
+ * @summary Sets the active state of an object when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -604,6 +610,8 @@ export class SetActiveOnClick extends Behaviour implements IPointerClickHandler,
 }
 
 /**
+ * Hides the object on scene start.
+ * @summary Hides the object on scene start
  * @category Everywhere Actions
  * @group Components
  */
@@ -651,6 +659,8 @@ export class HideOnStart extends Behaviour implements UsdzBehaviour {
 }
 
 /**
+ * Emphasize the target object when clicked.
+ * @summary Emphasizes the target object when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -683,6 +693,8 @@ export class EmphasizeOnClick extends Behaviour implements UsdzBehaviour {
 }
 
 /**
+ * Plays an audio clip when clicked.
+ * @summary Plays an audio clip when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -808,6 +820,8 @@ export class PlayAudioOnClick extends Behaviour implements IPointerClickHandler,
 }
 
 /**
+ * Plays an animation when clicked.
+ * @summary Plays an animation when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -1216,6 +1230,8 @@ export class PreliminaryTrigger extends Behaviour {
 }
 
 /**
+ * Hides or shows the object when clicked.
+ * @summary Hides or shows the object when clicked
  * @category Everywhere Actions
  * @group Components
  */
@@ -1241,6 +1257,8 @@ export class VisibilityAction extends PreliminaryAction {
 }
 
 /**
+ * Triggers an action when the object is tapped/clicked.
+ * @summary Triggers an action when the object is tapped/clicked
  * @category Everywhere Actions
  * @group Components
  */

package/src/engine-components/particlesystem/ParticleSystem.ts

@@ -692,6 +692,7 @@ class ParticlesEmissionState implements EmissionState {
  * 
  * Needle Engine uses [three.quarks](https://github.com/Alchemist0823/three.quarks) under the hood to handle particles.
  * 
+ * @summary Particle System
  * @category Rendering
  * @group Components
  */

package/src/engine-components/physics/Attractor.ts

@@ -14,6 +14,9 @@ import { Rigidbody } from "../RigidBody.js";
  * attractor.strength = 5; // positive value to attract
  * attractor.radius = 10; // only attract within 10 units
  * attractor.targets.push(rigidbody); // add the Rigidbody to be attracted
+ * @summary Attract Rigidbodies towards the position of this component
+ * @category Physics
+ * @group Components
  */
 export class Attractor extends Behaviour {
 

package/src/engine-components/postprocessing/Effects/BloomEffect.ts

@@ -19,6 +19,7 @@ import { registerCustomEffectType } from "../VolumeProfile.js";
  * volume.add(bloom);
  * ```
  * 
+ * @summary Bloom Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/ChromaticAberration.ts

@@ -7,6 +7,10 @@ import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType, VolumeProfile } from "../VolumeProfile.js";
 
 /**
+ * Chromatic Aberration effect simulates the color fringing effect seen in real-world cameras.  
+ * It offsets the red, green, and blue color channels to create a distorted, colorful edge around objects.  
+ * This effect can enhance the visual appeal of scenes by adding a subtle or pronounced chromatic distortion.
+ * @summary Chromatic Aberration Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/ColorAdjustments.ts

@@ -8,6 +8,9 @@ import { registerCustomEffectType } from "../VolumeProfile.js";
 import { ToneMappingEffect } from "./Tonemapping.js";
 
 /**
+ * Color Adjustments effect allows you to modify the overall color properties of the rendered scene, including post-exposure, contrast, hue shift, and saturation.  
+ * These adjustments can be used to enhance the visual aesthetics of the scene or to achieve specific artistic effects.
+ * @summary Color Adjustments Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/DepthOfField.ts

@@ -17,6 +17,10 @@ export enum DepthOfFieldMode {
 const debug = getParam("debugpost");
 
 /**
+ * Depth of Field effect simulates the focusing behavior of real-world cameras by blurring objects that are outside the focal plane.  
+ * This effect enhances the sense of depth in a scene by mimicking how cameras focus on subjects at varying distances, creating a more immersive visual experience.  
+ * It can be adjusted to achieve different artistic effects, from subtle background blurring to pronounced bokeh effects.
+ * @summary Depth of Field Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/EffectWrapper.ts

@@ -3,6 +3,7 @@ import type { Effect } from "postprocessing";
 import { EffectProviderResult, PostProcessingEffect } from "../PostProcessingEffect.js";
 
 /**
+ *
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/Pixelation.ts

@@ -7,6 +7,9 @@ import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 
 /**
+ * Pixelation effect simulates a pixelated look by enlarging pixels in the rendered scene.  
+ * This effect can be used to achieve a retro or stylized visual aesthetic, reminiscent of early video games or low-resolution graphics.
+ * @summary Pixelation Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/ScreenspaceAmbientOcclusionN8.ts

@@ -23,6 +23,10 @@ export enum ScreenSpaceAmbientOcclusionN8QualityMode {
 }
 
 /** Screen Space Ambient Occlusion (SSAO) effect.  
+ * Ambient Occlusion is a shading method used to calculate how exposed each point in a scene is to ambient lighting.  
+ * The effect enhances the depth and realism of 3D scenes by simulating the soft shadows that occur in crevices, corners, and areas where objects are close to each other.  
+ * This implementation uses the N8AO library to provide high-quality SSAO with various quality settings.
+ * @summary Screen Space Ambient Occlusion (SSAO) Post-Processing Effect
  * @category Effects
  * @group Components
  * @link [N8AO documentation](https://github.com/N8python/n8ao)

package/src/engine-components/postprocessing/Effects/Sharpening.ts

@@ -14,6 +14,10 @@ import { PostProcessingEffectOrder } from "../utils.js";
 // }
 
 /**
+ * Sharpening effect enhances the details and edges in the rendered scene by increasing the contrast between adjacent pixels.
+ * This effect can make textures and fine details appear clearer and more defined, improving the overall visual quality of the scene.  
+ * It is particularly useful in scenes where details may be lost due to blurriness or low resolution.
+ * @summary Sharpening Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/TiltShiftEffect.ts

@@ -5,6 +5,10 @@ import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 
 /**
+ * Tilt Shift effect simulates a miniature scene by applying a selective focus blur to the rendered image.  
+ * This effect creates a shallow depth of field, making real-world scenes appear as if they are small-scale models.  
+ * It is often used in photography and cinematography to draw attention to specific areas of the scene while blurring out the rest.
+ * @summary Tilt Shift Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/Tonemapping.ts

@@ -14,6 +14,10 @@ const debug = getParam("debugpost");
 
 
 /**
+ * Tonemapping effect adjusts the brightness and contrast of the rendered scene to map high dynamic range (HDR) colors to a displayable range.  
+ * This effect is essential for achieving realistic lighting and color representation in 3D scenes, as it helps to preserve details in both bright and dark areas.  
+ * Various tonemapping algorithms can be applied to achieve different visual styles and effects.
+ * @summary Tonemapping Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Effects/Vignette.ts

@@ -7,6 +7,10 @@ import { VolumeParameter } from "../VolumeParameter.js";
 import { registerCustomEffectType } from "../VolumeProfile.js";
 
 /**
+ * Vignette effect darkens the edges of the rendered scene to draw attention to the center.  
+ * This effect simulates the natural vignetting that occurs in photography and cinematography, where the corners of an image are darker than the center.  
+ * It can be used to enhance the visual focus on the main subject of the scene and create a more immersive viewing experience.
+ * @summary Vignette Post-Processing Effect
  * @category Effects
  * @group Components
  */

package/src/engine-components/postprocessing/Volume.ts

@@ -41,6 +41,7 @@ const debug = getParam("debugpost");
  * volume.addEffect(pixelation);
  * ```
  * 
+ * @summary Manage Post-Processing Effects
  * @category Rendering
  * @category Effects
  * @group Components

package/src/engine-components/splines/Spline.ts

@@ -37,6 +37,7 @@ export class SplineData {
  * 
  * You can create a SplineContainer from an array of points using the static method 'createFromPoints'.
  * 
+ * @summary Holds spline data and generates a spline curve.
  * @category Splines
  * @group Components
  */

package/src/engine-components/splines/SplineWalker.ts

@@ -12,6 +12,7 @@ import { SplineContainer } from "./Spline.js";
  * 
  * - Example http://samples.needle.tools/splines
  * 
+ * @summary Moves an object along a spline
  * @category Splines
  * @group Components
  */

package/src/engine-components/timeline/PlayableDirector.ts

@@ -56,6 +56,7 @@ export type CreateTrackFunction = (director: PlayableDirector, track: Models.Tra
  * The PlayableDirector component is the main component to control timelines in needle engine.
  * It is used to play, pause, stop and evaluate timelines.  
  * Assign a TimelineAsset to the `playableAsset` property to start playing a timeline.
+ * @summary Controls and plays TimelineAssets
  * @category Animation and Sequencing
  * @group Components
  */

package/src/engine-components/timeline/SignalAsset.ts

@@ -29,6 +29,7 @@ export class SignalReceiverEvent {
 /** SignalReceiver is a component that listens for signals and invokes a reaction when a signal is received. 
  * Signals can be added to a signal track on a {@link PlayableDirector}
  * 
+ * @summary Receives signals and invokes reactions
  * @category Sequencing and Timelines
  * @group Components
  */

package/src/engine-components/ui/Button.ts

@@ -61,6 +61,10 @@ class AnimationTriggers {
 }
 
 /**
+ * Button is a UI component that can be clicked by the user to perform an action.  
+ * It supports different visual states such as normal, highlighted, pressed, and disabled.  
+ * You can customize the button's appearance using colors or animations for each state.
+ * @summary Button UI Component
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/Canvas.ts

@@ -25,6 +25,11 @@ export enum RenderMode {
 const debugLayout = getParam("debuguilayout");
 
 /**
+ * Canvas is the root component for all UI elements in a scene.  
+ * It defines the area where UI elements are rendered and manages their layout and rendering settings.  
+ * Canvases can be set to render in world space or screen space (overlay or camera).  
+ * Multiple canvases can exist in a scene, each with its own settings and hierarchy of UI elements.
+ * @summary Canvas UI Component
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/CanvasGroup.ts

@@ -7,6 +7,10 @@ import { type ICanvasGroup, type IHasAlphaFactor } from "./Interfaces.js";
 
 
 /**
+ * CanvasGroup is a UI component that allows you to control the transparency and interactivity of a group of UI elements.  
+ * By adjusting the alpha property, you can fade in or out all child UI elements simultaneously.  
+ * The interactable and blocksRaycasts properties let you enable or disable user interaction for the entire group.
+ * @summary CanvasGroup UI Component
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/EventSystem.ts

@@ -36,6 +36,8 @@ onInitialized((ctx) => {
 })
 
 /**
+ * The EventSystem is responsible for managing and dispatching input events to UI components within the scene.
+ * @summary UI Input Event System
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/Image.ts

@@ -12,6 +12,10 @@ class Sprite {
 }
 
 /**
+ * Image is a UI component that displays a sprite (2D image) in the user interface.  
+ * You can set the image property to assign a texture to be displayed.  
+ * The sprite can be customized with various properties such as color tinting and pixel density.
+ * @summary Image UI Component
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/InputField.ts

@@ -10,6 +10,10 @@ import { tryGetUIComponent } from "./Utils.js";
 const debug = getParam("debuginputfield");
 
 /**
+ * InputField is a UI component that allows users to enter and edit text.  
+ * It provides a text input area where users can type, delete, and modify text.  
+ * The InputField supports placeholder text, events for value changes, and end edit actions.
+ * @summary Text Input Field UI Component
  * @category User Interface
  * @group Components
  */

package/src/engine-components/ui/Outline.ts

@@ -4,6 +4,13 @@ import { serializable } from "../../engine/engine_serialization.js";
 import { RGBAColor } from "../../engine/js-extensions/index.js";
 import { Behaviour } from "../Component.js";
 
+/**
+ * Outline is a UI component that adds an outline effect to UI elements.  
+ * You can customize the outline color and distance to create a visual border around the UI element.
+ * @summary Outline UI Component
+ * @category User Interface
+ * @group Components
+ */
 export class Outline extends Behaviour {
 
     @serializable(RGBAColor)

package/src/engine-components/ui/Text.ts

@@ -40,6 +40,7 @@ export enum FontStyle {
 }
 
 /**
+ * Text is a UI component that displays text in the user interface.
  * @category User Interface
  * @group Components
  */

package/src/engine-components/utils/LookAt.ts

@@ -12,6 +12,7 @@ import { Behaviour } from "../Component.js";
  * LookAt behaviour makes the object look at a target object or the camera.  
  * It can also invert the forward direction and keep the up direction.
  * 
+ * @summary Makes the object look at a target object or the camera
  * @category Interactivity, Everywhere Actions
  * @group Components
  */

package/src/engine-components/web/Clickthrough.ts

@@ -32,7 +32,7 @@ onStart(ctx => {
  * - Alternatively, add the `clickthrough` attribute to the `<needle-engine>` HTML element (e.g. `<needle-engine clickthrough></needle-engine>`).
  * 
  * - Example https://stackblitz.com/~/github.com/needle-engine/sample-3d-over-html
- * 
+ * @summary Allows pointer events to "click through" the 3D canvas to HTML elements behind it.
  * @category Web
  * @group Components
  * @component

package/src/engine-components/web/CursorFollow.ts

@@ -14,6 +14,7 @@ const debug = getParam("debugcursor");
  * 
  * - Example: [Look At Cursor sample](https://engine.needle.tools/samples/look-at-cursor-interactive-3d-header/). This sample combines the CursorFollow component with a LookAt component to create an interactive 3D header that looks at the cursor.
  * 
+ * @summary Makes the object follow the cursor position on screen
  * @category Web
  * @group Components
  * @component