@openhps/core/src/three/nodes/core/NodeFunctionInput.js

Open Hybrid Positioning System - Core component

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports.default = void 0;
/**
 * Describes the input of a {@link NodeFunction}.
 */
class NodeFunctionInput {
  /**
   * Constructs a new node function input.
   *
   * @param {string} type - The input type.
   * @param {string} name - The input name.
   * @param {?number} [count=null] - If the input is an Array, count will be the length.
   * @param {('in'|'out'|'inout')} [qualifier=''] - The parameter qualifier (only relevant for GLSL).
   * @param {boolean} [isConst=false] - Whether the input uses a const qualifier or not (only relevant for GLSL).
   */
  constructor(type, name, count = null, qualifier = '', isConst = false) {
    /**
     *  The input type.
     *
     * @type {string}
     */
    this.type = type;

    /**
     * The input name.
     *
     * @type {string}
     */
    this.name = name;

    /**
     * If the input is an Array, count will be the length.
     *
     * @type {?number}
     * @default null
     */
    this.count = count;

    /**
     *The parameter qualifier (only relevant for GLSL).
     *
     * @type {('in'|'out'|'inout')}
     * @default ''
     */
    this.qualifier = qualifier;

    /**
     * Whether the input uses a const qualifier or not (only relevant for GLSL).
     *
     * @type {boolean}
     * @default false
     */
    this.isConst = isConst;
  }
}
NodeFunctionInput.isNodeFunctionInput = true;
var _default = exports.default = NodeFunctionInput;