SIM_Noise Class Reference
This class defines the interface for noise generation functions. More...
#include <SIM_Noise.h>
Public Member Functions | |
| GETSET_DATA_FUNCS_V3 (SIM_NAME_MINVALUE, MinValue) | |
| GETSET_DATA_FUNCS_V3 (SIM_NAME_MAXVALUE, MaxValue) | |
| GETSET_DATA_FUNCS_B (SIM_NAME_SCALARNOISE, ScalarNoise) | |
| fpreal | getNoise (const UT_Vector3 &pos) const |
| void | getNoise (const UT_Vector3 &pos, UT_Vector3 &noise) const |
| SIM_PropertyResolver * | getNoiseResolver () const |
Protected Member Functions | |
| SIM_Noise (const SIM_DataFactory *factory) | |
| virtual | ~SIM_Noise () |
| void | getNoiseLimits (fpreal &min, fpreal &max) const |
| virtual void | getNoiseLimitsSubclass (fpreal &min, fpreal &max) const =0 |
| Override this function to return the actual bounds of the noise. | |
| virtual fpreal | getNoiseSubclass (const UT_Vector3 &pos) const |
| virtual void | getNoiseSubclass (const UT_Vector3 &pos, UT_Vector3 &noise) const |
| virtual SIM_PropertyResolver * | getNoiseResolverSubclass () const |
Friends | |
| class | SIM_NoiseResolverGeneric |
| class | SIM_NoiseResolver |
Detailed Description
This class defines the interface for noise generation functions.Definition at line 27 of file SIM_Noise.h.
Constructor & Destructor Documentation
| SIM_Noise::SIM_Noise | ( | const SIM_DataFactory * | factory | ) | [explicit, protected] |
| virtual SIM_Noise::~SIM_Noise | ( | ) | [protected, virtual] |
Member Function Documentation
| void SIM_Noise::getNoise | ( | const UT_Vector3 & | pos, | |
| UT_Vector3 & | noise | |||
| ) | const |
Gets the 3D value of the noise field at the specified position. The returned value is between the minvalue and the maxvalue.
| fpreal SIM_Noise::getNoise | ( | const UT_Vector3 & | pos | ) | const |
Gets the 1D value of the noise field at the specified position. The returned value is between the minvalue and the maxvalue.
Get the extents of the values generated by the noise function. These values are required to properly scale the returned values.
| virtual void SIM_Noise::getNoiseLimitsSubclass | ( | fpreal & | min, | |
| fpreal & | max | |||
| ) | const [protected, pure virtual] |
Override this function to return the actual bounds of the noise.
Implemented in SIM_MaskField, and SIM_NoiseStandard.
| SIM_PropertyResolver* SIM_Noise::getNoiseResolver | ( | ) | const |
Returns an accelerated property resolver to get the noise at any given place in a hopefully threadsafe manner.
| virtual SIM_PropertyResolver* SIM_Noise::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 in SIM_NoiseStandard.
| virtual void SIM_Noise::getNoiseSubclass | ( | const UT_Vector3 & | pos, | |
| UT_Vector3 & | noise | |||
| ) | const [protected, virtual] |
Override this function to implement a new noise function. The returned values must all be in the range [0..1]. The default implementation returns the 1D noise value for all three components.
Reimplemented in SIM_MaskField, and SIM_NoiseStandard.
| virtual fpreal SIM_Noise::getNoiseSubclass | ( | const UT_Vector3 & | pos | ) | const [protected, virtual] |
Override this function to implement a new noise function. The returned value must be in the range [0..1]. The default implementation returns the X component of the 3D noise.
Reimplemented in SIM_MaskField, and SIM_NoiseStandard.
| SIM_Noise::GETSET_DATA_FUNCS_B | ( | SIM_NAME_SCALARNOISE | , | |
| ScalarNoise | ||||
| ) |
| SIM_Noise::GETSET_DATA_FUNCS_V3 | ( | SIM_NAME_MAXVALUE | , | |
| MaxValue | ||||
| ) |
| SIM_Noise::GETSET_DATA_FUNCS_V3 | ( | SIM_NAME_MINVALUE | , | |
| MinValue | ||||
| ) |
Friends And Related Function Documentation
friend class SIM_NoiseResolver [friend] |
Definition at line 77 of file SIM_Noise.h.
friend class SIM_NoiseResolverGeneric [friend] |
Definition at line 76 of file SIM_Noise.h.
The documentation for this class was generated from the following file:
- SIM/SIM_Noise.h
