sen::GradientNoise< FloatType, dimensionCount > Class Template Reference

Utility class for generating n-dimensional noise. Mainly useful in tests and examples. More...

#include <gradient_noise.h>

Public Types
using	EngineType = std::default_random_engine
using	DistType = std::uniform_real_distribution<FloatType>
using	SeedType = EngineType::result_type

Public Member Functions
	GradientNoise ()
	~GradientNoise ()=default
void	seed (SeedType val=EngineType::default_seed)
	Seed the gradient noise.
FloatType	operator() (std::array< FloatType, dimensionCount > position)
	Return a noise value from an n-dimensional position.

Static Public Attributes
static constexpr unsigned int	discardCount = 1
	The number of random numbers discarded after a new engine seed.

Detailed Description

template<typename FloatType, std::size_t dimensionCount>
class sen::GradientNoise< FloatType, dimensionCount >

Utility class for generating n-dimensional noise. Mainly useful in tests and examples.

Member Typedef Documentation

EngineType

template<typename FloatType, std::size_t dimensionCount>

using sen::GradientNoise< FloatType, dimensionCount >::EngineType = std::default_random_engine

DistType

template<typename FloatType, std::size_t dimensionCount>

using sen::GradientNoise< FloatType, dimensionCount >::DistType = std::uniform_real_distribution<FloatType>

SeedType

template<typename FloatType, std::size_t dimensionCount>

using sen::GradientNoise< FloatType, dimensionCount >::SeedType = EngineType::result_type

Constructor & Destructor Documentation

GradientNoise()

template<typename FloatType, std::size_t dimensionCount>

sen::GradientNoise< FloatType, dimensionCount >::GradientNoise ( )

inlineexplicit

~GradientNoise()

template<typename FloatType, std::size_t dimensionCount>

sen::GradientNoise< FloatType, dimensionCount >::~GradientNoise ( )

default

Member Function Documentation

seed()

template<typename FloatType, std::size_t dimensionCount>

void sen::GradientNoise< FloatType, dimensionCount >::seed ( SeedType val = EngineType::default_seed )

inline

Seed the gradient noise.

operator()()

template<typename FloatType, std::size_t dimensionCount>

FloatType sen::GradientNoise< FloatType, dimensionCount >::operator() ( std::array< FloatType, dimensionCount > position )

inline

Return a noise value from an n-dimensional position.

Member Data Documentation

discardCount

template<typename FloatType, std::size_t dimensionCount>

unsigned int sen::GradientNoise< FloatType, dimensionCount >::discardCount = 1

staticconstexpr

The number of random numbers discarded after a new engine seed.

---

The documentation for this class was generated from the following file:

• gradient_noise.h