EntityComponent Class Reference

Abstraction base class for adding new functionalities to entities. More...

Inheritance diagram for EntityComponent:

[legend]

Collaboration diagram for EntityComponent:

[legend]

List of all members.

Public Member Functions
	EntityComponent (Entity *parent)
	Constructor.
virtual	~EntityComponent ()
	Deconstructor.
void	refAdd ()
	Increases the reference counter.
void	refRelease ()
	Decreases the reference counter.
u32	getID () const
	Gets the ID of this component.
const std::string &	getName () const
	Gets the name of this component.
const Entity *	getParent ()
	Gets the parent of this component.
void	setName (const std::string &name)
	Sets the name of this component.
Static Public Member Functions
static EntityComponent *	refFactory (Entity *parent)
	Will be used to instanciate objects of this class.
Protected Attributes
Entity *	pParent
u32	mID
std::string	mName

---

Detailed Description

Abstraction base class for adding new functionalities to entities.

Definition at line 30 of file EntityComponent.h.

---

Constructor & Destructor Documentation

EntityComponent::EntityComponent

(

Entity *

parent

)

Constructor.

Parameters:

parent

Pointer to parent Entity.

Definition at line 26 of file EntityComponent.cpp.

EntityComponent::~EntityComponent

(

)

[virtual]

Deconstructor.

Definition at line 45 of file EntityComponent.cpp.

---

Member Function Documentation

u32 EntityComponent::getID

(

)

const

Gets the ID of this component.

Definition at line 77 of file EntityComponent.cpp.

const std::string & EntityComponent::getName

(

)

const

Gets the name of this component.

Definition at line 89 of file EntityComponent.cpp.

const Entity * EntityComponent::getParent

(

)

Gets the parent of this component.

Definition at line 95 of file EntityComponent.cpp.

void EntityComponent::refAdd

(

)

Increases the reference counter.

Note:

For internal use only!

Definition at line 56 of file EntityComponent.cpp.

EntityComponent * EntityComponent::refFactory

(

Entity *

parent

)

[static]

Will be used to instanciate objects of this class.

Note:

For internal use only!

Reimplemented in AnimatedMeshComponent, BillboardComponent, CameraComponent, ImageComponent, LightComponent, MeshComponent, SceneComponent, TerrainComponent, TextBillboardComponent, and SoundSourceComponent.

Definition at line 50 of file EntityComponent.cpp.

void EntityComponent::refRelease

(

)

Decreases the reference counter.

Note:

For internal use only!

Definition at line 62 of file EntityComponent.cpp.

void EntityComponent::setName

(

const std::string &

name

)

Sets the name of this component.

Definition at line 83 of file EntityComponent.cpp.

---

Member Data Documentation

u32 EntityComponent::mID [protected]

Definition at line 69 of file EntityComponent.h.

std::string EntityComponent::mName [protected]

Definition at line 70 of file EntityComponent.h.

Entity* EntityComponent::pParent [protected]

Definition at line 67 of file EntityComponent.h.

---

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

• core/EntityComponent.h
• core/EntityComponent.cpp