GameEngine::GameObjectComponent Class Reference

#include <GameObjectComponent.h>

Inheritance diagram for GameEngine::GameObjectComponent:

Inheritance graph
[legend]
Collaboration diagram for GameEngine::GameObjectComponent:

Collaboration graph
[legend]
List of all members.

Detailed Description

A GameObjectComponent is a component

Definition at line 32 of file GameObjectComponent.h.

Public Member Functions

 GameObjectComponent ()
virtual bool init ()
virtual void destroy ()
void setParent (boost::shared_ptr< GameObject > parent)
boost::shared_ptr< GameObjectgetParent ()

Protected Attributes

boost::shared_ptr< GameObjectmParent


Constructor & Destructor Documentation

GameEngine::GameObjectComponent::GameObjectComponent (  )  [inline]

Constructor

Definition at line 37 of file GameObjectComponent.h.


Member Function Documentation

virtual bool GameEngine::GameObjectComponent::init ( void   )  [inline, virtual]

Initialise the component. Subclasses should call this function if overriding it

Reimplemented from GameEngine::Process.

Reimplemented in GameEngine::GraphicalComponent.

Definition at line 43 of file GameObjectComponent.h.

virtual void GameEngine::GameObjectComponent::destroy (  )  [inline, virtual]

Destroy the component. Subclasses should call this function if ovveriding it.

Reimplemented from GameEngine::Process.

Reimplemented in GameEngine::GraphicalComponent.

Definition at line 53 of file GameObjectComponent.h.

void GameEngine::GameObjectComponent::setParent ( boost::shared_ptr< GameObject parent  )  [inline]

Set the components parent object

Parameters:
parent The game object which is to be this components parent

Definition at line 62 of file GameObjectComponent.h.

boost::shared_ptr<GameObject> GameEngine::GameObjectComponent::getParent (  )  [inline]

Get the components parent

Returns:
The game object which is the parent of this component

Definition at line 67 of file GameObjectComponent.h.


Member Data Documentation

boost::shared_ptr<GameObject> GameEngine::GameObjectComponent::mParent [protected]

Definition at line 70 of file GameObjectComponent.h.


The documentation for this class was generated from the following file:
Generated on Thu Apr 19 09:48:46 2007 for GameEngine by  doxygen 1.5.2