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.

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

fmo-a4-creativecoding #85

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

fmo-a4-creativecoding #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c3135e0
add
Sep 28, 2019
c9221c4
readme
Sep 28, 2019
a9f4e3d
package
Sep 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
Binary file added .DS_Store
View file
Open in desktop
Binary file not shown.
93 changes: 38 additions & 55 deletions README.md
100755 → 100644
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,72 +1,55 @@
Assignment 4 - Creative Coding: Interactive Multimedia Experiences
===

Due: September 27th, by 11:59 PM.

For this assignment we will focus on client-side development using popular audio/graphics/visualization technologies; the server requirements are minimal. The goal of this assignment is to refine our JavaScript knowledge while exploring the multimedia capabilities of the browser.
https://fmo-a4-creativecoding.glitch.me

Baseline Requirements
---
### Introduction

Your application is required to implement the following functionalities:
This project aims to display the population of Australia states, including the population of each state, the growth rate since 2011 and the state area which is used to evaluate the population density.

- A server created using Express (you can also use an alternative server framework such as Koa) for basic file delivery and middleware. Your middleware stack should include the `compression` and `helmet` [middlewares]((https://expressjs.com/en/resources/middleware.html)) by default. You are not required to use Glitch for this assignment (but using Glitch is fine!); [Heroku](https://www.heroku.com) is another excellent option to explore. The course staff can't be resposible for helping with all other hosting options outside of Glitch, but some of us do have experience with other systems. It also never hurts to ask on Slack, as there's 99 other classmates who might have the experience you're looking for!
- A client-side interactive experience using at least one of the web technologies frameworks we discussed in class over the past week.
- [Three.js](https://threejs.org/): A library for 3D graphics / VR experiences
- [D3.js](https://d3js.org): A library that is primarily used for interactive data visualizations
- [Canvas](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API): A 2D raster drawing API included in all modern browsers
- [SVG](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API): A 2D vector drawing framework that enables shapes to be defined via XML.
- [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API): An API for audio synthesis, analysis, processing, and file playback.
- A user interface for interaction with your project, which must expose at least six parameters for user control. [dat.gui](https://workshop.chromeexperiments.com/examples/gui/#1--Basic-Usage) is highly recommended for this. You might also explore interaction by tracking mouse movement via the `window.onmousemove` event handler in tandem with the `event.clientX` and `event.clientY` properties. Consider using the [Pointer Events API](https://developer.mozilla.org/en-US/docs/Web/API/Pointer_events) to ensure that that mouse and touch events will both be supported in your app.
- Your application should display basic documentation for the user interface when the application first loads. This documentation should be dismissable, however, users should be able to redisplay it via either a help buton (this could, for example, be inside a dat.gui interface) or via a keyboard shortcut (commonly the question mark).
- Your application should feature at least two different ES6 modules that you write ([read about ES6 modules](https://www.sitepoint.com/understanding-es6-modules/)) and include into a main JavaScript file. This means that you will need to author *at least three JavaScript files* (a `app.js` or `main.js` file and two modules). We'll discuss modules in class on Monday 9/23; for this assignment modules should contain at least two functions.
- You are required to use a linter for your JavaScript. There are plugins for most IDEs, however it will be difficult to run the linter directly in Glitch. If you haven't moved to developing on your personal laptop and then uploading to Glitch when your project is completed, this is the assignment to do so!
- Your HTML and CSS should validate. There are options/plugins for most IDEs to check validation.
This map is to show the population(millions), growth rate(%) since 2011 and state area(km²) metrics of AU states of 2017, 2018 and 2019.
![Image of Map](screenshot/screenshot.png)

The interactive experience should possess a reasonable level of complexity. Some examples:
### Three.js
- A generative algorithm creates simple agents that move through a virtual world. Your interface controls the behavior / appearance of these agents.
- A simple 3D game
- An 3D audio visualization of a song of your choosing. User interaction should control aspects of the visualization.
### Canvas
- Implement a generative algorithm such as [Conway's Game of Life](https://bitstorm.org/gameoflife/) (or 1D cellular automata) and provide interactive controls. Note that the Game of Life has been created by 100s of people using <canvas>; we'll be checking to ensure that your implementation is not a copy of these.
- Design a 2D audio visualizer of a song of your choosing. User interaction should control visual aspects of the experience.
### Web Audio API
- Create a screen-based musical instrument using the Web Audio API. You can use projects such as [Interface.js](http://charlie-roberts.com/interface/) or [Nexus UI](https://nexus-js.github.io/ui/api/#Piano) to provide common musical interface elements, or use dat.GUI in combination with mouse/touch events (use the Pointer Events API). Your GUI should enable users to control aspects of sound synthesis.
### D3.js
- Create visualizations using the datasets found at [Awesome JSON Datasets](https://github.com/jdorfman/Awesome-JSON-Datasets). Experiment with providing different visualizations of the same data set, and providing users interactive control over visualization parameters and/or data filtering. Alternatively, create a single visualization with using one of the more complicated techniques shown at [d3js.org](d3js.org) and provide meaningful points of interaction for users.
### Challenges
The main challenge is how to display the map and show the corresponding on it, additionally, it also needs to be controlled by GUI panel.

Deliverables
---
### JS linter
In this project, it is implemented by VS Code and enable ESLinter plugin, the following rule is used:
```json
"rules": {
"semi": ["error", "always"],
"quotes": ["error", "double"]
}
```

Do the following to complete this assignment:
## Technical Achievements
- **Tech Achievement 1**: Use D3.js library to implement map visualization with geo json data for Australia states.
- **Tech Achievement 2**: Use dat.GUI to make user interactive friendly and allow users to adjust the data and map display.
- **Tech Achievement 3**: To provide responsive UI, I use Bootstrap V4 and font-awesome to prettify the webpage.
- **Tech Achievement 4**: Give a guideline to users and it can be closed and reopened by binding javascript events.
- **Tech Achievement 5**: Implement two modules in `geo.js` and `population.js` to read geography and population data and imported as controller for URL request handling.
- **Tech Achievement 6**: Flexible to use js bind and events to correspond to user interactive events, such as mouse moving events to show/hide tooltip when it moves on map.

1. Implement your project with the above requirements.
3. Test your project to make sure that when someone goes to your main page on Glitch/Heroku/etc., it displays correctly.
4. Ensure that your project has the proper naming scheme `a4-yourname` so we can find it.
5. Fork this repository and modify the README to the specifications below. *NOTE: If you don't use Glitch for hosting (where we can see the files) then you must include all project files that you author in your repo for this assignment*.
6. Create and submit a Pull Request to the original repo. Name the pull request using the following template: `a4-gitname-firstname-lastname`.
### Design/Evaluation Achievements
- **Design Achievement 1**: Use Bootstrap to dispaly the page in responsive container.
- **Design Achievement 2**: Clear code structure with custom js and css file without any embeded style and script code.
- **Design Achievement 3**: Besides meet visualization requirements, it also provides simply data analysis feature, like summerize total population of Australia.

Sample Readme (delete the above when you're ready to submit, and modify the below so with your links and descriptions)
---
### User Guide
#### Show state data on map by selecting category
As it provides population, growth rate and state area, 3 kinds of data, it can be selected by the dropdown box on control panel.

## Your Web Application Title
![Image of Map](screenshot/category.png)

your hosting link e.g. http://a4-charlieroberts.glitch.me
#### Show data for different year
You can also change the year to see the population data for the selected year.

Include a very brief summary of your project here. Images are encouraged, along with concise, high-level text. Be sure to include:
![Image of Map](screenshot/year.png)

- the goal of the application
- challenges you faced in realizing the application
- a brief description of the JS linter you used and what rules it follows (we'll be looking at your JS files for consistency)
#### Highlight the state
Select one state you want to highlight, it shows the detailed data on the left top corner and fade other states and it can return to all states display.

## Technical Achievements
- **Tech Achievement 1**: I wrote my own custom GLSL shaders to use as a material for my Three.js objects.
- **Tech Achievement 2**: My audiovisualizer uses both FFT and amplitude analysis to drive visualization.
- **Tech Achievement 3**: I optimized the efficiency of my reaction-diffusion algorithm by...
- **Tech Achievement 4**: I visualized the dataset X using three different visualization technqiues provided by D3, andprovided
![Image of Map](screenshot/highlight.png)

### Design/Evaluation Achievements
- **Design Achievement 1**: I ensured that my application would run on both desktops / mobile devices by changing X
- **Design Achievement 2**: I followed best practices for accessibility, including providing alt attributes for images and using semantic HTML. There are no `<div>` or `<span>` elements in my document.
- **Design Achievement 3**: We tested the application with n=X users, finding that...
#### Adjust style attributes for map color opacity and text
The other parameters on the GUI panel is to tune color opacity and font for the map
Loading