vtkm::source::PerlinNoise Class Reference

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

#include <PerlinNoise.h>

Inheritance diagram for vtkm::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 (vtkm::Id3 dims)
	PerlinNoise (vtkm::Id3 dims, vtkm::IdComponent seed)
	PerlinNoise (vtkm::Id3 dims, vtkm::Vec3f origin)
	PerlinNoise (vtkm::Id3 dims, vtkm::Vec3f origin, vtkm::IdComponent seed)
vtkm::Id3	GetPointDimensions () const
void	SetPointDimensions (vtkm::Id3 dims)
vtkm::Id3	GetCellDimensions () const
void	SetCellDimensions (vtkm::Id3 dims)
vtkm::Vec3f	GetOrigin () const
void	SetOrigin (const vtkm::Vec3f &origin)
vtkm::IdComponent	GetSeed () const
	The seed used for the pseudorandom number generation of the noise. More...
void	SetSeed (vtkm::IdComponent seed)
Public Member Functions inherited from vtkm::source::Source
virtual	~Source ()=default
vtkm::cont::DataSet	Execute () const

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

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

Additional Inherited Members
Protected Attributes inherited from vtkm::source::Source
vtkm::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]

vtkm::source::PerlinNoise::PerlinNoise ( )

default

~PerlinNoise()

vtkm::source::PerlinNoise::~PerlinNoise ( )

default

PerlinNoise() [2/7]

vtkm::source::PerlinNoise::PerlinNoise ( const PerlinNoise &  )

default

PerlinNoise() [3/7]

vtkm::source::PerlinNoise::PerlinNoise ( PerlinNoise &&  )

default

PerlinNoise() [4/7]

vtkm::source::PerlinNoise::PerlinNoise

(

vtkm::Id3

dims

)

PerlinNoise() [5/7]

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

PerlinNoise() [6/7]

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

PerlinNoise() [7/7]

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

Member Function Documentation

DoExecute()

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

overrideprivatevirtual

Implements vtkm::source::Source.

GetCellDimensions()

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

inline

GetOrigin()

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

inline

GetPointDimensions()

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

inline

GetSeed()

vtkm::IdComponent vtkm::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& vtkm::source::PerlinNoise::operator= ( const PerlinNoise &  )

default

operator=() [2/2]

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

default

SetCellDimensions()

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

inline

SetOrigin()

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

inline

SetPointDimensions()

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

inline

SetSeed()

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

inline

Member Data Documentation

Origin

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

private

PointDimensions

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

private

Seed

vtkm::IdComponent vtkm::source::PerlinNoise::Seed = 0

private

SeedSet

bool vtkm::source::PerlinNoise::SeedSet = false

private

---

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

• PerlinNoise.h