#include <SG_Spatial.h>

Inheritance diagram for SG_Spatial:

Public Member Functions
void	ClearModified ()
void	SetModified ()
void	ClearDirty ()
void	SetParentRelation (SG_ParentRelation *relation)
SG_ParentRelation *	GetParentRelation ()
void	RelativeTranslate (const MT_Vector3 &trans, const SG_Spatial *parent, bool local)
void	SetLocalPosition (const MT_Point3 &trans)
void	SetWorldPosition (const MT_Point3 &trans)
void	RelativeRotate (const MT_Matrix3x3 &rot, bool local)
void	SetLocalOrientation (const MT_Matrix3x3 &rot)
void	SetLocalOrientation (const float *rot)
void	SetWorldOrientation (const MT_Matrix3x3 &rot)
void	RelativeScale (const MT_Vector3 &scale)
void	SetLocalScale (const MT_Vector3 &scale)
void	SetWorldScale (const MT_Vector3 &scale)
const MT_Point3 &	GetLocalPosition () const
const MT_Matrix3x3 &	GetLocalOrientation () const
const MT_Vector3 &	GetLocalScale () const
const MT_Point3 &	GetWorldPosition () const
const MT_Matrix3x3 &	GetWorldOrientation () const
const MT_Vector3 &	GetWorldScaling () const
void	SetWorldFromLocalTransform ()
MT_Transform	GetWorldTransform () const
bool	ComputeWorldTransforms (const SG_Spatial *parent, bool &parentUpdated)
SG_BBox &	BBox ()
void	SetBBox (SG_BBox &bbox)
bool	inside (const MT_Point3 &point) const
void	getBBox (MT_Point3 *box) const
void	getAABBox (MT_Point3 *box) const
MT_Scalar	Radius () const
void	SetRadius (MT_Scalar radius)
bool	IsModified ()
bool	IsDirty ()
Protected Member Functions
	SG_Spatial (void clientobj, void clientinfo, SG_Callbacks &callbacks)
	SG_Spatial (const SG_Spatial &other)
virtual	~SG_Spatial ()
bool	UpdateSpatialData (const SG_Spatial *parent, double time, bool &parentUpdated)
Protected Attributes
MT_Point3	m_localPosition
MT_Matrix3x3	m_localRotation
MT_Vector3	m_localScaling
MT_Point3	m_worldPosition
MT_Matrix3x3	m_worldRotation
MT_Vector3	m_worldScaling
SG_ParentRelation *	m_parent_relation
SG_BBox	m_bbox
MT_Scalar	m_radius
bool	m_modified
bool	m_ogldirty
Friends
class	SG_Controller
class	KX_BoneParentRelation
class	KX_VertexParentRelation
class	KX_SlowParentRelation
class	KX_NormalParentRelation

Detailed Description

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.

Definition at line 53 of file SG_Spatial.h.

Constructor & Destructor Documentation

SG_Spatial::SG_Spatial	(	void *	clientobj,
		void *	clientinfo,
		SG_Callbacks &	callbacks
	)		`[protected]`

Protected constructor this class is not designed for direct instantiation

Definition at line 41 of file SG_Spatial.cpp.

SG_Spatial::SG_Spatial ( const SG_Spatial & other ) [protected]

Definition at line 66 of file SG_Spatial.cpp.

References m_parent_relation, and SG_ParentRelation::NewCopy().

SG_Spatial::~SG_Spatial ( ) [protected, virtual]

Definition at line 90 of file SG_Spatial.cpp.

References m_parent_relation.

Member Function Documentation

SG_BBox& SG_Spatial::BBox ( ) [inline]

Bounding box functions.

Definition at line 233 of file SG_Spatial.h.

References m_bbox.

Referenced by KX_Scene::AddReplicaObject(), BL_ConvertBlenderObjects(), KX_Scene::DupliGroupRecurse(), SG_Tree::Find(), and SG_Tree::SG_Tree().

void SG_Spatial::ClearDirty ( ) [inline]

Definition at line 83 of file SG_Spatial.h.

References m_ogldirty.

Referenced by KX_GameObject::GetOpenGLMatrix().

void SG_Spatial::ClearModified ( ) [inline]

Definition at line 73 of file SG_Spatial.h.

References m_modified, and m_ogldirty.

Referenced by KX_NormalParentRelation::UpdateChildCoordinates(), KX_BoneParentRelation::UpdateChildCoordinates(), KX_VertexParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

bool SG_Spatial::ComputeWorldTransforms	(	const SG_Spatial *	parent,
		bool &	parentUpdated
	)		`[inline]`

Definition at line 224 of file SG_Spatial.h.

References m_parent_relation, and SG_ParentRelation::UpdateChildCoordinates().

Referenced by UpdateSpatialData().

void SG_Spatial::getAABBox ( MT_Point3 * box ) const

Definition at line 214 of file SG_Spatial.cpp.

References SG_BBox::getaa(), GetWorldTransform(), and m_bbox.

void SG_Spatial::getBBox ( MT_Point3 * box ) const

Definition at line 209 of file SG_Spatial.cpp.

References SG_BBox::get(), GetWorldTransform(), and m_bbox.

Referenced by KX_Scene::MarkVisible().

const MT_Matrix3x3& SG_Spatial::GetLocalOrientation ( ) const [inline]

Definition at line 188 of file SG_Spatial.h.

References m_localRotation.

Referenced by KX_Scene::AddNodeReplicaObject(), KX_TrackToActuator::KX_TrackToActuator(), KX_GameObject::NodeGetLocalOrientation(), KX_Dome::RenderDomeFrame(), KX_Dome::RotateCamera(), KX_IpoSGController::Update(), KX_NormalParentRelation::UpdateChildCoordinates(), KX_BoneParentRelation::UpdateChildCoordinates(), KX_VertexParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

const MT_Point3& SG_Spatial::GetLocalPosition ( ) const [inline]

Definition at line 183 of file SG_Spatial.h.

References m_localPosition.

Referenced by KX_Scene::AddNodeReplicaObject(), KX_GameObject::NodeGetLocalPosition(), KX_TrackToActuator::Update(), KX_IpoSGController::Update(), KX_ConstraintActuator::Update(), KX_NormalParentRelation::UpdateChildCoordinates(), KX_BoneParentRelation::UpdateChildCoordinates(), KX_VertexParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

const MT_Vector3& SG_Spatial::GetLocalScale ( ) const [inline]

Definition at line 193 of file SG_Spatial.h.

References m_localScaling.

Referenced by KX_Scene::AddNodeReplicaObject(), KX_Scene::AddReplicaObject(), GPC_RenderTools::applyTransform(), KX_BlenderRenderTools::applyTransform(), KX_GameObject::NodeGetLocalScaling(), KX_GameObject::NodeSetRelativeScale(), KX_IpoSGController::Update(), KX_NormalParentRelation::UpdateChildCoordinates(), KX_BoneParentRelation::UpdateChildCoordinates(), KX_VertexParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

SG_ParentRelation* SG_Spatial::GetParentRelation ( ) [inline]

Definition at line 106 of file SG_Spatial.h.

References m_parent_relation.

const MT_Matrix3x3& SG_Spatial::GetWorldOrientation ( ) const [inline]

Definition at line 203 of file SG_Spatial.h.

References m_worldRotation.

Referenced by KX_GameObject::AlignAxisToVect(), KX_GameObject::GetAngularVelocity(), KX_GameObject::GetLinearVelocity(), KX_MotionState::getWorldOrientation(), KX_GameObject::NodeGetWorldOrientation(), KX_GameObject::NodeSetWorldPosition(), RelativeRotate(), RelativeTranslate(), ImageRender::Render(), KX_IpoSGController::Update(), KX_NormalParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

const MT_Point3& SG_Spatial::GetWorldPosition ( ) const [inline]

Definition at line 198 of file SG_Spatial.h.

References m_worldPosition.

Referenced by KX_MotionState::getWorldPosition(), KX_GameObject::NodeGetWorldPosition(), KX_GameObject::NodeSetWorldPosition(), KX_GameObject::RemoveParent(), ImageRender::Render(), KX_NormalParentRelation::UpdateChildCoordinates(), KX_VertexParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

const MT_Vector3& SG_Spatial::GetWorldScaling ( ) const [inline]

Definition at line 208 of file SG_Spatial.h.

References m_worldScaling.

Referenced by KX_GameObject::GetOpenGLMatrix(), KX_MotionState::getWorldScaling(), KX_Scene::MarkVisible(), KX_GameObject::NodeGetWorldScaling(), KX_GameObject::NodeSetWorldPosition(), ImageRender::Render(), KX_NormalParentRelation::UpdateChildCoordinates(), and KX_SlowParentRelation::UpdateChildCoordinates().

MT_Transform SG_Spatial::GetWorldTransform ( ) const

Definition at line 194 of file SG_Spatial.cpp.

References m_worldPosition, m_worldRotation, m_worldScaling, and MT_Matrix3x3::scaled().

Referenced by getAABBox(), getBBox(), inside(), SG_Tree::SG_Tree(), and KX_BoneParentRelation::UpdateChildCoordinates().

bool SG_Spatial::inside ( const MT_Point3 & point ) const

Definition at line 201 of file SG_Spatial.cpp.

References MT_Vector3::closestAxis(), MT_Point3::distance2(), GetWorldTransform(), SG_BBox::inside(), m_bbox, m_radius, m_worldPosition, m_worldScaling, and SG_BBox::transform().

Referenced by KX_Scene::MarkVisible().

bool SG_Spatial::IsDirty ( ) [inline]

Definition at line 251 of file SG_Spatial.h.

References m_ogldirty.

bool SG_Spatial::IsModified ( ) [inline]

Definition at line 250 of file SG_Spatial.h.

References m_modified.

Referenced by KX_NormalParentRelation::UpdateChildCoordinates(), and KX_VertexParentRelation::UpdateChildCoordinates().

MT_Scalar SG_Spatial::Radius ( ) const [inline]

Definition at line 248 of file SG_Spatial.h.

References m_radius.

Referenced by KX_Scene::AddReplicaObject(), KX_Scene::DupliGroupRecurse(), and KX_Scene::MarkVisible().

void SG_Spatial::RelativeRotate	(	const MT_Matrix3x3 &	rot,
		bool	local
	)

Scaling methods. Orientation and rotation methods.

Definition at line 180 of file SG_Spatial.cpp.

References GetWorldOrientation(), MT_Matrix3x3::inverse(), m_localRotation, and SetModified().

Referenced by KX_GameObject::ApplyRotation().

void SG_Spatial::RelativeScale ( const MT_Vector3 & scale ) [inline]

Definition at line 166 of file SG_Spatial.h.

References m_localScaling, and SetModified().

Referenced by KX_GameObject::NodeSetRelativeScale().

void SG_Spatial::RelativeTranslate	(	const MT_Vector3 &	trans,
		const SG_Spatial *	parent,
		bool	local
	)

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

Position and translation methods

Definition at line 150 of file SG_Spatial.cpp.

References GetWorldOrientation(), m_localPosition, m_localRotation, and SetModified().

Referenced by KX_GameObject::ApplyMovement().

void SG_Spatial::SetBBox ( SG_BBox & bbox ) [inline]

Definition at line 238 of file SG_Spatial.h.

References m_bbox.

Referenced by KX_Scene::AddReplicaObject(), KX_Scene::DupliGroupRecurse(), and gameobject_from_blenderobject().

void SG_Spatial::SetLocalOrientation ( const MT_Matrix3x3 & rot ) [inline]

Definition at line 148 of file SG_Spatial.h.

References m_localRotation, and SetModified().

Referenced by KX_Scene::AddNodeReplicaObject(), BL_ConvertBlenderObjects(), KX_GameObject::NodeSetGlobalOrientation(), KX_GameObject::NodeSetLocalOrientation(), KX_GameObject::RemoveParent(), ImageRender::Render(), and KX_MotionState::setWorldOrientation().

void SG_Spatial::SetLocalOrientation ( const float * rot ) [inline]

Definition at line 155 of file SG_Spatial.h.

References m_localRotation, SetModified(), and MT_Matrix3x3::setValue().

void SG_Spatial::SetLocalPosition ( const MT_Point3 & trans ) [inline]

Definition at line 130 of file SG_Spatial.h.

References m_localPosition, and SetModified().

Referenced by KX_Scene::AddNodeReplicaObject(), BL_ConvertBlenderObjects(), KX_GameObject::NodeSetLocalPosition(), KX_GameObject::RemoveParent(), ImageRender::Render(), and KX_MotionState::setWorldPosition().

void SG_Spatial::SetLocalScale ( const MT_Vector3 & scale ) [inline]

Definition at line 172 of file SG_Spatial.h.

References m_localScaling, and SetModified().

Referenced by KX_Scene::AddNodeReplicaObject(), BL_ConvertBlenderObjects(), KX_GameObject::NodeSetLocalScale(), and KX_GameObject::RemoveParent().

void SG_Spatial::SetModified ( ) [inline]

Definition at line 78 of file SG_Spatial.h.

References SG_IObject::ActivateScheduleUpdateCallback(), and m_modified.

Referenced by RelativeRotate(), RelativeScale(), RelativeTranslate(), SetLocalOrientation(), SetLocalPosition(), SetLocalScale(), and SetParentRelation().

void SG_Spatial::SetParentRelation ( SG_ParentRelation * relation )

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.

Definition at line 97 of file SG_Spatial.cpp.

References m_parent_relation, and SetModified().

Referenced by KX_Scene::AddNodeReplicaObject(), BL_ConvertBlenderObjects(), and KX_GameObject::KX_GameObject().

void SG_Spatial::SetRadius ( MT_Scalar radius ) [inline]

Definition at line 249 of file SG_Spatial.h.

References m_radius.

Referenced by KX_Scene::AddReplicaObject(), KX_Scene::DupliGroupRecurse(), and gameobject_from_blenderobject().

void SG_Spatial::SetWorldFromLocalTransform ( ) [inline]

Definition at line 213 of file SG_Spatial.h.

References m_localPosition, m_localRotation, m_localScaling, m_worldPosition, m_worldRotation, and m_worldScaling.

Referenced by KX_NormalParentRelation::UpdateChildCoordinates(), and KX_BoneParentRelation::UpdateChildCoordinates().

void SG_Spatial::SetWorldOrientation ( const MT_Matrix3x3 & rot ) [inline]