libcruft-util/noise/fractal/rmf.hpp
Danny Robson 51b8ef762a noise/fractal: add default constructors
we often use these in arrays which are annoying to construct otherwise
2015-10-13 00:04:17 +11:00

72 lines
2.2 KiB
C++

/*
* 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.
*
* Copyright 2012-2015 Danny Robson <danny@nerdcruft.net>
*/
#ifndef __UTIL_NOISE_FRACTAL_RMF_HPP
#define __UTIL_NOISE_FRACTAL_RMF_HPP
#include <cstdint>
#include "base.hpp"
#include "../../point.hpp"
namespace util { namespace noise { namespace fractal {
/// Rigid Multifractal summation, based on Musgrave's algorithm
///
/// octaves: count of layers to be summed
/// H: hurst parameter (~roughness)
/// offset: TODO
/// frequency: point scaling factor for the base octave
/// lacunarity: incremental octave frequency scaling factor
/// amplitude: value scaling factor for the base octave
/// gain: incremental octave value scaling factor
template <class B>
struct rmf : public base<B> {
using value_t = typename base<B>::value_t;
using point_t = typename base<B>::point_t;
static constexpr unsigned DEFAULT_OCTAVES = 5;
static constexpr value_t DEFAULT_H = 1;
static constexpr value_t DEFAULT_OFFSET = 1;
static constexpr value_t DEFAULT_FREQUENCY = 1;
static constexpr value_t DEFAULT_LACUNARITY = 2;
static constexpr value_t DEFAULT_AMPLITUDE = 2;
static constexpr value_t DEFAULT_GAIN = 1 / DEFAULT_LACUNARITY;
rmf (seed_t,
unsigned octaves,
value_t H,
value_t frequency,
value_t lacunarity,
value_t amplitude,
value_t gain,
value_t offset);
explicit rmf (seed_t = 0);
value_t operator() (point_t) const;
value_t offset (void) const;
value_t offset (value_t);
private:
value_t m_offset;
};
} } }
#include "rmf.ipp"
#endif