@babylonjs/materials 5.0.0-rc.1 → 5.0.0-rc.10

package/grid/gridMaterial.js

@@ -1,262 +1,277 @@
-import { __decorate, __extends } from "tslib";
-import { serializeAsTexture, serialize, expandToProperty, serializeAsColor3, SerializationHelper, serializeAsVector3 } from "@babylonjs/core/Misc/decorators.js";
-import { Vector4, Vector3 } from "@babylonjs/core/Maths/math.vector.js";
-import { Color3 } from "@babylonjs/core/Maths/math.color.js";
-import { MaterialDefines } from "@babylonjs/core/Materials/materialDefines.js";
-import { MaterialHelper } from "@babylonjs/core/Materials/materialHelper.js";
-import { PushMaterial } from "@babylonjs/core/Materials/pushMaterial.js";
-import { MaterialFlags } from "@babylonjs/core/Materials/materialFlags.js";
-import { VertexBuffer } from "@babylonjs/core/Buffers/buffer.js";
-import { RegisterClass } from '@babylonjs/core/Misc/typeStore.js';
-import "./grid.fragment.js";
-import "./grid.vertex.js";
-var GridMaterialDefines = /** @class */ (function (_super) {
-    __extends(GridMaterialDefines, _super);
-    function GridMaterialDefines() {
-        var _this = _super.call(this) || this;
-        _this.OPACITY = false;
-        _this.TRANSPARENT = false;
-        _this.FOG = false;
-        _this.PREMULTIPLYALPHA = false;
-        _this.MAX_LINE = false;
-        _this.UV1 = false;
-        _this.UV2 = false;
-        _this.INSTANCES = false;
-        _this.THIN_INSTANCES = false;
-        _this.IMAGEPROCESSINGPOSTPROCESS = false;
-        _this.SKIPFINALCOLORCLAMP = false;
-        _this.rebuild();
-        return _this;
-    }
-    return GridMaterialDefines;
-}(MaterialDefines));
-/**
- * The grid materials allows you to wrap any shape with a grid.
- * Colors are customizable.
- */
-var GridMaterial = /** @class */ (function (_super) {
-    __extends(GridMaterial, _super);
-    /**
-     * constructor
-     * @param name The name given to the material in order to identify it afterwards.
-     * @param scene The scene the material is used in.
-     */
-    function GridMaterial(name, scene) {
-        var _this = _super.call(this, name, scene) || this;
-        /**
-         * Main color of the grid (e.g. between lines)
-         */
-        _this.mainColor = Color3.Black();
-        /**
-         * Color of the grid lines.
-         */
-        _this.lineColor = Color3.Teal();
-        /**
-         * The scale of the grid compared to unit.
-         */
-        _this.gridRatio = 1.0;
-        /**
-         * Allows setting an offset for the grid lines.
-         */
-        _this.gridOffset = Vector3.Zero();
-        /**
-         * The frequency of thicker lines.
-         */
-        _this.majorUnitFrequency = 10;
-        /**
-         * The visibility of minor units in the grid.
-         */
-        _this.minorUnitVisibility = 0.33;
-        /**
-         * The grid opacity outside of the lines.
-         */
-        _this.opacity = 1.0;
-        /**
-         * Determine RBG output is premultiplied by alpha value.
-         */
-        _this.preMultiplyAlpha = false;
-        /**
-         * Determines if the max line value will be used instead of the sum wherever grid lines intersect.
-         */
-        _this.useMaxLine = false;
-        _this._gridControl = new Vector4(_this.gridRatio, _this.majorUnitFrequency, _this.minorUnitVisibility, _this.opacity);
-        return _this;
-    }
-    /**
-     * Returns wehter or not the grid requires alpha blending.
-     */
-    GridMaterial.prototype.needAlphaBlending = function () {
-        return this.opacity < 1.0 || this._opacityTexture && this._opacityTexture.isReady();
-    };
-    GridMaterial.prototype.needAlphaBlendingForMesh = function (mesh) {
-        return mesh.visibility < 1.0 || this.needAlphaBlending();
-    };
-    GridMaterial.prototype.isReadyForSubMesh = function (mesh, subMesh, useInstances) {
-        if (this.isFrozen) {
-            if (subMesh.effect && subMesh.effect._wasPreviouslyReady) {
-                return true;
-            }
-        }
-        if (!subMesh.materialDefines) {
-            subMesh.materialDefines = new GridMaterialDefines();
-        }
-        var defines = subMesh.materialDefines;
-        var scene = this.getScene();
-        if (this._isReadyForSubMesh(subMesh)) {
-            return true;
-        }
-        if (defines.TRANSPARENT !== (this.opacity < 1.0)) {
-            defines.TRANSPARENT = !defines.TRANSPARENT;
-            defines.markAsUnprocessed();
-        }
-        if (defines.PREMULTIPLYALPHA != this.preMultiplyAlpha) {
-            defines.PREMULTIPLYALPHA = !defines.PREMULTIPLYALPHA;
-            defines.markAsUnprocessed();
-        }
-        if (defines.MAX_LINE !== this.useMaxLine) {
-            defines.MAX_LINE = !defines.MAX_LINE;
-            defines.markAsUnprocessed();
-        }
-        // Textures
-        if (defines._areTexturesDirty) {
-            defines._needUVs = false;
-            if (scene.texturesEnabled) {
-                if (this._opacityTexture && MaterialFlags.OpacityTextureEnabled) {
-                    if (!this._opacityTexture.isReady()) {
-                        return false;
-                    }
-                    else {
-                        defines._needUVs = true;
-                        defines.OPACITY = true;
-                    }
-                }
-            }
-        }
-        MaterialHelper.PrepareDefinesForMisc(mesh, scene, false, false, this.fogEnabled, false, defines);
-        // Values that need to be evaluated on every frame
-        MaterialHelper.PrepareDefinesForFrameBoundValues(scene, scene.getEngine(), defines, !!useInstances);
-        // Get correct effect
-        if (defines.isDirty) {
-            defines.markAsProcessed();
-            scene.resetCachedMaterial();
-            // Attributes
-            MaterialHelper.PrepareDefinesForAttributes(mesh, defines, false, false);
-            var attribs = [VertexBuffer.PositionKind, VertexBuffer.NormalKind];
-            if (defines.UV1) {
-                attribs.push(VertexBuffer.UVKind);
-            }
-            if (defines.UV2) {
-                attribs.push(VertexBuffer.UV2Kind);
-            }
-            defines.IMAGEPROCESSINGPOSTPROCESS = scene.imageProcessingConfiguration.applyByPostProcess;
-            MaterialHelper.PrepareAttributesForInstances(attribs, defines);
-            // Defines
-            var join = defines.toString();
-            subMesh.setEffect(scene.getEngine().createEffect("grid", attribs, ["projection", "mainColor", "lineColor", "gridControl", "gridOffset", "vFogInfos", "vFogColor", "world", "view",
-                "opacityMatrix", "vOpacityInfos", "visibility"], ["opacitySampler"], join, undefined, this.onCompiled, this.onError), defines, this._materialContext);
-        }
-        if (!subMesh.effect || !subMesh.effect.isReady()) {
-            return false;
-        }
-        defines._renderId = scene.getRenderId();
-        subMesh.effect._wasPreviouslyReady = true;
-        return true;
-    };
-    GridMaterial.prototype.bindForSubMesh = function (world, mesh, subMesh) {
-        var scene = this.getScene();
-        var defines = subMesh.materialDefines;
-        if (!defines) {
-            return;
-        }
-        var effect = subMesh.effect;
-        if (!effect) {
-            return;
-        }
-        this._activeEffect = effect;
-        this._activeEffect.setFloat("visibility", mesh.visibility);
-        // Matrices
-        if (!defines.INSTANCES || defines.THIN_INSTANCE) {
-            this.bindOnlyWorldMatrix(world);
-        }
-        this._activeEffect.setMatrix("view", scene.getViewMatrix());
-        this._activeEffect.setMatrix("projection", scene.getProjectionMatrix());
-        // Uniforms
-        if (this._mustRebind(scene, effect)) {
-            this._activeEffect.setColor3("mainColor", this.mainColor);
-            this._activeEffect.setColor3("lineColor", this.lineColor);
-            this._activeEffect.setVector3("gridOffset", this.gridOffset);
-            this._gridControl.x = this.gridRatio;
-            this._gridControl.y = Math.round(this.majorUnitFrequency);
-            this._gridControl.z = this.minorUnitVisibility;
-            this._gridControl.w = this.opacity;
-            this._activeEffect.setVector4("gridControl", this._gridControl);
-            if (this._opacityTexture && MaterialFlags.OpacityTextureEnabled) {
-                this._activeEffect.setTexture("opacitySampler", this._opacityTexture);
-                this._activeEffect.setFloat2("vOpacityInfos", this._opacityTexture.coordinatesIndex, this._opacityTexture.level);
-                this._activeEffect.setMatrix("opacityMatrix", this._opacityTexture.getTextureMatrix());
-            }
-        }
-        // Fog
-        MaterialHelper.BindFogParameters(scene, mesh, this._activeEffect);
-        this._afterBind(mesh, this._activeEffect);
-    };
-    /**
-     * Dispose the material and its associated resources.
-     * @param forceDisposeEffect will also dispose the used effect when true
-     */
-    GridMaterial.prototype.dispose = function (forceDisposeEffect) {
-        _super.prototype.dispose.call(this, forceDisposeEffect);
-    };
-    GridMaterial.prototype.clone = function (name) {
-        var _this = this;
-        return SerializationHelper.Clone(function () { return new GridMaterial(name, _this.getScene()); }, this);
-    };
-    GridMaterial.prototype.serialize = function () {
-        var serializationObject = SerializationHelper.Serialize(this);
-        serializationObject.customType = "BABYLON.GridMaterial";
-        return serializationObject;
-    };
-    GridMaterial.prototype.getClassName = function () {
-        return "GridMaterial";
-    };
-    GridMaterial.Parse = function (source, scene, rootUrl) {
-        return SerializationHelper.Parse(function () { return new GridMaterial(source.name, scene); }, source, scene, rootUrl);
-    };
-    __decorate([
-        serializeAsColor3()
-    ], GridMaterial.prototype, "mainColor", void 0);
-    __decorate([
-        serializeAsColor3()
-    ], GridMaterial.prototype, "lineColor", void 0);
-    __decorate([
-        serialize()
-    ], GridMaterial.prototype, "gridRatio", void 0);
-    __decorate([
-        serializeAsVector3()
-    ], GridMaterial.prototype, "gridOffset", void 0);
-    __decorate([
-        serialize()
-    ], GridMaterial.prototype, "majorUnitFrequency", void 0);
-    __decorate([
-        serialize()
-    ], GridMaterial.prototype, "minorUnitVisibility", void 0);
-    __decorate([
-        serialize()
-    ], GridMaterial.prototype, "opacity", void 0);
-    __decorate([
-        serialize()
-    ], GridMaterial.prototype, "preMultiplyAlpha", void 0);
-    __decorate([
-        serialize()
-    ], GridMaterial.prototype, "useMaxLine", void 0);
-    __decorate([
-        serializeAsTexture("opacityTexture")
-    ], GridMaterial.prototype, "_opacityTexture", void 0);
-    __decorate([
-        expandToProperty("_markAllSubMeshesAsTexturesDirty")
-    ], GridMaterial.prototype, "opacityTexture", void 0);
-    return GridMaterial;
-}(PushMaterial));
-export { GridMaterial };
-RegisterClass("BABYLON.GridMaterial", GridMaterial);
+import { __decorate, __extends } from "tslib";
+/* eslint-disable @typescript-eslint/naming-convention */
+import { serializeAsTexture, serialize, expandToProperty, serializeAsColor3, SerializationHelper, serializeAsVector3 } from "@babylonjs/core/Misc/decorators.js";
+import { Vector4, Vector3 } from "@babylonjs/core/Maths/math.vector.js";
+import { Color3 } from "@babylonjs/core/Maths/math.color.js";
+import { MaterialDefines } from "@babylonjs/core/Materials/materialDefines.js";
+import { MaterialHelper } from "@babylonjs/core/Materials/materialHelper.js";
+import { PushMaterial } from "@babylonjs/core/Materials/pushMaterial.js";
+import { MaterialFlags } from "@babylonjs/core/Materials/materialFlags.js";
+import { VertexBuffer } from "@babylonjs/core/Buffers/buffer.js";
+import { RegisterClass } from "@babylonjs/core/Misc/typeStore.js";
+import "./grid.fragment";
+import "./grid.vertex";
+var GridMaterialDefines = /** @class */ (function (_super) {
+    __extends(GridMaterialDefines, _super);
+    function GridMaterialDefines() {
+        var _this = _super.call(this) || this;
+        _this.OPACITY = false;
+        _this.TRANSPARENT = false;
+        _this.FOG = false;
+        _this.PREMULTIPLYALPHA = false;
+        _this.MAX_LINE = false;
+        _this.UV1 = false;
+        _this.UV2 = false;
+        _this.INSTANCES = false;
+        _this.THIN_INSTANCES = false;
+        _this.IMAGEPROCESSINGPOSTPROCESS = false;
+        _this.SKIPFINALCOLORCLAMP = false;
+        _this.rebuild();
+        return _this;
+    }
+    return GridMaterialDefines;
+}(MaterialDefines));
+/**
+ * The grid materials allows you to wrap any shape with a grid.
+ * Colors are customizable.
+ */
+var GridMaterial = /** @class */ (function (_super) {
+    __extends(GridMaterial, _super);
+    /**
+     * constructor
+     * @param name The name given to the material in order to identify it afterwards.
+     * @param scene The scene the material is used in.
+     */
+    function GridMaterial(name, scene) {
+        var _this = _super.call(this, name, scene) || this;
+        /**
+         * Main color of the grid (e.g. between lines)
+         */
+        _this.mainColor = Color3.Black();
+        /**
+         * Color of the grid lines.
+         */
+        _this.lineColor = Color3.Teal();
+        /**
+         * The scale of the grid compared to unit.
+         */
+        _this.gridRatio = 1.0;
+        /**
+         * Allows setting an offset for the grid lines.
+         */
+        _this.gridOffset = Vector3.Zero();
+        /**
+         * The frequency of thicker lines.
+         */
+        _this.majorUnitFrequency = 10;
+        /**
+         * The visibility of minor units in the grid.
+         */
+        _this.minorUnitVisibility = 0.33;
+        /**
+         * The grid opacity outside of the lines.
+         */
+        _this.opacity = 1.0;
+        /**
+         * Determine RBG output is premultiplied by alpha value.
+         */
+        _this.preMultiplyAlpha = false;
+        /**
+         * Determines if the max line value will be used instead of the sum wherever grid lines intersect.
+         */
+        _this.useMaxLine = false;
+        _this._gridControl = new Vector4(_this.gridRatio, _this.majorUnitFrequency, _this.minorUnitVisibility, _this.opacity);
+        return _this;
+    }
+    /**
+     * Returns whether or not the grid requires alpha blending.
+     */
+    GridMaterial.prototype.needAlphaBlending = function () {
+        return this.opacity < 1.0 || (this._opacityTexture && this._opacityTexture.isReady());
+    };
+    GridMaterial.prototype.needAlphaBlendingForMesh = function (mesh) {
+        return mesh.visibility < 1.0 || this.needAlphaBlending();
+    };
+    GridMaterial.prototype.isReadyForSubMesh = function (mesh, subMesh, useInstances) {
+        if (this.isFrozen) {
+            if (subMesh.effect && subMesh.effect._wasPreviouslyReady) {
+                return true;
+            }
+        }
+        if (!subMesh.materialDefines) {
+            subMesh.materialDefines = new GridMaterialDefines();
+        }
+        var defines = subMesh.materialDefines;
+        var scene = this.getScene();
+        if (this._isReadyForSubMesh(subMesh)) {
+            return true;
+        }
+        if (defines.TRANSPARENT !== this.opacity < 1.0) {
+            defines.TRANSPARENT = !defines.TRANSPARENT;
+            defines.markAsUnprocessed();
+        }
+        if (defines.PREMULTIPLYALPHA != this.preMultiplyAlpha) {
+            defines.PREMULTIPLYALPHA = !defines.PREMULTIPLYALPHA;
+            defines.markAsUnprocessed();
+        }
+        if (defines.MAX_LINE !== this.useMaxLine) {
+            defines.MAX_LINE = !defines.MAX_LINE;
+            defines.markAsUnprocessed();
+        }
+        // Textures
+        if (defines._areTexturesDirty) {
+            defines._needUVs = false;
+            if (scene.texturesEnabled) {
+                if (this._opacityTexture && MaterialFlags.OpacityTextureEnabled) {
+                    if (!this._opacityTexture.isReady()) {
+                        return false;
+                    }
+                    else {
+                        defines._needUVs = true;
+                        defines.OPACITY = true;
+                    }
+                }
+            }
+        }
+        MaterialHelper.PrepareDefinesForMisc(mesh, scene, false, false, this.fogEnabled, false, defines);
+        // Values that need to be evaluated on every frame
+        MaterialHelper.PrepareDefinesForFrameBoundValues(scene, scene.getEngine(), defines, !!useInstances);
+        // Get correct effect
+        if (defines.isDirty) {
+            defines.markAsProcessed();
+            scene.resetCachedMaterial();
+            // Attributes
+            MaterialHelper.PrepareDefinesForAttributes(mesh, defines, false, false);
+            var attribs = [VertexBuffer.PositionKind, VertexBuffer.NormalKind];
+            if (defines.UV1) {
+                attribs.push(VertexBuffer.UVKind);
+            }
+            if (defines.UV2) {
+                attribs.push(VertexBuffer.UV2Kind);
+            }
+            defines.IMAGEPROCESSINGPOSTPROCESS = scene.imageProcessingConfiguration.applyByPostProcess;
+            MaterialHelper.PrepareAttributesForInstances(attribs, defines);
+            // Defines
+            var join = defines.toString();
+            subMesh.setEffect(scene
+                .getEngine()
+                .createEffect("grid", attribs, [
+                "projection",
+                "mainColor",
+                "lineColor",
+                "gridControl",
+                "gridOffset",
+                "vFogInfos",
+                "vFogColor",
+                "world",
+                "view",
+                "opacityMatrix",
+                "vOpacityInfos",
+                "visibility",
+            ], ["opacitySampler"], join, undefined, this.onCompiled, this.onError), defines, this._materialContext);
+        }
+        if (!subMesh.effect || !subMesh.effect.isReady()) {
+            return false;
+        }
+        defines._renderId = scene.getRenderId();
+        subMesh.effect._wasPreviouslyReady = true;
+        return true;
+    };
+    GridMaterial.prototype.bindForSubMesh = function (world, mesh, subMesh) {
+        var scene = this.getScene();
+        var defines = subMesh.materialDefines;
+        if (!defines) {
+            return;
+        }
+        var effect = subMesh.effect;
+        if (!effect) {
+            return;
+        }
+        this._activeEffect = effect;
+        this._activeEffect.setFloat("visibility", mesh.visibility);
+        // Matrices
+        if (!defines.INSTANCES || defines.THIN_INSTANCE) {
+            this.bindOnlyWorldMatrix(world);
+        }
+        this._activeEffect.setMatrix("view", scene.getViewMatrix());
+        this._activeEffect.setMatrix("projection", scene.getProjectionMatrix());
+        // Uniforms
+        if (this._mustRebind(scene, effect)) {
+            this._activeEffect.setColor3("mainColor", this.mainColor);
+            this._activeEffect.setColor3("lineColor", this.lineColor);
+            this._activeEffect.setVector3("gridOffset", this.gridOffset);
+            this._gridControl.x = this.gridRatio;
+            this._gridControl.y = Math.round(this.majorUnitFrequency);
+            this._gridControl.z = this.minorUnitVisibility;
+            this._gridControl.w = this.opacity;
+            this._activeEffect.setVector4("gridControl", this._gridControl);
+            if (this._opacityTexture && MaterialFlags.OpacityTextureEnabled) {
+                this._activeEffect.setTexture("opacitySampler", this._opacityTexture);
+                this._activeEffect.setFloat2("vOpacityInfos", this._opacityTexture.coordinatesIndex, this._opacityTexture.level);
+                this._activeEffect.setMatrix("opacityMatrix", this._opacityTexture.getTextureMatrix());
+            }
+        }
+        // Fog
+        MaterialHelper.BindFogParameters(scene, mesh, this._activeEffect);
+        this._afterBind(mesh, this._activeEffect);
+    };
+    /**
+     * Dispose the material and its associated resources.
+     * @param forceDisposeEffect will also dispose the used effect when true
+     */
+    GridMaterial.prototype.dispose = function (forceDisposeEffect) {
+        _super.prototype.dispose.call(this, forceDisposeEffect);
+    };
+    GridMaterial.prototype.clone = function (name) {
+        var _this = this;
+        return SerializationHelper.Clone(function () { return new GridMaterial(name, _this.getScene()); }, this);
+    };
+    GridMaterial.prototype.serialize = function () {
+        var serializationObject = SerializationHelper.Serialize(this);
+        serializationObject.customType = "BABYLON.GridMaterial";
+        return serializationObject;
+    };
+    GridMaterial.prototype.getClassName = function () {
+        return "GridMaterial";
+    };
+    GridMaterial.Parse = function (source, scene, rootUrl) {
+        return SerializationHelper.Parse(function () { return new GridMaterial(source.name, scene); }, source, scene, rootUrl);
+    };
+    __decorate([
+        serializeAsColor3()
+    ], GridMaterial.prototype, "mainColor", void 0);
+    __decorate([
+        serializeAsColor3()
+    ], GridMaterial.prototype, "lineColor", void 0);
+    __decorate([
+        serialize()
+    ], GridMaterial.prototype, "gridRatio", void 0);
+    __decorate([
+        serializeAsVector3()
+    ], GridMaterial.prototype, "gridOffset", void 0);
+    __decorate([
+        serialize()
+    ], GridMaterial.prototype, "majorUnitFrequency", void 0);
+    __decorate([
+        serialize()
+    ], GridMaterial.prototype, "minorUnitVisibility", void 0);
+    __decorate([
+        serialize()
+    ], GridMaterial.prototype, "opacity", void 0);
+    __decorate([
+        serialize()
+    ], GridMaterial.prototype, "preMultiplyAlpha", void 0);
+    __decorate([
+        serialize()
+    ], GridMaterial.prototype, "useMaxLine", void 0);
+    __decorate([
+        serializeAsTexture("opacityTexture")
+    ], GridMaterial.prototype, "_opacityTexture", void 0);
+    __decorate([
+        expandToProperty("_markAllSubMeshesAsTexturesDirty")
+    ], GridMaterial.prototype, "opacityTexture", void 0);
+    return GridMaterial;
+}(PushMaterial));
+export { GridMaterial };
+RegisterClass("BABYLON.GridMaterial", GridMaterial);
 //# sourceMappingURL=gridMaterial.js.map