@combeenation/3d-viewer 14.0.1-rc1 → 15.0.0

package/dist/lib-cjs/manager/model-manager.d.ts

@@ -1,145 +1,145 @@
-import { AssetContainer, TransformNode, Viewer } from '../index';
-export declare type ModelAssetDefinition = {
-    name: string;
-    url: string;
-};
-export declare type ModelVisibilityEntry = {
-    name: string;
-    visible: boolean;
-};
-/**
- * Callback for renaming nodes when cloning nodes in a model
- */
-export declare type NodeNamingStrategy = (node: TransformNode, newModelName: string) => string;
-/**
- * Callback for renaming tags when cloning nodes in a model
- */
-export declare type TagNamingStrategy = (tag: string, newModelName: string) => string;
-export declare type ModelCloneOptions = {
-    nodeNamingStrategy: NodeNamingStrategy;
-    tagNamingStrategy: TagNamingStrategy;
-};
-declare type Model = {
-    name: string;
-    url: string;
-    state: ModelAssetState;
-    assetContainer: AssetContainer;
-    isClone: boolean;
-    visibilityCallId?: number;
-};
-declare type ModelAssetState = 'notLoaded' | 'loading' | 'loaded' | 'inScene';
-/**
- * Manager for handling 3d models.\
- * Responsible for loading models and handling their visibility.\
- * Also contains advanced features like model cloning.
- */
-export declare class ModelManager {
-    protected viewer: Viewer;
-    /**
-     * CAUTION: this has to be in sync with the Combeenation backend!
-     * @internal
-     */
-    static readonly CBN_FALLBACK_MODEL_ASSET_NAME = "$fallback";
-    protected _modelAssets: {
-        [name: string]: Model;
-    };
-    protected _fallbackModelAsset: Model;
-    protected _loadModelPromises: {
-        [modelName: string]: Promise<void>;
-    };
-    get modelNames(): string[];
-    /**
-     * Nested models were targeted with slash notation previously, as Spec couldn't work with dots.
-     * Dots were interpreted as inherited model.
-     * Now the Hive viewer parameters are returning slash notated asset names, whereas the asset names from the
-     * prepacked asset manager are dot notated.
-     * This function converts slash to dot notation, so that models can be target with slash and dot notation alike.
-     */
-    protected static _replaceSlashes(inputStr: string): string;
-    constructor(viewer: Viewer);
-    /**
-     * Creates content for the fallback model, which is actually just a black cube.
-     * This is used for 3d assets that are linked in a data source but not available (yet).
-     * The Combeenation backend exchanges the missing 3d asset name with "$fallback", which indicates that we shouldn't
-     * throw an error but just show the fallback model instead.
-     *
-     * @internal
-     */
-    createFallbackModel(): void;
-    /**
-     * Register models for 3d viewer, this is required for each model before it can be loaded/shown.\
-     * The "viewer control" inside the Combeenation framework calls this function automatically with all assigned
-     * 3d assets.
-     */
-    registerModels(modelAssets: ModelAssetDefinition[]): void;
-    /**
-     * Loads the model and all it's assigned materials.\
-     * This function should be used for "eager loading" of models, so that model switching will be instant in the
-     * process.\
-     * If you don't plan to do this, just use {@link setModelVisibility} as this function will load the model under the
-     * hood the first time the model gets visible.
-     */
-    loadModel(name: string): Promise<void>;
-    /**
-     * Enables/disables multiple one or multiple models simultaniously.\
-     * All required models are loaded before adjusting the visibility to avoid flashing in the 3d scene.
-     *
-     * @returns Array of changed visibility status, combined with the corresponding model name
-     */
-    setModelVisibility(modelVisibility: ModelVisibilityEntry | ModelVisibilityEntry[]): Promise<ModelVisibilityEntry[]>;
-    /**
-     * Create a clone of an existing model.\
-     * Only the geometry (meshes, transform nodes) gets cloned, as materials are typically shared across the whole scene.
-     *
-     * @param show show model immediately after cloning
-     * @param options additional options for the cloning procedure, like renaming algorithms
-     */
-    cloneModel(name: string, newModelName: string, show?: boolean, options?: ModelCloneOptions): Promise<void>;
-    /**
-     * Removes a cloned model from the scene and from the internal model storage.\
-     * Deleted clones can not be shown again.
-     */
-    deleteClonedModel(name: string): void;
-    /**
-     * Removes all cloned models from the scene and the internal model storage.
-     */
-    deleteAllClonedModels(): void;
-    /**
-     * Loads and returns the asset container of a certain model.\
-     * This can be used to access the models content without having to add it to the scene.\
-     * A typical use case is to clone or instantiate a node from a "library" model.
-     */
-    getAssetContainerOfModel(name: string): Promise<AssetContainer>;
-    /**
-     * Get model by name
-     */
-    protected _getModel(name: string): Model | undefined;
-    /**
-     * Load model into scene, but don't show it immediately
-     */
-    protected _loadModel(model: Model): Promise<void>;
-    /**
-     * Apply parameter to the model in the asset container.
-     * This is typically done before the model is added to the scene to avoid changes on the visible model, which ensures
-     * a smooth model switch behaviour.
-     */
-    protected _prepareModelForScene(model: Model): Promise<void>;
-    /**
-     * Add assets of asset container to scene, do the scene preparation if required.
-     * CAUTION: model is expected to be in the correct loading state already.
-     *
-     * @param skipPreparation optionally skip applying parameter values to model before showing it
-     *                        (see {@link _prepareModelForScene})
-     */
-    protected _showModel(model: Model, skipPreparation?: boolean): Promise<void>;
-    /**
-     * Remove assets of asset container from scene
-     */
-    protected _hideModel(model: Model): void;
-    /**
-     * Creates and assigns each "deferred" material to the corresponding mesh, if the mesh is visible.
-     * Model should be ready to use immediately after this function has done it's job.
-     */
-    protected _applyDeferredMaterialsForAllVisibleMeshes(model: Model): Promise<void>;
-}
-export {};
+import { AssetContainer, TransformNode, Viewer } from '../index';
+export declare type ModelAssetDefinition = {
+    name: string;
+    url: string;
+};
+export declare type ModelVisibilityEntry = {
+    name: string;
+    visible: boolean;
+};
+/**
+ * Callback for renaming nodes when cloning nodes in a model
+ */
+export declare type NodeNamingStrategy = (node: TransformNode, newModelName: string) => string;
+/**
+ * Callback for renaming tags when cloning nodes in a model
+ */
+export declare type TagNamingStrategy = (tag: string, newModelName: string) => string;
+export declare type ModelCloneOptions = {
+    nodeNamingStrategy?: NodeNamingStrategy;
+    tagNamingStrategy?: TagNamingStrategy;
+};
+declare type Model = {
+    name: string;
+    url: string;
+    state: ModelAssetState;
+    assetContainer: AssetContainer;
+    isClone: boolean;
+    visibilityCallId?: number;
+};
+declare type ModelAssetState = 'notLoaded' | 'loading' | 'loaded' | 'inScene';
+/**
+ * Manager for handling 3d models.\
+ * Responsible for loading models and handling their visibility.\
+ * Also contains advanced features like model cloning.
+ */
+export declare class ModelManager {
+    protected viewer: Viewer;
+    /**
+     * CAUTION: this has to be in sync with the Combeenation backend!
+     * @internal
+     */
+    static readonly CBN_FALLBACK_MODEL_ASSET_NAME = "$fallback";
+    protected _modelAssets: {
+        [name: string]: Model;
+    };
+    protected _fallbackModelAsset: Model;
+    protected _loadModelPromises: {
+        [modelName: string]: Promise<void>;
+    };
+    get modelNames(): string[];
+    /**
+     * Nested models were targeted with slash notation previously, as Spec couldn't work with dots.
+     * Dots were interpreted as inherited model.
+     * Now the Hive viewer parameters are returning slash notated asset names, whereas the asset names from the
+     * prepacked asset manager are dot notated.
+     * This function converts slash to dot notation, so that models can be target with slash and dot notation alike.
+     */
+    protected static _replaceSlashes(inputStr: string): string;
+    constructor(viewer: Viewer);
+    /**
+     * Creates content for the fallback model, which is actually just a black cube.
+     * This is used for 3d assets that are linked in a data source but not available (yet).
+     * The Combeenation backend exchanges the missing 3d asset name with "$fallback", which indicates that we shouldn't
+     * throw an error but just show the fallback model instead.
+     *
+     * @internal
+     */
+    createFallbackModel(): void;
+    /**
+     * Register models for 3d viewer, this is required for each model before it can be loaded/shown.\
+     * The "viewer control" inside the Combeenation framework calls this function automatically with all assigned
+     * 3d assets.
+     */
+    registerModels(modelAssets: ModelAssetDefinition[]): void;
+    /**
+     * Loads the model and all it's assigned materials.\
+     * This function should be used for "eager loading" of models, so that model switching will be instant in the
+     * process.\
+     * If you don't plan to do this, just use {@link setModelVisibility} as this function will load the model under the
+     * hood the first time the model gets visible.
+     */
+    loadModel(name: string): Promise<void>;
+    /**
+     * Enables/disables multiple one or multiple models simultaniously.\
+     * All required models are loaded before adjusting the visibility to avoid flashing in the 3d scene.
+     *
+     * @returns Array of changed visibility status, combined with the corresponding model name
+     */
+    setModelVisibility(modelVisibility: ModelVisibilityEntry | ModelVisibilityEntry[]): Promise<ModelVisibilityEntry[]>;
+    /**
+     * Create a clone of an existing model.\
+     * Only the geometry (meshes, transform nodes) gets cloned, as materials are typically shared across the whole scene.
+     *
+     * @param show show model immediately after cloning
+     * @param options additional options for the cloning procedure, like renaming algorithms
+     */
+    cloneModel(name: string, newModelName: string, show?: boolean, options?: ModelCloneOptions): Promise<void>;
+    /**
+     * Removes a cloned model from the scene and from the internal model storage.\
+     * Deleted clones can not be shown again.
+     */
+    deleteClonedModel(name: string): void;
+    /**
+     * Removes all cloned models from the scene and the internal model storage.
+     */
+    deleteAllClonedModels(): void;
+    /**
+     * Loads and returns the asset container of a certain model.\
+     * This can be used to access the models content without having to add it to the scene.\
+     * A typical use case is to clone or instantiate a node from a "library" model.
+     */
+    getAssetContainerOfModel(name: string): Promise<AssetContainer>;
+    /**
+     * Get model by name
+     */
+    protected _getModel(name: string): Model | undefined;
+    /**
+     * Load model into scene, but don't show it immediately
+     */
+    protected _loadModel(model: Model): Promise<void>;
+    /**
+     * Apply parameter to the model in the asset container.
+     * This is typically done before the model is added to the scene to avoid changes on the visible model, which ensures
+     * a smooth model switch behaviour.
+     */
+    protected _prepareModelForScene(model: Model): Promise<void>;
+    /**
+     * Add assets of asset container to scene, do the scene preparation if required.
+     * CAUTION: model is expected to be in the correct loading state already.
+     *
+     * @param skipPreparation optionally skip applying parameter values to model before showing it
+     *                        (see {@link _prepareModelForScene})
+     */
+    protected _showModel(model: Model, skipPreparation?: boolean): Promise<void>;
+    /**
+     * Remove assets of asset container from scene
+     */
+    protected _hideModel(model: Model): void;
+    /**
+     * Creates and assigns each "deferred" material to the corresponding mesh, if the mesh is visible.
+     * Model should be ready to use immediately after this function has done it's job.
+     */
+    protected _applyDeferredMaterialsForAllVisibleMeshes(model: Model): Promise<void>;
+}
+export {};