Name attributes added since 2.48a more consistently.
[blender.git] / source / gameengine / GameLogic / SCA_RandomNumberGenerator.h
1 /**
2  * Generate random numbers that can be used by other components. Each
3  * generator needs its own generator, so that the seed can be set
4  * on a per-generator basis.
5  *
6  * $Id$
7  *
8  * ***** BEGIN GPL LICENSE BLOCK *****
9  *
10  * This program is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU General Public License
12  * as published by the Free Software Foundation; either version 2
13  * of the License, or (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
23  *
24  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
25  * All rights reserved.
26  *
27  * The Original Code is: all of this file.
28  *
29  * Contributor(s): none yet.
30  *
31  * ***** END GPL LICENSE BLOCK *****
32  */
33
34 #ifndef __KX_RANDOMNUMBERGENERATOR
35 #define __KX_RANDOMNUMBERGENERATOR
36
37 class SCA_RandomNumberGenerator {
38
39         /** base seed */
40         long m_seed;
41
42         /* A bit silly.. The N parameter is a define in the .cpp file */
43         /** the array for the state vector  */
44         /* unsigned long mt[N]; */
45         unsigned long mt[624];
46
47         /** mti==N+1 means mt[KX_MT_VectorLenght] is not initialized */
48         int mti; /* initialised in the cpp file */
49
50         /** Calculate a start vector */
51         void SetStartVector(void);
52  public:
53         SCA_RandomNumberGenerator(long seed);
54         ~SCA_RandomNumberGenerator();
55         unsigned long Draw();
56         float DrawFloat();
57         long GetSeed();
58         void SetSeed(long newseed);
59 };
60
61 #endif /* __KX_RANDOMNUMBERGENERATOR */
62