📄 `UniformNode.js`¶

📊 Analysis Summary¶

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

📚 Table of Contents¶

Imports
Variables & Constants
Functions
Classes

🛠️ File Location:¶

📂 src/nodes/core/UniformNode.js

📦 Imports¶

Name	Source
`InputNode`	`./InputNode.js`
`objectGroup`	`./UniformGroupNode.js`
`nodeObject`	`../tsl/TSLCore.js`
`getConstNodeType`	`../tsl/TSLCore.js`
`getValueFromType`	`./NodeUtils.js`

Variables & Constants¶

Name	Type	Kind	Value	Exported
`snippet`	`any`	let/var	`uniformName`	✗
`propertyName`	`any`	let/var	`nodeData.propertyName`	✗

Functions¶

`UniformNode.setName(name: string): UniformNode`¶

JSDoc:

/**
     * Sets the {@link UniformNode#name} property.
     *
     * @param {string} name - The name of the uniform.
     * @return {UniformNode} A reference to this node.
     */

Parameters:

name string

Returns: UniformNode

Code

setName( name ) {

        this.name = name;

        return this;

    }

`UniformNode.label(name: string): UniformNode`¶

JSDoc:

/**
     * Sets the {@link UniformNode#name} property.
     *
     * @deprecated
     * @param {string} name - The name of the uniform.
     * @return {UniformNode} A reference to this node.
     */

Parameters:

name string

Returns: UniformNode

Calls:

console.warn
this.setName

Code

label( name ) {

        console.warn( 'THREE.TSL: "label()" has been deprecated. Use "setName()" instead.' ); // @deprecated r179

        return this.setName( name );

    }

`UniformNode.setGroup(group: UniformGroupNode): UniformNode`¶

JSDoc:

/**
     * Sets the {@link UniformNode#groupNode} property.
     *
     * @param {UniformGroupNode} group - The uniform group.
     * @return {UniformNode} A reference to this node.
     */

Parameters:

group UniformGroupNode

Returns: UniformNode

Code

setGroup( group ) {

        this.groupNode = group;

        return this;

    }

`UniformNode.getGroup(): UniformGroupNode`¶

JSDoc:

/**
     * Returns the {@link UniformNode#groupNode}.
     *
     * @return {UniformGroupNode} The uniform group.
     */

Returns: UniformGroupNode

Code

getGroup() {

        return this.groupNode;

    }

`UniformNode.getUniformHash(builder: NodeBuilder): string`¶

JSDoc:

/**
     * By default, this method returns the result of {@link Node#getHash} but derived
     * classes might overwrite this method with a different implementation.
     *
     * @param {NodeBuilder} builder - The current node builder.
     * @return {string} The uniform hash.
     */

Parameters:

builder NodeBuilder

Returns: string

Calls:

this.getHash

Code

getUniformHash( builder ) {

        return this.getHash( builder );

    }

`UniformNode.onUpdate(callback: any, updateType: any): Node`¶

Parameters:

callback any
updateType any

Returns: Node

Calls:

this.getSelf
callback.bind
super.onUpdate
callback

Code

onUpdate( callback, updateType ) {

        const self = this.getSelf();

        callback = callback.bind( self );

        return super.onUpdate( ( frame ) => {

            const value = callback( frame, self );

            if ( value !== undefined ) {

                this.value = value;

            }

        }, updateType );

    }

`UniformNode.getInputType(builder: any): string`¶

Parameters:

builder any

Returns: string

Calls:

super.getInputType

Code

getInputType( builder ) {

        let type = super.getInputType( builder );

        if ( type === 'bool' ) {

            type = 'uint';

        }

        return type;

    }

`UniformNode.generate(builder: any, output: any): any`¶

Parameters:

builder any
output any

Returns: any

Calls:

this.getNodeType
this.getUniformHash
builder.getNodeFromHash
builder.setHashNode
sharedNode.getInputType
builder.getUniformFromNode
builder.getPropertyName
builder.getDataFromNode
builder.getVarFromNode
builder.format
builder.addLineFlowCode

Internal Comments:

// (x2)
// cache to variable (x2)

Code

generate( builder, output ) {

        const type = this.getNodeType( builder );

        const hash = this.getUniformHash( builder );

        let sharedNode = builder.getNodeFromHash( hash );

        if ( sharedNode === undefined ) {

            builder.setHashNode( this, hash );

            sharedNode = this;

        }

        const sharedNodeType = sharedNode.getInputType( builder );

        const nodeUniform = builder.getUniformFromNode( sharedNode, sharedNodeType, builder.shaderStage, this.name || builder.context.nodeName );
        const uniformName = builder.getPropertyName( nodeUniform );

        if ( builder.context.nodeName !== undefined ) delete builder.context.nodeName;

        //

        let snippet = uniformName;

        if ( type === 'bool' ) {

            // cache to variable

            const nodeData = builder.getDataFromNode( this );

            let propertyName = nodeData.propertyName;

            if ( propertyName === undefined ) {

                const nodeVar = builder.getVarFromNode( this, null, 'bool' );
                propertyName = builder.getPropertyName( nodeVar );

                nodeData.propertyName = propertyName;

                snippet = builder.format( uniformName, sharedNodeType, type );

                builder.addLineFlowCode( `${ propertyName } = ${ snippet }`, this );

            }

            snippet = propertyName;

        }

        return builder.format( snippet, type, output );

    }

`uniform(value: any, type: string): UniformNode`¶

Parameters:

value any
type string

Returns: UniformNode

Calls:

getConstNodeType (from ../tsl/TSLCore.js)
getValueFromType (from ./NodeUtils.js)
nodeObject (from ../tsl/TSLCore.js)

Internal Comments:

// if the value is a type but no having a value (x3)
// @TODO: get ConstNode from .traverse() in the future (x3)

Code

( value, type ) => {

    const nodeType = getConstNodeType( type || value );

    if ( nodeType === value ) {

        // if the value is a type but no having a value

        value = getValueFromType( nodeType );

    }

    // @TODO: get ConstNode from .traverse() in the future
    value = ( value && value.isNode === true ) ? ( value.node && value.node.value ) || value.value : value;

    return nodeObject( new UniformNode( value, nodeType ) );

}

Classes¶

`UniformNode`¶

Class Code

class UniformNode extends InputNode {

    static get type() {

        return 'UniformNode';

    }

    /**
     * Constructs a new uniform node.
     *
     * @param {any} value - The value of this node. Usually a JS primitive or three.js object (vector, matrix, color, texture).
     * @param {?string} nodeType - The node type. If no explicit type is defined, the node tries to derive the type from its value.
     */
    constructor( value, nodeType = null ) {

        super( value, nodeType );

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

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

        /**
         * The uniform group of this uniform. By default, uniforms are
         * managed per object but they might belong to a shared group
         * which is updated per frame or render call.
         *
         * @type {UniformGroupNode}
         */
        this.groupNode = objectGroup;

    }

    /**
     * Sets the {@link UniformNode#name} property.
     *
     * @param {string} name - The name of the uniform.
     * @return {UniformNode} A reference to this node.
     */
    setName( name ) {

        this.name = name;

        return this;

    }

    /**
     * Sets the {@link UniformNode#name} property.
     *
     * @deprecated
     * @param {string} name - The name of the uniform.
     * @return {UniformNode} A reference to this node.
     */
    label( name ) {

        console.warn( 'THREE.TSL: "label()" has been deprecated. Use "setName()" instead.' ); // @deprecated r179

        return this.setName( name );

    }

    /**
     * Sets the {@link UniformNode#groupNode} property.
     *
     * @param {UniformGroupNode} group - The uniform group.
     * @return {UniformNode} A reference to this node.
     */
    setGroup( group ) {

        this.groupNode = group;

        return this;

    }

    /**
     * Returns the {@link UniformNode#groupNode}.
     *
     * @return {UniformGroupNode} The uniform group.
     */
    getGroup() {

        return this.groupNode;

    }

    /**
     * By default, this method returns the result of {@link Node#getHash} but derived
     * classes might overwrite this method with a different implementation.
     *
     * @param {NodeBuilder} builder - The current node builder.
     * @return {string} The uniform hash.
     */
    getUniformHash( builder ) {

        return this.getHash( builder );

    }

    onUpdate( callback, updateType ) {

        const self = this.getSelf();

        callback = callback.bind( self );

        return super.onUpdate( ( frame ) => {

            const value = callback( frame, self );

            if ( value !== undefined ) {

                this.value = value;

            }

        }, updateType );

    }

    getInputType( builder ) {

        let type = super.getInputType( builder );

        if ( type === 'bool' ) {

            type = 'uint';

        }

        return type;

    }

    generate( builder, output ) {

        const type = this.getNodeType( builder );

        const hash = this.getUniformHash( builder );

        let sharedNode = builder.getNodeFromHash( hash );

        if ( sharedNode === undefined ) {

            builder.setHashNode( this, hash );

            sharedNode = this;

        }

        const sharedNodeType = sharedNode.getInputType( builder );

        const nodeUniform = builder.getUniformFromNode( sharedNode, sharedNodeType, builder.shaderStage, this.name || builder.context.nodeName );
        const uniformName = builder.getPropertyName( nodeUniform );

        if ( builder.context.nodeName !== undefined ) delete builder.context.nodeName;

        //

        let snippet = uniformName;

        if ( type === 'bool' ) {

            // cache to variable

            const nodeData = builder.getDataFromNode( this );

            let propertyName = nodeData.propertyName;

            if ( propertyName === undefined ) {

                const nodeVar = builder.getVarFromNode( this, null, 'bool' );
                propertyName = builder.getPropertyName( nodeVar );

                nodeData.propertyName = propertyName;

                snippet = builder.format( uniformName, sharedNodeType, type );

                builder.addLineFlowCode( `${ propertyName } = ${ snippet }`, this );

            }

            snippet = propertyName;

        }

        return builder.format( snippet, type, output );

    }

}

Methods¶

`setName(name: string): UniformNode`¶

Code

setName( name ) {

        this.name = name;

        return this;

    }

`label(name: string): UniformNode`¶

Code

label( name ) {

        console.warn( 'THREE.TSL: "label()" has been deprecated. Use "setName()" instead.' ); // @deprecated r179

        return this.setName( name );

    }

`setGroup(group: UniformGroupNode): UniformNode`¶

Code

setGroup( group ) {

        this.groupNode = group;

        return this;

    }

`getGroup(): UniformGroupNode`¶

Code

getGroup() {

        return this.groupNode;

    }

`getUniformHash(builder: NodeBuilder): string`¶

Code

getUniformHash( builder ) {

        return this.getHash( builder );

    }

`onUpdate(callback: any, updateType: any): Node`¶

Code

onUpdate( callback, updateType ) {

        const self = this.getSelf();

        callback = callback.bind( self );

        return super.onUpdate( ( frame ) => {

            const value = callback( frame, self );

            if ( value !== undefined ) {

                this.value = value;

            }

        }, updateType );

    }

`getInputType(builder: any): string`¶

Code

getInputType( builder ) {

        let type = super.getInputType( builder );

        if ( type === 'bool' ) {

            type = 'uint';

        }

        return type;

    }

`generate(builder: any, output: any): any`¶

Code

generate( builder, output ) {

        const type = this.getNodeType( builder );

        const hash = this.getUniformHash( builder );

        let sharedNode = builder.getNodeFromHash( hash );

        if ( sharedNode === undefined ) {

            builder.setHashNode( this, hash );

            sharedNode = this;

        }

        const sharedNodeType = sharedNode.getInputType( builder );

        const nodeUniform = builder.getUniformFromNode( sharedNode, sharedNodeType, builder.shaderStage, this.name || builder.context.nodeName );
        const uniformName = builder.getPropertyName( nodeUniform );

        if ( builder.context.nodeName !== undefined ) delete builder.context.nodeName;

        //

        let snippet = uniformName;

        if ( type === 'bool' ) {

            // cache to variable

            const nodeData = builder.getDataFromNode( this );

            let propertyName = nodeData.propertyName;

            if ( propertyName === undefined ) {

                const nodeVar = builder.getVarFromNode( this, null, 'bool' );
                propertyName = builder.getPropertyName( nodeVar );

                nodeData.propertyName = propertyName;

                snippet = builder.format( uniformName, sharedNodeType, type );

                builder.addLineFlowCode( `${ propertyName } = ${ snippet }`, this );

            }

            snippet = propertyName;

        }

        return builder.format( snippet, type, output );

    }

📄 UniformNode.js¶

📊 Analysis Summary¶

📚 Table of Contents¶

🛠️ File Location:¶

📦 Imports¶

Variables & Constants¶

Functions¶

UniformNode.setName(name: string): UniformNode¶

UniformNode.label(name: string): UniformNode¶

UniformNode.setGroup(group: UniformGroupNode): UniformNode¶

UniformNode.getGroup(): UniformGroupNode¶

UniformNode.getUniformHash(builder: NodeBuilder): string¶

UniformNode.onUpdate(callback: any, updateType: any): Node¶

UniformNode.getInputType(builder: any): string¶

UniformNode.generate(builder: any, output: any): any¶

uniform(value: any, type: string): UniformNode¶

Classes¶

UniformNode¶

Methods¶

setName(name: string): UniformNode¶

label(name: string): UniformNode¶

setGroup(group: UniformGroupNode): UniformNode¶

getGroup(): UniformGroupNode¶

getUniformHash(builder: NodeBuilder): string¶

onUpdate(callback: any, updateType: any): Node¶

getInputType(builder: any): string¶

generate(builder: any, output: any): any¶

📄 `UniformNode.js`¶

`UniformNode.setName(name: string): UniformNode`¶

`UniformNode.label(name: string): UniformNode`¶

`UniformNode.setGroup(group: UniformGroupNode): UniformNode`¶

`UniformNode.getGroup(): UniformGroupNode`¶

`UniformNode.getUniformHash(builder: NodeBuilder): string`¶

`UniformNode.onUpdate(callback: any, updateType: any): Node`¶

`UniformNode.getInputType(builder: any): string`¶

`UniformNode.generate(builder: any, output: any): any`¶

`uniform(value: any, type: string): UniformNode`¶

`UniformNode`¶

`setName(name: string): UniformNode`¶

`label(name: string): UniformNode`¶

`setGroup(group: UniformGroupNode): UniformNode`¶

`getGroup(): UniformGroupNode`¶

`getUniformHash(builder: NodeBuilder): string`¶

`onUpdate(callback: any, updateType: any): Node`¶

`getInputType(builder: any): string`¶

`generate(builder: any, output: any): any`¶