Skip to content
Snippets Groups Projects
Commit 51559f7c authored by Sebastian Eibl's avatar Sebastian Eibl
Browse files

added some documentation

parent 5af6b820
Branches
Tags
No related merge requests found
...@@ -33,12 +33,14 @@ namespace ccd { ...@@ -33,12 +33,14 @@ namespace ccd {
class ICCD : private NonCopyable { class ICCD : private NonCopyable {
public: public:
virtual ~ICCD() {}; virtual ~ICCD() {}
/// Generates a list of possible contact pairs.
/// This list is also stored in the member variable contacts_ for reuse lateron.
virtual PossibleContacts& generatePossibleContacts( WcTimingTree* tt = NULL ) = 0; virtual PossibleContacts& generatePossibleContacts( WcTimingTree* tt = NULL ) = 0;
PossibleContacts& getPossibleContacts() {return contacts_;} PossibleContacts& getPossibleContacts() {return contacts_;}
virtual void reloadBodies() {}; virtual void reloadBodies() {}
virtual int getObservedBodyCount() const = 0; virtual int getObservedBodyCount() const = 0;
protected: protected:
PossibleContacts contacts_; PossibleContacts contacts_;
......
...@@ -37,7 +37,18 @@ class IFCD : private NonCopyable{ ...@@ -37,7 +37,18 @@ class IFCD : private NonCopyable{
public: public:
virtual ~IFCD() {}; virtual ~IFCD() {};
///
/// \brief generates a list of actual collisions
///
/// Takes a list of possible contacts (pair of BodyIDs) and checks them
/// for actual collision. All generated contacts are stored in the member variable
/// contacts_ for later reuse.
/// Returns a list containing all contact points detected.
/// \param possibleContacts list of possible contacts generated by coarse collision detection
/// \return list of actual contacts
///
virtual Contacts& generateContacts(PossibleContacts& possibleContacts) = 0; virtual Contacts& generateContacts(PossibleContacts& possibleContacts) = 0;
/// returns saved list of contacts
Contacts& getContacts() {return contacts_;} Contacts& getContacts() {return contacts_;}
protected: protected:
Contacts contacts_; Contacts contacts_;
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment