⬅️ Back to Table of Contents

📄 SampleNode.js

📊 Analysis Summary

Metric	Count
🔧 Functions	3
🧱 Classes	1
📦 Imports	3

📚 Table of Contents

• Imports
• Functions
• Classes

🛠️ File Location:

📂 src/nodes/utils/SampleNode.js

📦 Imports

Name	Source
Node	../core/Node.js
uv	../accessors/UV.js
nodeObject	../tsl/TSLCore.js

---

Functions

SampleNode.setup(): Node

JSDoc:

/**
     * Sets up the node by sampling with the default UV accessor.
     *
     * @returns {Node} The result of the callback function when called with the UV node.
     */

Returns: Node

Calls:

• this.sample
• uv (from ../accessors/UV.js)

Code

setup() {

        return this.sample( uv() );

    }

SampleNode.sample(uv: any): Node

JSDoc:

/**
     * Calls the callback function with the provided UV node.
     *
     * @param {Node<vec2>} uv - The UV node or value to be passed to the callback.
     * @returns {Node} The result of the callback function.
     */

Parameters:

• uv any

Returns: Node

Calls:

• this.callback

Code

sample( uv ) {

        return this.callback( uv );

    }

sample(callback: Function): SampleNode

Parameters:

• callback Function

Returns: SampleNode

Calls:

• nodeObject (from ../tsl/TSLCore.js)

Code

( callback ) => nodeObject( new SampleNode( callback ) )

---

Classes

SampleNode

Class Code

class SampleNode extends Node {

    /**
     * Returns the type of the node.
     *
     * @type {string}
     * @readonly
     * @static
     */
    static get type() {

        return 'SampleNode';

    }

    /**
     * Creates an instance of SampleNode.
     *
     * @param {Function} callback - The function to be called when sampling. Should accept a UV node and return a value.
     */
    constructor( callback ) {

        super();

        this.callback = callback;

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

    }

    /**
     * Sets up the node by sampling with the default UV accessor.
     *
     * @returns {Node} The result of the callback function when called with the UV node.
     */
    setup() {

        return this.sample( uv() );

    }

    /**
     * Calls the callback function with the provided UV node.
     *
     * @param {Node<vec2>} uv - The UV node or value to be passed to the callback.
     * @returns {Node} The result of the callback function.
     */
    sample( uv ) {

        return this.callback( uv );

    }

}

Methods

setup(): Node

Code

setup() {

        return this.sample( uv() );

    }

sample(uv: any): Node

Code

sample( uv ) {

        return this.callback( uv );

    }

---