Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members

ForceEffector Class Reference

#include <forceeffector.h>

Inheritance diagram for ForceEffector:

Inheritance graph
[legend]
Collaboration diagram for ForceEffector:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 ForceEffector ()
virtual ~ForceEffector ()
virtual bool Realize (boost::shared_ptr< oxygen::ActionObject > action)
 realizes the action described by the ActionObject
virtual std::string GetPredicate ()
 returns the name of the predicate this effector implements.
virtual boost::shared_ptr<
oxygen::ActionObject
GetActionObject (const oxygen::Predicate &predicate)
 constructs an Actionobject, describing a predicate
virtual void OnLink ()
 setup the reference to the agents body node
virtual void OnUnlink ()
 remove the reference to the agents body node

Protected Attributes

boost::shared_ptr< oxygen::BodymBody
 the reference to the parents body node

Detailed Description

Definition at line 28 of file forceeffector.h.


Constructor & Destructor Documentation

ForceEffector::ForceEffector  ) 
 

Definition at line 32 of file forceeffector.cpp.

ForceEffector::~ForceEffector  )  [virtual]
 

Definition at line 36 of file forceeffector.cpp.


Member Function Documentation

shared_ptr< ActionObject > ForceEffector::GetActionObject const oxygen::Predicate predicate  )  [virtual]
 

constructs an Actionobject, describing a predicate

Implements oxygen::Effector.

Definition at line 64 of file forceeffector.cpp.

References oxygen::Predicate::begin(), zeitgeist::Object::GetLog(), GetPredicate(), oxygen::Predicate::GetValue(), and oxygen::Predicate::name.

Here is the call graph for this function:

virtual std::string ForceEffector::GetPredicate  )  [inline, virtual]
 

returns the name of the predicate this effector implements.

Implements oxygen::Effector.

Definition at line 41 of file forceeffector.h.

Referenced by GetActionObject().

void ForceEffector::OnLink  )  [virtual]
 

setup the reference to the agents body node

Reimplemented from zeitgeist::Leaf.

Definition at line 84 of file forceeffector.cpp.

References zeitgeist::Object::GetLog(), zeitgeist::Leaf::GetParent(), and mBody.

Here is the call graph for this function:

void ForceEffector::OnUnlink  )  [virtual]
 

remove the reference to the agents body node

Reimplemented from zeitgeist::Leaf.

Definition at line 109 of file forceeffector.cpp.

References mBody.

bool ForceEffector::Realize boost::shared_ptr< oxygen::ActionObject action  )  [virtual]
 

realizes the action described by the ActionObject

Implements oxygen::Effector.

Definition at line 40 of file forceeffector.cpp.

References zeitgeist::Object::GetLog(), and mBody.

Here is the call graph for this function:


Member Data Documentation

boost::shared_ptr<oxygen::Body> ForceEffector::mBody [protected]
 

the reference to the parents body node

Definition at line 55 of file forceeffector.h.

Referenced by OnLink(), OnUnlink(), and Realize().


The documentation for this class was generated from the following files:
Generated on Thu Apr 6 15:38:17 2006 for rcssserver3d by  doxygen 1.4.4