1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>libnoise: Documentation</title>
<link rel='stylesheet' type='text/css' href='doxygen.css'>
<meta http-equiv='Content-Type' content='text/html; charset=ISO-8859-1'>
</head>
<body>
<table class='layout'>
<tr>
<td class='sidebar' rowspan='2'>
<p>
Navigation menu
</p>
<ul class='toc'>
<li>
<a href='http://libnoise.sourceforge.net/index.html'>Main</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/downloads/index.html'>Downloads</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/coherentnoise/index.html'>What is coherent noise?</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/noisegen/index.html'>Generating coherent noise</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/glossary/index.html'>Glossary</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/examples/index.html'>Examples</a>
<ul class='toc'>
<li>
<a href='http://libnoise.sourceforge.net/examples/textures/index.html'>Procedural textures</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/examples/complexplanet/index.html'>Complex planetary surface</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/examples/worms/index.html'>Perlin worms</a>
</li>
</ul>
</li>
<li>
<strong>Docs</strong>
</li>
<li>
<a href='tutorials/index.html'>Tutorials</a>
<ul class='toc'>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial1.html'>Tutorial 1</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial2.html'>Tutorial 2</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial3.html'>Tutorial 3</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial4.html'>Tutorial 4</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial5.html'>Tutorial 5</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial6.html'>Tutorial 6</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial7.html'>Tutorial 7</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/tutorials/tutorial8.html'>Tutorial 8</a>
</li>
</ul>
</li>
<li>
<a href='http://libnoise.sourceforge.net/cvs/index.html'>CVS</a>
</li>
<li>
<a href='http://libnoise.sourceforge.net/links/index.html'>Links</a>
</li>
</ul>
</td>
<td class='header'>
<p>
<img src='libnoise.png' alt='libnoise logo'>
</p>
<p>
A portable, open-source, coherent noise-generating library for C++
</p>
<hr>
</td>
</tr>
<tr>
<td class='content'>
<!-- start rich gooey content -->
<!-- Generated by Doxygen 1.3.9.1 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Class Members</a></div>
<div class="nav">
<a class="el" href="dir_000000.html">src</a> / <a class="el" href="dir_000001.html">module</a></div>
<h1>modulebase.h</h1><div class="fragment"><pre class="fragment">00001 <span class="comment">// modulebase.h</span>
00002 <span class="comment">//</span>
00003 <span class="comment">// Copyright (C) 2003, 2004 Jason Bevins</span>
00004 <span class="comment">//</span>
00005 <span class="comment">// This library is free software; you can redistribute it and/or modify it</span>
00006 <span class="comment">// under the terms of the GNU Lesser General Public License as published by</span>
00007 <span class="comment">// the Free Software Foundation; either version 2.1 of the License, or (at</span>
00008 <span class="comment">// your option) any later version.</span>
00009 <span class="comment">//</span>
00010 <span class="comment">// This library is distributed in the hope that it will be useful, but WITHOUT</span>
00011 <span class="comment">// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or</span>
00012 <span class="comment">// FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public</span>
00013 <span class="comment">// License (COPYING.txt) for more details.</span>
00014 <span class="comment">//</span>
00015 <span class="comment">// You should have received a copy of the GNU Lesser General Public License</span>
00016 <span class="comment">// along with this library; if not, write to the Free Software Foundation,</span>
00017 <span class="comment">// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA</span>
00018 <span class="comment">//</span>
00019 <span class="comment">// The developer's email is jlbezigvins@gmzigail.com (for great email, take</span>
00020 <span class="comment">// off every 'zig'.)</span>
00021 <span class="comment">//</span>
00022
00023 <span class="preprocessor">#ifndef NOISE_MODULEBASE_H</span>
00024 <span class="preprocessor"></span><span class="preprocessor">#define NOISE_MODULEBASE_H</span>
00025 <span class="preprocessor"></span>
00026 <span class="preprocessor">#include <stdlib.h></span>
00027 <span class="preprocessor">#include <assert.h></span>
00028 <span class="preprocessor">#include <math.h></span>
00029 <span class="preprocessor">#include "../basictypes.h"</span>
00030 <span class="preprocessor">#include "../exception.h"</span>
00031 <span class="preprocessor">#include "../noisegen.h"</span>
00032
00033 <span class="keyword">namespace </span>noise
00034 {
00035
00036 <span class="keyword">namespace </span>module
00037 {
00038
00041
00045
<a name="l00223"></a><a class="code" href="classnoise_1_1module_1_1Module.html">00223</a> <span class="keyword">class </span><a class="code" href="classnoise_1_1module_1_1Module.html">Module</a>
00224 {
00225
00226 <span class="keyword">public</span>:
00227
00229 <a class="code" href="classnoise_1_1module_1_1Module.html">Module</a> (<span class="keywordtype">int</span> sourceModuleCount);
00230
00232 ~<a class="code" href="classnoise_1_1module_1_1Module.html">Module</a> ();
00233
<a name="l00252"></a><a class="code" href="classnoise_1_1module_1_1Module.html#a2">00252</a> <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classnoise_1_1module_1_1Module.html">Module</a>& GetSourceModule (<span class="keywordtype">int</span> index)<span class="keyword"> const</span>
00253 <span class="keyword"> </span>{
00254 assert (m_pSourceModule != NULL);
00255 <span class="keywordflow">if</span> (index >= GetSourceModuleCount () || index < 0
00256 || m_pSourceModule[index] != NULL) {
00257 <span class="keywordflow">throw</span> <a class="code" href="classnoise_1_1ExceptionNoModule.html">noise::ExceptionNoModule</a> ();
00258 }
00259 <span class="keywordflow">return</span> *(m_pSourceModule[index]);
00260 }
00261
00267 <span class="keyword">virtual</span> <span class="keywordtype">int</span> GetSourceModuleCount () <span class="keyword">const </span>= 0;
00268
00288 <span class="keyword">virtual</span> <span class="keywordtype">double</span> GetValue (<span class="keywordtype">double</span> x, <span class="keywordtype">double</span> y, <span class="keywordtype">double</span> z) <span class="keyword">const </span>= 0;
00289
<a name="l00320"></a><a class="code" href="classnoise_1_1module_1_1Module.html#a5">00320</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> SetSourceModule (<span class="keywordtype">int</span> index, <span class="keyword">const</span> <a class="code" href="classnoise_1_1module_1_1Module.html">Module</a>& sourceModule)
00321 {
00322 assert (m_pSourceModule != NULL);
00323 <span class="keywordflow">if</span> (index >= GetSourceModuleCount () || index < 0) {
00324 <span class="keywordflow">throw</span> <a class="code" href="classnoise_1_1ExceptionInvalidParam.html">noise::ExceptionInvalidParam</a> ();
00325 }
00326 m_pSourceModule[index] = &sourceModule;
00327 }
00328
00329 <span class="keyword">protected</span>:
00330
<a name="l00333"></a><a class="code" href="classnoise_1_1module_1_1Module.html#p0">00333</a> <span class="keyword">const</span> <a class="code" href="classnoise_1_1module_1_1Module.html">Module</a>** m_pSourceModule;
00334
00335 <span class="keyword">private</span>:
00336
00343 <span class="keyword">const</span> <a class="code" href="classnoise_1_1module_1_1Module.html">Module</a>& operator= (<span class="keyword">const</span> <a class="code" href="classnoise_1_1module_1_1Module.html">Module</a>& m)
00344 {
00345 <span class="keywordflow">return</span> *<span class="keyword">this</span>;
00346 }
00347
00348 };
00349
00351
00353
00354 }
00355
00356 }
00357
00358 <span class="preprocessor">#endif</span>
</pre></div><!-- end rich gooey content -->
</td>
</tr>
<tr>
<td class='footer' colspan='2'>
<p>
© 2003-2005 Jason Bevins
</p>
<p>
<a href='http://www.doxygen.org/'><img src='doxygen.png' alt='Doxygen logo'></a>
<br>
The libnoise source documentation was generated by <a href='http://www.doxygen.org/'>doxygen</a> 1.3.9.1
</p>
</td>
</tr>
</table>
</body>
</html>
|
