aboutsummaryrefslogtreecommitdiff
path: root/engine/src/terrain/com/jme3/terrain/noise/fractal/FractalSum.java
blob: 5fe5dcb4ac7b57bb970a9f3e30abbc5fef470156 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/**
 * Copyright (c) 2011, Novyon Events
 * 
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 * 
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * @author Anthyon
 */
package com.jme3.terrain.noise.fractal;

import com.jme3.terrain.noise.Basis;
import com.jme3.terrain.noise.ShaderUtils;
import com.jme3.terrain.noise.basis.ImprovedNoise;
import com.jme3.terrain.noise.basis.Noise;

/**
 * FractalSum is the simplest form of fractal functions summing up a few octaves
 * of the noise value with an ever decreasing (0 < roughness < 1) amplitude
 * 
 * lacunarity = 2.0f is the classical octave distance
 * 
 * Note: though noise basis functions are generally designed to return value
 * between -1..1, there sum can easily be made to extend out of this range. To
 * handle this is up to the user.
 * 
 * @author Anthyon
 * 
 */
public class FractalSum extends Noise implements Fractal {

	private Basis basis;
	private float lacunarity;
	private float amplitude;
	private float roughness;
	private float frequency;
	private float octaves;
	private int maxFreq;

	public FractalSum() {
		this.basis = new ImprovedNoise();
		this.lacunarity = 2.124367f;
		this.amplitude = 1.0f;
		this.roughness = 0.6f;
		this.frequency = 1f;
		this.setOctaves(1);
	}

	@Override
	public float value(final float x, final float y, final float z) {
		float total = 0;

		for (float f = this.frequency, a = this.amplitude; f < this.maxFreq; f *= this.lacunarity, a *= this.roughness) {
			total += this.basis.value(this.scale * x * f, this.scale * y * f, this.scale * z * f) * a;
		}

		return ShaderUtils.clamp(total, -1, 1);
	}

	@Override
	public Fractal addBasis(final Basis basis) {
		this.basis = basis;
		return this;
	}

	public float getOctaves() {
		return this.octaves;
	}

	@Override
	public Fractal setOctaves(final float octaves) {
		this.octaves = octaves;
		this.maxFreq = 1 << (int) octaves;
		return this;
	}

	public float getFrequency() {
		return this.frequency;
	}

	@Override
	public Fractal setFrequency(final float frequency) {
		this.frequency = frequency;
		return this;
	}

	public float getRoughness() {
		return this.roughness;
	}

	@Override
	public Fractal setRoughness(final float roughness) {
		this.roughness = roughness;
		return this;
	}

	public float getAmplitude() {
		return this.amplitude;
	}

	@Override
	public Fractal setAmplitude(final float amplitude) {
		this.amplitude = amplitude;
		return this;
	}

	public float getLacunarity() {
		return this.lacunarity;
	}

	@Override
	public Fractal setLacunarity(final float lacunarity) {
		this.lacunarity = lacunarity;
		return this;
	}

	@Override
	public void init() {

	}

}