Terrarum/src/com/sudoplay/joise/module/ModuleBlend.java

/*
 * Copyright (C) 2013 Jason Taylor.
 * Released as open-source under the Apache License, Version 2.0.
 * 
 * ============================================================================
 * | Joise
 * ============================================================================
 * 
 * Copyright (C) 2013 Jason Taylor
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * ============================================================================
 * | Accidental Noise Library
 * | --------------------------------------------------------------------------
 * | Joise is a derivative work based on Josua Tippetts' C++ library:
 * | http://accidentalnoise.sourceforge.net/index.html
 * ============================================================================
 * 
 * Copyright (C) 2011 Joshua Tippetts
 * 
 *   This software is provided 'as-is', without any express or implied
 *   warranty.  In no event will the authors be held liable for any damages
 *   arising from the use of this software.
 * 
 *   Permission is granted to anyone to use this software for any purpose,
 *   including commercial applications, and to alter it and redistribute it
 *   freely, subject to the following restrictions:
 * 
 *   1. The origin of this software must not be misrepresented; you must not
 *      claim that you wrote the original software. If you use this software
 *      in a product, an acknowledgment in the product documentation would be
 *      appreciated but is not required.
 *   2. Altered source versions must be plainly marked as such, and must not be
 *      misrepresented as being the original software.
 *   3. This notice may not be removed or altered from any source distribution.
 */

package com.sudoplay.joise.module;

import static com.sudoplay.joise.noise.Util.lerp;

import com.sudoplay.joise.ModuleInstanceMap;
import com.sudoplay.joise.ModuleMap;
import com.sudoplay.joise.ModulePropertyMap;

public class ModuleBlend extends Module {

  protected ScalarParameter low = new ScalarParameter(0.0);
  protected ScalarParameter high = new ScalarParameter(1.0);
  protected ScalarParameter control = new ScalarParameter(0.5);

  public void setLowSource(Module source) {
    low.set(source);
  }

  public void setLowSource(double source) {
    low.set(source);
  }

  public void setHighSource(Module source) {
    high.set(source);
  }

  public void setHighSource(double source) {
    high.set(source);
  }

  public void setControlSource(Module source) {
    control.set(source);
  }

  public void setControlSource(double source) {
    control.set(source);
  }

  @Override
  public double get(double x, double y) {
    double v1 = low.get(x, y);
    double v2 = high.get(x, y);
    double bl = control.get(x, y);
    bl = (bl + 1.0) * 0.5;
    return lerp(bl, v1, v2);
  }

  @Override
  public double get(double x, double y, double z) {
    double v1 = low.get(x, y, z);
    double v2 = high.get(x, y, z);
    double bl = control.get(x, y, z);
    return lerp(bl, v1, v2);
  }

  @Override
  public double get(double x, double y, double z, double w) {
    double v1 = low.get(x, y, z, w);
    double v2 = high.get(x, y, z, w);
    double bl = control.get(x, y, z, w);
    return lerp(bl, v1, v2);
  }

  @Override
  public double get(double x, double y, double z, double w, double u, double v) {
    double v1 = low.get(x, y, z, w, u, v);
    double v2 = high.get(x, y, z, w, u, v);
    double bl = control.get(x, y, z, w, u, v);
    return lerp(bl, v1, v2);
  }

  @Override
  protected void _writeToMap(ModuleMap map) {

    ModulePropertyMap props = new ModulePropertyMap(this);

    writeScalar("high", high, props, map);
    writeScalar("low", low, props, map);
    writeScalar("control", control, props, map);

    map.put(getId(), props);

  }

  @Override
  public Module buildFromPropertyMap(ModulePropertyMap props,
      ModuleInstanceMap map) {

    readScalar("high", "setHighSource", props, map);
    readScalar("low", "setLowSource", props, map);
    readScalar("control", "setControlSource", props, map);

    return this;
  }

}