Physics

Physics

New, better, improved physics!

Index

Installation
Angle
Vector
PhysicsBody

Angle

---

shwijs#Angle

You can create angles now! It is pretty self explanatory, but:

new Angle(value, unit)

To create a new angle, just create a new instance with the value of the angle and the unit with it!

const { Angle } = require("shwi-js");
const myAngle = new Angle(10, "deg");

Allowed units are degrees or radians.
Degrees: Alias[deg, degree, degrees]
Radians: Alias[rad, radian, radians] \

Angle#rotate(angle)

Rotate this angle to a new angle! Just pass in another angle instance to rotate!

const { Angle } = require("shwi-js");
const myAngle = new Angle(0, "deg");
const angleToAdd = new Angle(10, "deg");
myAngle.rotate(angleToAdd);
//=> value = 10, unit = deg

Yes, you can also pass in different unit angles, it will automatically convert them.

Angle#toRadian

Get the radian value of the angle. It will convert degrees to radian if the unit of angle is degrees, otherwise it will just return the value. (Because if the angle's unit is radian already, there's no need to convert, is there?)

Angle#toDegree

Get the degre value of the angle. Same as Angle#toRadian

Angle.rads

(Static) Get all the units allowed for radian.

Angle.degs

(Static) Get all the units allowed for degree.

Angle.IsRad(unit)

(Static) Check if a unit is in radian.

Angle.IsDeg(unit)

(Static) Check if a unit is in degree.

Vector

---

shwijs#Vector

Create a new vector (position).

new Vector(x, y)

Create a new vector with positions. (Defaults to Vector.ORIGIN)

const { Vector } = require("shwi-js");
new Vector(0, 0);

Vector#move(x, y)

Move this vector by a certain amount. It is the same as adding two vectors.

Vector#set(x, y)

Set this vector position to something else.

Vector#add(Vector)

Add another vector to this vector.

const { Vector } = require("shwi-js");
const myVector = new Vector(0, 2);
const vectorToAdd = new Vector(1, 5);
myVector.add(vectorToAdd);
//=> 1, 7

Vector#sub(Vector)

Subtract another vector from this vector. Similar to Vector#add()

Vector#addResultant(value, angle)

Add a resultant to this vector.

const { Vector, Angle } = require("shwi-js");
const myVector = new Vector(0, 0);
myVector.addResultant(5, new Angle(53, "deg"));
//=> myVector = 3, 4

Vector#subResultant(value, angle)

Subtract a resultant from this vector. Similar to Vector#addResultant()

Vector#toArray

Get the vector positions as an array. [x, y]

Vector#resultant

Get the resultant value of this vector (without angle).

Vector#distanceFromOrigin

Get the relative distance of the vector from origin.

const { Vector } = require("shwi-js");
const myVector = new Vector(3, 4);
console.log(myVector.distanceFromOrigin);
//=> 5

If the origin is different, say:

const { Vector } = require("shwi-js");
Vector.SetOrigin(1, 1);
const myVector = new Vector(5, 12);
console.log(myVector.distanceFromOrigin);
//=> 13

Vector#absolutePosition

Get the absolute position of the vector, no matter what the origin. In above example, its value would be 6, 13

Vector.ORIGIN

(Static) The origin position. (Of all vectors)

Vector.CheckIfValidPos(x, y, callback(err))

(Static) Check if the given vector components x and y are valid numbers.

const { Vector } = require("shwi-js");
Vector.CheckIfValidPos(0, 0, (err) => {
	if (err) return err.log();
	// do your thing
});

Vector.CalculateResultant(vector)

(Static) Calculate the resultant value of a vector.

Vector.CalculateComponents(value, angle)

(Static) Calculate the components of a resultant vector along with angle.

Returns a vector.

PhysicsBody

---

shwijs#PhysicsBody

new PhysicsBody(mass, vector)

Create a new physics body with mass (in kilograms) and a position (vector) shwijs#Vector

Default mass is 1 (kg).
Default position is Vector.ORIGIN

PhysicsBody#move(vector)

Move the physics body by some amount.

const { PhysicsBody, Vector } = require("shwi-js");

const myBody = new PhysicsBody(1, new Vector(1, 0));

myBody.move(new Vector(1, 2));

//=> new position becomes (2, 2)

PhysicsBody#moveTo(vector)

Move the physics body TO a certain position (vector)

PhysicsBody#setVelocity(velocityVector, durationInS)

Set the velocity of the body to some velocity vector (vector) for some time in second(s).

const { PhysicsBody, Vector } = require("shwi-js");

const myBody = new PhysicsBody();

myBody.setVelocity(new Vector(1, 1), 2);
//=> 1, 1
//=> 2, 2
//---done---

NOTE: The velocity vector is per second.

PhysicsBody#setMass(newMass)

Set the mass of the body to a new mass.

PhysicsBody#currentVelocity

Get the current velocity of the body. If there is none, returns a vector with zero values.

PhysicsBody#absolutePosition

Returns the absolute position of the body. The vector origin can be anything, but it will return the absolute from (0, 0)

PhysicsBody.CheckIfValidMass(mass)

(Static) Check if a certain mass is valid.

---

That's it!