On this page

Particle

Particle is the main object of this physics engine. It is a 2D circle that is treated like a point mass at the center and does not rotate. Particle is also a HashGridItem so it can be added to a SpatialHashGrid.

Constructor

new Particle(pos, vel, mass, radius, bounciness, charge, color)

Instantiates new Particle

Parameters:

Name	Type	Default	Description
`pos`	Vector2D		cartesian coordinates of the particle
`vel`	Vector2D		velocity of the particle
`mass`	Number
`radius`	Number
`bounciness`	Number	1	a value in [0,1] that represents the amount of energy retained after collision
`charge`	Number	0	similar to real physical charge
`color`	String	black	currently only supports HTML canvas colors format

Source: core/Particle.js, line 12

Extends

HashGridItem

Methods

addNearBehavior(b) → {Boolean}

Adds a NearBehavior to the particle if not added already

Parameters:

Name	Type	Description
`b`	NearBehavior

Source: core/Particle.js, line 90

Returns:

true if successfully added

Type:: Boolean

addSelfBehavior(b) → {Boolean}

Adds a SelfBehavior to the particle if not added already

Parameters:

Name	Type	Description
`b`	SelfBehavior

Source: core/Particle.js, line 76

Returns:

true if successfully added

Type:: Boolean

applyAcceleration(a, timeStep)

Increments the velocity by an acceleration a

Parameters:

Name	Type	Description
`a`	Vector2D
`timeStep`	Number

Source: core/Particle.js, line 66

applyForce(f, timeStep)

Applies force f to the velocity

Parameters:

Name	Type	Description
`f`	Vector2D
`timeStep`	Number

Source: core/Particle.js, line 56

applyVelocity(v, timeStep)

Increments the position by velocity v

Parameters:

Name	Type	Description
`v`	Vector2D
`timeStep`	Number

Source: core/Particle.js, line 46

clearBehaviors()

Clears all behaviors of the particle

Source: core/Particle.js, line 132

getHashDimensions() → {Array.<Number>}

Computes the dimensions of the item for the HashGrid.

Overrides: HashGridItem#getHashDimensions
Source: core/Particle.js, line 149

Returns:

Type:: Array.<Number>

getHashPos() → {Array.<Number>}

Computes the coordinate position for the item within the HashGrid, expects center position.

Overrides: HashGridItem#getHashPos
Source: core/Particle.js, line 141

Returns:

Type:: Array.<Number>

removeNearBehavior(b) → {Boolean}

Removes NearBehavior b if the particle has b

Parameters:

Name	Type	Description
`b`	NearBehavior

Source: core/Particle.js, line 104

Returns:

true if the action is successful

Type:: Boolean

removeSelfBehavior(b) → {Boolean}

Removes SelfBehavior b if the particle has b

Parameters:

Name	Type	Description
`b`	SelfBehavior

Source: core/Particle.js, line 119

Returns:

true if the action is successful

Type:: Boolean