Skip to content

⬅️ Back to Table of Contents

📄 MeshLambertNodeMaterial.js

📊 Analysis Summary

Metric Count
🔧 Functions 2
🧱 Classes 1
📦 Imports 4
📊 Variables & Constants 1

📚 Table of Contents

🛠️ File Location:

📂 src/materials/nodes/MeshLambertNodeMaterial.js

📦 Imports

Name Source
NodeMaterial ./NodeMaterial.js
BasicEnvironmentNode ../../nodes/lighting/BasicEnvironmentNode.js
PhongLightingModel ../../nodes/functions/PhongLightingModel.js
MeshLambertMaterial ../MeshLambertMaterial.js

Variables & Constants

Name Type Kind Value Exported
_defaultValues MeshLambertMaterial let/var new MeshLambertMaterial()

Functions

MeshLambertNodeMaterial.setupEnvironment(builder: NodeBuilder): any

JSDoc:

/**
     * Overwritten since this type of material uses {@link BasicEnvironmentNode}
     * to implement the default environment mapping.
     *
     * @param {NodeBuilder} builder - The current node builder.
     * @return {?BasicEnvironmentNode<vec3>} The environment node.
     */

Parameters:

  • builder NodeBuilder

Returns: any

Calls:

  • super.setupEnvironment
Code
setupEnvironment( builder ) {

        const envNode = super.setupEnvironment( builder );

        return envNode ? new BasicEnvironmentNode( envNode ) : null;

    }

MeshLambertNodeMaterial.setupLightingModel(): PhongLightingModel

JSDoc:

/**
     * Setups the lighting model.
     *
     * @return {PhongLightingModel} The lighting model.
     */

Returns: PhongLightingModel

Code
setupLightingModel( /*builder*/ ) {

        return new PhongLightingModel( false ); // ( specular ) -> force lambert

    }

Classes

MeshLambertNodeMaterial

Class Code
class MeshLambertNodeMaterial extends NodeMaterial {

    static get type() {

        return 'MeshLambertNodeMaterial';

    }

    /**
     * Constructs a new mesh lambert 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.isMeshLambertNodeMaterial = true;

        /**
         * Set to `true` because lambert materials react on lights.
         *
         * @type {boolean}
         * @default true
         */
        this.lights = true;

        this.setDefaultValues( _defaultValues );

        this.setValues( parameters );

    }

    /**
     * Overwritten since this type of material uses {@link BasicEnvironmentNode}
     * to implement the default environment mapping.
     *
     * @param {NodeBuilder} builder - The current node builder.
     * @return {?BasicEnvironmentNode<vec3>} The environment node.
     */
    setupEnvironment( builder ) {

        const envNode = super.setupEnvironment( builder );

        return envNode ? new BasicEnvironmentNode( envNode ) : null;

    }

    /**
     * Setups the lighting model.
     *
     * @return {PhongLightingModel} The lighting model.
     */
    setupLightingModel( /*builder*/ ) {

        return new PhongLightingModel( false ); // ( specular ) -> force lambert

    }

}

Methods

setupEnvironment(builder: NodeBuilder): any
Code
setupEnvironment( builder ) {

        const envNode = super.setupEnvironment( builder );

        return envNode ? new BasicEnvironmentNode( envNode ) : null;

    }
setupLightingModel(): PhongLightingModel
Code
setupLightingModel( /*builder*/ ) {

        return new PhongLightingModel( false ); // ( specular ) -> force lambert

    }