aframe/src/utils/entity.js

A web framework for building virtual reality experiences.

import { split } from './split.js';

/**
 * Split a delimited component property string (e.g., `material.color`) to an object
 * containing `component` name and `property` name. If there is no delimiter, just return the
 * string back.
 *
 * Uses the caching split implementation `AFRAME.utils.split`
 *
 * @param {string} str - e.g., `material.opacity`.
 * @param {string} delimiter - e.g., `.`.
 * @returns {string[]} e.g., `['material', 'opacity']`.
 */
export function getComponentPropertyPath (str, delimiter) {
  delimiter = delimiter || '.';
  var parts = split(str, delimiter);
  if (parts.length === 1) {
    return parts[0];
  }
  return parts;
}

/**
 * Get component property using encoded component name + component property name with a
 * delimiter.
 */
export function getComponentProperty (el, name, delimiter) {
  var splitName;
  delimiter = delimiter || '.';
  if (name.indexOf(delimiter) !== -1) {
    splitName = getComponentPropertyPath(name, delimiter);
    if (splitName.constructor === String) {
      return el.getAttribute(splitName);
    }
    return el.getAttribute(splitName[0])[splitName[1]];
  }
  return el.getAttribute(name);
}

/**
 * Set component property using encoded component name + component property name with a
 * delimiter.
 */
export function setComponentProperty (el, name, value, delimiter) {
  var splitName;
  delimiter = delimiter || '.';
  if (name.indexOf(delimiter) !== -1) {
    splitName = getComponentPropertyPath(name, delimiter);
    if (splitName.constructor === String) {
      el.setAttribute(splitName, value);
    } else {
      el.setAttribute(splitName[0], splitName[1], value);
    }
    return;
  }
  el.setAttribute(name, value);
}