[rbdr/sumo] / lib / components / grab_area.js

import { Component } from '@serpentity/serpentity';

/**
 * Component that stores an area used to grab things
 *
 * @extends {external:Serpentity.Component}
 * @class GrabAreaComponent
 * @param {object} config a configuration object to extend.
 */
export default class GrabAreaComponent extends Component {
  constructor(config) {

    super(config);

    /**
     * The properthy that holds the angle. Assumes the area behaves as a sensor
     *
     * @property {external:MatterJs.Body} area
     * @instance
     * @memberof GrabAreaComponent
     */
    this.area = this.area || null;

    /**
     * The constraint that ties this area to its parent
     *
     * @property {external:MatterJs.Constraint} constraint
     * @instance
     * @memberof GrabAreaComponent
     */
    this.constraint = this.constraint || null;
  }
}