particle-simulator-react-p5
TypeScript icon, indicating that this package has built-in type declarations

1.6.0 • Public • Published

particle-simulator-react-p5

reactLogo javascriptLogo typescriptLogo scssLogo cssLogo cssLogo

Description

This is a particle simulator package made with React Typescript and p5.js.

🚀🚀You can try it online from your browser 🚀🚀

It works on desktop and mobile as well with different controls (check the controls section).

The particles are set randomly on the screen in a circle shape. Their color change according to the speed of the particle. The particles are attracted to the mouse and they are repelled from the edges of the screen. You can toggle attract/repel by clicking with the mouse button on a screen. On tablet and mobile de the touch screen to move the particles by dragging your finger. To toggle attract/repel tap on the screen.

🚀🚀 The package is available on npm 🚀🚀

Note
I also made a C++ version for WebGL2 using OpenGL ES 3.0. You can check it out here.

Screenshots

Attraction Drag Repulsion
screenshot1 screenshot2 screenshot3

Demo video

https://user-images.githubusercontent.com/59691442/230526870-cd104007-be41-4cdd-a10e-4672da650974.mp4

Controls

The particles are initially attracted to the mouse, but you can toggle attract/repel by clicking with the mouse button on a screen.
On tablet and mobile de the touch screen to move the particles by dragging your finger. To toggle attract/repel tap on the screen.

You can also toggle fullscreen mode by pressing the F11 key.

Package installation

To install it type npm install particle-simulator-react-p5 in your terminal to install it.

Then you can import it in your project with import ParticleSimulator from 'particle-simulator-react-p5'.

Usage

To use it you can simply add the component in your project like this:

import React, {useEffect, useState} from 'react';
import ParticleSimulator from 'particle-simulator-react-p5';
import './App.css';

const App: React.FC = () => {
    const [isLoaded, setIsLoaded] = useState(false);
    const divRef = React.useRef <HTMLDivElement>(null);

    useEffect(() => {
        if (divRef.current) {
            setIsLoaded(true);
        }
    }, [divRef]);

    return (
        <div className='App'>
            <div ref={divRef}>
                {isLoaded ? (
                    <div className={'particle-sim-canvas'}>
                        <ParticleSimulator
                            parentRef={divRef}
                        />
                    </div>
                ) : (
                    <p className={'wait-sim-canvas'}>Loading...</p>
                )}
            </div>
        </div>
    );
};

export default App;

or you can change all the settings like this:

import React, {useEffect, useState} from 'react';
import ParticleSimulator from 'particle-simulator-react-p5';
import './App.css';

const App: React.FC = () => {
    const [isLoaded, setIsLoaded] = useState(false);
    const divRef = React.useRef <HTMLDivElement>(null);

    useEffect(() => {
        if (divRef.current) {
            setIsLoaded(true);
        }
    }, [divRef]);

    return (
        <div className='App'>
            <div ref={divRef}>
                {isLoaded ? (
                    <div className={'particle-sim-canvas'}>
                        <ParticleSimulator
                            parentRef={divRef}
                            particleCountMobile={1000}
                            particleCountComputer={3000}
                            fixedUpdate={60}
                            frameRate={60}
                            spawnAreaRadius={2}
                            gravitationalConstant={1}
                            particlesMass={50}
                            attractorMass={250}
                            friction={0.99}
                            softening={10}
                            pixelsPerMeter={100}
                            initColor={[0, 255, 255, 200]}
                            finalColor={[255, 0, 255, 200]}
                            maxColorVelocity={5}
                            backColor={[0, 0, 0, 255]}
                        />
                    </div>
                ) : (
                    <p className={'wait-sim-canvas'}>Loading...</p>
                )}
            </div>
        </div>
    );
};

export default App;

The component takes 1 to 16 props:

  • parentRef - a reference to the parent div of the canvas. It is used to get the size of the canvas.
  • particleCountMobile - the number of particles on mobile devices.
  • particleCountComputer - the number of particles on desktop devices.
  • fixedUpdate - the number of fixed updates per second.
  • frameRate - the number of frames per second.
  • spawnAreaRadius - the radius of the spawn area of the particles (in meters).
  • gravitationalConstant - the gravitational constant of the simulation.
  • particlesMass - the mass of the particles.
  • attractorMass - the mass of the attractor.
  • friction - the friction of the particles.
  • softening - the softening parameter of the gravitational force calculation.
  • pixelsPerMeter - the number of pixels to represent 1 meter.
  • initColor - the initial color of the particles (in RGB).
  • finalColor - the final color of the particles (in RGB).
  • maxColorVelocity - the maximum velocity of the particles at which the color will be the final color.
  • backColor - the background color of the canvas (in RGB).

This will create a canvas with 3000 particles on desktop and 1000 on mobile in fullscreen which will be resized when the window is resized.

Note The default values of the props are the same as the ones in the example above.

You can find the complete example of the project in the GitHub repository here.

Note
Be sure to do like in the example, the parent div of the canvas must be set before the p5 canvas is created.

Calculations

The calculations are made with the Newtonian mechanics equations.

$$ F = G \frac{m_1 m_2}{r^2} $$

To prevent to have a division by zero when the particles are too close to each other, we add a softening parameter $\epsilon$. The implementation is not made to be physically accurate, but to be visually appealing. By adding the offset $\epsilon$ directly like below, the particles will come from a far distance faster than they should.

$$ F = G \frac{m_1 m_2}{r^2 + \epsilon} $$

One of the real force calculation with softening could be like this:

$$ F = G \frac{m_1 m_2}{(r^2 + \epsilon^2)^\frac{3}{2}} $$

Where G is the gravitational constant, m1 and m2 are the masses of the particles, r is the distance between the particles and d is the softening parameter.

Known issues

Warning
The React-p5 dependency may have issues with the index.js file.

const root = ReactDOM.createRoot(document.getElementById('root'));
root.render(
    <React.StrictMode>
        <App/>
    </React.StrictMode>
);

Please delete the React.StrictMode tag in the index.js file and replace it with the code below.

const root = ReactDOM.createRoot(document.getElementById('root'));
root.render(
    <>
        <App/>
    </>
);

GitHub Actions

Node.js CI ESLint CodeQL Node.js Package

The project is set up to run the following actions:

  • node.js.yml : Runs the tests for the Node.js project.
  • eslint.yml : Runs the ESLint linter on the project.
  • codeql.yml : Runs the CodeQL linter on the project.
  • npm-publish.yml : Publishes the package to npm.

Libraries

React:
https://reactjs.org/docs/getting-started.html

Xo:
https://github.com/xojs/xo
https://github.com/xojs/eslint-config-xo-react
https://github.com/xojs/eslint-config-xo-typescript

ESLint:
https://eslint.org/docs/latest/user-guide/getting-started

GitHub gh-pages:
https://github.com/gitname/react-gh-pages

P5.js:
https://p5js.org/
https://www.npmjs.com/package/react-p5

react-device-detect:
https://www.npmjs.com/package/react-device-detect

Documentation

The Coding Challenge (math and physics):
https://www.youtube.com/watch?v=OAcXnzRNiCY

P5.js:
https://p5js.org/

P5.js React:
https://www.npmjs.com/package/react-p5

Links

Check the source code on github

Check the demo on github

Check the package on npm

Contributors

Quentin MOREL :

GitHub contributors

Package Sidebar

Install

npm i particle-simulator-react-p5

Weekly Downloads

7

Version

1.6.0

License

MIT

Unpacked Size

51.2 kB

Total Files

23

Last publish

Collaborators

  • im-rises