Skip to content

⬅️ Back to Table of Contents

📄 NodeFunction.js

📊 Analysis Summary

Metric Count
🔧 Functions 1
🧱 Classes 1

📚 Table of Contents

🛠️ File Location:

📂 src/nodes/core/NodeFunction.js

Functions

NodeFunction.getCode(): string

JSDoc:

/**
     * This method returns the native code of the node function.
     *
     * @abstract
     * @param {string} name - The function's name.
     * @return {string} A shader code.
     */

Returns: string

Calls:

  • console.warn
Code
getCode( /*name = this.name*/ ) {

        console.warn( 'Abstract function.' );

    }

Classes

NodeFunction

Class Code
class NodeFunction {

    /**
     * Constructs a new node function.
     *
     * @param {string} type - The node type. This type is the return type of the node function.
     * @param {Array<NodeFunctionInput>} inputs - The function's inputs.
     * @param {string} [name=''] - The function's name.
     * @param {string} [precision=''] - The precision qualifier.
     */
    constructor( type, inputs, name = '', precision = '' ) {

        /**
         * The node type. This type is the return type of the node function.
         *
         * @type {string}
         */
        this.type = type;

        /**
         * The function's inputs.
         *
         * @type {Array<NodeFunctionInput>}
         */
        this.inputs = inputs;

        /**
         * The name of the uniform.
         *
         * @type {string}
         * @default ''
         */
        this.name = name;

        /**
         * The precision qualifier.
         *
         * @type {string}
         * @default ''
         */
        this.precision = precision;

    }

    /**
     * This method returns the native code of the node function.
     *
     * @abstract
     * @param {string} name - The function's name.
     * @return {string} A shader code.
     */
    getCode( /*name = this.name*/ ) {

        console.warn( 'Abstract function.' );

    }

}

Methods

getCode(): string
Code
getCode( /*name = this.name*/ ) {

        console.warn( 'Abstract function.' );

    }