sugarlabs/musicblocks
author:joykirat (Joykirat Singh)
- Project Title: MusicBlock-v4 Palettes and Artboard Canvas
- Proposal: Proposal
- Organization: Sugarlabs
- Mentors : Anindya Kundu
Peace Ojemeh
Walter Bender
Devin Ulibarri
MusicBlocks is being refactored from scratch, so this gives us the opportunity to work on a new, improved version of the project with the latest tech stacks and enhanced performance.
Spend the summer of 2021 working on MusicBlocks-v4 and has been an amazing experience.
I'm very grateful to Sugarlabs for accepting my contributions and supporting me through the process of building the new MusicBlocks.
For the past four months, I, along with my peers, have been working tirelessly on four different major components, i.e. ArtBoard(canvas), palette, Menus and Blocks. I took the responsibility of building the palette section and functionality of drawing on the artBoard canvas. Also made sure that the performance of the new components build was better than the previous version of musicBlocks.
This is a description of my work on MusicBlock Palette and Canvas during Google Summer Of Code 2021 with Sugar Labs. This repository contains the work done, the code and the documentation written by me for the project.
The new MusicBlocks is build using React + Typescript. This decision was taken to improve the performance and the code quality of the project. React virtual dom helps improve the performance, and strict type checking using Typescript over javascript helps improve the code quality.
The palette was build using functional components and various hooks.
p5 library is used to create and handle canvases. p5.js provides many inbuilt functions to draw graphics and turtles over the canvas. p5.js has several predefined functions which we can use to draw anything we want. The most basic (and necessary) functions are the setup() and draw() functions. A simple canvas using p5 in react can be created like this.
p5 Canvas is created in instance mode.
const Sketch = (sketch: P5Instance): void => {
let demoCanvas: p5.Element;
/** This is a setup function */
sketch.setup = () => {
demoCanvas = sketch.createCanvas(1200, 600);
};
/** This is a draw function */
sketch.draw = () => {
sketch.background(220);
sketch.ellipse(50, 50, 80, 80);
};
};
It creates a canvas as a p5 element with a circle on top of it. There are two essential functions setup and draw. The code inside the draw() function runs continuously from top to bottom until the program is stopped. The setup function runs only once in the beginning.
Using React, we get all the advantages of declarative code with clean, reusable and reactive components. All the while still maintaining the easy to use abstractions exposed by p5. The above sketch definition is called inside a react component.
During the Community Bonding Period, we brainstormed to decide the tech stack we were going to use and the project's architecture. We decided to go for MVVM architecture. Model — View — ViewModel (MVVM) is the industry-recognized software architecture pattern that overcomes all drawbacks of MVP and MVC design patterns. MVVM suggests separating the data presentation logic(Views or UI) from the core business logic part of the application.
The separate code layers of MVVM are:
- Model: This layer is responsible for the abstraction of the data sources. Model and ViewModel work together to get and save the data.
- View: The purpose of this layer is to inform the ViewModel about the user's action. This layer observes the ViewModel and does not contain any kind of application logic.
- ViewModel: It exposes those data streams which are relevant to the View. Moreover, it servers as a link between the Model and the View.
My ten weeks of work on the project were divided into Building the palette and Building artBoard Functionality.
The palette is a crucial part of MusicBlock. All the blocks are divided into different sections, and the user can select different blocks.
MVVM architecture is followed to build the palette.
The view models are palette.ts and PaletteBlock.ts.
The palette.ts is responsible for showing the palettes sections and subSections. The palette.ts ViewModel calls the palette.tsx view to render the subSections.
The paletteBlocks is used to show the PopUp containing all the blocks. It divides the block into low Shelf and High Shelf blocks.
- High Shelf Blocks: The high shelf blocks contain the users mostly used and can be easily found.
- Low Shelf Blocks: The low shelf blocks contain blocks that are rarely used and can be grouped with other blocks.
PopUp.tsx is the view for the PopUp and is responsible for how the low and high shelf blocks are shown.
For more details on the structure of the palette, you can see the complete documentation here.
The artBoard is the canvas where the user can draw using the turtle. The user can perform 4 functionlity on the turtle:
- Move turtle forward/backwards
- Rotate turtle clockwise/counter clockwise
- Move turtle in an arc
- Draw and drop turtle
The user can define the angle, the distance and the speed of the turtle. The detail on the functionality and the structure of the artBoard can be seen in the complete documentation here.
The two models artBoardDraw.ts and turtle.ts store the canvas and turtles created, respectively.They are called by the artBoardSketch.tsx and artBoardTurtle.tsx respectively. For more detail on the structure of artBoard model you can see the full documentation here.
| PR | Description |
|---|---|
| 70 | The MVVM architecture is used to build the palette. The basic styling is completed, and blocks are divided into high and low Shelf. |
| 74 | The move functionality of the turtle is added. The user can move the turtle around the canvas and specify the number of turtles rendered on canvas. |
| 85 | Many props were being passed around the views, so wrapped the artBoard in a context API layer to clean up some of the code. |
| 86 | The turtle can be dragged and dropped on the canvas. The topmost turtle always gets priority while two turtles are overlapping. |
| 90 | Disabled mouse events on the turtle when it is moving. Due to this, only stationary turtles can be dragged and dropped. |
| 91 | ArtBoard Canvas Documentation. |
| 92 | Palette Documentation. |
- Improve the design of the palette.
- Users can make their own low shelf and high shlef blocks category.
- The popUp can expand to full screen and user can drag and drop the popUp to any position.
- Connect the palette with the blocks frameWork.
- Add more different turtle Shapes.
- Improve the performance of the artBoard.
On a final note, I am incredibly grateful to my mentors, Anindya Kundu, Walter Bender, Peace Ojemeh, and Devin Ulibarri. I am also very thankful for their motivation which helped me improve the quality of my code and helping me improve my soft skills.
Thanks to Sugarlabs and MusicBlocks for this great opportunity.
Thanks
Joykirat Singh