⬅️ Back to Table of Contents

📄 VolumeNodeMaterial.js

📊 Analysis Summary

Metric	Count
🔧 Functions	1
🧱 Classes	1
📦 Imports	3

📚 Table of Contents

• Imports
• Functions
• Classes

🛠️ File Location:

📂 src/materials/nodes/VolumeNodeMaterial.js

📦 Imports

Name	Source
NodeMaterial	./NodeMaterial.js
VolumetricLightingModel	../../nodes/functions/VolumetricLightingModel.js
BackSide	../../constants.js

---

Functions

VolumeNodeMaterial.setupLightingModel(): VolumetricLightingModel

Returns: VolumetricLightingModel

Code

setupLightingModel() {

        return new VolumetricLightingModel();

    }

---

Classes

VolumeNodeMaterial

Class Code

class VolumeNodeMaterial extends NodeMaterial {

    static get type() {

        return 'VolumeNodeMaterial';

    }

    /**
     * Constructs a new volume node material.
     *
     * @param {Object} [parameters] - The configuration parameter.
     */
    constructor( parameters ) {

        super();

        /**
         * This flag can be used for type testing.
         *
         * @type {boolean}
         * @readonly
         * @default true
         */
        this.isVolumeNodeMaterial = true;

        /**
         * Number of steps used for raymarching.
         *
         * @type {number}
         * @default 25
         */
        this.steps = 25;

        /**
         * Offsets the distance a ray has been traveled through a volume.
         * Can be used to implement dithering to reduce banding.
         *
         * @type {Node<float>}
         * @default null
         */
        this.offsetNode = null;

        /**
         * Node used for scattering calculations.
         *
         * @type {Function|FunctionNode<vec4>}
         * @default null
         */
        this.scatteringNode = null;

        this.lights = true;

        this.transparent = true;
        this.side = BackSide;

        this.depthTest = false;
        this.depthWrite = false;

        this.setValues( parameters );

    }

    setupLightingModel() {

        return new VolumetricLightingModel();

    }

}

Methods

setupLightingModel(): VolumetricLightingModel

Code

setupLightingModel() {

        return new VolumetricLightingModel();

    }

---