@combeenation/3d-viewer 12.4.1 → 13.0.0

package/dist/lib-cjs/api/classes/parameter.d.ts

@@ -1,410 +0,0 @@
-import { Color3 } from '@babylonjs/core/Maths/math.color';
-import { Vector3 } from '@babylonjs/core/Maths/math.vector';
-/**
- * This `Parameter` class defines all parameters that can be consumed and committed by a {@link ParameterObservable}.
- * Use {@link ParameterObservable.addParameterObserver} or {@link ParameterObservable.commitParameters} to either add or
- * commit parameters on your observable objects.
- */
-export declare class Parameter {
-    /**
-     * Constructor.
-     */
-    private constructor();
-    /**
-     * Mutates the visibility. Helper methods are {@link VariantParameterizable.show} and
-     * {@link VariantParameterizable.hide}. Getter and setter is {@link VariantParameterizable.visible}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     * * {@link ViewerLight} Available for all light types
-     *
-     * @parser {@link parseBoolean}
-     */
-    static readonly VISIBLE = "visible";
-    /**
-     * Stretches or compresses some meshes. Getter and setter is {@link VariantParameterizable.scaling}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseScaling}
-     */
-    static readonly SCALING = "scaling";
-    /**
-     * Mutates the material. Getter and setter is {@link VariantParameterizable.material}. The value of this parameter
-     * represents the ID of a baked-in glTF or custom created material in the {@link Variant} tree.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser string
-     */
-    static readonly MATERIAL = "material";
-    /**
-     * Mutates the material color.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseColor}
-     */
-    static readonly MATERIAL_COLOR = "material.color";
-    /**
-     * Mutates the material metallness.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly MATERIAL_METALLNESS = "material.metallness";
-    /**
-     * Mutates the material roughness.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly MATERIAL_ROUGHNESS = "material.roughness";
-    /**
-     * Mutates whether a highlight layer should be enabled.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseBoolean}
-     */
-    static readonly HIGHLIGHT_ENABLED = "highlight.enabled";
-    /**
-     * Changes the highlight color.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseColor}
-     */
-    static readonly HIGHLIGHT_COLOR = "highlight.color";
-    /**
-     * Mutates the highlighted state. Getter and setter is {@link VariantParameterizable.highlighted}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseBoolean}
-     */
-    static readonly HIGHLIGHTED = "highlighted";
-    /**
-     * Mutates the position relative to its origin position. Getter and setter is {@link VariantParameterizable.position}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#position), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#position), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#position)
-     *
-     * @parser {@link parseVector}
-     */
-    static readonly POSITION = "position";
-    /**
-     * Mutates the rotation relative to its origin rotation. Getter and setter is {@link VariantParameterizable.rotation}.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseRotation}
-     */
-    static readonly ROTATION = "rotation";
-    /**
-     * Mutates the color.
-     *
-     * Scopes:
-     * * {@link Material} via {@link TagManager}
-     *
-     * @parser {@link parseColor}
-     */
-    static readonly COLOR = "color";
-    /**
-     * Mutates the metallic.
-     *
-     * Scopes:
-     * * {@link Material} via {@link TagManager}
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly METALLIC = "metallic";
-    /**
-     * Paintables can be used to let the client/browser draw graphics on a 3d model by mutating the texture of a
-     * material.\
-     * For detailed information have a look at the [paintables](./../pages/documentation/Paintables.html) page.
-     *
-     * Also see {@link parsePaintable} for detailed information on which values you can pass to the `paintable`
-     * parameter.
-     *
-     * Scopes:
-     * * {@link Material} via {@link TagManager}
-     *
-     * @parser {@link parsePaintable}
-     *
-     */
-    static readonly PAINTABLE = "paintable";
-    /**
-     * Mutates the roughness.
-     *
-     * Scopes:
-     * * {@link Material} via {@link TagManager}
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly ROUGHNESS = "roughness";
-    /**
-     * Mutates whether a shadow should be casted or not.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseBoolean}
-     */
-    static readonly CAST_SHADOW = "castShadow";
-    /**
-     * Mutates from which lights a shadow should be casted.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseCommaSeparatedList}
-     */
-    static readonly CAST_SHADOW_FROM_LIGHTS = "castShadow.fromLights";
-    /**
-     * Mutates whether to receive shadows or not.
-     *
-     * Scopes:
-     * * {@link Element}
-     * * {@link Variant}
-     *
-     * @parser {@link parseBoolean}
-     */
-    static readonly RECEIVE_SHADOWS = "receiveShadows";
-    /**
-     * Mutates the intensity of Lights.
-     *
-     * Scopes:
-     * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#intensity), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#intensity), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#intensity), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#intensity)
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly INTENSITY = "intensity";
-    /**
-     * Mutates the direction of Lights.
-     *
-     * Scopes:
-     * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#direction), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#direction), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#direction), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#direction)
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly DIRECTION = "direction";
-    /**
-     * Mutates the angle of Lights.
-     *
-     * Scopes:
-     * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#angle)
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly ANGLE = "angle";
-    /**
-     * Mutates the exponent of Lights.
-     *
-     * Scopes:
-     * * {@link ViewerLight} Available for [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#exponent)
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly EXPONENT = "exponent";
-    /**
-     * Mutates the diffuse color of Lights.
-     *
-     * Scopes:
-     * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#diffuse), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#diffuse), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#diffuse), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#diffuse)
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly DIFFUSE = "diffuse";
-    /**
-     * Mutates the specular color of Lights.
-     *
-     * Scopes:
-     * * {@link ViewerLight} Available for [PointLight](https://doc.babylonjs.com/typedoc/classes/babylon.pointlight#specular), [SpotLight](https://doc.babylonjs.com/typedoc/classes/babylon.spotlight#specular), [DirectionalLight](https://doc.babylonjs.com/typedoc/classes/babylon.directionallight#specular), [HemisphericLight](https://doc.babylonjs.com/typedoc/classes/babylon.hemisphericlight#specular)
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly SPECULAR = "specular";
-    /**
-     * Sets the environment. See [BABYLON.Scene.environmentTexture](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#environmentTexture).
-     *
-     * Usually the URL to an `*.env` file.
-     *
-     * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
-     *
-     * Scopes:
-     * * {@link SceneManager}
-     *
-     * @parser string
-     */
-    static readonly ENVIRONMENT = "environment";
-    /**
-     * Sets [BABYLON.Scene.clearColor](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#clearColor)
-     *
-     * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
-     *
-     * Scopes:
-     * * {@link SceneManager}
-     *
-     * @parser {@link parseColor}
-     */
-    static readonly ENVIRONMENT_COLOR = "environment.color";
-    /**
-     * Rotates connected textures, i.e. IBL, reflection, background, ...
-     * Rotation angle in degree.
-     *
-     * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
-     *
-     * Scopes:
-     * * {@link SceneManager}
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly ENVIRONMENT_ROTATION = "environment.rotation";
-    /**
-     * Intensity of IBL. Defaults to 1, usually between 0 & 2.
-     *
-     * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
-     *
-     * Scopes:
-     * * {@link SceneManager}
-     *
-     * @parser {@link parseNumber}
-     */
-    static readonly ENVIRONMENT_INTENSITY = "environment.intensity";
-    /**
-     * Background texture on a [PhotoDome](https://doc.babylonjs.com/divingDeeper/environment/360PhotoDome).
-     * Just background, no IBL or reflection.
-     *
-     * Recommended format is `*.jpg`. HDR files are not supported as background but can be converted to `*.jpg` using
-     * tools like Photoshop, Gimp or various free online converters.
-     *
-     * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
-     *
-     * Scopes:
-     * * {@link SceneManager}
-     *
-     * @parser string
-     */
-    static readonly ENVIRONMENT_BACKGROUND = "environment.background";
-    /**
-     * If `true`, sets a `scene.environmentTexture` and creates a *BackgroundHelper* Node (via
-     * [scene.createDefaultEnvironment](https://doc.babylonjs.com/typedoc/classes/BABYLON.Scene#createDefaultEnvironment))
-     * with two subnodes/meshes:
-     * - BackgroundPlane
-     * - BackgroundSkybox
-     *
-     * The value of this parameter is ignored if {@link ENVIRONMENT_BACKGROUND} is also set.
-     *
-     * See [environment page](./../pages/documentation/Environment.html) for details on how to use this.
-     *
-     * Scopes:
-     * * {@link SceneManager}
-     *
-     * @parser {@link parseBoolean}
-     */
-    static readonly ENVIRONMENT_USEDEFAULT = "environment.usedefault";
-    /**
-     * The {@link ParameterDeclarations} for all parameters in this class.
-     */
-    static get declarations(): ParameterDeclarations;
-    /**
-     * The default {@link ParameterValue}s returned as {@link ParameterBag} for a set of parameters in this class.
-     */
-    static get defaultValues(): ParameterBag;
-    /**
-     * Gets the default {@link ParameterValue} for a given {@link Parameter} declared in this class.
-     */
-    static getDefaultValue(parameter: string): ParameterValue;
-    /**
-     * All parameters defined in this class.
-     */
-    static get all(): string[];
-    /**
-     * Asserts whether given parameter is declared and valid.
-     */
-    static assertParameter(parameterDeclaration: ParameterDeclarations, parameter: string, value: ParameterValue): void;
-    /**
-     * Parses given {@link ParameterBag} with given {@link ParameterDeclarations}.
-     */
-    static parseFromDeclarations(declarations: ParameterDeclarations, parameterBag: ParameterBag): ParsedParameterBag;
-    /**
-     * Parses a string of format `'(x,y,z)'` to a `Vector3`.
-     */
-    static parseVector(value: ParameterValue): Vector3;
-    /**
-     * Stringifies a Vector3 to format `(x,y,z)`.
-     */
-    static stringifyVector(value: Vector3): string;
-    /**
-     * Parses a string of format `'(x,y,z)'` with angular degrees to a `Vector3` with rotation information in radians.
-     */
-    static parseRotation(value: ParameterValue): Vector3;
-    /**
-     * Parses a string of format `'(x,y,z)'` or a simple `number` to a `Vector3` for scaling.
-     */
-    static parseScaling(value: ParameterValue): Vector3;
-    /**
-     * Parses a string of format `'#rrggbb'` or `'(r,g,b)'` to a `Color3`.
-     */
-    static parseColor(value: ParameterValue): Color3;
-    /**
-     * Parses a `boolean` string (`'true'`/`'1'` or `'false'`/`'0'`) or `number` (`1` or `0`) to a `boolean` or
-     * `undefined`.
-     */
-    static parseBoolean(value: ParameterValue): boolean;
-    /**
-     * Parses a number `string` to a `number`.
-     */
-    static parseNumber(value: ParameterValue): number;
-    /**
-     * Parses string defintion of a paintable into a paintable object.\
-     * Here are some examples:
-     * ```ts
-     * // Default definition as JSON object:
-     * '{ "src": "https://path.to/image.jpg", "uScale": 0.5 }'
-     *
-     * // Short hand definition, only contains source string:
-     * 'https://path.to/image.jpg'
-     *
-     * // Full content, paintable texture is flipped in both directions
-     * '{ "src": "https://path.to/image.jpg", "uScale": -1, "vScale": -1, "uOffset": 0, "vOffset": 0 }'
-     *
-     * // SVG content can be used directly:
-     * '<svg>...</svg>'
-     *
-     * // SVG in src property works as well:
-     * '{ "src": "<svg>...</svg>", "uScale": 0.5 }'
-     * ```
-     */
-    static parsePaintable(value: ParameterValue): PaintableValue;
-    /**
-     * Parses a string with comma separated values to a list of strings.
-     */
-    static parseCommaSeparatedList(value: ParameterValue): string[];
-}