Launch demo or watch the video. NOTE: Works only on desktops with good GPUs.
Include gp.js into your Three.js project HTML:
<script src="gp.js"></script>Sample code below. See the examples/ directory for full examples.
// Create a simulation world
var world = new gp.World({
renderer: threejsRenderer, // Must be a THREE.WebGLRenderer
maxBodies: 128 * 128, // Max number of bodies
maxParticles: 128 * 128, // Max number of particles (each body consists of a number of particles)
radius: 0.05, // Size of a particle in the simulation
stiffness: 100, // Contact stiffness
damping: 0.4, // Contact damping
fixedTimeStep: 1/60, // Simulation timestep
boxSize: new THREE.Vector3(10,10,10), // World collision bounds
// The "grid" is a box where collisions can occur. Specify its position and resolution.
// The size of the grid box is gridResolution * radius * 2
gridPosition: new THREE.Vector3(0,0,0),
gridResolution: new THREE.Vector3(128,16,128),
gravity: new THREE.Vector3(0,-1,0),
friction: 0.4,
drag: 0.3,
});
// Create a body
// position rotation mass inertia
var bodyId = world.addBody(0, 0, 0, 0,0,0,1, 1, 0.1,0.1,0.1);
world.addParticle(bodyId, 0,0,0); // Add a particle in the center of the body
// Get the UV coordinate for the body
var uv = world.getBodyUV(bodyId);
myCustomShaderMaterial.uniforms.bodyUV.value = uv;
// A simple render loop can look like this:
var prevTime;
function render(time) {
requestAnimationFrame(render);
// Calculate time since last frame
var deltaTime = prevTime ? (time - prevTime) / 1000 : 0;
prevTime = time;
// Update physics
world.step( deltaTime );
// Use textures from the world, they contain positions and rotations of all bodies.
// Note: you need to fetch these textures every frame from the World, since they are swapped by the World every step.
myCustomShaderMaterial.uniforms.bodyPositionTex.value = world.bodyPositionTexture;
myCustomShaderMaterial.uniforms.bodyQuaternionTex.value = world.bodyQuaternionTexture;
// Render scene
renderer.render( scene, camera );
}
requestAnimationFrame(render);The demo is largely based on GPU Gems 3 ch. 29, Real-Time Rigid Body Simulation on GPUs. It heavily relies on the THREE.WebGLRenderTarget class and custom shaders.
The simulation loop is in short:
- Create float render targets of size N*N for bodies: position, quaternion, velocity, angular velocity, force, torque.
- Create float render targets of size M*M for particles: local position, world position, relative position, force.
- Create float render target of size 4*M*M for a broadphase grid.
- While running:
- Calculate particle properties: world position, body-relative position, velocity.
- Set up "broadphase render target". Stencil buffer is set up for stencil routing (see this presentation, slide 24) by clearing once (to set stencil values to zero) and drawing point clouds thrice to set values 1, 2 and 3 into the stencil buffer. An alternative is using PBOs to set these values, but it doesn't seem to be available in WebGL1.
- Particles are drawn to the "broadphase render target" using GL_POINTS with point-size 2. This maps them into the correct "grid bucket" and writes the particle ID's there. The stencil routing guarantees four particle ID's can be drawn into the same grid bucket in this single draw call.
- Particle forces are calculated using spring-and-dashpot model equations. Neighboring particles are easily looked up in the broadphase render target.
- Forces are added to the bodies' force render target using GL_POINTS with additive blending. Other forces such as gravity is added here too.
- Torque is added to bodies' torque render target in the same way.
- Body velocities are updated: velocity += deltaTime * force / inertia.
- Body positions are updated: position += deltaTime * velocity.
- Render each body by looking up body position and quaternion in the correct render target texture.