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

HingeEffector Class Reference

#include <hingeeffector.h>

Inheritance diagram for HingeEffector:

Inheritance graph
[legend]
Collaboration diagram for HingeEffector:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 HingeEffector ()
virtual ~HingeEffector ()
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

Protected Member Functions

virtual void OnLink ()
 setup the reference to the HingeJoint parent node
virtual void OnUnlink ()
 remove the reference to the HingeJoint parent node

Protected Attributes

boost::shared_ptr< oxygen::HingeJointmJoint
 cached reference to the monitor joint

Detailed Description

Definition at line 26 of file hingeeffector.h.


Constructor & Destructor Documentation

HingeEffector::HingeEffector  ) 
 

Definition at line 29 of file hingeeffector.cpp.

References zeitgeist::Leaf::SetName().

Here is the call graph for this function:

HingeEffector::~HingeEffector  )  [virtual]
 

Definition at line 34 of file hingeeffector.cpp.


Member Function Documentation

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

constructs an Actionobject, describing a predicate

Implements oxygen::Effector.

Definition at line 61 of file hingeeffector.cpp.

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

Here is the call graph for this function:

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

returns the name of the predicate this effector implements.

Implements oxygen::Effector.

Definition at line 36 of file hingeeffector.h.

References zeitgeist::Leaf::GetName().

Referenced by GetActionObject().

Here is the call graph for this function:

void HingeEffector::OnLink  )  [protected, virtual]
 

setup the reference to the HingeJoint parent node

Reimplemented from zeitgeist::Leaf.

Definition at line 94 of file hingeeffector.cpp.

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

Here is the call graph for this function:

void HingeEffector::OnUnlink  )  [protected, virtual]
 

remove the reference to the HingeJoint parent node

Reimplemented from zeitgeist::Leaf.

Definition at line 106 of file hingeeffector.cpp.

References mJoint.

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

realizes the action described by the ActionObject

Implements oxygen::Effector.

Definition at line 38 of file hingeeffector.cpp.

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

Here is the call graph for this function:


Member Data Documentation

boost::shared_ptr<oxygen::HingeJoint> HingeEffector::mJoint [protected]
 

cached reference to the monitor joint

Definition at line 51 of file hingeeffector.h.

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


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