@combeenation/3d-viewer 6.1.0 → 6.2.0

package/dist/lib-cjs/api/manager/variantInstanceManager.d.ts

@@ -1,92 +1,92 @@
-import { EventBroadcaster } from '../classes/eventBroadcaster';
-import { Variant } from '../classes/variant';
-import { VariantInstance } from '../classes/variantInstance';
-/**
- * There's usually no need to instantiate a {@link VariantInstanceManager} yourself as it is provided by each
- * {@link Viewer} instance via its {@link Viewer.variantInstances}
- */
-export declare class VariantInstanceManager extends EventBroadcaster {
-    protected rootVariant: Variant;
-    protected variantInstancePromises: Map<string, Promise<VariantInstance>>;
-    protected variantInstances: Map<string, VariantInstance>;
-    protected variantInstanceDefinitions: Map<string, VariantInstanceDefinition>;
-    protected parameters: ParameterBag;
-    protected queues: {
-        [name: string]: Promise<VariantInstance>[];
-    };
-    /**
-     * Constructor.
-     */
-    protected constructor(rootVariant: Variant);
-    /**
-     * Creates a {@link VariantInstanceManager} based on given root Variant.
-     */
-    static create(rootVariant: Variant): Promise<VariantInstanceManager>;
-    /**
-     * Gets all instances.
-     */
-    get all(): VariantInstance[];
-    /**
-     * Gets all instance definitions.
-     */
-    get allDefinitions(): VariantInstanceDefinition[];
-    /**
-     * Checks whether a {@link VariantInstance} is either registered or created.
-     */
-    has(name: string): boolean;
-    /**
-     * Retrieves a {@link VariantInstance}.
-     * If the instance has been created, the created instance will be returned.
-     * If the instance is registered, the instance will be created and returned.
-     * if the instance has already been requested and is currently pending, the dedicated promise will be returned.
-     * If none of these apply, an Error is thrown.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
-     */
-    get(name: string): Promise<VariantInstance>;
-    /**
-     * Creates and registers a unique {@link VariantInstance}.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
-     */
-    create(dottedPath: DottedPathArgument, name?: string, parameters?: ParameterBag): Promise<VariantInstance>;
-    /**
-     * Registers a unique {@link VariantInstanceDefinition}.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
-     */
-    register(instanceDefinition: VariantInstanceDefinition): VariantInstanceDefinition;
-    /**
-     * Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
-     */
-    commitParameters(parameters?: ParameterBag, onlyVisible?: boolean): Promise<VariantInstanceManager>;
-    /**
-     * Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
-     * instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
-     * the calls end up in a queue according to the FIFO principle (the last one wins).
-     */
-    show(name: string, exclusive?: boolean): Promise<VariantInstance>;
-    /**
-     * Clones and registers a new {@link VariantInstance} with a new, unique name.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CLONED}
-     */
-    clone(name: string, newName: string, parameters?: ParameterBag): Promise<VariantInstance>;
-    /**
-     * Destroys the instance by removing the {@link Variant} and de-registering the instance.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
-     */
-    destroy(name: string): VariantInstanceManager;
-    /**
-     * Creates and registers a unique {@link VariantInstance} from `definition`.
-     *
-     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
-     */
-    protected createFromDefinition(definition: VariantInstanceDefinition): Promise<VariantInstance>;
-    /**
-     * Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
-     * Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
-     */
-    protected ensureUniqueName(name: string): string;
-}
+import { EventBroadcaster } from '../classes/eventBroadcaster';
+import { Variant } from '../classes/variant';
+import { VariantInstance } from '../classes/variantInstance';
+/**
+ * There's usually no need to instantiate a {@link VariantInstanceManager} yourself as it is provided by each
+ * {@link Viewer} instance via its {@link Viewer.variantInstances}
+ */
+export declare class VariantInstanceManager extends EventBroadcaster {
+    protected rootVariant: Variant;
+    protected variantInstancePromises: Map<string, Promise<VariantInstance>>;
+    protected variantInstances: Map<string, VariantInstance>;
+    protected variantInstanceDefinitions: Map<string, VariantInstanceDefinition>;
+    protected parameters: ParameterBag;
+    protected queues: {
+        [name: string]: Promise<VariantInstance>[];
+    };
+    /**
+     * Constructor.
+     */
+    protected constructor(rootVariant: Variant);
+    /**
+     * Creates a {@link VariantInstanceManager} based on given root Variant.
+     */
+    static create(rootVariant: Variant): Promise<VariantInstanceManager>;
+    /**
+     * Gets all instances.
+     */
+    get all(): VariantInstance[];
+    /**
+     * Gets all instance definitions.
+     */
+    get allDefinitions(): VariantInstanceDefinition[];
+    /**
+     * Checks whether a {@link VariantInstance} is either registered or created.
+     */
+    has(name: string): boolean;
+    /**
+     * Retrieves a {@link VariantInstance}.
+     * If the instance has been created, the created instance will be returned.
+     * If the instance is registered, the instance will be created and returned.
+     * if the instance has already been requested and is currently pending, the dedicated promise will be returned.
+     * If none of these apply, an Error is thrown.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
+     */
+    get(name: string): Promise<VariantInstance>;
+    /**
+     * Creates and registers a unique {@link VariantInstance}.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
+     */
+    create(dottedPath: DottedPathArgument, name?: string, parameters?: ParameterBag): Promise<VariantInstance>;
+    /**
+     * Registers a unique {@link VariantInstanceDefinition}.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_REGISTERED}
+     */
+    register(instanceDefinition: VariantInstanceDefinition): VariantInstanceDefinition;
+    /**
+     * Commits the {@link ParameterBag} to all registered and created {@link VariantInstance}s.
+     */
+    commitParameters(parameters?: ParameterBag, onlyVisible?: boolean): Promise<VariantInstanceManager>;
+    /**
+     * Show one {@link VariantInstance}. If `exclusive` is set to `true` it will hide all other
+     * instances handled by this {@link VariantInstanceManager}. If the function is called synchronously,
+     * the calls end up in a queue according to the FIFO principle (the last one wins).
+     */
+    show(name: string, exclusive?: boolean): Promise<VariantInstance>;
+    /**
+     * Clones and registers a new {@link VariantInstance} with a new, unique name.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CLONED}
+     */
+    clone(name: string, newName: string, parameters?: ParameterBag): Promise<VariantInstance>;
+    /**
+     * Destroys the instance by removing the {@link Variant} and de-registering the instance.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_DESTROYED}
+     */
+    destroy(name: string): VariantInstanceManager;
+    /**
+     * Creates and registers a unique {@link VariantInstance} from `definition`.
+     *
+     * @emits {@link Event.VARIANT_INSTANCE_CREATED}
+     */
+    protected createFromDefinition(definition: VariantInstanceDefinition): Promise<VariantInstance>;
+    /**
+     * Creates a unique instance name based on already registered instance names on the {@link VariantInstanceManager}.
+     * Appends an `_i` to the name where `i = 0` and increments as long as the name is not registered.
+     */
+    protected ensureUniqueName(name: string): string;
+}