Castor3D::MovableObject Class Reference

Movable object class. More...

Inheritance diagram for Castor3D::MovableObject:

Collaboration diagram for Castor3D::MovableObject:

Classes
class	BinaryParser
	MovableObject loader. More...
class	TextLoader
	MovableObject loader. More...

Public Member Functions
C3D_API	MovableObject (Castor::String const &p_name, Scene &p_scene, eMOVABLE_TYPE p_type, SceneNodeSPtr p_sn)
	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 (SceneNodeSPtr p_node)
	Attaches the movable object to a node. More...
Castor::String const &	GetName () const
	Retrieves the object name. More...
SceneNodeSPtr	GetParent () const
	Retrieves the parent node. More...
eMOVABLE_TYPE	GetType () const
	Retrieves the object type. More...
void	SetName (Castor::String const &p_name)
	Sets the object name. More...
Public Member Functions inherited from Castor3D::Animable
C3D_API AnimationSPtr	CreateAnimation (Castor::String const &p_name)
	Creates an animation. More...
C3D_API void	CleanupAnimations ()
	Empties the animations map. More...
C3D_API AnimationSPtr	GetAnimation (Castor::String const &p_name)
	Retrieves an animation. More...
AnimationPtrStrMap const &	GetAnimations () const

Protected Attributes
eMOVABLE_TYPE	m_type
	Movable object type. More...
Castor::String	m_name
	The object name. More...
Castor::String	m_strNodeName
	The parent node name. More...
SceneNodeWPtr	m_pSceneNode
	The parent scene node. More...
uint32_t	m_notifyIndex = 0
	The node change notification index. More...
Protected Attributes inherited from Castor3D::Animable
AnimationPtrStrMap	m_animations
	All animations. More...

Additional Inherited Members
Protected Member Functions inherited from Castor3D::Animable
	Animable ()
	Constructor. More...
	~Animable ()
	Destructor. More...

Detailed Description

Movable object class.

Author

Sylvain DOREMUS

Version

0.1

Date

09/02/2010

Constructor & Destructor Documentation

MovableObject()

C3D_API Castor3D::MovableObject::MovableObject	(	Castor::String const &	p_name,
		Scene &	p_scene,
		eMOVABLE_TYPE	p_type,
		SceneNodeSPtr	p_sn
	)

Constructor.

Parameters

[in]	p_name	The name
[in]	p_scene	The parent scene
[in]	p_sn	Parent node
[in]	p_type	MovableObject type

~MovableObject()

virtual C3D_API Castor3D::MovableObject::~MovableObject ( )

virtual

Destructor.

Member Function Documentation

AttachTo()

virtual C3D_API void Castor3D::MovableObject::AttachTo ( SceneNodeSPtr  p_node )

virtual

Attaches the movable object to a node.

Reimplemented in Castor3D::Light.

Detach()

C3D_API void Castor3D::MovableObject::Detach

(

)

Detaches the movable object from it's parent.

GetName()

Castor::String const& Castor3D::MovableObject::GetName ( ) const

inline

Retrieves the object name.

Returns

The value

References m_name.

GetParent()

SceneNodeSPtr Castor3D::MovableObject::GetParent ( ) const

inline

Retrieves the parent node.

Returns

The value

References m_pSceneNode.

GetType()

eMOVABLE_TYPE Castor3D::MovableObject::GetType ( ) const

inline

Retrieves the object type.

Returns

The value

References m_type.

SetName()

void Castor3D::MovableObject::SetName ( Castor::String const &  p_name )

inline

Sets the object name.

Parameters

[in]

p_name

The new value

References m_name.

Member Data Documentation

m_name

Castor::String Castor3D::MovableObject::m_name

protected

The object name.

Referenced by GetName(), and SetName().

m_notifyIndex

uint32_t Castor3D::MovableObject::m_notifyIndex = 0

protected

The node change notification index.

m_pSceneNode

SceneNodeWPtr Castor3D::MovableObject::m_pSceneNode

protected

The parent scene node.

Referenced by GetParent().

m_strNodeName

Castor::String Castor3D::MovableObject::m_strNodeName

protected

The parent node name.

m_type

eMOVABLE_TYPE Castor3D::MovableObject::m_type

protected

Movable object type.

Referenced by GetType().

---

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

• Z:/Projets/C++/Castor3D/source/Core/Castor3D/Src/MovableObject.hpp