Patch to change license to GPL only, from GSR.
[blender.git] / source / gameengine / GameLogic / SCA_RandomSensor.cpp
1 /**
2  * Generate random pulses
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #include "SCA_RandomSensor.h"
33 #include "SCA_EventManager.h"
34 #include "SCA_RandomEventManager.h"
35 #include "SCA_LogicManager.h"
36 #include "ConstExpr.h"
37 #include <iostream>
38
39 #ifdef HAVE_CONFIG_H
40 #include <config.h>
41 #endif
42
43 /* ------------------------------------------------------------------------- */
44 /* Native functions                                                          */
45 /* ------------------------------------------------------------------------- */
46
47 SCA_RandomSensor::SCA_RandomSensor(SCA_EventManager* eventmgr, 
48                                  SCA_IObject* gameobj, 
49                                  int startseed,
50                                  PyTypeObject* T)
51     : SCA_ISensor(gameobj,eventmgr, T)
52 {
53     m_iteration  = 0;
54         m_lastdraw   = false;
55         
56         m_basegenerator = new SCA_RandomNumberGenerator(startseed);
57     m_currentDraw = m_basegenerator->Draw();
58         RegisterToManager();
59 }
60
61
62
63 SCA_RandomSensor::~SCA_RandomSensor() 
64 {
65     /* Nothing to be done here. */
66 }
67
68
69
70 CValue* SCA_RandomSensor::GetReplica()
71 {
72         CValue* replica = new SCA_RandomSensor(*this);
73         // this will copy properties and so on...
74         CValue::AddDataToReplica(replica);
75
76         return replica;
77 }
78
79
80
81 bool SCA_RandomSensor::IsPositiveTrigger()
82
83         return (m_invert !=m_lastdraw);
84 }
85
86
87 bool SCA_RandomSensor::Evaluate(CValue* event)
88 {
89     /* Random generator is the generator from Line 25 of Table 1 in          */
90     /* [KNUTH 1981, The Art of Computer Programming Vol. 2                   */
91     /* (2nd Ed.), pp102]                                                     */
92     /* It's a very simple max. length sequence generator. We can             */
93     /* draw 32 bool values before having to generate the next                */
94     /* sequence value. There are some theorems that will tell you            */
95     /* this is a reasonable way of generating bools. Check Knuth.            */
96     /* Furthermore, we only draw each <delay>-eth frame.                     */
97
98     bool drawResult = false;
99
100         if (m_iteration > 31) {
101                 m_currentDraw = m_basegenerator->Draw();
102                 drawResult = (m_currentDraw & 0x1) == 0;
103                 m_iteration = 1;
104         } else {
105                 drawResult = ((m_currentDraw >> m_iteration) & 0x1) == 0;
106                 m_iteration++;
107         }
108     
109     /* now pass this result to some controller */
110         m_lastdraw = drawResult;
111         return drawResult;
112 }
113
114 /* ------------------------------------------------------------------------- */
115 /* Python functions                                                          */
116 /* ------------------------------------------------------------------------- */
117
118 /* Integration hooks ------------------------------------------------------- */
119 PyTypeObject SCA_RandomSensor::Type = {
120         PyObject_HEAD_INIT(&PyType_Type)
121         0,
122         "SCA_RandomSensor",
123         sizeof(SCA_RandomSensor),
124         0,
125         PyDestructor,
126         0,
127         __getattr,
128         __setattr,
129         0, //&MyPyCompare,
130         __repr,
131         0, //&cvalue_as_number,
132         0,
133         0,
134         0,
135         0
136 };
137
138 PyParentObject SCA_RandomSensor::Parents[] = {
139         &SCA_RandomSensor::Type,
140         &SCA_ISensor::Type,
141         &SCA_ILogicBrick::Type,
142         &CValue::Type,
143         NULL
144 };
145
146 PyMethodDef SCA_RandomSensor::Methods[] = {
147         {"setSeed",     (PyCFunction) SCA_RandomSensor::sPySetSeed, METH_VARARGS, SetSeed_doc},
148         {"getSeed",     (PyCFunction) SCA_RandomSensor::sPyGetSeed, METH_VARARGS, GetSeed_doc},
149         {"getLastDraw", (PyCFunction) SCA_RandomSensor::sPyGetLastDraw, METH_VARARGS, GetLastDraw_doc},
150         {NULL,NULL} //Sentinel
151 };
152
153 PyObject* SCA_RandomSensor::_getattr(const STR_String& attr) {
154         _getattr_up(SCA_ISensor);
155 }
156
157 /* 1. setSeed                                                            */
158 char SCA_RandomSensor::SetSeed_doc[] = 
159 "setSeed(seed)\n"
160 "\t- seed: integer\n"
161 "\tSet the initial seed of the generator. Equal seeds produce\n"
162 "\tequal series. If the seed is 0, the generator will produce\n"
163 "\tthe same value on every call.\n";
164 PyObject* SCA_RandomSensor::PySetSeed(PyObject* self, PyObject* args, PyObject* kwds) {
165         long seedArg;
166         if(!PyArg_ParseTuple(args, "i", &seedArg)) {
167                 return NULL;
168         }
169         
170         m_basegenerator->SetSeed(seedArg);
171         
172         Py_Return;
173 }
174
175 /* 2. getSeed                                                            */
176 char SCA_RandomSensor::GetSeed_doc[] = 
177 "getSeed()\n"
178 "\tReturns the initial seed of the generator. Equal seeds produce\n"
179 "\tequal series.\n";
180 PyObject* SCA_RandomSensor::PyGetSeed(PyObject* self, PyObject* args, PyObject* kwds) {
181         return PyInt_FromLong(m_basegenerator->GetSeed());
182 }
183
184 /* 3. getLastDraw                                                            */
185 char SCA_RandomSensor::GetLastDraw_doc[] = 
186 "getLastDraw()\n"
187 "\tReturn the last value that was drawn.\n";
188 PyObject* SCA_RandomSensor::PyGetLastDraw(PyObject* self, PyObject* args, PyObject* kwds) {
189         return PyInt_FromLong(m_lastdraw);
190 }
191
192 /* eof */