blender/source/gameengine/Ketsji/KX_CameraActuator.h
Benoit Bolsee 9ed079bf5c BGE patch: Relink actuators with target within group when duplicating group; generalize protection against object deletion for all actuators that point to objects.
Certain actuators hold a pointer to an objects: Property,
SceneCamera, AddObject, Camera, Parent, TractTo. When a
group is duplicated, the actuators that point to objects
within the group will be relinked to point to the
replicated objects and not to the original objects.
This helps to setup self-contained group with a camera
following a character for example.
This feature also works when adding a single object
(and all its children) with the AddObject actuator.

The second part of the patch extends the protection
against object deletion to all the actuators of the above
list (previously, only the TrackTo, AddObject and
Property actuators were protected). In case the target
object of these actuators is deleted, the BGE won't
crash.
2008-07-19 07:45:19 +00:00

142 lines
3.6 KiB
C++

/**
* KX_CameraActuator.h
*
* $Id$
*
* ***** 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., 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.
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef __KX_CAMERAACTUATOR
#define __KX_CAMERAACTUATOR
#include "SCA_IActuator.h"
#include "MT_Scalar.h"
#include "SCA_LogicManager.h"
/**
* 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;
private :
/** Object that will be tracked. */
SCA_IObject *m_ob;
/** height (float), */
//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;
/** min (float), */
MT_Scalar m_minHeight;
/** max (float), */
MT_Scalar m_maxHeight;
/** 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,
//const CValue *ob,
SCA_IObject *ob,
MT_Scalar hght,
MT_Scalar minhght,
MT_Scalar maxhght,
bool xytog,
PyTypeObject* T=&Type
);
~KX_CameraActuator();
/** Methods Inherited from CValue */
CValue* GetReplica();
virtual void ProcessReplica();
/** Methods inherited from SCA_IActuator */
virtual bool Update(
double curtime,
bool frame
);
virtual bool UnlinkObject(SCA_IObject* clientobj);
/** Methods inherited from SCA_ILogicBrick */
virtual void Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
/* --------------------------------------------------------------------- */
/* Python interface ---------------------------------------------------- */
/* --------------------------------------------------------------------- */
virtual PyObject* _getattr(const STR_String& attr);
/* 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);
};
#endif //__KX_CAMERAACTUATOR