Skip to content

Joseph Klinger #18

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

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

Joseph Klinger #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0b1a6bb
Added more feathers to the wing
Jan 31, 2017
14dfaa1
Added some gui functionality
Jan 31, 2017
9b5c7e0
added for gui functionality
Jan 31, 2017
c90555f
Finished
Feb 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 3 additions & 80 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,5 @@
# [Project2: Toolbox Functions](https://github.com/CIS700-Procedural-Graphics/Project2-Toolbox-Functions)
## Joseph Klinger - CIS 700 Procedural Graphics - Project 2 - Bird Wing

## Overview
This project uses various forms of interpolation (mostly quadratic and cubic) to place and displace bird feathers.

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`.
The feathers are organized into 4 layers and can be transformed using the GUI parameters provided.
260 changes: 247 additions & 13 deletions src/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,136 @@

const THREE = require('three'); // older modules are imported like this. You shouldn't have to worry about this much
import Framework from './framework'
import {layer1, layer2, layer3, layer4, updateYPosition, updateZPosition, updateXRotation, updateYRotation, updateZRotation, updateXScale, updateYScale, updateZScale, flapWing, applyWind} from './toolbox_functions'

var featherGroup = new THREE.Object3D();
featherGroup.name = 'feather_group';

var flappingSpeed = { flappingSpeedScale : 1 }; //This goes into the onUpdate function and scale up/down the sin function.

var flappingMotion = { flappingMotionScale : 1 }; //Like above. scales up/down the amplitude of the sin function.

var windIntensity = { wind_intensity : 0.01};

var numFeathers; //set after loading in the feather obj during the callback function

//Choose how densely populated the first layer should be
var layer1Num = 52;
var layer2Num = 100;
var layer3Num = 150;
var layer4Num = 25;

function ApplyWind(framework) {
applyWind(featherGroup, 0.15);
}

function flapEachFeather(framework, flapScale, flapValue) {
for(var i = 0; i < layer1Num; i++) {
var currentFeather = framework.scene.getObjectByName("feather_" + i);
flapWing(currentFeather, i, layer1Num, flapScale, flapValue);
}

for(var j = 0; j < layer2Num; j++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j));
flapWing(currentFeather, j, layer2Num, flapScale, flapValue);
}

for(var k = 0; k < layer3Num; k++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j + k));
flapWing(currentFeather, k, layer3Num, flapScale, flapValue);
}

for(var l = 0; l < layer4Num; l++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j + k + l));
flapWing(currentFeather, l, layer4Num, flapScale, flapValue);
}
}

function UpdateXScales(framework, scaleAmount) {
framework.scene.getObjectByName('feather_group').scale.set(scaleAmount, 1, 1);
}

function UpdateYScales(framework, scaleAmount) {
framework.scene.getObjectByName('feather_group').scale.set(1, scaleAmount, 1);
}

function UpdateZScales(framework, scaleAmount) {
framework.scene.getObjectByName('feather_group').scale.set(1, 1, scaleAmount);
}



function updateXRotations(framework, rotAmount) {
for(var i = 0; i < numFeathers; i++) {
var currentFeather = framework.scene.getObjectByName('feather_group').children[i];
updateXRotation(currentFeather, rotAmount);
}
}

function updateYRotations(framework, rotAmount) {
for(var i = 0; i < numFeathers; i++) {
var currentFeather = framework.scene.getObjectByName('feather_group').children[i];
updateYRotation(currentFeather, rotAmount);
}
}

function updateZRotations(framework, rotAmount) {
for(var i = 0; i < numFeathers; i++) {
var currentFeather = framework.scene.getObjectByName('feather_group').children[i];
updateZRotation(currentFeather, rotAmount);
}
}

function updateYPositions(framework, curvatureAmount) {
for(var i = 0; i < layer1Num; i++) {
var currentFeather = framework.scene.getObjectByName("feather_" + i);
updateYPosition(currentFeather, i, layer1Num, curvatureAmount);
}

for(var j = 0; j < layer2Num; j++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j));
updateYPosition(currentFeather, j, layer2Num, curvatureAmount);
}

for(var k = 0; k < layer3Num; k++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j + k));
updateYPosition(currentFeather, k, layer3Num, curvatureAmount);
}

for(var l = 0; l < layer4Num; l++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j + k + l));
updateYPosition(currentFeather, l, layer4Num, curvatureAmount);
}
}

function updateZPositions(framework, exponent) {
for(var i = 0; i < layer1Num; i++) {
var currentFeather = framework.scene.getObjectByName("feather_" + i);
updateZPosition(currentFeather, i, layer1Num, exponent);
}

for(var j = 0; j < layer2Num; j++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j));
updateZPosition(currentFeather, j, layer2Num, exponent);
}

for(var k = 0; k < layer3Num; k++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j + k));
updateZPosition(currentFeather, k, layer3Num, exponent);
}

for(var l = 0; l < layer4Num; l++) {
var currentFeather = framework.scene.getObjectByName("feather_" + (i + j + k + l));
updateZPosition(currentFeather, l, layer4Num, exponent);
}
}

function UpdateColor(framework, newColor) {
for(var i = 0; i < numFeathers; i++) {
var currentFeather = framework.scene.getObjectByName('feather_group').children[i];
currentFeather.material.color.set(new THREE.Color(newColor));
}
}

// called after the scene loads
function onLoad(framework) {
Expand All @@ -13,7 +143,10 @@ function onLoad(framework) {
var stats = framework.stats;

// Basic Lambert white
var lambertWhite = new THREE.MeshLambertMaterial({ color: 0xaaaaaa, side: THREE.DoubleSide });
var physGold = new THREE.MeshPhysicalMaterial({ color: 0xFFD700, side: THREE.DoubleSide });
var physGreen = new THREE.MeshPhysicalMaterial({ color: 0xDDFF00, side: THREE.DoubleSide });
var physBlue = new THREE.MeshPhysicalMaterial({ color: 0x0063Af, side: THREE.DoubleSide });
var physRed = new THREE.MeshPhysicalMaterial({ color: 0xDD0000, side: THREE.DoubleSide });

// Set light
var directionalLight = new THREE.DirectionalLight( 0xffffff, 1 );
Expand All @@ -32,19 +165,72 @@ function onLoad(framework) {
] );

scene.background = skymap;


//Add multiple copies of the feather mesh into the scene upon loading the obj
//https://github.com/mrdoob/three.js/blob/master/examples/webgl_performance.html#L56

/* GUI related parameters */

//create methods for each of these, have to iterate over each feather using
//get object by name and start with the corresponding integer offset
var interpolationExponent = { distribution: 0.5 }; //This is NOT per layer. changes how the position of the feathers is interpolated, default to 2, as it is now. Have to alter every feather's position.

//this one is for all feathers at once
var curvature = { curvature : 0 }; //have all feathers uniformly scale up their y-axis position, which should be quadratically lerped. first 3 layers default 0 to 0, fourth has a lil offset.

var x_orientation = { x_orientation : 0};
var y_orientation = { y_orientation : 0};
var z_orientation = { z_orientation : 0}; //This is NOT per layer. rotate each individual feather by what ever amount

var x_scale = { x_scale : 1};
var y_scale = { y_scale : 1};
var z_scale = { z_scale : 1};

var wingColor = { value : 0x000000 }; //Per layer - alter the material color of each feather's material by whatever newVal

// load a simple obj mesh
var objLoader = new THREE.OBJLoader();
objLoader.load('/geo/feather.obj', function(obj) {

// LOOK: This function runs after the obj has finished loading
var featherGeo = obj.children[0].geometry;

var featherMesh = new THREE.Mesh(featherGeo, lambertWhite);
featherMesh.name = "feather";
scene.add(featherMesh);

//Create the first layer of feathers- actually the 3rd layer if counting outwards
for(var i = 0; i < layer1Num; i++) {
var featherMesh = new THREE.Mesh(featherGeo, physGold);
featherMesh.name = "feather_" + i;
layer1(featherMesh, i, layer1Num, 0.5);
//scene.add(featherMesh);
featherGroup.add(featherMesh);
}

for(var j = 0; j < layer2Num; j++) {
var featherMesh = new THREE.Mesh(featherGeo, physGreen);
featherMesh.name = "feather_" + (j + i);
layer2(featherMesh, j, layer2Num, 0.5);
//scene.add(featherMesh);
featherGroup.add(featherMesh);
}

for(var k = 0; k < layer3Num; k++) {
var featherMesh = new THREE.Mesh(featherGeo, physBlue);
featherMesh.name = "feather_" + (k + j + i);
layer3(featherMesh, k, layer3Num, 0.5);
//scene.add(featherMesh);
featherGroup.add(featherMesh);
}

for(var l = 0; l < layer4Num; l++) {
var featherMesh = new THREE.Mesh(featherGeo, physRed);
featherMesh.name = "feather_" + (l + k + j + i);
layer4(featherMesh, l, layer4Num, 0.5);
//scene.add(featherMesh);
featherGroup.add(featherMesh);
}
scene.add(featherGroup);
numFeathers = i + j + k + l;
});

// set camera position
camera.position.set(0, 1, 5);
camera.lookAt(new THREE.Vector3(0,0,0));
Expand All @@ -57,16 +243,64 @@ function onLoad(framework) {
gui.add(camera, 'fov', 0, 180).onChange(function(newVal) {
camera.updateProjectionMatrix();
});

gui.add(interpolationExponent, 'distribution', 0.1, 5).onChange(function(newVal) {
updateZPositions(framework, newVal);
});

gui.add(curvature, 'curvature', 0, 50).onChange(function(newVal) {
updateYPositions(framework, newVal);
});

gui.add(flappingSpeed, 'flappingSpeedScale', 0.1, 10);
gui.add(flappingMotion, 'flappingMotionScale', 0.1, 10);

//Can't get these to work with non-integer steps
gui.add(x_orientation, 'x_orientation', 0.0, 10.0).step(0.1).listen().onChange(function(newVal) {
updateXRotations(framework, newVal);
});

gui.add(y_orientation, 'y_orientation', 0.0, 10.0).step(0.1).listen().onChange(function(newVal) {
updateYRotations(framework, newVal);
});

gui.add(z_orientation, 'z_orientation', 0.0, 10.0).step(0.1).listen().onChange(function(newVal) {
updateZRotations(framework, newVal);
});

gui.add(windIntensity, 'wind_intensity', 0.01, 20.1);

gui.add(x_scale, 'x_scale', 0.5, 10.0).step(0.1).listen().onChange(function(newVal) {
UpdateXScales(framework, newVal);
});

gui.add(y_scale, 'y_scale', 0.5, 10.0).step(0.1).listen().onChange(function(newVal) {
UpdateYScales(framework, newVal);
});

gui.add(z_scale, 'z_scale', 0.5, 10.0).step(0.1).listen().onChange(function(newVal) {
UpdateZScales(framework, newVal);
});

gui.addColor(wingColor, 'value').name('Wing Color').onChange(function(newVal) {
//iterate over all the feathers and add this color
UpdateColor(framework, newVal);
});
}

// called on frame updates
function onUpdate(framework) {
var feather = framework.scene.getObjectByName("feather");
if (feather !== undefined) {
// Simply flap wing
var date = new Date();
feather.rotateZ(Math.sin(date.getTime() / 100) * 2 * Math.PI / 180);
}
//for(var i = 0; i < numFeathers; i++) {
var featherGroup = framework.scene.getObjectByName('feather_group');//.children[i];

//Flap the feather
if (featherGroup !== undefined) {
var date = new Date();
//featherGroup.rotateX(flappingMotion.flappingMotionScale* Math.sin(date.getTime() * flappingSpeed.flappingSpeedScale / 100) * 2 * Math.PI / 180);
flapEachFeather(framework, flappingMotion.flappingMotionScale, Math.sin(date.getTime() * flappingSpeed.flappingSpeedScale / 1000));
ApplyWind(framework);
}
//}
}

// when the scene is done initializing, it will call onLoad, then on frame updates, call onUpdate
Expand Down
Loading