viskores::source::PerlinNoise Class Reference

The PerlinNoise source creates a uniform dataset. More...

#include <PerlinNoise.h>

Inheritance diagram for viskores::source::PerlinNoise:

Public Member Functions
	PerlinNoise ()=default
	~PerlinNoise ()=default
	PerlinNoise (const PerlinNoise &)=default
	PerlinNoise (PerlinNoise &&)=default
PerlinNoise &	operator= (const PerlinNoise &)=default
PerlinNoise &	operator= (PerlinNoise &&)=default
	PerlinNoise (viskores::Id3 dims)
	PerlinNoise (viskores::Id3 dims, viskores::IdComponent seed)
	PerlinNoise (viskores::Id3 dims, viskores::Vec3f origin)
	PerlinNoise (viskores::Id3 dims, viskores::Vec3f origin, viskores::IdComponent seed)
viskores::Id3	GetPointDimensions () const
void	SetPointDimensions (viskores::Id3 dims)
viskores::Id3	GetCellDimensions () const
void	SetCellDimensions (viskores::Id3 dims)
viskores::Vec3f	GetOrigin () const
void	SetOrigin (const viskores::Vec3f &origin)
viskores::IdComponent	GetSeed () const
	The seed used for the pseudorandom number generation of the noise. More...
void	SetSeed (viskores::IdComponent seed)
Public Member Functions inherited from viskores::source::Source
virtual	~Source ()=default
viskores::cont::DataSet	Execute () const

Private Member Functions
viskores::cont::DataSet	DoExecute () const override

Private Attributes
viskores::Id3	PointDimensions = { 16, 16, 16 }
viskores::Vec3f	Origin = { 0, 0, 0 }
viskores::IdComponent	Seed = 0
bool	SeedSet = false

Additional Inherited Members
Protected Attributes inherited from viskores::source::Source
viskores::cont::Invoker	Invoke

Detailed Description

The PerlinNoise source creates a uniform dataset.

This class generates a uniform grid dataset with a tileable perlin noise scalar point field.

The Execute method creates a complete structured dataset that have a scalar point field named 'perlinnoise'.

Constructor & Destructor Documentation

PerlinNoise() [1/7]

viskores::source::PerlinNoise::PerlinNoise ( )

default

~PerlinNoise()

viskores::source::PerlinNoise::~PerlinNoise ( )

default

PerlinNoise() [2/7]

viskores::source::PerlinNoise::PerlinNoise ( const PerlinNoise &  )

default

PerlinNoise() [3/7]

viskores::source::PerlinNoise::PerlinNoise ( PerlinNoise &&  )

default

PerlinNoise() [4/7]

viskores::source::PerlinNoise::PerlinNoise

(

viskores::Id3

dims

)

PerlinNoise() [5/7]

viskores::source::PerlinNoise::PerlinNoise	(	viskores::Id3	dims,
		viskores::IdComponent	seed
	)

PerlinNoise() [6/7]

viskores::source::PerlinNoise::PerlinNoise	(	viskores::Id3	dims,
		viskores::Vec3f	origin
	)

PerlinNoise() [7/7]

viskores::source::PerlinNoise::PerlinNoise	(	viskores::Id3	dims,
		viskores::Vec3f	origin,
		viskores::IdComponent	seed
	)

Member Function Documentation

DoExecute()

viskores::cont::DataSet viskores::source::PerlinNoise::DoExecute ( ) const

overrideprivatevirtual

Implements viskores::source::Source.

GetCellDimensions()

viskores::Id3 viskores::source::PerlinNoise::GetCellDimensions ( ) const

inline

GetOrigin()

viskores::Vec3f viskores::source::PerlinNoise::GetOrigin ( ) const

inline

GetPointDimensions()

viskores::Id3 viskores::source::PerlinNoise::GetPointDimensions ( ) const

inline

GetSeed()

viskores::IdComponent viskores::source::PerlinNoise::GetSeed ( ) const

inline

The seed used for the pseudorandom number generation of the noise.

If the seed is not set, then a new, unique seed is picked each time Execute is run.

operator=() [1/2]

PerlinNoise& viskores::source::PerlinNoise::operator= ( const PerlinNoise &  )

default

operator=() [2/2]

PerlinNoise& viskores::source::PerlinNoise::operator= ( PerlinNoise &&  )

default

SetCellDimensions()

void viskores::source::PerlinNoise::SetCellDimensions ( viskores::Id3  dims )

inline

SetOrigin()

void viskores::source::PerlinNoise::SetOrigin ( const viskores::Vec3f &  origin )

inline

SetPointDimensions()

void viskores::source::PerlinNoise::SetPointDimensions ( viskores::Id3  dims )

inline

SetSeed()

void viskores::source::PerlinNoise::SetSeed ( viskores::IdComponent  seed )

inline

Member Data Documentation

Origin

viskores::Vec3f viskores::source::PerlinNoise::Origin = { 0, 0, 0 }

private

PointDimensions

viskores::Id3 viskores::source::PerlinNoise::PointDimensions = { 16, 16, 16 }

private

Seed

viskores::IdComponent viskores::source::PerlinNoise::Seed = 0

private

SeedSet

bool viskores::source::PerlinNoise::SeedSet = false

private

---

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

• PerlinNoise.h