Babylon.js/src/Materials/Textures/Procedurals/babylon.noiseProceduralTexture.ts

module BABYLON {
    /**
     * Class used to generate noise procedural textures
     */
    export class NoiseProceduralTexture extends ProceduralTexture {
        private _time = 0;

        /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
        public brightness = 0.2;

        /** Defines the number of octaves to process */
        public octaves = 3;

        /** Defines the level of persistence (0.8 by default) */
        public persistence = 0.8;

        /** Gets or sets animation speed factor (default is 1) */
        public animationSpeedFactor = 1;

        /**
         * Creates a new NoiseProceduralTexture
         * @param name defines the name fo the texture
         * @param size defines the size of the texture (default is 256)
         * @param scene defines the hosting scene
         * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
         * @param generateMipMaps defines if mipmaps must be generated (true by default)
         */
        constructor(name: string, size: number = 256, scene: Nullable<Scene> = Engine.LastCreatedScene, fallbackTexture?: Texture, generateMipMaps?: boolean) {
            super(name, size, "noise", scene, fallbackTexture, generateMipMaps);
            this.autoClear = false;
            this._updateShaderUniforms();
        }

        private _updateShaderUniforms() {
            let scene = this.getScene();

            if (!scene) {
                return;
            }

            this._time += scene.getAnimationRatio() * this.animationSpeedFactor * 0.01;

            this.setFloat("brightness", this.brightness);
            this.setFloat("persistence", this.persistence);
            this.setFloat("timeScale", this._time);
        }

        protected _getDefines(): string {
            return "#define OCTAVES " + (this.octaves | 0);
        }

        /** Generate the current state of the procedural texture */
        public render(useCameraPostProcess?: boolean) {
            this._updateShaderUniforms();
            super.render(useCameraPostProcess);
        }

        /**
         * Serializes this noise procedural texture
         * @returns a serialized noise procedural texture object
         */
        public serialize(): any {
            var serializationObject: any = {};
            serializationObject.customType = "BABYLON.NoiseProceduralTexture";

            serializationObject.brightness = this.brightness;
            serializationObject.octaves = this.octaves;
            serializationObject.persistence = this.persistence;
            serializationObject.animationSpeedFactor = this.animationSpeedFactor;
            serializationObject.size = this.getSize().width;
            serializationObject.generateMipMaps = this._generateMipMaps;

            return serializationObject;
        }

        /**
         * Creates a NoiseProceduralTexture from parsed noise procedural texture data
         * @param parsedTexture defines parsed texture data
         * @param scene defines the current scene
         * @param rootUrl defines the root URL containing noise procedural texture information
         * @returns a parsed NoiseProceduralTexture
         */
        public static Parse(parsedTexture: any, scene: Scene, rootUrl: string): NoiseProceduralTexture {
            var texture = new NoiseProceduralTexture(parsedTexture.name, parsedTexture.size, scene, undefined, parsedTexture.generateMipMaps);

            texture.brightness = parsedTexture.brightness;
            texture.octaves = parsedTexture.octaves;
            texture.persistence = parsedTexture.persistence;
            texture.animationSpeedFactor = parsedTexture.animationSpeedFactor;

            return texture;
        }
    }
}