Hydrax::Noise::Perlin Class Reference

Description

Perlin noise module class.

Definition at line 73 of file Perlin.h.

Inheritance diagram for Hydrax::Noise::Perlin:

Data Structures
struct	Options

Public Member Functions
	Perlin ()
	Perlin (const Options &Options)
	~Perlin ()
void	create ()
void	remove ()
bool	createGPUNormalMapResources (GPUNormalMapManager *g)
void	update (const Ogre::Real &timeSinceLastFrame)
void	saveCfg (Ogre::String &Data)
bool	loadCfg (Ogre::ConfigFile &CfgFile)
float	getValue (const float &x, const float &y)
void	setOptions (const Options &Options)
const Options &	getOptions () const
Public Member Functions inherited from Hydrax::Noise::Noise
	Noise (const Ogre::String &Name, const bool &GPUNormalMapSupported)
virtual	~Noise ()
virtual void	removeGPUNormalMapResources (GPUNormalMapManager *g)
const Ogre::String &	getName () const
const bool &	isCreated () const
const bool &	isGPUNormalMapSupported () const
const bool &	areGPUNormalMapResourcesCreated () const

Private Member Functions
void	_initNoise ()
void	_calculeNoise ()
void	_updateGPUNormalMapResources ()
int	_readTexelLinearDual (const int &u, const int &v, const int &o)
float	_getHeigthDual (float u, float v)
int	_mapSample (const int &u, const int &v, const int &upsamplepower, const int &octave)

Private Attributes
int	noise [n_size_sq *noise_frames]
int	o_noise [n_size_sq *max_octaves]
int	p_noise [np_size_sq *(max_octaves > >(n_packsize-1))]
int *	r_noise
float	magnitude
double	time
GPUNormalMapManager *	mGPUNormalMapManager
Options	mOptions

Additional Inherited Members
Protected Attributes inherited from Hydrax::Noise::Noise
Ogre::String	mName
bool	mCreated
bool	mGPUNormalMapSupported
bool	mGPUNormalMapResourcesCreated

Constructor & Destructor Documentation

Perlin() [1/2]

Hydrax::Noise::Perlin::Perlin

(

)

Default constructor.

Definition at line 37 of file Perlin.cpp.

Perlin() [2/2]

Hydrax::Noise::Perlin::Perlin

(

const Options &

Options

)

Constructor.

Parameters

Options

Perlin noise options

Definition at line 46 of file Perlin.cpp.

~Perlin()

Hydrax::Noise::Perlin::~Perlin

(

)

Destructor.

Definition at line 56 of file Perlin.cpp.

Member Function Documentation

_calculeNoise()

void Hydrax::Noise::Perlin::_calculeNoise ( )

private

Calcule noise.

Definition at line 447 of file Perlin.cpp.

_getHeigthDual()

float Hydrax::Noise::Perlin::_getHeigthDual ( float  u, float  v  )

private

Read texel linear.

Parameters

u	u
v	v

Returns

Heigth

Definition at line 547 of file Perlin.cpp.

_initNoise()

void Hydrax::Noise::Perlin::_initNoise ( )

private

Initialize noise.

Definition at line 408 of file Perlin.cpp.

_mapSample()

int Hydrax::Noise::Perlin::_mapSample ( const int &  u, const int &  v, const int &  upsamplepower, const int &  octave  )

private

Map sample.

Parameters

u	u
v	v
level	Level
octave	Octave

Returns

Map sample

Definition at line 569 of file Perlin.cpp.

_readTexelLinearDual()

int Hydrax::Noise::Perlin::_readTexelLinearDual ( const int &  u, const int &  v, const int &  o  )

private

Read texel linear dual.

Parameters

u	u
v	v
o	Octave

Returns

int

Definition at line 526 of file Perlin.cpp.

_updateGPUNormalMapResources()

void Hydrax::Noise::Perlin::_updateGPUNormalMapResources ( )

private

Update gpu normal map resources.

Definition at line 378 of file Perlin.cpp.

create()

void Hydrax::Noise::Perlin::create ( )

virtual

Create.

Reimplemented from Hydrax::Noise::Noise.

Definition at line 63 of file Perlin.cpp.

createGPUNormalMapResources()

bool Hydrax::Noise::Perlin::createGPUNormalMapResources ( GPUNormalMapManager *  g )

virtual

Create GPUNormalMap resources.

Parameters

g	GPUNormalMapManager pointer

Returns

true if it needs to be created, false if not

Reimplemented from Hydrax::Noise::Noise.

Definition at line 126 of file Perlin.cpp.

getOptions()

const Options & Hydrax::Noise::Perlin::getOptions ( ) const

inline

Get current Perlin noise options.

Returns

Current perlin noise options

Definition at line 226 of file Perlin.h.

getValue()

float Hydrax::Noise::Perlin::getValue ( const float &  x, const float &  y  )

virtual

Get the especified x/y noise value.

Parameters

x	X Coord
y	Y Coord

Returns

Noise value

Remarks

range [~-0.2, ~0.2]

Implements Hydrax::Noise::Noise.

Definition at line 403 of file Perlin.cpp.

loadCfg()

bool Hydrax::Noise::Perlin::loadCfg ( Ogre::ConfigFile &  CfgFile )

virtual

Load config.

Returns

True if is the correct noise config

Reimplemented from Hydrax::Noise::Noise.

Definition at line 348 of file Perlin.cpp.

remove()

void Hydrax::Noise::Perlin::remove ( )

virtual

Remove.

Reimplemented from Hydrax::Noise::Noise.

Definition at line 74 of file Perlin.cpp.

saveCfg()

void Hydrax::Noise::Perlin::saveCfg ( Ogre::String &  Data )

virtual

Save config.

Parameters

Data	String reference

Reimplemented from Hydrax::Noise::Noise.

Definition at line 335 of file Perlin.cpp.

setOptions()

void Hydrax::Noise::Perlin::setOptions

(

const Options &

Options

)

Set/Update perlin noise options.

Parameters

Options

Perlin noise options

Remarks

If create() have been already called, Octaves option doesn't be updated.

Definition at line 91 of file Perlin.cpp.

update()

void Hydrax::Noise::Perlin::update ( const Ogre::Real &  timeSinceLastFrame )

virtual

Call it each frame.

Parameters

timeSinceLastFrame

Time since last frame(delta)

Implements Hydrax::Noise::Noise.

Definition at line 367 of file Perlin.cpp.

Field Documentation

magnitude

float Hydrax::Noise::Perlin::magnitude

private

Definition at line 273 of file Perlin.h.

mGPUNormalMapManager

GPUNormalMapManager* Hydrax::Noise::Perlin::mGPUNormalMapManager

private

GPUNormalMapManager pointer.

Definition at line 279 of file Perlin.h.

mOptions

Options Hydrax::Noise::Perlin::mOptions

private

Perlin noise options.

Definition at line 282 of file Perlin.h.

noise

int Hydrax::Noise::Perlin::noise[n_size_sq *noise_frames]

private

Perlin noise variables.

Definition at line 269 of file Perlin.h.

o_noise

int Hydrax::Noise::Perlin::o_noise[n_size_sq *max_octaves]

private

Definition at line 270 of file Perlin.h.

p_noise

int Hydrax::Noise::Perlin::p_noise[np_size_sq *(max_octaves > >(n_packsize-1))]

private

Definition at line 271 of file Perlin.h.

r_noise

int* Hydrax::Noise::Perlin::r_noise

private

Definition at line 272 of file Perlin.h.

time

double Hydrax::Noise::Perlin::time

private

Elapsed time.

Definition at line 276 of file Perlin.h.

---

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

• source/main/gfx/hydrax/Perlin.h
• source/main/gfx/hydrax/Perlin.cpp