blender/source/gameengine/Ketsji/KX_SCA_AddObjectActuator.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

137 lines
3.3 KiB
C++

//
// Add object to the game world on action of this actuator. A copy is made
// of a referenced object. The copy inherits some properties from the owner
// of this actuator.
//
// $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 *****
//
// Previously existed as:
// \source\gameengine\GameLogic\SCA_AddObjectActuator.h
// Please look here for revision history.
#ifndef __KX_SCA_AddObjectActuator
#define __KX_SCA_AddObjectActuator
/* Actuator tree */
#include "SCA_IActuator.h"
#include "SCA_LogicManager.h"
#include "MT_Vector3.h"
class SCA_IScene;
class KX_SCA_AddObjectActuator : public SCA_IActuator
{
Py_Header;
/// Time field: lifetime of the new object
int m_timeProp;
/// Original object reference (object to replicate)
SCA_IObject* m_OriginalObject;
/// Object will be added to the following scene
SCA_IScene* m_scene;
/// Linear velocity upon creation of the object.
MT_Vector3 m_linear_velocity;
/// Apply the velocity locally
bool m_localFlag;
SCA_IObject* m_lastCreatedObject;
public:
/**
* This class also has the default constructors
* available. Use with care!
*/
KX_SCA_AddObjectActuator(
SCA_IObject *gameobj,
SCA_IObject *original,
int time,
SCA_IScene* scene,
const MT_Vector3& linvel,
bool local,
PyTypeObject* T=&Type
);
~KX_SCA_AddObjectActuator(void);
CValue*
GetReplica(
) ;
virtual void
ProcessReplica();
virtual bool
UnlinkObject(SCA_IObject* clientobj);
virtual void
Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map);
virtual bool
Update();
virtual PyObject*
_getattr(
const STR_String& attr
);
SCA_IObject*
GetLastCreatedObject(
) const ;
void InstantAddObject();
/* 1. setObject */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,SetObject);
/* 2. setTime */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,SetTime);
/* 3. getTime */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,GetTime);
/* 4. getObject */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,GetObject);
/* 5. getLinearVelocity */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,GetLinearVelocity);
/* 6. setLinearVelocity */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,SetLinearVelocity);
/* 7. getLastCreatedObject */
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,GetLastCreatedObject);
/* 8. instantAddObject*/
KX_PYMETHOD_DOC(KX_SCA_AddObjectActuator,InstantAddObject);
}; /* end of class KX_SCA_AddObjectActuator : public KX_EditObjectActuator */
#endif