KX_NetworkMessageSensor.h

Go to the documentation of this file.

/*
 * $Id: KX_NetworkMessageSensor.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_NETWORKMESSAGE_SENSOR_H
#define __KX_NETWORKMESSAGE_SENSOR_H

#include "SCA_ISensor.h"

class KX_NetworkEventManager;
class NG_NetworkScene;

class KX_NetworkMessageSensor : public SCA_ISensor
{
        // note: Py_Header MUST BE the first listed here
        Py_Header;
        NG_NetworkScene        *m_NetworkScene;

        // The subject we filter on.
        STR_String m_subject;

        // The number of messages caught since the last frame.
        int m_frame_message_count;

        bool m_IsUp;

        class CListValue* m_BodyList;
        class CListValue* m_SubjectList;
public:
        KX_NetworkMessageSensor(
                KX_NetworkEventManager* eventmgr,       // our eventmanager
                NG_NetworkScene *NetworkScene,          // our scene
                SCA_IObject* gameobj,                           // the sensor controlling object
                const STR_String &subject
        );
        virtual ~KX_NetworkMessageSensor();

        virtual CValue* GetReplica();
        virtual bool Evaluate();
        virtual bool IsPositiveTrigger();
        virtual void Init();
        void EndFrame();
        
        virtual void Replace_NetworkScene(NG_NetworkScene *val)
        {
                m_NetworkScene= val;
        };

#ifdef WITH_PYTHON

        /* ------------------------------------------------------------- */
        /* Python interface -------------------------------------------- */
        /* ------------------------------------------------------------- */

        /* attributes */
        static PyObject*        pyattr_get_bodies(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);     
        static PyObject*        pyattr_get_subjects(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);

#endif // WITH_PYTHON

};

#endif //__KX_NETWORKMESSAGE_SENSOR_H