lse::CEntity Class Reference

An entity is simply the most abstract form of a "thing" in the game world. More...

#include <LSEEntity.h>

Inheritance diagram for lse::CEntity:

List of all members.

Public Member Functions
virtual LSUINT32 LSE_CALL	EntityType () const
virtual LSVOID LSE_CALL	SetEntityParent (CEntity *_peParent)
virtual LSBOOL LSE_CALL	AddEntityChild (CEntity *_peChild)
virtual LSBOOL LSE_CALL	RemEntityChild (CEntity *_peChild)
LSE_INLINE CEntity *LSE_CALL	EntityParent ()
LSE_INLINE const CEntity *LSE_CALL	EntityParent () const
LSE_INLINE CEntity *LSE_CALL	EntityGrandFather () const
Protected Attributes
CVectorPoD< CEntity *, LSUINT32 >	m_vEntityChildren
CEntity *	m_peParent

---

Detailed Description

An entity is simply the most abstract form of a "thing" in the game world.

Class CEntity Description: An entity is simply the most abstract form of a "thing" in the game world. This base class provides a parent/child system. All entities can be parented and have children.

---

Member Function Documentation

virtual LSBOOL LSE_CALL lse::CEntity::AddEntityChild

(

CEntity *

_peChild

)

[virtual]

Add a child.

Parameters:

_peChild

The child to add.

Returns:

Returns true if there was enough RAM to add the child.

LSE_INLINE CEntity *LSE_CALL lse::CEntity::EntityGrandFather

(

)

const

Gets the upper-most parent of this entity or NULL if there are no parents.

Returns:

Returns the upper-most parent of this entity if any.

LSE_INLINE CEntity *LSE_CALL lse::CEntity::EntityParent

(

)

Gets the parent of this entity, which may be NULL.

Returns:

Returns the parent of this entity, if any.

LSE_INLINE const CEntity *LSE_CALL lse::CEntity::EntityParent

(

)

const

Gets the parent of this entity, which may be NULL.

Returns:

Returns the parent of this entity, if any.

virtual LSUINT32 LSE_CALL lse::CEntity::EntityType

(

)

const [virtual]

Get the entity type.

Returns:

Returns the type mask for this entity.

Reimplemented in lse::CCamera, lse::CActor, lse::CMeshInstance, and lse::CModelInstance.

virtual LSBOOL LSE_CALL lse::CEntity::RemEntityChild

(

CEntity *

_peChild

)

[virtual]

Remove a child.

Parameters:

_peChild

The child to add.

Returns:

Returns true if the given pointer was a child of this entity.

virtual LSVOID LSE_CALL lse::CEntity::SetEntityParent

(

CEntity *

_peParent

)

[virtual]

Set our parent.

Parameters:

_peParent

A pointer to our new parent.

Reimplemented in lse::CActor.

---

Member Data Documentation

CEntity* lse::CEntity::m_peParent [protected]

Our parent.

CVectorPoD<CEntity *, LSUINT32> lse::CEntity::m_vEntityChildren [protected]

Our list of children.

---

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

• F:/My Projects/LSEngine/Modules/LSEngine/Src/Entity/LSEEntity.h