Particle
A point body that is controlled by the Physics Engine. A particle has position and velocity states that are updated by the Physics Engine. Ultimately, a particle is a special type of modifier, and can be added to the Famo.us Scene Graph like any other modifier.
Particle(options)
Constructor Parameters
options
Options
An object of configurable options.
position
Array
The position of the particle.
velocity
Array
The velocity of the particle.
mass
Number
The mass of the particle.
Methods
Show Private Methods
isBody()Static
isActive()
Determines if particle is active
Returns
Boolean
sleep()
Stops the particle from updating
wake()
Starts the particle update
setPosition(position)
Basic setter for position
Parameters
setPosition1D(x)
1-dimensional setter for position
Parameters
getPosition()
Basic getter function for position
Returns
Array
position
getPosition1D()
1-dimensional getter for position
Returns
Number
value
()
Basic setter function for velocity Vector
setVelocity1D(x)
1-dimensional setter for velocity
Parameters
getVelocity()
Basic getter function for velocity Vector
Returns
Array
velocity
setForce()
Basic setter function for force Vector
Returns
Array
force
getVelocity1D()
1-dimensional getter for velocity
Returns
Number
velocity
setMass(mass)
Basic setter function for mass quantity
Parameters
getMass()
Basic getter function for mass quantity
Returns
Number
mass
reset(position, velocity)
Reset position and velocity
Parameters
applyForce(force)
Add force vector to existing internal force Vector
Parameters
applyImpulse(impulse)
Add impulse (change in velocity) Vector to this Vector's velocity.
Parameters
integrateVelocity(dt)
Update a particle's velocity from its force accumulator
Parameters
dt
Number
Time differential
integratePosition(dt)
Update a particle's position from its velocity
Parameters
dt
Number
Time differential
_integrate(dt)Protected
Update the position and velocity of the particle
Parameters
dt
Number
Time differential
()
Get kinetic energy of the particle.
Generate transform from the current position state
Returns
Transform
Transform
modify(target)
The modify interface of a Modifier
Parameters
Returns
Spec
Spec