feat: Add core/Component.js

Having a generic component base allows us to reduce redundancy in
renderables and component. E.g. currently Mesh and DOMElement (and
potentially all future renderables) have a _requestUpdate method.

Abstracting this out into a core component encapsulates functionality
commonly used by most components.

Author: alexanderGugel

core/Component.js

@@ -0,0 +1,80 @@
+/**
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2015 Famous Industries Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+'use strict';
+
+/**
+ * An abstract component meant to be subclassed.
+ *
+ * @class Component
+ * @constructor
+ * @abstract
+ *
+ * @param {Node} node Node to which the component should be added.
+ */
+function Component(node) {
+    if (!node) throw new Error(
+        'Component must be instantiated on a Node'
+    );
+
+    /** @protected */
+    this._node = node;
+
+    /** @protected */
+    this._id = this._node.addComponent(this);
+
+    /** @protected */
+    this._requestingUpdate = false;
+}
+
+/**
+ * Requests a new update from the Node. This results into the component's
+ * `onUpdate` method being called on the next
+ *
+ * @method _requestUpdate
+ * @protected
+ *
+ * @return {undefined} undefined
+ */
+Component.prototype._requestUpdate = function _requestUpdate () {
+    if (!this._requestingUpdate && this.onUpdate) {
+        this._node.requestUpdate(this._id);
+        this._requestingUpdate = true;
+    }
+};
+
+/**
+ * A method to be invoked during the node's update phase if an update has been
+ * requested previously.
+ *
+ * @method onUpdate
+ * @private
+ *
+ * @return {undefined} undefined
+ */
+Component.prototype.onUpdate = function onUpdate () {
+    this._requestingUpdate = false;
+};
+
+module.exports = Component;

core/FamousEngine.js

@@ -1,18 +1,18 @@
 /**
  * The MIT License (MIT)
- * 
+ *
  * Copyright (c) 2015 Famous Industries Inc.
- * 
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

core/index.js

@@ -26,6 +26,7 @@
 
 module.exports = {
     Clock: require('./Clock'),
+    Component: require('./Component'),
     Event: require('./Event'),
     Scene: require('./Scene'),
     FamousEngine: require('./FamousEngine'),