@thatopen/components 2.0.0-alpha.15 → 2.0.0-alpha.16

package/dist/core/Cullers/index.d.ts

@@ -7,15 +7,45 @@ export * from "./src";
  * that are not visible to the camera.
  */
 export declare class Cullers extends Component implements Disposable {
+    /**
+     * A unique identifier for the Cullers component.
+     */
     static readonly uuid: "69f2a50d-c266-44fc-b1bd-fa4d34be89e6";
+    /**
+     * Indicates whether the Cullers component is enabled.
+     */
     private _enabled;
+    /**
+     * A map of MeshCullerRenderer instances, keyed by their world UUIDs.
+     */
     list: Map<string, MeshCullerRenderer>;
-    /** {@link Disposable.onDisposed} */
+    /**
+     * An event that is triggered when the Cullers component is disposed.
+     */
     readonly onDisposed: Event<unknown>;
-    /** {@link Component.enabled} */
+    /**
+     * Gets the enabled state of the Cullers component.
+     *
+     * @returns The current enabled state.
+     */
     get enabled(): boolean;
+    /**
+     * Sets the enabled state of the Cullers component.
+     * Also sets the enabled state of all MeshCullerRenderer instances.
+     *
+     * @param value - The new enabled state.
+     */
     set enabled(value: boolean);
     constructor(components: Components);
+    /**
+   * Creates a new MeshCullerRenderer for the given world.
+   * If a MeshCullerRenderer already exists for the world, it will return the existing one.
+   *
+   * @param world - The world for which to create the MeshCullerRenderer.
+   * @param config - Optional configuration settings for the MeshCullerRenderer.
+   *
+   * @returns The newly created or existing MeshCullerRenderer for the given world.
+   */
     create(world: World, config?: Partial<CullerRendererSettings>): MeshCullerRenderer;
     delete(world: World): void;
     /** {@link Disposable.dispose} */

package/dist/core/Worlds/index.d.ts

@@ -3,13 +3,48 @@ import { Components } from "../Components";
 import { SimpleWorld } from "./src";
 export * from "./src";
 export declare class Worlds extends Component implements Updateable, Disposable {
+    /**
+     * A unique identifier for the component.
+     * This UUID is used to register the component within the Components system.
+     */
     static readonly uuid: "fdb61dc4-2ec1-4966-b83d-54ea795fad4a";
+    /**
+     * Event triggered after the update process of all worlds.
+     * Subscribers can listen to this event to perform actions post-update.
+     */
     readonly onAfterUpdate: Event<unknown>;
+    /**
+     * Event triggered before the update process of all worlds.
+     * Subscribers can listen to this event to perform actions pre-update.
+     */
     readonly onBeforeUpdate: Event<unknown>;
+    /**
+     * Event triggered when the Worlds component is disposed.
+     * Subscribers can listen to this event to perform cleanup actions.
+     */
     readonly onDisposed: Event<unknown>;
+    /**
+     * A collection of worlds managed by this component.
+     * The key is the unique identifier (UUID) of the world, and the value is the World instance.
+     */
     list: Map<string, World>;
+    /**
+     * A flag indicating whether the Worlds component is enabled.
+     * If false, the update process will be skipped.
+     */
     enabled: boolean;
     constructor(components: Components);
+    /**
+   * Creates a new instance of a SimpleWorld and adds it to the list of worlds.
+   *
+   * @template T - The type of the scene, extending from BaseScene. Defaults to BaseScene.
+   * @template U - The type of the camera, extending from BaseCamera. Defaults to BaseCamera.
+   * @template S - The type of the renderer, extending from BaseRenderer. Defaults to BaseRenderer.
+   *
+   * @returns {SimpleWorld<T, U, S>} - The newly created SimpleWorld instance.
+   *
+   * @throws {Error} - Throws an error if a world with the same UUID already exists in the list.
+   */
     create<T extends BaseScene = BaseScene, U extends BaseCamera = BaseCamera, S extends BaseRenderer = BaseRenderer>(): SimpleWorld<T, U, S>;
     delete(world: World): void;
     dispose(): void;