SIM_NoiseStandard Class Reference

This class defines the interface for noise generation functions. More...

#include <SIM_NoiseStandard.h>

Inheritance diagram for SIM_NoiseStandard:

SIM_Noise SIM_Data SIM_OptionsUser

List of all members.

Public Member Functions

 GETSET_DATA_FUNCS_I (SIM_NAME_SEED, Seed)
 GETSET_DATA_FUNCS_I (SIM_NAME_FRACTALDEPTH, FractalDepth)
 GETSET_DATA_FUNCS_F (SIM_NAME_ROUGHNESS, Roughness)
 GETSET_DATA_FUNCS_F (SIM_NAME_ATTENUATION, Attenuation)
 GETSET_DATA_FUNCS_V3 (SIM_NAME_FREQUENCY, Frequency)
 GETSET_DATA_FUNCS_V3 (SIM_NAME_OFFSET, Offset)
 GETSET_DATA_FUNCS_E (SIM_NAME_NOISETYPE, NoiseType, UT_Noise::UT_NoiseType)

Protected Member Functions

 SIM_NoiseStandard (const SIM_DataFactory *factory)
virtual ~SIM_NoiseStandard ()
virtual void optionChangedSubclass (const char *name)
 Respond to changes in the noise type.
virtual void getNoiseLimitsSubclass (fpreal &min, fpreal &max) const
 Override this function to return the correct noise extents.
virtual fpreal getNoiseSubclass (const UT_Vector3 &pos) const
 Override this function to implement a new 1D noise function.
virtual void getNoiseSubclass (const UT_Vector3 &pos, UT_Vector3 &noise) const
 Override this function to implement a new 3D noise function.
SIM_PropertyResolvergetNoiseResolverSubclass () const

Friends

class SIM_NoiseResolverStandard


Detailed Description

This class defines the interface for noise generation functions.

Definition at line 25 of file SIM_NoiseStandard.h.


Constructor & Destructor Documentation

SIM_NoiseStandard::SIM_NoiseStandard ( const SIM_DataFactory factory  )  [explicit, protected]

virtual SIM_NoiseStandard::~SIM_NoiseStandard (  )  [protected, virtual]


Member Function Documentation

virtual void SIM_NoiseStandard::getNoiseLimitsSubclass ( fpreal min,
fpreal max 
) const [protected, virtual]

Override this function to return the correct noise extents.

Implements SIM_Noise.

SIM_PropertyResolver* SIM_NoiseStandard::getNoiseResolverSubclass (  )  const [protected, virtual]

Create a SIM_PropertyResolver to quickly compute the noise, defaults to a generic one that just calls back to SIM_Noise.

Reimplemented from SIM_Noise.

virtual void SIM_NoiseStandard::getNoiseSubclass ( const UT_Vector3 pos,
UT_Vector3 noise 
) const [protected, virtual]

Override this function to implement a new 3D noise function.

Reimplemented from SIM_Noise.

virtual fpreal SIM_NoiseStandard::getNoiseSubclass ( const UT_Vector3 pos  )  const [protected, virtual]

Override this function to implement a new 1D noise function.

Reimplemented from SIM_Noise.

SIM_NoiseStandard::GETSET_DATA_FUNCS_E ( SIM_NAME_NOISETYPE  ,
NoiseType  ,
UT_Noise::UT_NoiseType   
)

SIM_NoiseStandard::GETSET_DATA_FUNCS_F ( SIM_NAME_ATTENUATION  ,
Attenuation   
)

SIM_NoiseStandard::GETSET_DATA_FUNCS_F ( SIM_NAME_ROUGHNESS  ,
Roughness   
)

SIM_NoiseStandard::GETSET_DATA_FUNCS_I ( SIM_NAME_FRACTALDEPTH  ,
FractalDepth   
)

SIM_NoiseStandard::GETSET_DATA_FUNCS_I ( SIM_NAME_SEED  ,
Seed   
)

SIM_NoiseStandard::GETSET_DATA_FUNCS_V3 ( SIM_NAME_OFFSET  ,
Offset   
)

SIM_NoiseStandard::GETSET_DATA_FUNCS_V3 ( SIM_NAME_FREQUENCY  ,
Frequency   
)

virtual void SIM_NoiseStandard::optionChangedSubclass ( const char *  name  )  [protected, virtual]

Respond to changes in the noise type.

Reimplemented from SIM_OptionsUser.


Friends And Related Function Documentation

friend class SIM_NoiseResolverStandard [friend]

Definition at line 65 of file SIM_NoiseStandard.h.


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

Generated on Fri May 25 00:10:40 2012 for HDK by  doxygen 1.5.9