SCA_RandomActuator.h

Go to the documentation of this file.

/*
 * $Id: SCA_RandomActuator.h 35063 2011-02-22 10:33:14Z jesterking $
 *
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef __KX_RANDOMACTUATOR
#define __KX_RANDOMACTUATOR

#include "SCA_IActuator.h"
#include "SCA_RandomNumberGenerator.h"

class SCA_RandomActuator : public SCA_IActuator
{
        Py_Header;
        STR_String m_propname;
        
        float m_parameter1;
        float m_parameter2;

        SCA_RandomNumberGenerator *m_base;

        int m_counter;

        long m_previous;

        void enforceConstraints(void);
        
 public:

        enum KX_RANDOMACT_MODE {
                KX_RANDOMACT_NODEF,
                KX_RANDOMACT_BOOL_CONST,
                KX_RANDOMACT_BOOL_UNIFORM,
                KX_RANDOMACT_BOOL_BERNOUILLI,           
                KX_RANDOMACT_INT_CONST,
                KX_RANDOMACT_INT_UNIFORM,
                KX_RANDOMACT_INT_POISSON,               
                KX_RANDOMACT_FLOAT_CONST,
                KX_RANDOMACT_FLOAT_UNIFORM,
                KX_RANDOMACT_FLOAT_NORMAL,
                KX_RANDOMACT_FLOAT_NEGATIVE_EXPONENTIAL,
                KX_RANDOMACT_MAX
        };
        KX_RANDOMACT_MODE m_distribution;
        
        SCA_RandomActuator(class SCA_IObject* gameobj,
                                          long seed,
                                          KX_RANDOMACT_MODE mode,
                                          float para1,
                                          float para2,
                                          const STR_String &propName);
        virtual ~SCA_RandomActuator();
        virtual bool Update();
        
        virtual CValue* GetReplica();
        virtual void ProcessReplica();

#ifdef WITH_PYTHON
        
        /* --------------------------------------------------------------------- */
        /* Python interface ---------------------------------------------------- */
        /* --------------------------------------------------------------------- */

        static PyObject* pyattr_get_seed(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef);
        static int pyattr_set_seed(void *self, const struct KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);

        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setBoolConst);
        KX_PYMETHOD_DOC_NOARGS(SCA_RandomActuator, setBoolUniform);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setBoolBernouilli);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setIntConst);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setIntUniform);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setIntPoisson);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setFloatConst);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setFloatUniform);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setFloatNormal);
        KX_PYMETHOD_DOC_VARARGS(SCA_RandomActuator, setFloatNegativeExponential);

#endif // WITH_PYTHON

}; /* end of class KX_EditObjectActuator : public SCA_PropertyActuator */

#endif