@openhps/core/dist/cjs/three/nodes/accessors/RendererReferenceNode.js

Open Hybrid Positioning System - Core component

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.rendererReference = exports.default = void 0;
var _ReferenceBaseNode = _interopRequireDefault(require("./ReferenceBaseNode.js"));
var _TSLCore = require("../tsl/TSLCore.js");
var _UniformGroupNode = require("../core/UniformGroupNode.js");
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
/**
 * This node is a special type of reference node which is intended
 * for linking renderer properties with node values.
 * ```js
 * const exposureNode = rendererReference( 'toneMappingExposure', 'float', renderer );
 * ```
 * When changing `renderer.toneMappingExposure`, the node value of `exposureNode` will
 * automatically be updated.
 *
 * @augments ReferenceBaseNode
 */
class RendererReferenceNode extends _ReferenceBaseNode.default {
  static get type() {
    return 'RendererReferenceNode';
  }

  /**
   * Constructs a new renderer reference node.
   *
   * @param {string} property - The name of the property the node refers to.
   * @param {string} inputType - The uniform type that should be used to represent the property value.
   * @param {?Renderer} [renderer=null] - The renderer the property belongs to. When no renderer is set,
   * the node refers to the renderer of the current state.
   */
  constructor(property, inputType, renderer = null) {
    super(property, inputType, renderer);

    /**
     * The renderer the property belongs to. When no renderer is set,
     * the node refers to the renderer of the current state.
     *
     * @type {?Renderer}
     * @default null
     */
    this.renderer = renderer;
    this.setGroup(_UniformGroupNode.renderGroup);
  }

  /**
   * Updates the reference based on the given state. The state is only evaluated
   * {@link RendererReferenceNode#renderer} is not set.
   *
   * @param {(NodeFrame|NodeBuilder)} state - The current state.
   * @return {Object} The updated reference.
   */
  updateReference(state) {
    this.reference = this.renderer !== null ? this.renderer : state.renderer;
    return this.reference;
  }
}
var _default = exports.default = RendererReferenceNode;
/**
 * TSL function for creating a renderer reference node.
 *
 * @tsl
 * @function
 * @param {string} name - The name of the property the node refers to.
 * @param {string} type - The uniform type that should be used to represent the property value.
 * @param {?Renderer} [renderer=null] - The renderer the property belongs to. When no renderer is set,
 * the node refers to the renderer of the current state.
 * @returns {RendererReferenceNode}
 */
const rendererReference = (name, type, renderer = null) => (0, _TSLCore.nodeObject)(new RendererReferenceNode(name, type, renderer));
exports.rendererReference = rendererReference;