🇬🇧 Added origin method to the API and updated README.

Author: wagerfield

README.md

@@ -84,7 +84,9 @@ In addition to the behaviours described above, there are **two** methods `enable
   data-scalar-x="2"
   data-scalar-y="8"
   data-friction-x="0.2"
-  data-friction-y="0.8">
+  data-friction-y="0.8"
+  data-origin-x="0.0"
+  data-origin-y="1.0">
   <li class="layer" data-depth="0.00"><img src="graphics/layer1.png"></li>
   <li class="layer" data-depth="0.20"><img src="graphics/layer2.png"></li>
   <li class="layer" data-depth="0.40"><img src="graphics/layer3.png"></li>
@@ -108,7 +110,9 @@ var parallax = new Parallax(scene, {
   scalarX: 2,
   scalarY: 8,
   frictionX: 0.2,
-  frictionY: 0.8
+  frictionY: 0.8,
+  originX: 0.0,
+  originY: 1.0
 });
 ```
 
@@ -124,6 +128,7 @@ parallax.invert(false, true);
 parallax.limit(false, 10);
 parallax.scalar(2, 8);
 parallax.friction(0.2, 0.8);
+parallax.origin(0.0, 1.0);
 ```
 
 ## jQuery
@@ -148,7 +153,9 @@ $('#scene').parallax({
   scalarX: 2,
   scalarY: 8,
   frictionX: 0.2,
-  frictionY: 0.8
+  frictionY: 0.8,
+  originX: 0.0,
+  originY: 1.0
 });
 ```
 ### jQuery: API
@@ -162,6 +169,7 @@ $scene.parallax('invert', false, true);
 $scene.parallax('limit', false, 10);
 $scene.parallax('scalar', 2, 8);
 $scene.parallax('friction', 0.2, 0.8);
+$scene.parallax('origin', 0.0, 1.0);
 ```
 
 ## iOS

bower.json

@@ -1,7 +1,7 @@
 {
   "name": "parallax",
   "description": "Parallax Engine that reacts to the orientation of a smart device.",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "license": "MIT",
   "homepage": "http://wagerfield.github.io/parallax/",
   "authors": [

deploy/jquery.parallax.js

@@ -84,7 +84,9 @@
       scalarX: parseFloat(this.$context.data('scalar-x')) || null,
       scalarY: parseFloat(this.$context.data('scalar-y')) || null,
       frictionX: parseFloat(this.$context.data('friction-x')) || null,
-      frictionY: parseFloat(this.$context.data('friction-y')) || null
+      frictionY: parseFloat(this.$context.data('friction-y')) || null,
+      originX: parseFloat(this.$context.data('origin-x')) || null,
+      originY: parseFloat(this.$context.data('origin-y')) || null
     };
 
     // Delete Null Data Values
@@ -323,6 +325,11 @@
     this.limitY = y === undefined ? this.limitY : y;
   };
 
+  Plugin.prototype.origin = function(x, y) {
+    this.originX = x === undefined ? this.originX : x;
+    this.originY = y === undefined ? this.originY : y;
+  };
+
   Plugin.prototype.clamp = function(value, min, max) {
     value = Math.max(value, min);
     value = Math.min(value, max);
@@ -487,7 +494,8 @@
     friction: Plugin.prototype.friction,
     invert: Plugin.prototype.invert,
     scalar: Plugin.prototype.scalar,
-    limit: Plugin.prototype.limit
+    limit: Plugin.prototype.limit,
+    origin: Plugin.prototype.origin
   };
 
   $.fn[NAME] = function (value) {

deploy/jquery.parallax.min.js

@@ -81,7 +81,9 @@
       scalarX: this.data(this.element, 'scalar-x'),
       scalarY: this.data(this.element, 'scalar-y'),
       frictionX: this.data(this.element, 'friction-x'),
-      frictionY: this.data(this.element, 'friction-y')
+      frictionY: this.data(this.element, 'friction-y'),
+      originX: this.data(this.element, 'origin-x'),
+      originY: this.data(this.element, 'origin-y')
     };
 
     // Delete Null Data Values
@@ -351,6 +353,11 @@
     this.limitY = y === undefined ? this.limitY : y;
   };
 
+  Parallax.prototype.origin = function(x, y) {
+    this.originX = x === undefined ? this.originX : x;
+    this.originY = y === undefined ? this.originY : y;
+  };
+
   Parallax.prototype.clamp = function(value, min, max) {
     value = Math.max(value, min);
     value = Math.min(value, max);

deploy/parallax.js

@@ -1,7 +1,7 @@
 {
   "name": "parallax",
   "description": "Parallax Engine that reacts to the orientation of a smart device.",
-  "version": "2.1.0",
+  "version": "2.1.1",
   "license": "MIT",
   "homepage": "http://wagerfield.github.io/parallax/",
   "author": "Matthew Wagerfield <[email protected]>",

deploy/parallax.min.js

@@ -53,7 +53,9 @@
       scalarX: parseFloat(this.$context.data('scalar-x')) || null,
       scalarY: parseFloat(this.$context.data('scalar-y')) || null,
       frictionX: parseFloat(this.$context.data('friction-x')) || null,
-      frictionY: parseFloat(this.$context.data('friction-y')) || null
+      frictionY: parseFloat(this.$context.data('friction-y')) || null,
+      originX: parseFloat(this.$context.data('origin-x')) || null,
+      originY: parseFloat(this.$context.data('origin-y')) || null
     };
 
     // Delete Null Data Values
@@ -292,6 +294,11 @@
     this.limitY = y === undefined ? this.limitY : y;
   };
 
+  Plugin.prototype.origin = function(x, y) {
+    this.originX = x === undefined ? this.originX : x;
+    this.originY = y === undefined ? this.originY : y;
+  };
+
   Plugin.prototype.clamp = function(value, min, max) {
     value = Math.max(value, min);
     value = Math.min(value, max);
@@ -456,7 +463,8 @@
     friction: Plugin.prototype.friction,
     invert: Plugin.prototype.invert,
     scalar: Plugin.prototype.scalar,
-    limit: Plugin.prototype.limit
+    limit: Plugin.prototype.limit,
+    origin: Plugin.prototype.origin
   };
 
   $.fn[NAME] = function (value) {

package.json

@@ -50,7 +50,9 @@
       scalarX: this.data(this.element, 'scalar-x'),
       scalarY: this.data(this.element, 'scalar-y'),
       frictionX: this.data(this.element, 'friction-x'),
-      frictionY: this.data(this.element, 'friction-y')
+      frictionY: this.data(this.element, 'friction-y'),
+      originX: this.data(this.element, 'origin-x'),
+      originY: this.data(this.element, 'origin-y')
     };
 
     // Delete Null Data Values
@@ -320,6 +322,11 @@
     this.limitY = y === undefined ? this.limitY : y;
   };
 
+  Parallax.prototype.origin = function(x, y) {
+    this.originX = x === undefined ? this.originX : x;
+    this.originY = y === undefined ? this.originY : y;
+  };
+
   Parallax.prototype.clamp = function(value, min, max) {
     value = Math.max(value, min);
     value = Math.min(value, max);