summaryrefslogtreecommitdiff
path: root/doc/html/classsf_1_1Randomizer.htm
blob: bc60632b48d3994299eb70d4736cac46a87c807d (plain)
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
    <head>
        <title>SFML - Simple and Fast Multimedia Library</title>
        <meta http-equiv="Content-Type" content="text/html;charset=UTF-8" />
        <link href="doxygen.css" rel="stylesheet" type="text/css" />
        <link href="tabs.css" rel="stylesheet" type="text/css" />
    </head>
    <body>
        <div id="logo">
            <img src="./logo.jpg" width="770" height="200" title="SFML home" alt="SFML logo" />
        </div>
<!-- Generated by Doxygen 1.5.2 -->
<div class="tabs">
  <ul>
    <li><a href="index.htm"><span>Main&nbsp;Page</span></a></li>
    <li><a href="namespaces.htm"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.htm"><span>Classes</span></a></li>
    <li><a href="files.htm"><span>Files</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.htm"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.htm"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.htm"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.htm"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<div class="nav">
<a class="el" href="namespacesf.htm">sf</a>::<a class="el" href="classsf_1_1Randomizer.htm">Randomizer</a></div>
<h1>sf::Randomizer Class Reference</h1><!-- doxytag: class="sf::Randomizer" --><a class="el" href="classsf_1_1Randomizer.htm" title="Randomizer is an utility class for generating pseudo-random numbers.">Randomizer</a> is an utility class for generating pseudo-random numbers.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="Randomizer_8hpp-source.htm">Randomizer.hpp</a>&gt;</code>
<p>
<a href="classsf_1_1Randomizer-members.htm">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Randomizer.htm#ae267a2d8a652b663786a06fad975db2">SetSeed</a> (unsigned int Seed)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the seed for the generator.  <a href="#ae267a2d8a652b663786a06fad975db2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Randomizer.htm#1813fbdd8110c68e92390b2872ba714a">GetSeed</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the seed used to generate random numbers the generator.  <a href="#1813fbdd8110c68e92390b2872ba714a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Randomizer.htm#af29ff35360b7914cef1a7232c728fc5">Random</a> (float Begin, float End)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a random float number in a given range.  <a href="#af29ff35360b7914cef1a7232c728fc5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsf_1_1Randomizer.htm#6ca7745e48c91a51614efda2a9ad44c3">Random</a> (int Begin, int End)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a random integer number in a given range.  <a href="#6ca7745e48c91a51614efda2a9ad44c3"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<a class="el" href="classsf_1_1Randomizer.htm" title="Randomizer is an utility class for generating pseudo-random numbers.">Randomizer</a> is an utility class for generating pseudo-random numbers. 
<p>

<p>
Definition at line <a class="el" href="Randomizer_8hpp-source.htm#l00040">40</a> of file <a class="el" href="Randomizer_8hpp-source.htm">Randomizer.hpp</a>.<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="ae267a2d8a652b663786a06fad975db2"></a><!-- doxytag: member="sf::Randomizer::SetSeed" ref="ae267a2d8a652b663786a06fad975db2" args="(unsigned int Seed)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static void sf::Randomizer::SetSeed           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>Seed</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the seed for the generator. 
<p>
Using a known seed allows you to reproduce the same sequence of random number<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>Seed</em>&nbsp;</td><td>: Number to use as the seed </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="1813fbdd8110c68e92390b2872ba714a"></a><!-- doxytag: member="sf::Randomizer::GetSeed" ref="1813fbdd8110c68e92390b2872ba714a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static unsigned int sf::Randomizer::GetSeed           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the seed used to generate random numbers the generator. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Current seed </dd></dl>

</div>
</div><p>
<a class="anchor" name="af29ff35360b7914cef1a7232c728fc5"></a><!-- doxytag: member="sf::Randomizer::Random" ref="af29ff35360b7914cef1a7232c728fc5" args="(float Begin, float End)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static float sf::Randomizer::Random           </td>
          <td>(</td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>Begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&nbsp;</td>
          <td class="paramname"> <em>End</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a random float number in a given range. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Start : Start of the range <p>
End : End of the range<p>
Random number in [Begin, End] </dd></dl>

</div>
</div><p>
<a class="anchor" name="6ca7745e48c91a51614efda2a9ad44c3"></a><!-- doxytag: member="sf::Randomizer::Random" ref="6ca7745e48c91a51614efda2a9ad44c3" args="(int Begin, int End)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static int sf::Randomizer::Random           </td>
          <td>(</td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>Begin</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>End</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get a random integer number in a given range. 
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>Start : Start of the range <p>
End : End of the range<p>
Random number in [Begin, End] </dd></dl>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Randomizer_8hpp-source.htm">Randomizer.hpp</a></ul>

        <p id="footer">
            &nbsp;::&nbsp; Copyright &copy; 2007-2008 Laurent Gomila, all rights reserved &nbsp;::&nbsp;
            Documentation generated by <a href="http://www.doxygen.org/" title="doxygen website">doxygen 1.5.2</a> &nbsp;::&nbsp;
        </p>

    </body>
</html>