2002-10-12 11:37:38 +00:00
|
|
|
/**
|
|
|
|
* KX_CameraActuator.h
|
|
|
|
*
|
|
|
|
* $Id$
|
|
|
|
*
|
2008-04-16 22:40:48 +00:00
|
|
|
* ***** BEGIN GPL LICENSE BLOCK *****
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* 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
|
2008-04-16 22:40:48 +00:00
|
|
|
* of the License, or (at your option) any later version.
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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.
|
|
|
|
*
|
2008-04-16 22:40:48 +00:00
|
|
|
* ***** END GPL LICENSE BLOCK *****
|
2002-10-12 11:37:38 +00:00
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef __KX_CAMERAACTUATOR
|
|
|
|
#define __KX_CAMERAACTUATOR
|
|
|
|
|
|
|
|
#include "SCA_IActuator.h"
|
|
|
|
#include "MT_Scalar.h"
|
2004-12-29 01:33:15 +00:00
|
|
|
#include "SCA_LogicManager.h"
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The camera actuator does a Robbie Muller prespective for you. This is a
|
|
|
|
* weird set of rules that positions the camera sort of behind the object,
|
|
|
|
* tracking, while avoiding any objects between the 'ideal' position and the
|
|
|
|
* actor being tracked.
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
class KX_CameraActuator : public SCA_IActuator
|
|
|
|
{
|
|
|
|
Py_Header;
|
2004-06-04 03:00:13 +00:00
|
|
|
private :
|
2002-10-12 11:37:38 +00:00
|
|
|
/** Object that will be tracked. */
|
2008-07-19 07:45:19 +00:00
|
|
|
SCA_IObject *m_ob;
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/** height (float), */
|
2004-12-29 01:33:15 +00:00
|
|
|
//const MT_Scalar m_height;
|
|
|
|
/** min (float), */
|
|
|
|
//const MT_Scalar m_minHeight;
|
|
|
|
/** max (float), */
|
|
|
|
//const MT_Scalar m_maxHeight;
|
|
|
|
|
|
|
|
/** height (float), */
|
|
|
|
MT_Scalar m_height;
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/** min (float), */
|
2004-12-29 01:33:15 +00:00
|
|
|
MT_Scalar m_minHeight;
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/** max (float), */
|
2004-12-29 01:33:15 +00:00
|
|
|
MT_Scalar m_maxHeight;
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/** xy toggle (pick one): true == x, false == y */
|
|
|
|
bool m_x;
|
|
|
|
|
|
|
|
/* get the KX_IGameObject with this name */
|
|
|
|
CValue *findObject(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;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the bool toggle to true to use x lock, false for y lock
|
|
|
|
*/
|
|
|
|
KX_CameraActuator(
|
|
|
|
|
|
|
|
SCA_IObject *gameobj,
|
2004-12-29 01:33:15 +00:00
|
|
|
//const CValue *ob,
|
2008-07-19 07:45:19 +00:00
|
|
|
SCA_IObject *ob,
|
2002-10-12 11:37:38 +00:00
|
|
|
MT_Scalar hght,
|
|
|
|
MT_Scalar minhght,
|
|
|
|
MT_Scalar maxhght,
|
|
|
|
bool xytog,
|
|
|
|
PyTypeObject* T=&Type
|
|
|
|
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
|
|
~KX_CameraActuator();
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
/** Methods Inherited from CValue */
|
|
|
|
CValue* GetReplica();
|
2008-07-19 07:45:19 +00:00
|
|
|
virtual void ProcessReplica();
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
/** Methods inherited from SCA_IActuator */
|
2004-10-16 11:41:50 +00:00
|
|
|
virtual bool Update(
|
2002-10-12 11:37:38 +00:00
|
|
|
double curtime,
|
2004-10-16 11:41:50 +00:00
|
|
|
bool frame
|
2002-10-12 11:37:38 +00:00
|
|
|
);
|
2008-07-19 07:45:19 +00:00
|
|
|
virtual bool UnlinkObject(SCA_IObject* clientobj);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2008-07-19 07:45:19 +00:00
|
|
|
/** Methods inherited from SCA_ILogicBrick */
|
|
|
|
virtual void Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/* --------------------------------------------------------------------- */
|
|
|
|
/* Python interface ---------------------------------------------------- */
|
|
|
|
/* --------------------------------------------------------------------- */
|
|
|
|
|
2004-05-16 13:05:15 +00:00
|
|
|
virtual PyObject* _getattr(const STR_String& attr);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2004-12-29 01:33:15 +00:00
|
|
|
/* set object to look at */
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,SetObject);
|
|
|
|
/* get current object */
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,GetObject);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,SetMin);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,GetMin);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,SetMax);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,GetMax);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,SetHeight);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,GetHeight);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,SetXY);
|
|
|
|
KX_PYMETHOD_DOC(KX_CameraActuator,GetXY);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
};
|
2002-10-30 02:07:20 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
#endif //__KX_CAMERAACTUATOR
|
2002-10-30 02:07:20 +00:00
|
|
|
|