Commit patch #8799: Realtime SetParent function in the BGE

This patch consists in new KX_GameObject::SetParent() and KX_GameObject::RemoveParent() functions to create and destroy parent relation during game. These functions are accessible through python and through a new actuator KX_ParentActuator. Function documentation in PyDoc.
The object keeps its orientation, position and scale when it is parented but will further rotate, move and scale with its parent from that point on. When the parent relation is broken, the object keeps the orientation, position and scale it had at that time.
The function has no effect if any of the X/Y/Z scale of the object or its new parent are below Epsilon.

1 files changed, 86 insertions, 0 deletions

diff --git a/source/gameengine/Ketsji/KX_ParentActuator.h b/source/gameengine/Ketsji/KX_ParentActuator.h
new file mode 100644
index 00000000000..1bceacc9078
--- /dev/null
+++ b/source/gameengine/Ketsji/KX_ParentActuator.h
@@ -0,0 +1,86 @@
+/**
+ * Set or remove an objects parent
+ *
+ *
+ * $Id: KX_ParentActuator.h 3271 2004-10-16 11:41:50Z kester $
+ *
+ * ***** BEGIN GPL/BL DUAL 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. The Blender
+ * Foundation also sells licenses for use in proprietary software under
+ * the Blender License.  See http://www.blender.org/BL/ for information
+ * about this.
+ *
+ * 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/BL DUAL LICENSE BLOCK *****
+ */
+
+#ifndef __KX_PARENTACTUATOR
+#define __KX_PARENTACTUATOR
+
+#include "SCA_IActuator.h"
+#include "SCA_LogicManager.h"
+
+class KX_ParentActuator : public SCA_IActuator
+{
+	Py_Header;
+	
+	/** Mode */
+	int m_mode;
+	
+	/** Object to set as parent */
+	CValue *m_ob;
+	
+	
+
+ public:
+ 	enum KX_PARENTACT_MODE
+	{
+		KX_PARENT_NODEF = 0,
+		KX_PARENT_SET,
+		KX_PARENT_REMOVE,
+
+	};
+ 
+	KX_ParentActuator(class SCA_IObject* gameobj,
+						int mode,
+						CValue *ob,
+						PyTypeObject* T=&Type);
+	virtual ~KX_ParentActuator();
+	virtual bool Update();
+	
+	virtual CValue* GetReplica();
+	
+	/* --------------------------------------------------------------------- */
+	/* Python interface ---------------------------------------------------- */
+	/* --------------------------------------------------------------------- */
+
+	virtual PyObject* _getattr(const STR_String& attr);
+
+	/* 1. setObject                                                            */
+	KX_PYMETHOD_DOC(KX_ParentActuator,SetObject);
+	/* 2. getObject                                                            */
+	KX_PYMETHOD_DOC(KX_ParentActuator,GetObject);
+	
+}; /* end of class KX_ParentActuator : public SCA_PropertyActuator */
+
+#endif
+