Home | Namespaces | Hierarchy | Alphabetical List | Class list | Files | Namespace Members | Class members | File members

nge::game::GameEntity Class Reference

#include <GameEntity.hpp>

Inheritance diagram for nge::game::GameEntity:

nge::engine::ILevelNode irr::IReferenceCounted nge::game::IActor nge::game::IItemEntity nge::game::INPC nge::game::IPlayer nge::game::PlayerSpaceship

List of all members.

Public Member Functions

 GameEntity (ILevelNode *parent, ILevelManager *lmgr, ISceneNode *SceneNode, s32 id)
 Constructor.
virtual f32 getMass () const
 Returns the physical amount of mass this entity has.
virtual f32 getMoveSpeed () const
 Get the entity's movement speed.
virtual f32 getRotateSpeed () const
 Get the entity's rotation speed.
virtual ISceneNodegetSceneNode () const
virtual E_LEVEL_NODE_TYPE getType () const
 Returns type of the level node.
virtual void invertRotation (bool X, bool Y)
 Set should the rotation on both X and Y axes be inverted.
virtual void invertXRotation (bool isInvert)
 Set should the rotation on the X axis be inverted.
virtual void invertYRotation (bool isInvert)
 Set should the rotation on the Y axis be inverted.
virtual bool isTriggered () const
virtual bool isVerticalMovementEnabled ()
 Returns if the entity could move vertically or not.
virtual bool isXRotationInverted () const
 Returns whether the rotation on the X axis is inverted or not.
virtual bool isYRotationInverted () const
 Returns whether the rotation on the Y axis is inverted or not.
virtual void OnEvent (const NGEReceiver *event)
virtual void OnRegisterLevelNode ()
 This method is called just before the processing of the node.
virtual void process ()=0
 Process the node.
virtual void setMass (const f32 Mass)
 Sets the physical amount of mass this entity has.
virtual void setMoveSpeed (f32 speed)
 Set the entity's movement speed.
virtual void setRotateSpeed (f32 speed)
 Set the entity's rotation speed.
virtual void setSceneNode (ISceneNode *node)
virtual void setTriggered (bool isTriggered)
virtual void setVerticalMovementEnabled (bool enabled)
 Sets if the entity could move vertically or not.
virtual void toggleTriggered ()
virtual ~GameEntity ()
 Destructor.

Protected Attributes

ISceneNodeControllerAnimatorm_pMovementAnimator

Private Attributes

bool m_IsTriggered
f32 m_Mass
ISceneNodem_pSceneNode


Detailed Description

Definition at line 21 of file GameEntity.hpp.


Constructor & Destructor Documentation

nge::game::GameEntity::GameEntity ( ILevelNode parent,
ILevelManager lmgr,
ISceneNode SceneNode,
s32  id 
)

Constructor.

virtual nge::game::GameEntity::~GameEntity (  )  [virtual]

Destructor.


Member Function Documentation

virtual f32 nge::game::GameEntity::getMass (  )  const [virtual]

Returns the physical amount of mass this entity has.

virtual f32 nge::game::GameEntity::getMoveSpeed (  )  const [virtual]

Get the entity's movement speed.

virtual f32 nge::game::GameEntity::getRotateSpeed (  )  const [virtual]

Get the entity's rotation speed.

virtual ISceneNode* nge::game::GameEntity::getSceneNode (  )  const [virtual]

virtual E_LEVEL_NODE_TYPE nge::game::GameEntity::getType (  )  const [virtual]

Returns type of the level node.

Reimplemented from nge::engine::ILevelNode.

Reimplemented in nge::game::IPlayer.

virtual void nge::game::GameEntity::invertRotation ( bool  X,
bool  Y 
) [virtual]

Set should the rotation on both X and Y axes be inverted.

virtual void nge::game::GameEntity::invertXRotation ( bool  isInvert  )  [virtual]

Set should the rotation on the X axis be inverted.

virtual void nge::game::GameEntity::invertYRotation ( bool  isInvert  )  [virtual]

Set should the rotation on the Y axis be inverted.

virtual bool nge::game::GameEntity::isTriggered (  )  const [virtual]

virtual bool nge::game::GameEntity::isVerticalMovementEnabled (  )  [virtual]

Returns if the entity could move vertically or not.

virtual bool nge::game::GameEntity::isXRotationInverted (  )  const [virtual]

Returns whether the rotation on the X axis is inverted or not.

virtual bool nge::game::GameEntity::isYRotationInverted (  )  const [virtual]

Returns whether the rotation on the Y axis is inverted or not.

virtual void nge::game::GameEntity::OnEvent ( const NGEReceiver event  )  [virtual]

Reimplemented from nge::engine::ILevelNode.

virtual void nge::game::GameEntity::OnRegisterLevelNode (  )  [virtual]

This method is called just before the processing of the node.

Nodes may register themselves in the process pipeline during this call, precalculate everything that should be processed, and prevent their children from being able to register themselves if they are idle by simply not calling their OnRegisterLevelNode() method. If you are implementing your own level node, you should override this method with an implementtion code looking like this:

                        if(!IsIdle)
                        LevelManager->registerNodeForProcessing(this, pass);

                        ILevelNode::OnRegisterLevelNode();

Reimplemented from nge::engine::ILevelNode.

Reimplemented in nge::game::IPlayer.

virtual void nge::game::GameEntity::process (  )  [pure virtual]

Process the node.

Implements nge::engine::ILevelNode.

Implemented in nge::game::PlayerSpaceship.

virtual void nge::game::GameEntity::setMass ( const f32  Mass  )  [virtual]

Sets the physical amount of mass this entity has.

virtual void nge::game::GameEntity::setMoveSpeed ( f32  speed  )  [virtual]

Set the entity's movement speed.

virtual void nge::game::GameEntity::setRotateSpeed ( f32  speed  )  [virtual]

Set the entity's rotation speed.

virtual void nge::game::GameEntity::setSceneNode ( ISceneNode node  )  [virtual]

virtual void nge::game::GameEntity::setTriggered ( bool  isTriggered  )  [virtual]

virtual void nge::game::GameEntity::setVerticalMovementEnabled ( bool  enabled  )  [virtual]

Sets if the entity could move vertically or not.

virtual void nge::game::GameEntity::toggleTriggered (  )  [virtual]


Member Data Documentation

Definition at line 91 of file GameEntity.hpp.

Definition at line 93 of file GameEntity.hpp.

Definition at line 88 of file GameEntity.hpp.

Definition at line 92 of file GameEntity.hpp.


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

The NUSoftware Game Engine
The NUSoftware Game Engine Documentation © 2007-2008 by Tomer Nosrati. Generated on Sat Apr 26 16:52:36 2008 by Doxygen (1.5.5)