Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

physics::CollisionState Class Reference

Inheritance diagram for physics::CollisionState:

Inheritance graph
[legend]
Collaboration diagram for physics::CollisionState:

Collaboration graph
[legend]
List of all members.

Public Types

typedef std::vector< ContactContacts

Public Member Functions

 CollisionState (ref< const Collidable > collidable1, ref< const Collidable > collidable2)
 CollisionState (const CollisionState &cs)
virtual ~CollisionState ()
virtual String className () const
virtual base::Objectclone () const
virtual bool isSameKindAs (const ReferencedObject &) const
virtual bool isSameKindAs (const Object &) const
void reference () const
bool unreference () const
const int referenceCount () const
void enableOnUnreferenceCall (bool enabled)
virtual void onUnreference () const

Public Attributes

ref< const Collidablecollidable1
ref< const Collidablecollidable2
Contacts contacts

Protected Attributes

int _refCount
bool onUnreferenceEnabled

Member Typedef Documentation

typedef std::vector<Contact> physics::CollisionState::Contacts
 

Definition at line 68 of file CollisionState.


Constructor & Destructor Documentation

physics::CollisionState::CollisionState ref< const Collidable collidable1,
ref< const Collidable collidable2
[inline]
 

Definition at line 42 of file CollisionState.

Referenced by clone().

physics::CollisionState::CollisionState const CollisionState cs  )  [inline]
 

Definition at line 44 of file CollisionState.

References collidable1, collidable2, and contacts.

virtual physics::CollisionState::~CollisionState  )  [inline, virtual]
 

Definition at line 46 of file CollisionState.


Member Function Documentation

virtual String physics::CollisionState::className  )  const [inline, virtual]
 

return the name of the object's class type. Must be defined by derived classes.

Implements base::Object.

Reimplemented in physics::GJKCollisionDetector::GJKCollisionState, physics::OBBCollisionDetector::OBBCollisionState, physics::ODECollisionDetector::ODECollisionState, and physics::SOLIDCollisionDetector::SOLIDCollisionState.

Definition at line 48 of file CollisionState.

Referenced by clone().

virtual base::Object& physics::CollisionState::clone  )  const [inline, virtual]
 

Definition at line 49 of file CollisionState.

References className(), CollisionState(), and NewNamedObj.

void base::Referenced::enableOnUnreferenceCall bool  enabled  )  [inline, inherited]
 

If enabled, each call to unreference() will also call virtual method onUnreference()

Definition at line 115 of file Referenced.

References base::Referenced::onUnreferenceEnabled.

virtual bool base::Object::isSameKindAs const Object  )  const [inline, virtual, inherited]
 

Definition at line 47 of file Object.

virtual bool base::ReferencedObject::isSameKindAs const ReferencedObject  )  const [inline, virtual, inherited]
 

Definition at line 52 of file ReferencedObject.

virtual void base::Referenced::onUnreference  )  const [inline, virtual, inherited]
 

Called by unreference() if enabled via enableOnUnreferenceCall(true). Typically overridden in subclasses that wish to know about unreference() calls - for example to handle manually breaking cyclic references

Reimplemented in robot::control::ControllableAdaptor::AdaptorControlInterface, and robot::control::ControllableAdaptor.

Definition at line 121 of file Referenced.

Referenced by base::Referenced::unreference().

void base::Referenced::reference  )  const [inline, inherited]
 

Increment the reference count by one, indicating that this object has another pointer which is referencing it.

Definition at line 65 of file Referenced.

References base::Referenced::_refCount.

const int base::Referenced::referenceCount  )  const [inline, inherited]
 

Return the number pointers currently referencing this object.

Definition at line 112 of file Referenced.

References base::Referenced::_refCount.

Referenced by robot::control::ControllableAdaptor::AdaptorControlInterface::onUnreference().

bool base::Referenced::unreference  )  const [inline, inherited]
 

Decrement the reference count by one, indicating that a pointer to this object is referencing it. If the refence count goes to zero, it is assumed that this object is nolonger referenced and is automatically deleted.

Definition at line 81 of file Referenced.

References base::Referenced::_refCount, Exception, base::Referenced::onUnreference(), and base::Referenced::onUnreferenceEnabled.


Member Data Documentation

int base::Referenced::_refCount [mutable, protected, inherited]
 

Definition at line 136 of file Referenced.

Referenced by base::Referenced::reference(), base::Referenced::referenceCount(), base::Referenced::Referenced(), base::Referenced::unreference(), and base::Referenced::~Referenced().

ref<const Collidable> physics::CollisionState::collidable1
 

Definition at line 52 of file CollisionState.

Referenced by CollisionState().

ref<const Collidable> physics::CollisionState::collidable2
 

Definition at line 53 of file CollisionState.

Referenced by CollisionState().

Contacts physics::CollisionState::contacts
 

Definition at line 69 of file CollisionState.

Referenced by CollisionState().

bool base::Referenced::onUnreferenceEnabled [protected, inherited]
 

Definition at line 137 of file Referenced.

Referenced by base::Referenced::enableOnUnreferenceCall(), base::Referenced::Referenced(), and base::Referenced::unreference().


The documentation for this class was generated from the following file:
Generated on Thu Jul 29 16:40:17 2004 for OpenSim by doxygen 1.3.6