Ellen Duong Submission

README.md

@@ -1,67 +1,2 @@
 
-The objective of this assignment is to create an L System parser and generate interesting looking plants. Start by forking and then cloning this repository: [https://github.com/CIS700-Procedural-Graphics/Project3-LSystems](https://github.com/CIS700-Procedural-Graphics/Project3-LSystems)
-
-# L-System Parser
-
-lsystem.js contains classes for L-system, Rule, and LinkedList. Here’s our suggested structure:
-
-**The Symbol Nodes/Linked List:**
-
-Rather than representing our symbols as a string like in many L-system implementations, we prefer to use a linked list. This allows us to store additional information about each symbol at time of parsing (e.g. what iteration was this symbol added in?) Since we’re adding and replacing symbols at each iteration, we also save on the overhead of creating and destroying strings, since linked lists of course make it easy to add and remove nodes. You should write a Linked List class with Nodes that contain at least the following information:
-
-- The next node in the linked list
-- The previous node in the linked list
-- The grammar symbol at theis point in the overal string
-
-We also recommend that you write the following functions to interact with your linked list:
-
-- A function to symmetrically link two nodes together (e.g. Node A’s next is Node B, and Node B’s prev is Node A)
-- A function to expand one of the symbol nodes of the linked list by replacing it with several new nodes. This function should look at the list of rules associated with the symbol in the linked list’s grammar dictionary, then generate a uniform random number between 0 and 1 in order to determine which of the Rules should be used to expand the symbol node. You will refer to a Rule’s probability and compare it to your random number in order to determine which Rule should be chosen.
-
-**Rules:**
-
-These are containers for the preconditions, postconditions and probability of a single replacement operation. They should operate on a symbol node in your linked list.
-
-**L-system:**
-
-This is the parser, which will loop through your linked list of symbol nodes and apply rules at each iteration.
-
-Implement the following functions in L-System so that you can apply grammar rules to your axiom given some number of iterations. More details and implementation suggestions about  functions can be found in the TODO comments
-
-- `stringToLinkedList(input_string)`
-- `linkedListToString(linkedList)`
-- `replaceNode(linkedList, node, replacementString)`
-- `doIterations(num)`
-
-## Turtle
-
-`turtle.js` has a function called renderSymbol that takes in a single node of a linked list and performs an operation to change the turtle’s state based on the symbol contained in the node. Usually, the turtle’s change in state will result in some sort of rendering output, such as drawing a cylinder when the turtle moves forward. We have provided you with a few example functions to illustrate how to write your own functions to be called by renderSymbol; these functions are rotateTurtle, moveTurtle, moveForward, and makeCylinder. If you inspect the constructor of the Turtle class, you can see how to associate an operation with a grammar symbol.
-
-- Modify turtle.js to support operations associated with the symbols `[` and `]`
-    - When you parse `[` you need to store the current turtle state somewhere
-    - When you parse `]` you need to set your turtle’s state to the most recently stored state. Think of this a pushing and popping turtle states on and off a stack. For example, given `F[+F][-F]`, the turtle should draw a Y shape. Note that your program must be capable of storing many turtle states at once in a stack.
-
-- In addition to operations for `[` and `]`, you must invent operations for any three symbols of your choosing.
-
-
-## Interactivity
-
-Using dat.GUI and the examples provided in the reference code, make some aspect of your demo an interactive variable. For example, you could modify:
-
-1. the axiom
-2. Your input grammer rules and their probability
-3. the angle of rotation of the turtle
-4. the size or color or material of the cylinder the turtle draws, etc!
-
-## L-System Plants
-
-Design a grammar for a new procedural plant! As the preceding parts of this assignment are basic computer science tasks, this is where you should spend the bulk of your time on this assignment. Come up with new grammar rules and include screenshots of your plants in your README. For inspiration, take a look at Example 7: Fractal Plant in Wikipedia: https://en.wikipedia.org/wiki/L-system Your procedural plant must have the following features
-
-1. Grow in 3D. Take advantage of three.js! 
-2. Have flowers or leaves that are added as a part of the grammar
-3. Variation. Different instances of your plant should look distinctly different!
-4. A twist. Broccoli trees are cool and all, but we hope to see sometime a little more surprising in your grammars
-
-# Publishing Your code
-
-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`. NOTE: You MUST commit AND push all changes to your MASTER branch before doing this or you may lose your work. The `git` command must also be available in your terminal or command prompt. If you're using Windows, it's a good idea to use Git Bash.
+This is an Lsystem that creates a basic snowflake. My apologies. 

src/linkedlist.js

@@ -0,0 +1,76 @@
+export default class LinkedList {
+	constructor() {
+		this.head = null;
+		this.tail = null;
+	};
+
+	// Pushes node with value into the LL
+	push(value) {
+		var node = {
+			value: value,
+			next: null,
+			prev: null
+		}
+
+		if (this.head === null) {
+			// First element
+			this.head = node;
+			this.tail = node;
+		} else {
+			// Add to end of list
+			node.prev = this.tail;
+			this.tail.next = node;
+			this.tail = node; // Update tail
+		}
+	};
+
+	// Pops node off of the LL
+	pop() {
+		// 0 Elements
+		if (this.head === null) {
+			return null;
+		}
+
+		// 1 Element
+		else if (this.tail === this.head) {
+			var node = this.head;
+
+			this.head = null;
+			this.tail = null;
+
+			return node;
+		}
+
+		// 2+ Elements
+		else {
+			var node = this.tail;
+			this.tail = this.tail.prev;
+			this.tail.next = null;
+
+			return node;
+		}
+	};
+
+	// Returns a string version of the LL
+	toString() {
+		if (this.head === null) {
+			return '';
+		} else {
+			var curr = this.head;
+			var result = '';
+
+			while (curr !== null) {
+				result += curr.value;
+				curr = curr.next;
+			}
+
+			return result;
+		} 
+	};
+
+	// Clones the LL
+	clone() {
+		return JSON.parse(JSON.stringify(this));
+	};
+}
+

src/lsystem.js

@@ -1,41 +1,159 @@
+import LinkedList from './linkedlist.js'
+
 // A class that represents a symbol replacement rule to
 // be used when expanding an L-system grammar.
 function Rule(prob, str) {
 	this.probability = prob; // The probability that this Rule will be used when replacing a character in the grammar string
 	this.successorString = str; // The string that will replace the char that maps to this Rule
 }
 
-// TODO: Implement a linked list class and its requisite functions
+// Implement a linked list class and its requisite functions
 // as described in the homework writeup
+// See linkedlist.js
 
-// TODO: Turn the string into linked list 
+// Turn the string into linked list 
 export function stringToLinkedList(input_string) {
 	// ex. assuming input_string = "F+X"
 	// you should return a linked list where the head is 
 	// at Node('F') and the tail is at Node('X')
 	var ll = new LinkedList();
+
+	for (var i = 0; i < input_string.length; i++) {
+		ll.push(input_string.charAt(i));
+	}
+
 	return ll;
 }
 
-// TODO: Return a string form of the LinkedList
+// Return a string form of the LinkedList
 export function linkedListToString(linkedList) {
 	// ex. Node1("F")->Node2("X") should be "FX"
-	var result = "";
-	return result;
+	return linkedList.toString();
 }
 
-// TODO: Given the node to be replaced, 
+// Given the node to be replaced, 
 // insert a sub-linked-list that represents replacementString
+// WASN'T SUPPOSED TO GO THROUGH THE ENTIRE LOOP I THINK.
+// WHAT HAVE YOU DONE ELLEN LMAO.
+// Returns the next node to work on
 function replaceNode(linkedList, node, replacementString) {
+	if (linkedList === null || node === null) {
+		// If LL doesn't exist or is empty just return
+		return;
+	}
+
+	// Replacement string is empty
+	// Basically remove node at evey appearance
+	if (!replacementString || replacementString.length == 0) {
+		// Delete the node at every appearance
+
+		// 1 Element Case
+		if (linkedList.head == linkedList.tail && linkedList.head == node) {
+			linkedList.pop(); // remove
+			return linkedList.head;
+		}
+
+		// Node is the head
+		else if (node == linkedList.head) {
+			linkedList.head = linkedList.head.next;
+			linkedList.head.prev = null;
+			return linkedList.head;
+		}
+
+		// Node is the tail
+		else if (node == linkedList.tail) {
+			linkedList.tail = linkedList.tail.prev;
+			linkedList.next =  null;
+			return null;
+		}
+
+		// Node is a middle node
+		// Or doesn't exist in the linked list, but well hopefully the function
+		// is used properly. And I mean, I'm going to used it properly...
+		else {
+			var before = node.prev;
+			var after = node.next;
+
+			// Drop reference to node
+			before.next = after;
+			after.prev = before;
+
+			return after;
+		}
+	// ReplacementString is not empty
+	} else {
+		// Create LL of replacementString
+		var rsll = stringToLinkedList(replacementString);
+
+		// 1 Element Case
+		if (linkedList.head == linkedList.tail && linkedList.head == node) {
+			// Replace LL with RSLL
+			linkedList.head = rsll.head;
+			linkedList.tail = rsll.tail;
+			return null;
+		}
+
+
+		// 2+ Element cases
+		// If node is the head
+		if (node == linkedList.head) {
+			var after = linkedList.head.next;
+
+			// Attach copied RSLL, skipping head
+			rsll.tail.next = after;
+			after.prev = rsll.tail; // update prev
+
+			// Update LL head
+			linkedList.head = rsll.head; // prev is already null
+
+			return after;
+		} 
+
+		// If node is the tail
+		else if (node == linkedList.tail) {
+			var before = linkedList.tail.prev;
+
+			// remove node (which is the tail) and add pointer to next
+			before.next = rsll.head;
+			rsll.head.prev = before; 
+
+			// Update tail pointer
+			linkedList.tail = rsll.tail;
+
+			return null;
+		}
+
+		// Node is a middle node
+		// Or doesn't exist in the linked list, but well hopefully the function
+		// is used properly. And I mean, I'm going to used it properly...
+		else {
+			// Replace
+			var before = node.prev;
+			var after = node.next;
+
+			// rsll the replacementString LinkedList
+			rsll.head.prev = before;
+			rsll.tail.next = after;
+
+			// update the pointers in the linked list
+			before.next = rsll.head;
+			after.prev = rsll.tail;
+
+			return after;
+		} 
+	}
 }
 
 export default function Lsystem(axiom, grammar, iterations) {
 	// default LSystem
-	this.axiom = "FX";
-	this.grammar = {};
-	this.grammar['X'] = [
-		new Rule(1.0, '[-FX][+FX]')
-	];
+	this.axiom = "F-F-F-F-F";
+	this.grammar = {
+		'F': [ new Rule(1.0, 'F-F++F+F-F-F') ],
+		'[': [ new Rule(1.0, '[') ],
+		']': [ new Rule(1.0, ']') ],
+		'-': [ new Rule(1.0, '-') ],
+		'+': [ new Rule(1.0, '+') ]
+	};
 	this.iterations = 0; 
 
 	// Set up the axiom string
@@ -64,13 +182,33 @@ export default function Lsystem(axiom, grammar, iterations) {
 		}
 	}
 
-	// TODO
 	// This function returns a linked list that is the result 
 	// of expanding the L-system's axiom n times.
 	// The implementation we have provided you just returns a linked
 	// list of the axiom.
 	this.doIterations = function(n) {	
-		var lSystemLL = StringToLinkedList(this.axiom);
+		// If there isn't an axiom, then just return
+		if (this.axiom == null || this.axiom.length <= 0) {
+			return;
+		}
+
+		var lSystemLL = stringToLinkedList(this.axiom);
+
+		// Iterate n times
+		for (var i = 0; i < n; i++) {
+			var curr = lSystemLL.head;
+
+			while (curr != null) {
+				var curr_grammar = this.grammar[curr.value][0];
+
+				if (curr_grammar && Math.random() <= curr_grammar.probability) {
+					curr = replaceNode(lSystemLL, curr, curr_grammar.successorString);
+				} else {
+					curr = curr.next;
+				}
+			}
+		}
+
 		return lSystemLL;
 	}
 }

src/main.js

@@ -34,7 +34,7 @@ function onLoad(framework) {
   });
 
   gui.add(lsys, 'axiom').onChange(function(newVal) {
-    lsys.UpdateAxiom(newVal);
+    lsys.updateAxiom(newVal);
     doLsystem(lsys, lsys.iterations, turtle);
   });
 
@@ -54,7 +54,7 @@ function clearScene(turtle) {
 }
 
 function doLsystem(lsystem, iterations, turtle) {
-    var result = lsystem.DoIterations(iterations);
+    var result = lsystem.doIterations(iterations);
     turtle.clear();
     turtle = new Turtle(turtle.scene);
     turtle.renderSymbols(result);