Have ideas to improve npm?Join in the discussion! »

p5.scenemanager

1.0.6 • Public • Published

p5.js SceneManager

News

  • A modified version of 'p5.js SceneManager' is a key component of codeguppy.com - a new coding site for kids, teens and creative adults.

JavaScript projects

Note: If you are using p5.js SceneManager in your project, it will be great if you share the details of your project with me (totally optional though).

Description

p5.js SceneManager helps you create p5.js sketches with multiple states / scenes. Each scene is a like a sketch within the main sketch. You focus on creating the scene like a regular sketch and SceneManager ensure scene switching routing the main setup(), draw(), mousePressed(), etc. events to the appropriate current scene.

Instead of putting all your code in the main setup() and draw() like this:

function setup() {
 
}
 
function draw() {
 
}

... you put each scene code in the setup() and draw() methods of individual Scene classes:

// Intro scene constructor function
function Intro()
{
    this.setup = function() {
    }
 
    this.draw = function() {
    }
 
    this.keyPressed = function() {
        // switch the scene
        this.sceneManager.showScene( Game );
    }
}
 
// Main games scene constructor function
function Game()
{
    this.setup = function() {
    }
 
    this.draw = function() {
    }
}

The SceneManager will provide you with methods necesary to switch to the appropriate scene and route the main p5.js events to your defined events.

Draw something in all scenes

if you wish, you can add a event to execute after each draw() of all scenes.

To do this, in your .js file that contains setup() to load the main scene (generally sketch.js), add a drawScene() global event, like this:

function setup() {
  ...
 
  let mgr = new SceneManager();
  mgr.wire();
  mgr.showScene(MainScene);
}
 
function drawScene() {
    // Draw something in the canvas,
    // after draw() of each scene
}

Source Code

Source code is located in lib/scenemanager.js

Demo Code

For demo please check sample.html, sample_instance.html and game.html

Online demo

You can try online the SceneManager using the following demos:

Future development

The library can be further extended with features such as:

  • routing of more / all events to the appropriate scene class
  • running of multiple scenes in parallel (overlapped)
  • running of multiple scenes in parallel in individual areas of a bigger canvas

If you are interested in these features, please open an issue here on GitHub.

License

CC BY 2.0

VMA

Install

npm i p5.scenemanager

DownloadsWeekly Downloads

0

Version

1.0.6

License

ISC

Unpacked Size

2.24 MB

Total Files

13

Last publish

Collaborators

  • avatar