From 51559f7c5c2b12d90b48ad06e6fda018b5019985 Mon Sep 17 00:00:00 2001
From: Sebastian Eibl <sebastian.eibl@fau.de>
Date: Fri, 14 Jul 2017 15:11:47 +0200
Subject: [PATCH] added some documentation
---
src/pe/ccd/ICCD.h | 6 ++++--
src/pe/fcd/IFCD.h | 11 +++++++++++
2 files changed, 15 insertions(+), 2 deletions(-)
diff --git a/src/pe/ccd/ICCD.h b/src/pe/ccd/ICCD.h
index d3922b5ed..b47a301e4 100644
--- a/src/pe/ccd/ICCD.h
+++ b/src/pe/ccd/ICCD.h
@@ -33,12 +33,14 @@ namespace ccd {
class ICCD : private NonCopyable {
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;
PossibleContacts& getPossibleContacts() {return contacts_;}
- virtual void reloadBodies() {};
+ virtual void reloadBodies() {}
virtual int getObservedBodyCount() const = 0;
protected:
PossibleContacts contacts_;
diff --git a/src/pe/fcd/IFCD.h b/src/pe/fcd/IFCD.h
index 63b7e5a4f..0fb86fc59 100644
--- a/src/pe/fcd/IFCD.h
+++ b/src/pe/fcd/IFCD.h
@@ -37,7 +37,18 @@ class IFCD : private NonCopyable{
public:
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;
+ /// returns saved list of contacts
Contacts& getContacts() {return contacts_;}
protected:
Contacts contacts_;
--
GitLab