@combeenation/3d-viewer 5.1.2 → 5.2.0-alpha1

package/dist/{lib-es6 → lib-cjs/src}/api/util/babylonHelper.d.ts

@@ -1,174 +1,174 @@
-import { HighlightLayer } from '@babylonjs/core/Layers/highlightLayer';
-import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
-import { Material } from '@babylonjs/core/Materials/material';
-import { Color3 } from '@babylonjs/core/Maths/math.color';
-import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
-import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
-import { Node } from '@babylonjs/core/node';
-import { Scene } from '@babylonjs/core/scene';
-import { DottedPath } from '../classes/dottedPath';
-declare const backgroundDomeName = "BackgroundDome_ViewerGenerated";
-declare const envHelperMetadataName = "viewerEnvHelper";
-/**
- * @param node
- * @return Node
- */
-declare const getRootNode: (node: Node) => Node;
-/**
- * @param nodes
- * @param predicate
- * @return Map<DottedPath, T>
- */
-declare const mapToDottedNodes: <T>(nodes: Node[], predicate?: ((node: Node) => boolean) | undefined) => Map<DottedPath, T>;
-/**
- * @param node
- * @return DottedPath
- */
-declare const getDottedPathForNode: (node: Node) => DottedPath;
-/**
- * @param node
- * @param predicate
- * @param deep
- * @return TransformNode | null
- */
-declare const cloneTransformNode: (node: TransformNode, predicate?: ((node: TransformNode) => boolean) | undefined, deep?: boolean) => TransformNode | null;
-/**
- * @param node
- */
-declare const cloneNodeWithParents: (node: Node | null) => Node | null;
-/**
- * @param node
- * @param deep
- * @param prefix
- * @return TransformNode
- */
-declare const cloneTransformNodeMaterial: (node: TransformNode, prefix?: DottedPathArgument, deep?: boolean) => TransformNode;
-/**
- * @param node
- * @param deep
- * @param metadata
- */
-declare const injectNodeMetadata: (node: Node, metadata: {}, deep?: boolean) => void;
-/**
- * @param node
- * @param assertCallable
- * @param callableParameters
- * @param deep
- */
-declare const assertTransformNode: (node: TransformNode, assertCallable: CallableFunction, callableParameters?: any[], deep?: boolean) => void;
-/**
- * @param node
- * @param deep
- */
-declare const activateTransformNode: (node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param deep
- */
-declare const deactivateTransformNode: (node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- */
-declare const enableNodeWithParents: (node: Node) => void;
-/**
- * @param node
- */
-declare const disableNodeWithParents: (node: Node) => void;
-/**
- * Applies a {@link TransformationDefinition} consecutively to ensure dependencies in positioning etc.
- * @param node
- * @param transformation
- */
-declare const transformTransformNode: (node: TransformNode, transformation: TransformationDefinition) => void;
-/**
- * Apply changes of environment (background texture, etc.) consecutively in order to avoid dependency related issues.
- * @param scene
- * @param envDef
- */
-declare const changeEnvironment: (scene: Scene, envDef: EnvironmentDefinition) => void;
-/**
- * @param node
- * @param materialName
- * @param deep
- */
-declare const setMaterial: (variant: Variant, node: TransformNode, materialName: string, deep?: boolean) => void;
-/**
- * !!! Warning !!!
- * This function is not public API. Whilst it can help solving certain problems, it only works reliably in well defined
- * situations and can cause unwanted side effects under some conditions. Use carefully at your own risk!
- *
- * See https://combeenation.myjetbrains.com/youtrack/issue/CB-5906 for further details regarding this warning.
- *
- * Set material of an instanced meshes source mesh.
- * Changes the material of all instanced meshes which have the same source mesh.
- *
- * @param node
- * @param material
- * @param deep
- *
- * @ignore
- */
-declare const setSourceNodeMaterial: (node: TransformNode, material: Material, deep?: boolean) => void;
-/**
- * @param node
- * @param color
- * @param deep
- */
-declare const setMaterialColor: (node: TransformNode, color: Color3, deep?: boolean) => void;
-/**
- * @param node
- * @param texture
- * @param deep
- */
-declare const setMaterialTexture: (node: TransformNode, texture: Texture, deep?: boolean) => void;
-/**
- * @param node
- * @param metallness
- * @param deep
- */
-declare const setMaterialMetallness: (node: TransformNode, metallness: number, deep?: boolean) => void;
-/**
- * @param node
- * @param roughness
- * @param deep
- */
-declare const setMaterialRoughness: (node: TransformNode, roughness: number, deep?: boolean) => void;
-/**
- * @param node
- * @param layer
- * @param color
- * @param deep
- */
-declare const addToHighlightLayer: (layer: HighlightLayer, color: Color3, node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param layer
- * @param deep
- */
-declare const removeFromHighlightLayer: (layer: HighlightLayer, node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param receiveShadows
- * @param deep
- */
-declare const setReceiveShadows: (node: TransformNode, receiveShadows: boolean, deep?: boolean) => void;
-/**
- * @param node
- * @param generator
- * @param deep
- */
-declare const addToShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
-/**
- * @param node
- * @param generator
- * @param deep
- */
-declare const removeFromShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
-/**
- * https://forum.babylonjs.com/t/get-mesh-bounding-box-position-and-size-in-2d-screen-coordinates/1058/3
- * @param mesh
- * @param scene
- * @param canvas
- */
-declare const getClientRectFromMesh: (mesh: AbstractMesh, scene: Scene, canvas: HTMLCanvasElement) => ClientRect;
-export { getRootNode, mapToDottedNodes, getDottedPathForNode, cloneTransformNode, cloneNodeWithParents, cloneTransformNodeMaterial, injectNodeMetadata, assertTransformNode, activateTransformNode, deactivateTransformNode, enableNodeWithParents, disableNodeWithParents, transformTransformNode, setMaterial, setSourceNodeMaterial, setMaterialColor, setMaterialTexture, setMaterialMetallness, setMaterialRoughness, addToHighlightLayer, removeFromHighlightLayer, setReceiveShadows, addToShadowGenerator, removeFromShadowGenerator, getClientRectFromMesh, changeEnvironment, backgroundDomeName, envHelperMetadataName, };
+import { DottedPath } from '../classes/dottedPath';
+import { HighlightLayer } from '@babylonjs/core/Layers/highlightLayer';
+import { ShadowGenerator } from '@babylonjs/core/Lights/Shadows/shadowGenerator';
+import { Material } from '@babylonjs/core/Materials/material';
+import { Color3 } from '@babylonjs/core/Maths/math.color';
+import { AbstractMesh } from '@babylonjs/core/Meshes/abstractMesh';
+import { TransformNode } from '@babylonjs/core/Meshes/transformNode';
+import { Node } from '@babylonjs/core/node';
+import { Scene } from '@babylonjs/core/scene';
+declare const backgroundDomeName = "BackgroundDome_ViewerGenerated";
+declare const envHelperMetadataName = "viewerEnvHelper";
+/**
+ * @param node
+ * @return Node
+ */
+declare const getRootNode: (node: Node) => Node;
+/**
+ * @param nodes
+ * @param predicate
+ * @return Map<DottedPath, T>
+ */
+declare const mapToDottedNodes: <T>(nodes: Node[], predicate?: ((node: Node) => boolean) | undefined) => Map<DottedPath, T>;
+/**
+ * @param node
+ * @return DottedPath
+ */
+declare const getDottedPathForNode: (node: Node) => DottedPath;
+/**
+ * @param node
+ * @param predicate
+ * @param deep
+ * @return TransformNode | null
+ */
+declare const cloneTransformNode: (node: TransformNode, predicate?: ((node: TransformNode) => boolean) | undefined, deep?: boolean) => TransformNode | null;
+/**
+ * @param node
+ */
+declare const cloneNodeWithParents: (node: Node | null) => Node | null;
+/**
+ * @param node
+ * @param deep
+ * @param prefix
+ * @return TransformNode
+ */
+declare const cloneTransformNodeMaterial: (node: TransformNode, prefix?: DottedPathArgument, deep?: boolean) => TransformNode;
+/**
+ * @param node
+ * @param deep
+ * @param metadata
+ */
+declare const injectNodeMetadata: (node: Node, metadata: {}, deep?: boolean) => void;
+/**
+ * @param node
+ * @param assertCallable
+ * @param callableParameters
+ * @param deep
+ */
+declare const assertTransformNode: (node: TransformNode, assertCallable: CallableFunction, callableParameters?: any[], deep?: boolean) => void;
+/**
+ * @param node
+ * @param deep
+ */
+declare const activateTransformNode: (node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param deep
+ */
+declare const deactivateTransformNode: (node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ */
+declare const enableNodeWithParents: (node: Node) => void;
+/**
+ * @param node
+ */
+declare const disableNodeWithParents: (node: Node) => void;
+/**
+ * Applies a {@link TransformationDefinition} consecutively to ensure dependencies in positioning etc.
+ * @param node
+ * @param transformation
+ */
+declare const transformTransformNode: (node: TransformNode, transformation: TransformationDefinition) => void;
+/**
+ * Apply changes of environment (background texture, etc.) consecutively in order to avoid dependency related issues.
+ * @param scene
+ * @param envDef
+ */
+declare const changeEnvironment: (scene: Scene, envDef: EnvironmentDefinition) => void;
+/**
+ * @param node
+ * @param materialName
+ * @param deep
+ */
+declare const setMaterial: (variant: Variant, node: TransformNode, materialName: string, deep?: boolean) => void;
+/**
+ * !!! Warning !!!
+ * This function is not public API. Whilst it can help solving certain problems, it only works reliably in well defined
+ * situations and can cause unwanted side effects under some conditions. Use carefully at your own risk!
+ *
+ * See https://combeenation.myjetbrains.com/youtrack/issue/CB-5906 for further details regarding this warning.
+ *
+ * Set material of an instanced meshes source mesh.
+ * Changes the material of all instanced meshes which have the same source mesh.
+ *
+ * @param node
+ * @param material
+ * @param deep
+ *
+ * @ignore
+ */
+declare const setSourceNodeMaterial: (node: TransformNode, material: Material, deep?: boolean) => void;
+/**
+ * @param node
+ * @param color
+ * @param deep
+ */
+declare const setMaterialColor: (node: TransformNode, color: Color3, deep?: boolean) => void;
+/**
+ * @param node
+ * @param texture
+ * @param deep
+ */
+declare const setMaterialTexture: (node: TransformNode, texture: Texture, deep?: boolean) => void;
+/**
+ * @param node
+ * @param metallness
+ * @param deep
+ */
+declare const setMaterialMetallness: (node: TransformNode, metallness: number, deep?: boolean) => void;
+/**
+ * @param node
+ * @param roughness
+ * @param deep
+ */
+declare const setMaterialRoughness: (node: TransformNode, roughness: number, deep?: boolean) => void;
+/**
+ * @param node
+ * @param layer
+ * @param color
+ * @param deep
+ */
+declare const addToHighlightLayer: (layer: HighlightLayer, color: Color3, node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param layer
+ * @param deep
+ */
+declare const removeFromHighlightLayer: (layer: HighlightLayer, node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param receiveShadows
+ * @param deep
+ */
+declare const setReceiveShadows: (node: TransformNode, receiveShadows: boolean, deep?: boolean) => void;
+/**
+ * @param node
+ * @param generator
+ * @param deep
+ */
+declare const addToShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
+/**
+ * @param node
+ * @param generator
+ * @param deep
+ */
+declare const removeFromShadowGenerator: (generator: ShadowGenerator, node: TransformNode, deep?: boolean) => void;
+/**
+ * https://forum.babylonjs.com/t/get-mesh-bounding-box-position-and-size-in-2d-screen-coordinates/1058/3
+ * @param mesh
+ * @param scene
+ * @param canvas
+ */
+declare const getClientRectFromMesh: (mesh: AbstractMesh, scene: Scene, canvas: HTMLCanvasElement) => ClientRect;
+export { getRootNode, mapToDottedNodes, getDottedPathForNode, cloneTransformNode, cloneNodeWithParents, cloneTransformNodeMaterial, injectNodeMetadata, assertTransformNode, activateTransformNode, deactivateTransformNode, enableNodeWithParents, disableNodeWithParents, transformTransformNode, setMaterial, setSourceNodeMaterial, setMaterialColor, setMaterialTexture, setMaterialMetallness, setMaterialRoughness, addToHighlightLayer, removeFromHighlightLayer, setReceiveShadows, addToShadowGenerator, removeFromShadowGenerator, getClientRectFromMesh, changeEnvironment, backgroundDomeName, envHelperMetadataName, };