PhysicsObjectInterface Class Reference

#include <PhysicsObjectInterface.h>

Inherited by CursorSpringConnector, and PhysicsEntity.

List of all members.

Public Member Functions
virtual	~PhysicsObjectInterface ()
virtual void	getRigidBodies (std::vector< oops::RigidBody * > &rigidBodyList)=0
virtual void	getJoints (std::vector< oops::Joint * > &jointList)=0
virtual PhysicsObjectID	getPhysicsObjectID ()=0
virtual void	setPhysicsObjectManager (PhysicsObjectManager *objectManager)=0
Friends
class	SynchronisationModel

---

Detailed Description

Interface for all simulated objects of the Physics Module This interface is used for the simulated objects of the Physics Module. Every object which should be simulated has to implement this interface.

---

Constructor & Destructor Documentation

virtual PhysicsObjectInterface::~PhysicsObjectInterface

(

)

[inline, virtual]

Empty destructor.

---

Member Function Documentation

virtual void PhysicsObjectInterface::getJoints

(

std::vector< oops::Joint * > &

jointList

)

[pure virtual]

Fills the passed list with all Joints it contains. It is mainly used by the PhysicsObjectManager to add the Joints to the simulation.

Parameters:

jointList

List which is filled with contained Joints

Implemented in ArticulatedPhysicsEntity, CursorSpringConnector, LinkedPhysicsEntity, PhysicsEntity, and SimplePhysicsEntity.

virtual PhysicsObjectID PhysicsObjectInterface::getPhysicsObjectID

(

)

[pure virtual]

Adds the PhysicsObject to the passed simulation instance.

Parameters:

simulation

oops::Simulation class instance

Returns:

true if the object could be added, false otherwise Removes the PhysicsObject from the passed simulation instance.

Parameters:

simulation

oops::Simulation class instance

Returns:

true if the object could be removed, false otherwise Returns the ID of the PhysicsObject. The method has to return the unique PhysicsObjectID of the PhysicsObject. The programmer has to ensure that this PhysicsObjectID is set properly and that it is unique.

ID of the PhysicsObject

Implemented in ArticulatedPhysicsEntity, CursorSpringConnector, LinkedPhysicsEntity, PhysicsEntity, and SimplePhysicsEntity.

virtual void PhysicsObjectInterface::getRigidBodies

(

std::vector< oops::RigidBody * > &

rigidBodyList

)

[pure virtual]

Fills the passed list with all RigidBodies it contains. It is mainly used by the PhysicsObjectManager to add the RigidBodies to the simulation.

Parameters:

rigidBodyList

List which is filled with contained RigidBodies

Implemented in ArticulatedPhysicsEntity, CursorSpringConnector, LinkedPhysicsEntity, PhysicsEntity, and SimplePhysicsEntity.

virtual void PhysicsObjectInterface::setPhysicsObjectManager

(

PhysicsObjectManager *

objectManager

)

[pure virtual]

Transforms the incoming Message into a message call. The method is called from the PhysicsObjectManager. It has to decode the passed Message and call the method call encoded in it.

Parameters:

msg

Message containing a method call

Returns:

true if the encoded method could be called, false otherwise Sets the PhysicsObjectManager responsible for the object. The method has to store the PhysicsObjectManager in order to call the handleClientInput method if a change in the physical state of the PhysicsObject should take place (e.g. via a user input)

Parameters:

objectManager

PhysicsObjectManager responsible for the object

Implemented in CursorSpringConnector, and PhysicsEntity.

---

Friends And Related Function Documentation

friend class SynchronisationModel [friend]

---

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

• src/inVRs/Modules/3DPhysics/PhysicsObjectInterface.h