victor - npm Package Compare versions

Comparing version 0.1.4 to 0.2.0

index.js

@@ -91,35 +91,2 @@ exports = module.exports = Victor;
 
-Victor.add = function (vecA, vecB) {
-	return new Victor(vecA.x + vecB.x, vecA.y + vecB.y);
-};
-
-Victor.subtract = function (vecA, vecB) {
-	return new Victor(vecA.x - vecB.x, vecA.y - vecB.y);
-};
-
-Victor.multiply = function (vec, scalar) {
-	return new Victor(vec.x * scalar, vec.y * scalar);
-};
-
-Victor.divide = function (vec, scalar) {
-	return new Victor(vec.x / scalar, vec.y / scalar);
-};
-
-Victor.mix = function (vecA, vecB, amount) {
-	if (typeof amount === 'undefined') {
-		amount = 0.5;
-	}
-
-	var x = (1 - amount) * vecA.x + amount * vecB.x;
-	var y = (1 - amount) * vecA.y + amount * vecB.y;
-	return new Victor(x, y);
-};
-
-Victor.random = function (maxX, maxY) {
-	var x = Math.floor(Math.random() * maxX),
-		y = Math.floor(Math.random() * maxY);
-
-	return new Victor(x, y);
-};
-
 /**
@@ -187,4 +154,4 @@ * # Manipulation
 Victor.prototype.add = function (vec) {
-	this.addX(vec);
-	this.addY(vec);
+	this.x += vec.x;
+	this.y += vec.y;
 	return this;
@@ -249,4 +216,4 @@ };
 Victor.prototype.subtract = function (vec) {
-	this.subtractX(vec);
-	this.subtractY(vec);
+	this.x -= vec.x;
+	this.y -= vec.y;
 	return this;
@@ -256,17 +223,18 @@ };
 /**
- * Divides the X axis by a number
+ * Divides the X axis by the x component of given vector
  *
  * ### Examples:
  *     var vec = new Victor(100, 50);
+ *     var vec2 = new Victor(2, 0);
  *
- *     vec.divideX(2);
+ *     vec.divideX(vec2);
  *     vec.toString();
  *     // => x:50, y:50
  *
- * @param {Number} number The number to divide the axis by
+ * @param {Victor} vector The other vector you want divide by
  * @return {Victor} `this` for chaining capabilities
  * @api public
  */
-Victor.prototype.divideX = function (scalar) {
-	this.x /= scalar;
+Victor.prototype.divideX = function (vector) {
+	this.x /= vector.x;
 	return this;
@@ -276,17 +244,18 @@ };
 /**
- * Divides the Y axis by a number
+ * Divides the Y axis by the y component of given vector
  *
  * ### Examples:
  *     var vec = new Victor(100, 50);
+ *     var vec2 = new Victor(0, 2);
  *
- *     vec.divideY(2);
+ *     vec.divideY(vec2);
  *     vec.toString();
  *     // => x:100, y:25
  *
- * @param {Number} number The number to divide the axis by
+ * @param {Victor} vector The other vector you want divide by
  * @return {Victor} `this` for chaining capabilities
  * @api public
  */
-Victor.prototype.divideY = function (scalar) {
-	this.y /= scalar;
+Victor.prototype.divideY = function (vector) {
+	this.y /= vector.y;
 	return this;
@@ -296,18 +265,19 @@ };
 /**
- * Divides both vector axis by a number
+ * Divides both vector axis by a axis values of given vector
  *
  * ### Examples:
  *     var vec = new Victor(100, 50);
+ *     var vec2 = new Victor(2, 2);
  *
- *     vec.divide(2);
+ *     vec.divide(vec2);
  *     vec.toString();
  *     // => x:50, y:25
  *
- * @param {Number} number The number to divide the axis by
+ * @param {Victor} vector The vector to divide by
  * @return {Victor} `this` for chaining capabilities
  * @api public
  */
-Victor.prototype.divide = function (scalar) {
-	this.divideX(scalar);
-	this.divideY(scalar);
+Victor.prototype.divide = function (vector) {
+	this.x /= vector.x;
+	this.y /= vector.y;
 	return this;
@@ -372,17 +342,18 @@ };
 /**
- * Multiplies the X axis by a number
+ * Multiplies the X axis by X component of given vector
  *
  * ### Examples:
  *     var vec = new Victor(100, 50);
+ *     var vec2 = new Victor(2, 0);
  *
- *     vec.multiplyX(2);
+ *     vec.multiplyX(vec2);
  *     vec.toString();
  *     // => x:200, y:50
  *
- * @param {Number} number The number to multiply the axis with
+ * @param {Victor} vector The vector to multiply the axis with
  * @return {Victor} `this` for chaining capabilities
  * @api public
  */
-Victor.prototype.multiplyX = function (scalar) {
-	this.x *= scalar;
+Victor.prototype.multiplyX = function (vector) {
+	this.x *= vector.x;
 	return this;
@@ -392,17 +363,18 @@ };
 /**
- * Multiplies the Y axis by a number
+ * Multiplies the Y axis by Y component of given vector
  *
  * ### Examples:
  *     var vec = new Victor(100, 50);
+ *     var vec2 = new Victor(0, 2);
  *
- *     vec.multiplyY(2);
+ *     vec.multiplyX(vec2);
  *     vec.toString();
  *     // => x:100, y:100
  *
- * @param {Number} number The number to multiply the axis with
+ * @param {Victor} vector The vector to multiply the axis with
  * @return {Victor} `this` for chaining capabilities
  * @api public
  */
-Victor.prototype.multiplyY = function (scalar) {
-	this.y *= scalar;
+Victor.prototype.multiplyY = function (vector) {
+	this.y *= vector.y;
 	return this;
@@ -412,18 +384,19 @@ };
 /**
- * Multiplies both vector axis by a number
+ * Multiplies both vector axis by values from a given vector
  *
  * ### Examples:
  *     var vec = new Victor(100, 50);
+ *     var vec2 = new Victor(2, 2);
  *
- *     vec.multiply(2);
+ *     vec.multiply(vec2);
  *     vec.toString();
  *     // => x:200, y:100
  *
- * @param {Number} number The number to multiply the axis with
+ * @param {Victor} vector The vector to multiply by
  * @return {Victor} `this` for chaining capabilities
  * @api public
  */
-Victor.prototype.multiply = function (scalar) {
-	this.multiplyX(scalar);
-	this.multiplyY(scalar);
+Victor.prototype.multiply = function (vector) {
+	this.x *= vector.x;
+	this.y *= vector.y;
 	return this;
@@ -734,2 +707,19 @@ };
 /**
+ * Sets the vector to zero (0,0)
+ *
+ * ### Examples:
+ *     var vec1 = new Victor(10, 10);
+ *		 var1.zero();
+ *     vec1.toString();
+ *     // => x:0, y:0
+ *
+ * @return {Victor} `this` for chaining capabilities
+ * @api public
+ */
+Victor.prototype.zero = function () {
+	this.x = this.y = 0;
+	return this;
+};
+
+/**
  * Calculates the dot product of this vector and another
@@ -752,2 +742,7 @@ *
 
+Victor.prototype.cross = function (vec2) {
+	return (this.x * vec2.y ) - (this.y * vec2.x );
+};
+
+
 Victor.prototype.horizontalAngle = function () {
@@ -943,2 +938,35 @@ return Math.atan2(this.y, this.x);
 /**
+ * Returns a true if vector is (0, 0)
+ *
+ * ### Examples:
+ *     var vec = new Victor(100, 50);
+ *     vec.zero();
+ *
+ *     // => true
+ *
+ * @return {Boolean} 
+ * @api public
+ */
+Victor.prototype.isZero = function() {
+	return this.x === 0 && this.y === 0;
+};
+
+/**
+ * Returns a true if this vector is the same as another
+ *
+ * ### Examples:
+ *     var vec1 = new Victor(100, 50);
+ *     var vec2 = new Victor(100, 50);
+ *     vec1.isEqualTo(vec2);
+ *
+ *     // => true
+ *
+ * @return {Boolean} 
+ * @api public
+ */
+Victor.prototype.isEqualTo = function(vec2) {
+	return this.x === vec2.x && this.y === vec2.y;
+};
+
+/**
  * # Utility Methods
@@ -945,0 +973,0 @@ */

package.json

 {
   "name": "victor",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "A JavaScript 2D vector class with methods for common vector operations",
@@ -5,0 +5,0 @@ "keywords": [

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

2147814

increased by0.05%

Number of package files

71

increased by1.43%

Lines of code

977

increased by3.28%

No dependency changes