KX_RaySensor.h

Go to the documentation of this file.

/*
 * $Id: KX_RaySensor.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_RAYSENSOR_H
#define __KX_RAYSENSOR_H

#include "SCA_ISensor.h"
#include "MT_Point3.h"
#include "SCA_IScene.h" /* only for scene replace */
#include "KX_Scene.h" /* only for scene replace */

struct KX_ClientObjectInfo;
class KX_RayCast;

class KX_RaySensor : public SCA_ISensor
{
        Py_Header;
        STR_String              m_propertyname;
        bool                    m_bFindMaterial;
        bool                    m_bXRay;
        float                   m_distance;
        class KX_Scene* m_scene;
        bool                    m_bTriggered;
        int                             m_axis;
        bool                    m_rayHit;
        float                   m_hitPosition[3];
        SCA_IObject*    m_hitObject;
        float                   m_hitNormal[3];
        float                   m_rayDirection[3];

public:
        KX_RaySensor(class SCA_EventManager* eventmgr,
                                        SCA_IObject* gameobj,
                                        const STR_String& propname,
                                        bool bFindMaterial,
                                        bool bXRay,
                                        double distance,
                                        int axis,
                                        class KX_Scene* ketsjiScene);
        virtual ~KX_RaySensor();
        virtual CValue* GetReplica();

        virtual bool Evaluate();
        virtual bool IsPositiveTrigger();
        virtual void Init();

        bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
        bool NeedRayCast(KX_ClientObjectInfo* client);

        virtual void            Replace_IScene(SCA_IScene *val) 
        {       
                m_scene= static_cast<KX_Scene *>(val); 
        }

        //Python Interface
        enum RayAxis {
                KX_RAY_AXIS_POS_Y = 0,
                KX_RAY_AXIS_POS_X,
                KX_RAY_AXIS_POS_Z,
                KX_RAY_AXIS_NEG_X,
                KX_RAY_AXIS_NEG_Y,
                KX_RAY_AXIS_NEG_Z
        };
        
#ifdef WITH_PYTHON

        /* Attributes */
        static PyObject* pyattr_get_hitobject(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
        
#endif // WITH_PYTHON

};

#endif //__KX_RAYSENSOR_H