Cortex  10.0.0-a4
Turbulence.h
1 //
3 // Copyright (c) 2007-2011, Image Engine Design Inc. All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 // * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //
12 // * Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
15 //
16 // * Neither the name of Image Engine Design nor the names of any
17 // other contributors to this software may be used to endorse or
18 // promote products derived from this software without specific prior
19 // written permission.
20 //
21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22 // IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
23 // THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
25 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32 //
34 
35 #ifndef IE_CORE_TURBULENCE_H
36 #define IE_CORE_TURBULENCE_H
37 
38 #include "IECore/PerlinNoise.h"
39 
40 namespace IECore
41 {
42 
50 template<typename N>
52 {
53 
54  public :
55 
56  typedef N Noise;
57  typedef typename N::Point Point;
58  typedef typename VectorTraits<Point>::BaseType PointBaseType;
59  typedef typename N::Value Value;
60  typedef typename VectorTraits<Value>::BaseType ValueBaseType;
61 
65  Turbulence( const unsigned int octaves = 4, const Value &gain = Value( 0.5 ),
66  PointBaseType lacunarity = 2.0, bool turbulent = true, const N &noise = N() );
68  Turbulence( const Turbulence &other );
69 
74 
75  void setOctaves( unsigned int octaves );
76  unsigned int getOctaves() const;
77 
78  void setGain( const Value &gain );
79  const Value &getGain() const;
80 
81  void setLacunarity( PointBaseType lacunarity );
82  PointBaseType getLacunarity() const;
83 
84  void setTurbulent( bool turbulent );
85  bool getTurbulent() const;
86 
87  void setNoise( const Noise &n );
88  const Noise &getNoise() const;
90 
93  Value turbulence( const Point &p ) const;
95  Value turbulence( const Point &p, PointBaseType filterWidth ) const;
96 
97  private :
98 
99  // This calculates m_offset and m_scale so as to bring the
100  // result into the appropriate -0.5 to 0.5 range.
101  void calculateScaleAndOffset();
102  Value m_offset;
103  Value m_scale;
104 
105  unsigned int m_octaves;
106  Value m_gain;
107  PointBaseType m_lacunarity;
108  bool m_turbulent;
109 
110  Noise m_noise;
111 
112 };
113 
118 
122 
126 
130 
131 } // namespace IECore
132 
133 #include "IECore/Turbulence.inl"
134 
135 #endif // IE_CORE_TURBULENCE_H
Turbulence(const unsigned int octaves=4, const Value &gain=Value(0.5), PointBaseType lacunarity=2.0, bool turbulent=true, const N &noise=N())
Definition: Turbulence.h:51
Definition: VectorTraits.h:48
Turbulence< PerlinNoiseV3ff > TurbulenceV3ff
Typedefs for common uses.
Definition: Turbulence.h:115
Value turbulence(const Point &p) const
T::BaseType BaseType
The type of the components of the vector.
Definition: VectorTraits.h:51
This namespace contains all components of the core library.
Definition: AddSmoothSkinningInfluencesOp.h:43