vim-web 0.3.42 → 0.3.44-dev.0

package/dist/types/react-viewers/helpers/isolation.d.ts

@@ -1,87 +1,128 @@
-/**
- * @module viw-webgl-react
- */
 import * as VIM from '../../core-viewers/webgl/index';
 import { ComponentSettings } from '../settings/settings';
 import { ComponentCamera } from './camera';
+import { ISimpleEvent } from 'ste-simple-events';
 /**
- * Manages the isolation mechanic in the vim component.
+ * Manages the isolation mechanic in the VIM component.
+ *
+ * **Isolation** determines which objects are visible (isolated) and which are
+ * hidden or displayed as ghosted. This class applies materials, updates object
+ * visibility, and ensures the camera view is adjusted when isolation changes.
  */
 export declare class Isolation {
     private _viewer;
     private _settings;
     private _isolation;
-    private _lastIsolation;
     private _camera;
-    private _references;
     private _onChanged;
-    /** Signal dispatched when the isolation set changes. */
-    get onChanged(): import("ste-simple-events").ISimpleEvent<string>;
-    constructor(viewer: VIM.Viewer, camera: ComponentCamera, settings: ComponentSettings);
-    /**
-     * Applies relevant settings to isolation.
-     * @param settings The settings to be applied to isolation.
-     */
-    applySettings(settings: ComponentSettings): void;
     /**
-     * Sets the reference objects for a given VIM.
-     * @param vim The VIM for which reference objects are being set.
-     * @param reference An array of reference objects or the string 'always' to indicate permanent reference.
+     * An event that is dispatched whenever the isolation set changes.
+     *
+     * @remarks
+     * This can be used by other parts of the application to react to isolation
+     * updates (for example, updating UI or triggering additional viewport actions).
+     *
+     * @returns {ISimpleEvent<string>} Event interface for subscribing to isolation changes.
      */
-    setReference(vim: VIM.Vim, reference: VIM.Object3D[] | 'always'): void;
+    get onChanged(): ISimpleEvent<string>;
     /**
-     * Retrieves the reference objects set for a given VIM.
-     * @param vim The VIM for which reference objects are being retrieved.
-     * @returns The reference objects set for the specified VIM.
+     * Constructs an IsolationManager.
+     *
+     * @param viewer - The VIM Viewer responsible for managing the 3D scene and objects.
+     * @param camera - A component that handles camera control and framing.
+     * @param settings - The settings that control isolation and material usage.
      */
-    getReference(vim: VIM.Vim): Set<VIM.Object3D> | "always";
+    constructor(viewer: VIM.Viewer, camera: ComponentCamera, settings: ComponentSettings);
     /**
-     * Clears all reference objects set for VIMs.
+     * Applies relevant settings to the isolation behavior.
+     *
+     * @param settings - The new settings to apply.
+     *
+     * @remarks
+     * This updates the internal reference to settings and immediately sets
+     * the material based on whether isolation is currently active.
      */
-    clearReferences(): void;
+    applySettings(settings: ComponentSettings): void;
     /**
-     * Returns true if there are currently objects isolated.
-     * @returns True if there are currently objects isolated; otherwise, false.
+     * Checks if isolation is currently active (i.e., any objects are isolated).
+     *
+     * @returns True if isolation is active; otherwise, false.
      */
-    any(): boolean;
+    isActive(): boolean;
     /**
-     * Returns the current array of isolated objects.
-     * @returns The array of objects currently isolated, or undefined if no objects are isolated.
+     * Retrieves the current array of isolated objects.
+     *
+     * @returns An array of isolated objects, or undefined if isolation is not active.
      */
-    current(): VIM.Object3D[];
+    current(): VIM.Object3D[] | undefined;
     /**
-     * Isolates the objects in the given array and shows the rest as ghost.
-     * @param objects An array of objects to isolate.
-     * @param source The source of isolation.
-     * @returns True if isolation occurs; otherwise, false.
+     * Sets the specified objects as isolated, hiding or ghosting the rest.
+     *
+     * @param objects - The objects to isolate.
+     * @param source - A label or identifier indicating the source of this action (e.g., "user").
      */
-    isolate(objects: VIM.Object3D[], source: string): boolean;
+    isolate(objects: VIM.Object3D[], source: string): void;
     /**
-     * Toggles current isolation based on selection.
-     * @param source The source of isolation.
+     * Toggles isolation by using the current selection.
+     *
+     * @param source - A label or identifier for the isolation action.
+     *
+     * @remarks
+     * This method replaces the current isolation set with whatever objects are
+     * currently selected. If selection is empty, it effectively clears isolation.
      */
-    toggleIsolation(source: string): void;
+    toggle(source: string): void;
     /**
-     * Removes the given objects from the isolation set.
-     * @param objects An array of objects to be removed from isolation.
-     * @param source The source of the removal operation.
+     * Hides the specified objects from the isolation set.
+     *
+     * @param objects - The objects to hide.
+     * @param source - A label or identifier for the isolation action.
+     *
+     * @remarks
+     * If there is no active isolation set (i.e., all objects are visible),
+     * the method first treats all objects in the scene as isolated,
+     * and then removes the specified objects. This ensures the specified
+     * objects become hidden.
      */
     hide(objects: VIM.Object3D[], source: string): void;
     /**
-     * Adds the given objects to the isolation set.
-     * @param objects An array of objects to be added to isolation.
-     * @param source The source of the addition operation.
+     * Adds the specified objects to the current isolation set (making them visible).
+     *
+     * @param objects - The objects to show.
+     * @param source - A label or identifier for the isolation action.
      */
     show(objects: VIM.Object3D[], source: string): void;
     /**
-     * Clears the current isolation.
-     * @param source The source of the isolation clearing operation.
+     * Clears the current isolation set, making all objects visible.
+     *
+     * @param source - A label or identifier for the isolation action.
      */
     clear(source: string): void;
     /**
-     * Show all objects and quit isolation mode.
+     * Constructs the correct material (or array of materials) based on the given settings.
+     *
+     * @param settings - The current component settings, including isolation rules.
+     * @param isolate - Whether or not isolation is active.
+     * @returns The material(s) to assign to the renderer, or undefined if default materials should be used.
+     *
+     * @remarks
+     * - If isolation is active and `useGhostMaterial` is true, an array containing
+     *   the simple and ghost materials is returned.
+     * - If fast materials are enabled, the simple material is returned.
+     * - Otherwise, defaults to undefined, allowing the system to pick a standard material.
+     */
+    private getMaterial;
+    /**
+     * Applies the current isolation state: sets visibility for objects, updates materials,
+     * and dispatches the changed event.
+     *
+     * @param source - A label or identifier for the isolation action.
+     */
+    private _apply;
+    /**
+     * Gathers all objects from all loaded VIM instances.
+     *
+     * @returns An array of all objects within the loaded VIM scenes.
      */
-    private _showAll;
-    getMaterial(settings: ComponentSettings, isolate: boolean): import("three").Material;
-    private _isolate;
+    private getAllObjects;
 }

package/dist/types/react-viewers/settings/settings.d.ts

@@ -32,12 +32,13 @@ export declare function isFalse(value: UserBoolean | boolean): value is false |
  * @interface ComponentSettings
  */
 export type ComponentSettings = {
-    peformance: {
+    materials: {
         useFastMaterial: boolean;
+        useGhostMaterial: boolean;
+        smallGhostThreshold: number;
     };
     isolation: {
         enable: boolean;
-        useIsolationMaterial: boolean;
     };
     capacity: {
         canFollowUrl: boolean;