castor3d::MovableObject Class Reference

#include <MovableObject.hpp>

Inheritance diagram for castor3d::MovableObject:

Collaboration diagram for castor3d::MovableObject:

Public Member Functions
C3D_API	MovableObject (castor::String const &name, Scene &scene, MovableType type, SceneNode &node)
	Constructor. More...
C3D_API	MovableObject (castor::String const &name, Scene &scene, MovableType type)
	Constructor. More...
virtual C3D_API	~MovableObject ()
	Destructor. More...
C3D_API void	detach ()
	Detaches the movable object from it's parent. More...
virtual C3D_API void	attachTo (SceneNode &node)
	Attaches the movable object to a node. More...
C3D_API EngineRPtr	getEngine () const
SceneNode *	getParent () const
MovableType	getType () const

Protected Attributes
MovableType	m_type
castor::String	m_strNodeName
SceneNode *	m_sceneNode
OnSceneNodeChangedConnection	m_notifyIndex

Constructor & Destructor Documentation

MovableObject() [1/2]

C3D_API castor3d::MovableObject::MovableObject	(	castor::String const &	name,
		Scene &	scene,
		MovableType	type,
		SceneNode &	node
	)

Constructor.

Parameters

[in]	name	The name
[in]	scene	The parent scene
[in]	node	Parent node
[in]	type	MovableObject type

MovableObject() [2/2]

C3D_API castor3d::MovableObject::MovableObject	(	castor::String const &	name,
		Scene &	scene,
		MovableType	type
	)

Constructor.

Parameters

[in]	name	The name
[in]	scene	The parent scene
[in]	type	MovableObject type

~MovableObject()

virtual C3D_API castor3d::MovableObject::~MovableObject ( )

virtual

Destructor.

Member Function Documentation

attachTo()

virtual C3D_API void castor3d::MovableObject::attachTo ( SceneNode &  node )

virtual

Attaches the movable object to a node.

Reimplemented in castor3d::BillboardList, castor3d::Camera, and castor3d::Light.

detach()

C3D_API void castor3d::MovableObject::detach

(

)

Detaches the movable object from it's parent.

getEngine()

C3D_API EngineRPtr castor3d::MovableObject::getEngine

(

)

const

getParent()

SceneNode * castor3d::MovableObject::getParent ( ) const

inline

References m_sceneNode.

getType()

MovableType castor3d::MovableObject::getType ( ) const

inline

References m_type.

Member Data Documentation

m_notifyIndex

OnSceneNodeChangedConnection castor3d::MovableObject::m_notifyIndex

protected

The node change notification index.

m_sceneNode

SceneNode* castor3d::MovableObject::m_sceneNode

protected

The parent scene node.

Referenced by getParent().

m_strNodeName

castor::String castor3d::MovableObject::m_strNodeName

protected

The parent node name.

m_type

MovableType castor3d::MovableObject::m_type

protected

Movable object type.

Referenced by getType().

---

The documentation for this class was generated from the following file:

• Scene/MovableObject.hpp