2011-02-22 19:30:37 +00:00
|
|
|
/*
|
2002-10-12 11:37:38 +00:00
|
|
|
* $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,
|
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
|
|
|
*/
|
|
|
|
|
2011-02-22 19:30:37 +00:00
|
|
|
/** \file SG_Spatial.h
|
|
|
|
* \ingroup bgesg
|
|
|
|
*/
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
#ifndef __SG_SPATIAL_H
|
|
|
|
#define __SG_SPATIAL_H
|
|
|
|
|
|
|
|
#include <MT_Vector3.h>
|
|
|
|
#include <MT_Point3.h>
|
|
|
|
#include <MT_Matrix3x3.h> // or Quaternion later ?
|
|
|
|
#include "SG_IObject.h"
|
2004-05-16 12:54:44 +00:00
|
|
|
#include "SG_BBox.h"
|
2009-06-08 20:08:19 +00:00
|
|
|
#include "SG_ParentRelation.h"
|
2004-05-16 12:54:44 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
class SG_Node;
|
|
|
|
class SG_ParentRelation;
|
|
|
|
|
2004-05-16 12:54:44 +00:00
|
|
|
/**
|
|
|
|
* SG_Spatial contains spatial information (local & world position, rotation
|
|
|
|
* and scaling) for a Scene graph node.
|
|
|
|
* It also contains a link to the node's parent.
|
|
|
|
*/
|
2002-10-12 11:37:38 +00:00
|
|
|
class SG_Spatial : public SG_IObject
|
|
|
|
{
|
|
|
|
|
|
|
|
protected:
|
|
|
|
MT_Point3 m_localPosition;
|
2004-05-21 09:21:15 +00:00
|
|
|
MT_Matrix3x3 m_localRotation;
|
2002-10-12 11:37:38 +00:00
|
|
|
MT_Vector3 m_localScaling;
|
|
|
|
|
|
|
|
MT_Point3 m_worldPosition;
|
2004-05-21 09:21:15 +00:00
|
|
|
MT_Matrix3x3 m_worldRotation;
|
2002-10-12 11:37:38 +00:00
|
|
|
MT_Vector3 m_worldScaling;
|
|
|
|
|
2004-05-21 09:21:15 +00:00
|
|
|
SG_ParentRelation * m_parent_relation;
|
|
|
|
|
|
|
|
SG_BBox m_bbox;
|
|
|
|
MT_Scalar m_radius;
|
2009-04-20 15:06:46 +00:00
|
|
|
bool m_modified;
|
2009-06-08 20:08:19 +00:00
|
|
|
bool m_ogldirty; // true if the openGL matrix for this object must be recomputed
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
public:
|
2009-06-08 20:08:19 +00:00
|
|
|
inline void ClearModified()
|
|
|
|
{
|
|
|
|
m_modified = false;
|
|
|
|
m_ogldirty = true;
|
|
|
|
}
|
|
|
|
inline void SetModified()
|
|
|
|
{
|
|
|
|
m_modified = true;
|
|
|
|
ActivateScheduleUpdateCallback();
|
|
|
|
}
|
|
|
|
inline void ClearDirty()
|
|
|
|
{
|
|
|
|
m_ogldirty = false;
|
|
|
|
}
|
2002-10-12 11:37:38 +00:00
|
|
|
/**
|
|
|
|
* Define the realtionship this node has with it's parent
|
|
|
|
* node. You should pass an unshared instance of an SG_ParentRelation
|
|
|
|
* allocated on the heap to this method. Ownership of this
|
|
|
|
* instance is assumed by this class.
|
|
|
|
* You may call this function several times in the lifetime
|
|
|
|
* of a node to change the relationship dynamically.
|
|
|
|
* You must call this method before the first call to UpdateSpatialData().
|
|
|
|
* An assertion willl be fired at run-time in debug if this is not
|
|
|
|
* the case.
|
|
|
|
* The relation is activated only if no controllers of this object
|
|
|
|
* updated the coordinates of the child.
|
|
|
|
*/
|
|
|
|
|
|
|
|
void
|
|
|
|
SetParentRelation(
|
|
|
|
SG_ParentRelation *relation
|
|
|
|
);
|
2008-06-14 17:12:49 +00:00
|
|
|
|
2009-06-08 20:08:19 +00:00
|
|
|
SG_ParentRelation * GetParentRelation()
|
|
|
|
{
|
|
|
|
return m_parent_relation;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Apply a translation relative to the current position.
|
|
|
|
* if local then the translation is assumed to be in the
|
|
|
|
* local coordinates of this object. If not then the translation
|
|
|
|
* is assumed to be in global coordinates. In this case
|
|
|
|
* you must provide a pointer to the parent of this object if it
|
|
|
|
* exists otherwise if there is no parent set it to NULL
|
|
|
|
*/
|
|
|
|
|
|
|
|
void
|
|
|
|
RelativeTranslate(
|
|
|
|
const MT_Vector3& trans,
|
|
|
|
const SG_Spatial *parent,
|
|
|
|
bool local
|
|
|
|
);
|
|
|
|
|
2009-06-08 20:08:19 +00:00
|
|
|
void SetLocalPosition(const MT_Point3& trans)
|
|
|
|
{
|
|
|
|
m_localPosition = trans;
|
|
|
|
SetModified();
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetWorldPosition(const MT_Point3& trans)
|
|
|
|
{
|
|
|
|
m_worldPosition = trans;
|
|
|
|
}
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
|
|
|
|
void
|
|
|
|
RelativeRotate(
|
|
|
|
const MT_Matrix3x3& rot,
|
|
|
|
bool local
|
|
|
|
);
|
|
|
|
|
2009-06-08 20:08:19 +00:00
|
|
|
void SetLocalOrientation(const MT_Matrix3x3& rot)
|
|
|
|
{
|
|
|
|
m_localRotation = rot;
|
|
|
|
SetModified();
|
|
|
|
}
|
|
|
|
|
|
|
|
// rot is arrange like openGL matrix
|
|
|
|
void SetLocalOrientation(const float* rot)
|
|
|
|
{
|
|
|
|
m_localRotation.setValue(rot);
|
|
|
|
SetModified();
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetWorldOrientation(const MT_Matrix3x3& rot)
|
|
|
|
{
|
|
|
|
m_worldRotation = rot;
|
|
|
|
}
|
|
|
|
|
|
|
|
void RelativeScale(const MT_Vector3& scale)
|
|
|
|
{
|
|
|
|
m_localScaling = m_localScaling * scale;
|
|
|
|
SetModified();
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetLocalScale(const MT_Vector3& scale)
|
|
|
|
{
|
|
|
|
m_localScaling = scale;
|
|
|
|
SetModified();
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetWorldScale(const MT_Vector3& scale)
|
|
|
|
{
|
|
|
|
m_worldScaling = scale;
|
|
|
|
}
|
|
|
|
|
|
|
|
const MT_Point3& GetLocalPosition() const
|
|
|
|
{
|
|
|
|
return m_localPosition;
|
|
|
|
}
|
|
|
|
|
|
|
|
const MT_Matrix3x3& GetLocalOrientation() const
|
|
|
|
{
|
|
|
|
return m_localRotation;
|
|
|
|
}
|
|
|
|
|
|
|
|
const MT_Vector3& GetLocalScale() const
|
|
|
|
{
|
|
|
|
return m_localScaling;
|
|
|
|
}
|
|
|
|
|
|
|
|
const MT_Point3& GetWorldPosition() const
|
|
|
|
{
|
|
|
|
return m_worldPosition;
|
|
|
|
}
|
|
|
|
|
|
|
|
const MT_Matrix3x3& GetWorldOrientation() const
|
|
|
|
{
|
|
|
|
return m_worldRotation;
|
|
|
|
}
|
|
|
|
|
|
|
|
const MT_Vector3& GetWorldScaling() const
|
|
|
|
{
|
|
|
|
return m_worldScaling;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetWorldFromLocalTransform()
|
|
|
|
{
|
|
|
|
m_worldPosition= m_localPosition;
|
|
|
|
m_worldScaling= m_localScaling;
|
|
|
|
m_worldRotation= m_localRotation;
|
|
|
|
}
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
|
2009-02-25 06:43:03 +00:00
|
|
|
|
2004-05-21 09:21:15 +00:00
|
|
|
MT_Transform GetWorldTransform() const;
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2009-06-08 20:08:19 +00:00
|
|
|
bool ComputeWorldTransforms(const SG_Spatial *parent, bool& parentUpdated)
|
|
|
|
{
|
|
|
|
return m_parent_relation->UpdateChildCoordinates(this,parent,parentUpdated);
|
|
|
|
}
|
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
|
2004-05-16 12:54:44 +00:00
|
|
|
/**
|
|
|
|
* Bounding box functions.
|
|
|
|
*/
|
2009-06-08 20:08:19 +00:00
|
|
|
SG_BBox& BBox()
|
|
|
|
{
|
|
|
|
return m_bbox;
|
|
|
|
}
|
|
|
|
|
|
|
|
void SetBBox(SG_BBox& bbox)
|
|
|
|
{
|
|
|
|
m_bbox = bbox;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2004-05-16 12:54:44 +00:00
|
|
|
bool inside(const MT_Point3 &point) const;
|
|
|
|
void getBBox(MT_Point3 *box) const;
|
|
|
|
void getAABBox(MT_Point3 *box) const;
|
2004-05-21 09:21:15 +00:00
|
|
|
|
|
|
|
MT_Scalar Radius() const { return m_radius; }
|
|
|
|
void SetRadius(MT_Scalar radius) { m_radius = radius; }
|
2009-04-20 15:06:46 +00:00
|
|
|
bool IsModified() { return m_modified; }
|
2009-06-08 20:08:19 +00:00
|
|
|
bool IsDirty() { return m_ogldirty; }
|
2004-05-21 09:21:15 +00:00
|
|
|
|
2002-10-12 11:37:38 +00:00
|
|
|
protected:
|
2002-11-05 19:54:23 +00:00
|
|
|
friend class SG_Controller;
|
2009-04-20 15:06:46 +00:00
|
|
|
friend class KX_BoneParentRelation;
|
|
|
|
friend class KX_VertexParentRelation;
|
|
|
|
friend class KX_SlowParentRelation;
|
|
|
|
friend class KX_NormalParentRelation;
|
2002-10-12 11:37:38 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Protected constructor this class is not
|
|
|
|
* designed for direct instantiation
|
|
|
|
*/
|
|
|
|
|
|
|
|
SG_Spatial(
|
|
|
|
void* clientobj,
|
|
|
|
void* clientinfo,
|
2009-06-08 20:08:19 +00:00
|
|
|
SG_Callbacks& callbacks
|
2002-10-12 11:37:38 +00:00
|
|
|
);
|
|
|
|
|
|
|
|
SG_Spatial(
|
|
|
|
const SG_Spatial& other
|
|
|
|
);
|
|
|
|
|
|
|
|
|
|
|
|
virtual ~SG_Spatial();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Update the world coordinates of this spatial node. This also informs
|
|
|
|
* any controllers to update this object.
|
|
|
|
*/
|
|
|
|
|
2004-05-26 12:06:41 +00:00
|
|
|
bool
|
2002-10-12 11:37:38 +00:00
|
|
|
UpdateSpatialData(
|
|
|
|
const SG_Spatial *parent,
|
2009-04-20 15:06:46 +00:00
|
|
|
double time,
|
|
|
|
bool& parentUpdated
|
2002-10-12 11:37:38 +00:00
|
|
|
);
|
|
|
|
|
2009-08-18 15:37:31 +00:00
|
|
|
|
|
|
|
#ifdef WITH_CXX_GUARDEDALLOC
|
|
|
|
public:
|
2010-06-06 01:15:44 +00:00
|
|
|
void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:SG_Spatial"); }
|
2009-08-18 15:37:31 +00:00
|
|
|
void operator delete( void *mem ) { MEM_freeN(mem); }
|
|
|
|
#endif
|
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 //__SG_SPATIAL_H
|
2002-10-30 02:07:20 +00:00
|
|
|
|