Giter Club home page Giter Club logo

mandelbrot-maps's Introduction

Mandelbrot Maps on a phone and tablet

Mandelbrot Maps CircleCI

Mandelbrot Maps is an interactive fractal explorer built using React and WebGL.

Developed by Joao Maio in 2019/2020 as part of an Honours Project at The University of Edinburgh, under the supervision of Philip Wadler.

The project was simultaneously undertaken by Freddie Bawden, also under the supervision of Philip Wadler. Freddie's version of the project is available at: mmaps.freddiejbawden.com

The original Mandelbrot Maps project was developed by Iain Parris in 2008 as a Java Applet.

Mandelbrot set shader code adapted from Mandelbrot - smooth by Inigo Quilez.


This project was bootstrapped with Create React App.

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

npm run build

Builds the app for production to the build folder.
It correctly bundles React in production mode and optimizes the build for the best performance.

The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

See the section about deployment for more information.

npm run eject

Note: this is a one-way operation. Once you eject, you can’t go back!

If you aren’t satisfied with the build tool and configuration choices, you can eject at any time. This command will remove the single build dependency from your project.

Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except eject will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.

You don’t have to ever use eject. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

Learn More

You can learn more in the Create React App documentation.

To learn React, check out the React documentation.

Code Splitting

This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting

Analyzing the Bundle Size

This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size

Making a Progressive Web App

This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app

Advanced Configuration

This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration

Deployment

This section has moved here: https://facebook.github.io/create-react-app/docs/deployment

npm run build fails to minify

This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify

mandelbrot-maps's People

Contributors

dependabot[bot] avatar jmaio avatar yonadaaa avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

mandelbrot-maps's Issues

Updating notice broken?

after upgrading to yarn 2 (?), update notifications no longer pop up on the website...
maybe react-scripts / workbox changes?

Controls

  • re-center button
  • toggle controls (on touch screen?)
  • control demo / info bubble / help explanation
  • manual number input fields (x, y, zoom, theta?)
  • make "+" and "-" buttons keep zooming if long-pressed

Controls and indicators

It's now possible to control position, zoom, and rotation.
Zoom and Rotation do not yet have robust visual indicators:

  • zoom control - Google Maps slider? with +/- buttons
  • rotation control - compass-esque, rotatable disc / slim dial? also needs reset function

URL coordinate scheme and animation

looking to use wouter; use case is:

  1. (optionally select target point through the ui)
  2. update URL to next location (hash router)
  3. trigger react-spring animation to point

need to settle on URL scheme, requirements are:

  • mandelbrot viewer
    • [x, y]
    • zoom
    • theta
  • julia viewer tbd

also tbd: should the hash URL be updated when the user stops dragging? (yes)

  • animate on start
  • smooth animation (too quick to zoom)
  • update on spring "rest"
  • animate on (hash) location change
  • user hash location change navigable (in-browser back / forward)
  • validation of input

UI

  • PiP type-thing for Julia set
    • top right? floating window?
    • click to switch?
    • split-view (horizontal / vertical split?)
    • reverse vertical view (Mandelbrot bottom, Julia top)
  • "crosshair" for selecting z for Julia set
  • iteration ?slider? / ?dial?
  • shader parameters (AA, maxI)
  • speed dial blocks input

Separate renderer from controls

currently controls and renderer are actually in the same component
removing useSpring props and substituting with only values or render callback ideal

Renderer implementation

  • basic gl shader
  • touch target div
    • tiled canvas
  • multi-target gl shader
  • Julia renderer
  • shader parameters (maxI, AA, etc) + trigger recompile

Add WebGL shader compilation tests

Find a way to test shaders to make sure they compile.
Need to either have a mock WebGL context or directly invoke WebGL compilation functions in test files.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.