Copyright (C) 2016  NinjaStix
    [email protected]

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

package com.ninjaguild.dragoneggdrop.utils;

import java.util.HashMap;
import java.util.Map;

import com.ninjaguild.dragoneggdrop.utils.math.MathExpression;
import com.ninjaguild.dragoneggdrop.utils.math.MathUtils;

import org.apache.commons.lang.Validate;
import org.bukkit.Location;
import org.bukkit.Particle;
import org.bukkit.World;

 * Represents a defined particle shape. Allows for easy shape-creation with two
 * expressions along the x and z axis, as well as an initial location to start
 * the shape
 * @author Parker Hawke - 2008Choco
public class ParticleShapeDefinition {
	private final Map<String, Double> variables = new HashMap<>();
	private final Location initialLocation;
	private final World world;
	private final MathExpression xExpression, zExpression;
	 * Construct a new ParticleShapeDefinition with a given location, and mathmatical equations
	 * for both the x and z axis
	 * @param initialLocation the initial starting location
	 * @param xExpression the expression for the x axis
	 * @param zExpression the expression for the y axis
	public ParticleShapeDefinition(Location initialLocation, String xExpression, String zExpression) {
		Validate.notNull(initialLocation, "Null initial locations are not supported");
		Validate.notEmpty(xExpression, "The x axis expression cannot be null or empty");
		Validate.notEmpty(zExpression, "The z axis expression cannot be null or empty");
		this.variables.put("x", 0.0);
		this.variables.put("z", 0.0);
		this.variables.put("t", 0.0);
		this.variables.put("theta", 0.0);
		this.initialLocation = initialLocation;
		this.world = initialLocation.getWorld();
		this.xExpression = MathUtils.parseExpression(xExpression, variables);
		this.zExpression = MathUtils.parseExpression(zExpression, variables);
	 * Update the variables with new values
	 * @param x the new x value
	 * @param z the new y value
	 * @param t the new value of "t", time (or tick)
	 * @param theta the new theta value
	public void updateVariables(double x, double z, double t, double theta) {
		this.variables.put("x", x);
		this.variables.put("z", z);
		this.variables.put("t", t);
		this.variables.put("theta", theta);
	 * Execute the particle shape definition expressions with current values. To update values,
	 * see {@link #updateVariables(double, double, double, double)}
	 * @param particleType the type of particle to display
	 * @param particleAmount the amount of particles to display
	 * @param xOffset the x offset for each particle
	 * @param yOffset the y offset for each particle
	 * @param zOffset the z offset for each particle
	 * @param particleExtra the extra value of the particle (generally speed, though this is
	 * dependent on the type of particle used)
	public void executeExpression(Particle particleType, int particleAmount, double xOffset, double yOffset, double zOffset, double particleExtra) {
		Validate.notNull(particleType, "Cannot spawn Particle of type null");
		double x = this.xExpression.evaluate(), z = this.zExpression.evaluate();
		this.initialLocation.add(x, 0, z);
		this.world.spawnParticle(particleType, this.initialLocation, particleAmount, xOffset, yOffset, zOffset, particleExtra, null);
		this.initialLocation.subtract(x, 0, z);