David Liao

README.md

@@ -1,82 +1,34 @@
 # [Project2: Toolbox Functions](https://github.com/CIS700-Procedural-Graphics/Project2-Toolbox-Functions)
 
 ## Overview
-
-The objective of this assignment is to procedurally model and animate a bird wing. Let's get creative!
-
-Start by forking and then cloning [this repository](https://github.com/CIS700-Procedural-Graphics/Project2-Toolbox-Functions)
-
-## Modeling
-
-##### Reference images
-
-Search for three or more images of a bird wing (or any flying creature, really) in order to provide yourself reference material, as you're going to base your modeling and animation from these images. For the more artistic minds, feel free to sketch your own concept.
-
-##### Make wing curve
-
-Begin with a 3D curve for your basic wing shape. Three.js provides classes to create many different types of curves, so you may use whatever type of curve you prefer.
-
-##### Distribute feathers
-
-We have provided a simple feather model from which to begin. You are not required to use this model if you have others that you prefer. From this base, you must duplicate the feather to model a complete wing, and your wing should consist of at least thirty feathers. Distribute points along the curve you created previously; you will append the feather primitives to the curve at these points. Make sure that you modify the size, orientation, and color of your feathers depending on their location on the wing. 
-
-Feel free to diversify your wings by using multiple base feather models.
-
-## Animation
-
-Add a wind force to your scene, and parameterize its direction and speed. You will use this wind force to animate the feathers of your wing by vibrating them slightly. Using Dat.GUI, allow the user to modify these wind parameters. Please note that we don't care about your feather motion being physically accurate, as long as it looks nice.
-
-Additionally, animate the control points of your wing curve to make the wing flap, and allow the user to control the speed of the wing flapping.
-
-## Interactivity
-
-Using Dat.GUI and the examples provided in the reference code, allow the user to adjust the following controls:
-
-1. The curvature of the wing's basic shape
-2. Feather distribution
-3. Feather size
-4. Feather color
-5. Feather orientation
-6. Flapping speed
-7. Flapping motion
-
-## For the Overachievers
-
-Suggestions:
-- Make a pretty iridescent or otherwise feather appropriate shader.
-- Otherwise, going the extra mile for this assignment is really in the polish!
-
-## Submission
-
-- Create a folder called `references` to include your reference images.
-
-- Update `README.md` to contain a solid description of your project
-
-- Publish your project to gh-pages. `npm run deploy`. It should now be visible at http://username.github.io/repo-name
-
-- Create a [pull request](https://help.github.com/articles/creating-a-pull-request/) to this repository, and in the comment, include a link to your published project.
-
-- Submit the link to your pull request on Canvas.
-
-## Getting Started
-
-1. [Install Node.js](https://nodejs.org/en/download/). Node.js is a JavaScript runtime. It basically allows you to run JavaScript when not in a browser. For our purposes, this is not necessary. The important part is that with it comes `npm`, the Node Package Manager. This allows us to easily declare and install external dependencies such as [three.js](https://threejs.org/), [dat.GUI](https://workshop.chromeexperiments.com/examples/gui/#1--Basic-Usage), and [glMatrix](http://glmatrix.net/). Some other packages we'll be using make it significantly easier to develop your code and create modules for better code reuse and clarity. These tools make it _signficantly_ easier to write code in multiple `.js` files without globally defining everything.
-
-2. Fork and clone your repository.
-
-3. In the root directory of your project, run `npm install`. This will download all of those dependencies.
-
-4. Do either of the following (but I highly recommend the first one for reasons I will explain later).
-
-    a. Run `npm start` and then go to `localhost:7000` in your web browser
-
-    b. Run `npm run build` and then go open `index.html` in your web browser
-
-    You should hopefully see the framework code with a 3D cube at the center of the screen!
-
-
-## Developing Your Code
-All of the JavaScript code is living inside the `src` directory. The main file that gets executed when you load the page as you may have guessed is `main.js`. Here, you can make any changes you want, import functions from other files, etc. The reason that I highly suggest you build your project with `npm start` is that doing so will start a process that watches for any changes you make to your code. If it detects anything, it'll automagically rebuild your project and then refresh your browser window for you. Wow. That's cool. If you do it the other way, you'll need to run `npm build` and then refresh your page every time you want to test something.
-
-## Publishing Your Code
-We highly suggest that you put your code on GitHub. One of the reasons we chose to make this course using JavaScript is that the Web is highly accessible and making your awesome work public and visible can be a huge benefit when you're looking to score a job or internship. To aid you in this process, running `npm run deploy` will automatically build your project and push it to `gh-pages` where it will be visible at `username.github.io/repo-name`.
+Animated bird wing using Three.js and dat.GUI.
+
+## Features
+- Wing controls
+  - Bezier control points
+- Feather controls
+  - length
+  - width
+  - distribution (density)
+  - layers
+  - color
+- Wind controls
+  - Wind speed
+  - Wind directions (wind always blows in the +z axis, but you can control x and y directions to modulate feather orientation)
+- Wing Controls
+  - Flapping speed
+  - Flapping motion
+    - 5 Keyframes
+
+## The Bird Wing
+The wing itself is segmented into 3 sections and 3 layers (modifiable). These sections spawn off of a "bone" cubic Bezier curve. These sections represent the primary, secondary, and tertiary feathers that the bird uses to guide itself, give itself thrust, and stay warm respectively. The added layers gives the wing some density and thickness to make it realistic. The primary feathers is splayed using a power curve as well as a LERP. The rotation along the y-axis as the feathers extend outward uses a LERP as well. The secondary feathers, also use LERPs as well as a parabolic curve for added realism (referencing a wing photo). Finally, the scapular or tertiary wings use a cubic pulse as we can best control the falloff of the curve. The feathers are sampled regularly depending on the layer. The higher layers are more sparse but compensate by being wider (z-axis scaling).
+
+## Cool Things
+Try turning the wind on and raise flapping speed to ~6-8 to see a flapping wing! Note the Bezier controls are reactive to the position of the wing. Two functions help us achieve this: a `diff` function that calculates the keyframe delta with an added alpha parameter to modulate step-sizes (for keyframe interpolation), and a `moveWingTo`/`moveWing` function that moves the wing using Bezier control points in an absolute/relative fashion.
+
+
+## Future work
+- Rotational and Scale Keyframes
+- Feather shaders
+- More anatomically correct wing
+- Smoother keyframe interpolations

deploy.js

@@ -0,0 +1,38 @@
+let colors = require('colors');
+let path = require('path');
+let git = require('simple-git')(__dirname);
+let deploy = require('gh-pages-deploy');
+let packageJSON = require('require-module')('./package.json');
+
+let success = 1;
+git.fetch('origin', 'master', function(err) {
+    if (err) throw err;
+    git.status(function(err, status) {
+        if (err) throw err;
+        if (!status.isClean()) {
+            success = 0;
+            console.error('Error: You have uncommitted changes! Please commit them first'.red);   
+        }
+
+        if (status.current !== 'master') {
+            success = 0;
+            console.warn('Warning: Please deploy from the master branch!'.yellow)
+        }
+
+        git.diffSummary(['origin/master'], function(err, diff) {
+            if (err) throw err;
+
+            if (diff.files.length || diff.insertions || diff.deletions) {
+                success = 0;
+                console.error('Error: Current branch is different from origin/master! Please push all changes first'.red)
+            }
+
+            if (success) {
+                let cfg = packageJSON['gh-pages-deploy'] || {};
+                let buildCmd = deploy.getFullCmd(cfg);
+                deploy.displayCmds(deploy.getFullCmd(cfg));
+                deploy.execBuild(buildCmd, cfg);
+            }
+        })
+    })
+})