Skip to content

add before/after preload and setup #6433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 14 commits into from
Oct 4, 2023
Merged

add before/after preload and setup #6433

Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
2543102
add hooks
capGoblin Sep 25, 2023
50163a2
Refactor hooks
capGoblin Sep 26, 2023
6b16199
add callRegisteredHooksFor
capGoblin Sep 27, 2023
25d9cb4
corrected a typo
capGoblin Sep 27, 2023
6bb0e6f
update callRegisteredHooksFor to use context
capGoblin Sep 27, 2023
5514eaa
use callRegisteredHooksFor for pre/post draw
capGoblin Sep 27, 2023
fa06c9c
isGlobal is not read inside callRegisteredHooksFor
capGoblin Sep 27, 2023
ff32bbd
fix tests fails
capGoblin Sep 27, 2023
a9394b7
add tests for hooks
capGoblin Sep 28, 2023
c0d6349
refactor the tests
capGoblin Oct 3, 2023
670cbda
Merge branch 'processing:main' into add-hooks
capGoblin Oct 3, 2023
f2aec47
update docs
capGoblin Oct 4, 2023
b09e55a
Merge branch 'add-hooks' of https://github.com/capGoblin/p5.js into a…
capGoblin Oct 4, 2023
e872ad6
Merge branch 'processing:main' into add-hooks
capGoblin Oct 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/core/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,6 +231,19 @@ class p5 {
this._events.devicemotion = null;
}

// Function to call registered before and after hooks for preload and setup
function callRegisteredHooksFor(hookName) {
const target = this || p5.prototype;
if (target._registeredMethods.hasOwnProperty(hookName)) {
const methods = target._registeredMethods[hookName];
for (const method of methods) {
if (typeof method === 'function') {
method.call(this);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work on this helper function! Just for consistency, now that we have this helper, can we update the pre/post draw hooks to use this too? Currently that happens here:

p5.js/src/core/structure.js

Line 486 in 63f94b0

context._registeredMethods.pre.forEach(callMethod);

I also notice that for pre/post draw, rather than passing this to call, they pass context, where it is defined as:

p5.js/src/core/structure.js

Line 469 in 63f94b0

const context = this._isGlobal ? window : this;

Maybe we can do that here too?

}
}
}
}

this._start = () => {
// Find node if id given
if (this._userNode) {
Expand All @@ -241,6 +254,7 @@ class p5 {

const context = this._isGlobal ? window : this;
if (context.preload) {
callRegisteredHooksFor('beforePreload');
// Setup loading screen
// Set loading screen into dom if not present
// Otherwise displays and removes user provided loading screen
Expand Down Expand Up @@ -286,6 +300,7 @@ class p5 {
if (loadingScreen) {
loadingScreen.parentNode.removeChild(loadingScreen);
}
callRegisteredHooksFor('afterPreload');
if (!this._setupDone) {
this._lastTargetFrameTime = window.performance.now();
this._lastRealFrameTime = window.performance.now();
Expand Down Expand Up @@ -322,6 +337,7 @@ class p5 {
};

this._setup = () => {
callRegisteredHooksFor('beforeSetup');
// Always create a default canvas.
// Later on if the user calls createCanvas, this default one
// will be replaced
Expand Down Expand Up @@ -369,6 +385,7 @@ class p5 {
if (this._accessibleOutputs.grid || this._accessibleOutputs.text) {
this._updateAccsOutput();
}
callRegisteredHooksFor('afterSetup');
};

this._draw = () => {
Expand Down