Skip to content
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.

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

Potential Visualizer writers need easily accessible guidance #46

Closed
gwhitney opened this issue Nov 19, 2021 · 14 comments
Closed

Potential Visualizer writers need easily accessible guidance #46

gwhitney opened this issue Nov 19, 2021 · 14 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@gwhitney
Copy link
Collaborator

This is mainly a placeholder for the fact that ultimately the "user's guide" will need to include a section on writing/deploying a new Visualizer. In particular, this will need to address whether and how it's possible to do that independently of running from a modified clone of the full frontscope source.

@gwhitney gwhitney added the documentation Improvements or additions to documentation label Nov 19, 2021
@gwhitney
Copy link
Collaborator Author

Also as noted in #42, this guidance likely will also need to comment on how best to manipulate the output of Sequences numerically, especially if non-integer functions like sine or log need to be applied.

@katestange
Copy link
Member

There is some of this in README.md, to be expanded.

@gwhitney
Copy link
Collaborator Author

There is some of this in README.md, to be expanded.

True, but one of the intentions of this issue is to make this sort of information accessible through the Numberscope site, in conjunction with the other "User's Guide" information that is already available that way.

@katestange
Copy link
Member

katestange commented Dec 2, 2021

A note for eventual inclusion in visualization documentation: I ran across the issue that p5 colours can't be defined outside setup() and draw(). With typescript, this requires some workaround for your colour variables. See here: processing/p5.js#1293

@gwhitney

This comment has been minimized.

@katestange

This comment has been minimized.

@katestange
Copy link
Member

Another small thing to make sure is included in these docs: when the canvas is resized and it starts over (e.g. in the current setup when going from a "card thumbnail" to the full viz and back), the code runs setup() again without first cleaning up; so make sure setup() cleans up anything you've been doing in draw(). (I ran into bugs from not realizing this and not cleaning out an array.)

@liammulh
Copy link
Member

liammulh commented Jun 7, 2022

Related to #127.

@liammulh
Copy link
Member

I'm not working on this right now. Unassigning myself.

@liammulh liammulh removed their assignment Jan 11, 2023
@gwhitney
Copy link
Collaborator Author

#293 is relevant, but I doubt will be comprehensive to all of the aspects brainstormed in this issue, so there will likely be a remnant of this issue to be left open even after that lands.

@gwhitney
Copy link
Collaborator Author

We are close to resolving this, so should just be finished off with doc overhaul for alpha.

@gwhitney
Copy link
Collaborator Author

gwhitney commented Nov 5, 2024

this will need to address whether and how it's possible to do that independently of running from a modified clone of the full frontscope source

Moved this point to #489 for the sake of being able to resolve this in hopefully under three years from its creation (gosh, have I been collaborating on Numberscope that long??!)

@gwhitney
Copy link
Collaborator Author

gwhitney commented Nov 5, 2024

There are only two points remaining in this issue:

  • Guidance on how to use non-integer-valued functions (like sine or exp) in computing with sequence values [I put this in working-with-bigints.md.]
  • How/when one can initialize p5 Color variables and the use of INVALID_COLOR as a TypeScript workaround.

I could use some guidance/suggestions as to where to put this information in the documentation, especially with the "Building a Visualizer" page already so long. If we adopt the suggestion from a discussion of having an "intermediate" visualizer-writing page, I think they could both go there. But maybe there's a better way to split the information currently in "Building a visualizer" together with these points?

@gwhitney gwhitney added question Further information is requested meeting To be discussed at weekly meeting and removed question Further information is requested meeting To be discussed at weekly meeting labels Nov 5, 2024
@gwhitney
Copy link
Collaborator Author

All of these items are in ui2 per #486, so closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

No branches or pull requests

3 participants