Brian Tong

README.md

@@ -1,67 +1,13 @@
 
-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
+For this project, I wanted to create a L-System based star system generator. This still needs a bit more polish but I think it looks pretty good!
 
-# L-System Parser
+![Star System](https://i.imgur.com/CUcrrRw.png)
 
-lsystem.js contains classes for L-system, Rule, and LinkedList. Here’s our suggested structure:
+Playing around with the parameters, you can get an interesting digital effect if the rotation angles are set to 90 degrees:
+![Digital Effect](https://i.imgur.com/LoYa65r.png)
 
-**The Symbol Nodes/Linked List:**
+Demo: https://iambrian.github.io/Project3-LSystems/
 
-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.
+# Future Ideas
+Procedurally innervating a mesh

src/lsystem.js

@@ -7,70 +7,176 @@ function Rule(prob, str) {
 
 // TODO: Implement a linked list class and its requisite functions
 // as described in the homework writeup
+function LinkedList() {
+	this.head = undefined;
+	this.tail = undefined;
+}
+
+function LinkedListNode() {
+	this.character = '';
+	this.prev = undefined;
+	this.next = undefined;
+}
 
-// TODO: Turn the string into linked list 
-export function stringToLinkedList(input_string) {
+// TODO: 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 
+	// you should return a linked list where the head is
 	// at Node('F') and the tail is at Node('X')
 	var ll = new LinkedList();
+
+	var prev = undefined;
+	for (var i = 0; i < input_string.length; i++) {
+		var node = new LinkedListNode();
+		node.character = input_string.charAt(i);
+		node.prev = prev;
+		if (prev) {
+			prev.next = node;
+		}
+		prev = node;
+
+		if (i == 0) {
+			ll.head = node;
+		}
+
+		if (i == input_string.length - 1) {
+			ll.tail = node;
+		}
+	}
+
 	return ll;
 }
 
 // TODO: Return a string form of the LinkedList
-export function linkedListToString(linkedList) {
+export function LinkedListToString(linkedList) {
 	// ex. Node1("F")->Node2("X") should be "FX"
-	var result = "";
+	var temp = [];
+	for (var node = linkedList.head; node != linkedList.tail; node = node.next) {
+		temp.push(node.character);
+	}
+	var result = temp.join("");
 	return result;
 }
 
-// TODO: Given the node to be replaced, 
+// TODO: Given the node to be replaced,
 // insert a sub-linked-list that represents replacementString
 function replaceNode(linkedList, node, replacementString) {
 }
 
+function pickRuleFromDistr(distribution) {
+	var rules = [];
+	var probs = [];
+	for (var i = 0; i < distribution.length; i++) {
+		rules.push(distribution[i].successorString);
+		probs.push(distribution[i].probability);
+	}
+	var filtered = probs.filter(function(val) { return val > 0; });
+	var minProb = Math.min.apply(null, filtered);
+	var probs = probs.map(function(x) { return Math.round(x / minProb); });
+	var cmlProbs = [];
+	probs.reduce(function(a,b,i) { return cmlProbs[i] = a+b; }, 0);
+
+	var r = Math.random() * cmlProbs[cmlProbs.length-1]-0.0000001; // ensure always less than max
+	for (var i = 0; i < cmlProbs.length; i++) {
+		if (r < cmlProbs[i]) {
+			return rules[i];
+		}
+	}
+	console.log("No Rules to pick from!");
+}
+
 export default function Lsystem(axiom, grammar, iterations) {
 	// default LSystem
-	this.axiom = "FX";
+	this.axiom = "X";
 	this.grammar = {};
-	this.grammar['X'] = [
-		new Rule(1.0, '[-FX][+FX]')
-	];
-	this.iterations = 0; 
-
+	// this.grammar['X'] = [
+	// 	new Rule(1.0, '[-FX][+FX]')
+	// ];
+	this.iterations = 0;
+	this.expansions = {};
+
 	// Set up the axiom string
 	if (typeof axiom !== "undefined") {
 		this.axiom = axiom;
 	}
 
-	// Set up the grammar as a dictionary that 
+	// Set up the grammar as a dictionary that
 	// maps a single character (symbol) to a Rule.
 	if (typeof grammar !== "undefined") {
 		this.grammar = Object.assign({}, grammar);
 	}
-	
-	// Set up iterations (the number of times you 
+
+	// Set up iterations (the number of times you
 	// should expand the axiom in DoIterations)
 	if (typeof iterations !== "undefined") {
 		this.iterations = iterations;
 	}
 
-	// A function to alter the axiom string stored 
+	// A function to alter the axiom string stored
 	// in the L-system
-	this.updateAxiom = function(axiom) {
+	this.UpdateAxiom = function(axiom) {
 		// Setup axiom
 		if (typeof axiom !== "undefined") {
 			this.axiom = axiom;
+			this.expansions = {};
+		}
+	}
+
+	this.UpdateRules = function(rules) {
+		this.grammar = {};
+		this.expansions = {};
+		for (var key in rules) {
+			var entry = rules[key];
+			var prob = entry.Prob;
+			var data = entry.Rule.replace(/\s/g, "").split("=");
+			if (data.length == 2) {
+				var symbol = data[0];
+				var rule = data[1];
+				var R = new Rule(prob, rule);
+				if (!this.grammar[symbol]) {
+					this.grammar[symbol] = [];
+				}
+				this.grammar[symbol].push(R);
+			} else {
+				console.log("Invalid Rule: " + key);
+			}
 		}
 	}
 
+	this.DoExpansion = function(n) {
+		if (n < 0) {
+			throw 'Invalid number of expansions!';
+		}
+
+		if (n == 0) {
+			this.expansions[0] = this.axiom;
+		} else if (!this.expansions[n]) {
+			var prev = this.DoExpansion(n-1);
+			var expsn = [];
+			for (var i = 0; i < prev.length; i++) {
+				var c = prev.charAt(i);
+				if (this.grammar[c] && this.grammar[c].length > 0) {
+					var r = pickRuleFromDistr(this.grammar[c]);
+					expsn.push(r);
+				} else {
+					expsn.push(c);
+				}
+			}
+			this.expansions[n] = expsn.join("");
+		}
+		return this.expansions[n];
+	}
+
 	// TODO
-	// This function returns a linked list that is the result 
+	// 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);
+	this.DoIterations = function(n) {
+		if (!this.expansions[n]) {
+			this.DoExpansion(n);
+		}
+		var lSystemLL = StringToLinkedList(this.expansions[n]);
 		return lSystemLL;
 	}
-}
+}