KX_CameraActuator.h

Go to the documentation of this file.

/*
 * KX_CameraActuator.h
 *
 *
 * ***** 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_CAMERAACTUATOR
#define __KX_CAMERAACTUATOR

#include "SCA_IActuator.h"
#include "MT_Scalar.h"
#include "SCA_LogicManager.h"

class KX_CameraActuator : public SCA_IActuator
{
    Py_Header
private :
    SCA_IObject *m_ob;

    //const MT_Scalar m_height;
    //const MT_Scalar m_minHeight;
    //const MT_Scalar m_maxHeight;
    
    float m_height;
    
    float m_minHeight;
    
    float m_maxHeight;
    
    short m_axis;
    
    float m_damping;

    /* get the KX_IGameObject with this name */
    CValue *findObject(const char *obName);

    /* parse x or y to a toggle pick */
    bool string2axischoice(const char *axisString);
    
 public:
    static STR_String X_AXIS_STRING;
    static STR_String Y_AXIS_STRING;
    
    KX_CameraActuator(

        SCA_IObject *gameobj,
        //const CValue *ob,
        SCA_IObject *ob,
        float hght,
        float minhght,
        float maxhght,
        short axis,
        float damping
    );


    ~KX_CameraActuator();



    CValue* GetReplica();
    virtual void ProcessReplica();
    

    virtual bool Update(
        double curtime,
        bool frame
    );
    virtual bool    UnlinkObject(SCA_IObject* clientobj);

    virtual void    Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map);

#ifdef WITH_PYTHON

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

    /* set object to look at */
    static PyObject*    pyattr_get_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static int          pyattr_set_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);

#endif // WITH_PYTHON

};

#endif //__KX_CAMERAACTUATOR