2011-02-22 10:33:14 +00:00
|
|
|
/*
|
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,
|
2010-02-12 13:34:04 +00:00
|
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
2002-10-12 11:37:38 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
*
|
|
|
|
*/
|
2005-04-23 11:36:44 +00:00
|
|
|
|
2011-02-22 10:33:14 +00:00
|
|
|
/** \file KX_SG_NodeRelationships.h
|
|
|
|
* \ingroup ketsji
|
|
|
|
* \section KX_SG_NodeRelationships
|
|
|
|
* This file provides common concrete implementations of
|
|
|
|
* SG_ParentRelation used by the game engine. These are
|
|
|
|
* KX_SlowParentRelation a slow parent relationship.
|
|
|
|
* KX_NormalParentRelation a normal parent relationship where
|
|
|
|
* orientation and position are inherited from the parent by
|
|
|
|
* the child.
|
|
|
|
* KX_VertexParentRelation only location information is
|
|
|
|
* inherited by the child.
|
|
|
|
*/
|
|
|
|
|
2012-02-23 10:41:31 +00:00
|
|
|
#ifndef __KX_SG_NODERELATIONSHIPS_H__
|
|
|
|
#define __KX_SG_NODERELATIONSHIPS_H__
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
#include "SG_Spatial.h"
|
|
|
|
#include "SG_ParentRelation.h"
|
|
|
|
|
|
|
|
class KX_NormalParentRelation : public SG_ParentRelation
|
|
|
|
{
|
|
|
|
|
|
|
|
public :
|
|
|
|
/**
|
|
|
|
* Allocate and construct a new KX_NormalParentRelation
|
|
|
|
* on the heap.
|
|
|
|
*/
|
|
|
|
|
|
|
|
static
|
|
|
|
KX_NormalParentRelation *
|
|
|
|
New(
|
2012-09-16 04:58:18 +00:00
|
|
|
);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Method inherited from KX_ParentRelation
|
|
|
|
*/
|
|
|
|
|
2004-05-26 12:06:41 +00:00
|
|
|
bool
|
2002-10-12 11:37:38 +00:00
|
|
|
UpdateChildCoordinates(
|
|
|
|
SG_Spatial * child,
|
2009-04-20 15:06:46 +00:00
|
|
|
const SG_Spatial * parent,
|
2012-09-16 04:58:18 +00:00
|
|
|
bool& parentUpdated
|
2002-10-12 11:37:38 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Method inherited from KX_ParentRelation
|
|
|
|
*/
|
|
|
|
|
|
|
|
SG_ParentRelation *
|
|
|
|
NewCopy(
|
|
|
|
);
|
|
|
|
|
|
|
|
~KX_NormalParentRelation(
|
|
|
|
);
|
|
|
|
|
|
|
|
private :
|
|
|
|
|
|
|
|
KX_NormalParentRelation(
|
|
|
|
);
|
|
|
|
|
2009-08-18 15:37:31 +00:00
|
|
|
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
2012-06-25 09:14:37 +00:00
|
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_NormalParentRelation")
|
2009-08-18 15:37:31 +00:00
|
|
|
#endif
|
2002-10-12 11:37:38 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class KX_VertexParentRelation : public SG_ParentRelation
|
|
|
|
{
|
|
|
|
|
|
|
|
public :
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Allocate and construct a new KX_VertexParentRelation
|
|
|
|
* on the heap.
|
|
|
|
*/
|
|
|
|
|
|
|
|
static
|
|
|
|
KX_VertexParentRelation *
|
|
|
|
New(
|
2012-09-16 04:58:18 +00:00
|
|
|
);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Method inherited from KX_ParentRelation
|
|
|
|
*/
|
|
|
|
|
2004-05-26 12:06:41 +00:00
|
|
|
bool
|
2002-10-12 11:37:38 +00:00
|
|
|
UpdateChildCoordinates(
|
|
|
|
SG_Spatial * child,
|
2009-04-20 15:06:46 +00:00
|
|
|
const SG_Spatial * parent,
|
2012-09-16 04:58:18 +00:00
|
|
|
bool& parentUpdated
|
2002-10-12 11:37:38 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Method inherited from KX_ParentRelation
|
|
|
|
*/
|
|
|
|
|
|
|
|
SG_ParentRelation *
|
|
|
|
NewCopy(
|
|
|
|
);
|
|
|
|
|
|
|
|
~KX_VertexParentRelation(
|
|
|
|
);
|
|
|
|
|
2008-05-14 20:22:57 +00:00
|
|
|
bool
|
|
|
|
IsVertexRelation(
|
|
|
|
) {
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
private :
|
|
|
|
|
|
|
|
KX_VertexParentRelation(
|
|
|
|
);
|
|
|
|
|
2009-08-18 15:37:31 +00:00
|
|
|
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
2012-06-25 09:14:37 +00:00
|
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_VertexParentRelation")
|
2009-08-18 15:37:31 +00:00
|
|
|
#endif
|
2002-10-12 11:37:38 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
class KX_SlowParentRelation : public SG_ParentRelation
|
|
|
|
{
|
|
|
|
|
|
|
|
public :
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Allocate and construct a new KX_VertexParentRelation
|
|
|
|
* on the heap.
|
|
|
|
*/
|
|
|
|
|
|
|
|
static
|
|
|
|
KX_SlowParentRelation *
|
|
|
|
New(
|
|
|
|
MT_Scalar relaxation
|
2012-09-16 04:58:18 +00:00
|
|
|
);
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Method inherited from KX_ParentRelation
|
|
|
|
*/
|
|
|
|
|
2004-05-26 12:06:41 +00:00
|
|
|
bool
|
2002-10-12 11:37:38 +00:00
|
|
|
UpdateChildCoordinates(
|
|
|
|
SG_Spatial * child,
|
2009-04-20 15:06:46 +00:00
|
|
|
const SG_Spatial * parent,
|
2012-09-16 04:58:18 +00:00
|
|
|
bool& parentUpdated
|
2002-10-12 11:37:38 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Method inherited from KX_ParentRelation
|
|
|
|
*/
|
|
|
|
|
|
|
|
SG_ParentRelation *
|
|
|
|
NewCopy(
|
|
|
|
);
|
|
|
|
|
2008-06-14 17:12:49 +00:00
|
|
|
MT_Scalar
|
|
|
|
GetTimeOffset(
|
|
|
|
) { return m_relax; }
|
|
|
|
|
|
|
|
void
|
|
|
|
SetTimeOffset(
|
|
|
|
MT_Scalar relaxation
|
|
|
|
) { m_relax = relaxation; }
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
~KX_SlowParentRelation(
|
|
|
|
);
|
2008-06-14 17:12:49 +00:00
|
|
|
|
|
|
|
bool
|
|
|
|
IsSlowRelation(
|
|
|
|
) {
|
|
|
|
return true;
|
|
|
|
}
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
private :
|
|
|
|
|
|
|
|
KX_SlowParentRelation(
|
|
|
|
MT_Scalar relaxation
|
|
|
|
);
|
|
|
|
|
|
|
|
// the relaxation coefficient.
|
|
|
|
|
|
|
|
MT_Scalar m_relax;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Looks like a hack flag to me.
|
|
|
|
* We need to compute valid world coordinates the first
|
|
|
|
* time we update spatial data of the child. This is done
|
|
|
|
* by just doing a normal parent relation the first time
|
|
|
|
* UpdateChildCoordinates is called and then doing the
|
|
|
|
* slow parent relation
|
|
|
|
*/
|
|
|
|
|
|
|
|
bool m_initialized;
|
|
|
|
|
2009-08-18 15:37:31 +00:00
|
|
|
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
2012-06-25 09:14:37 +00:00
|
|
|
MEM_CXX_CLASS_ALLOC_FUNCS("GE:KX_SlowParentRelation")
|
2009-08-18 15:37:31 +00:00
|
|
|
#endif
|
2002-10-12 11:37:38 +00:00
|
|
|
};
|
|
|
|
|
2005-04-23 11:36:44 +00:00
|
|
|
#endif
|