/* Copyright (C) 2011 Garrett Fleenor

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

 This library is distributed in the hope that it will be useful, but WITHOUT
 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
 License (COPYING.txt) for more details.

 You should have received a copy of the GNU Lesser General Public License
 along with this library; if not, write to the Free Software Foundation,
 Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

 This is a port of libnoise ( http://libnoise.sourceforge.net/index.html ).  Original implementation by Jason Bevins

 */
package com.bioxx.libnoise.module.modifier;

import com.bioxx.libnoise.exception.NoModuleException;
import com.bioxx.libnoise.module.Module;

public class ScaleBias extends Module {
	/// Default bias for the noise::module::ScaleBias noise module.
	public static final double DEFAULT_BIAS = 0.0;

	/// Default scale for the noise::module::ScaleBias noise module.
	public static final double DEFAULT_SCALE = 1.0;

	/// Bias to apply to the scaled output value from the source module.
	double bias = DEFAULT_BIAS;

	/// Scaling factor to apply to the output value from the source
	/// module.
	double scale = DEFAULT_SCALE;

	public ScaleBias() {
		super(1);
	}
	public ScaleBias(Module source) {
		this();
		this.setSourceModule(0, source);
	}

	public double getBias() {
		return bias;
	}

	public void setBias(double bias) {
		this.bias = bias;
	}

	public double getScale() {
		return scale;
	}

	public void setScale(double scale) {
		this.scale = scale;
	}

	@Override
	public int GetSourceModuleCount() {
		return 1;
	}

	@Override
	public double GetValue(double x, double y, double z) {
		if (SourceModule[0] == null)
			throw new NoModuleException();

		return SourceModule[0].GetValue(x, y, z) * scale + bias;
	}

}